dart_runner::DartTestComponentController Class Reference

#include <dart_test_component_controller.h>

Inheritance diagram for dart_runner::DartTestComponentController:

Public Member Functions
	DartTestComponentController (fuchsia::component::runner::ComponentStartInfo start_info, std::shared_ptr< sys::ServiceDirectory > runner_incoming_services, fidl::InterfaceRequest< fuchsia::component::runner::ComponentController > controller, DoneCallback done_callback)
	~DartTestComponentController () override
void	SetUp ()
void	GetTests (fidl::InterfaceRequest< fuchsia::test::CaseIterator > iterator) override
	|Suite| protocol implementation.
void	Run (std::vector< fuchsia::test::Invocation > tests, fuchsia::test::RunOptions options, fidl::InterfaceHandle< fuchsia::test::RunListener > listener) override
	|Suite| protocol implementation.
fidl::InterfaceRequestHandler< fuchsia::test::Suite >	GetHandler ()
void	handle_unknown_method (uint64_t ordinal, bool method_has_response) override

Detailed Description

Starts a Dart test component written in CFv2. It's different from DartComponentController in that it must implement the |fuchsia.test.Suite| protocol. It was forked to avoid a naming clash between the two classes' methods as the Suite protocol requires a Run() method for the test_manager to call on. This way, we avoid an extra layer between the test_manager and actual test execution. TODO(fxb/98369): Look into combining the two component classes once dart testing is stable.

Definition at line 35 of file dart_test_component_controller.h.

Constructor & Destructor Documentation

DartTestComponentController()

dart_runner::DartTestComponentController::DartTestComponentController	(	fuchsia::component::runner::ComponentStartInfo	start_info,
		std::shared_ptr< sys::ServiceDirectory >	runner_incoming_services,
		fidl::InterfaceRequest< fuchsia::component::runner::ComponentController >	controller,
		DoneCallback	done_callback
	)

Definition at line 102 of file dart_test_component_controller.cc.

    : loop_(new async::Loop(&kLoopConfig)),
      executor_(loop_->dispatcher()),
      label_(GetLabelFromUrl(start_info.resolved_url())),
      url_(std::move(start_info.resolved_url())),
      runner_incoming_services_(runner_incoming_services),
      start_info_(std::move(start_info)),
      binding_(this),
      done_callback_(std::move(done_callback)) {
  // TODO(fxb/84537): This data path is configured based how we build Flutter
  // applications in tree currently, but the way we build the Flutter
  // application may change. We should avoid assuming the data path and let the
  // CML file specify this data path instead.
  test_component_name_ = GetComponentNameFromUrl(url_);
  data_path_ = "pkg/data/" + test_component_name_;
 
  if (controller.is_valid()) {
    binding_.Bind(std::move(controller));
    binding_.set_error_handler([this](zx_status_t status) { Kill(); });
  } else {
    FML_LOG(ERROR) << "Fuchsia component controller endpoint is not valid.";
  }
 
  zx_status_t idle_timer_status =
      zx::timer::create(ZX_TIMER_SLACK_LATE, ZX_CLOCK_MONOTONIC, &idle_timer_);
  if (idle_timer_status != ZX_OK) {
    FML_LOG(INFO) << "Idle timer creation failed: "
                  << zx_status_get_string(idle_timer_status);
  } else {
    idle_wait_.set_object(idle_timer_.get());
    idle_wait_.set_trigger(ZX_TIMER_SIGNALED);
    idle_wait_.Begin(async_get_default_dispatcher());
  }
 
  // Close the runtime_dir channel if we don't intend to serve it. Otherwise any
  // access to the runtime_dir will hang forever.
  start_info_.clear_runtime_dir();
}

References FML_LOG.

~DartTestComponentController()

dart_runner::DartTestComponentController::~DartTestComponentController ( )

override

Definition at line 146 of file dart_test_component_controller.cc.

                                                          {
  if (namespace_) {
    fdio_ns_destroy(namespace_);
    namespace_ = nullptr;
  }
  close(stdout_fd_);
  close(stderr_fd_);
}

Member Function Documentation

GetHandler()

fidl::InterfaceRequestHandler< fuchsia::test::Suite > dart_runner::DartTestComponentController::GetHandler ( )

inline

Definition at line 64 of file dart_test_component_controller.h.

                                                             {
    return suite_bindings_.GetHandler(this, loop_->dispatcher());
  }

Referenced by SetUp().

GetTests()

void dart_runner::DartTestComponentController::GetTests ( fidl::InterfaceRequest< fuchsia::test::CaseIterator >  iterator )

override

|Suite| protocol implementation.

Definition at line 408 of file dart_test_component_controller.cc.

                                                            {
  auto case_iterator = std::make_unique<CaseIterator>(
      std::move(iterator), loop_->dispatcher(), test_component_name_,
      [this](CaseIterator* case_iterator) {
        RemoveCaseInterator(case_iterator);
      });
  case_iterators_.emplace(case_iterator.get(), std::move(case_iterator));
}

handle_unknown_method()

void dart_runner::DartTestComponentController::handle_unknown_method ( uint64_t  ordinal, bool  method_has_response  )

override

Definition at line 670 of file dart_test_component_controller.cc.

                              {
  FML_LOG(ERROR) << "Unknown method called on DartTestComponentController. "
                    "Ordinal: "
                 << ordinal;
}

References FML_LOG.

Run()

void dart_runner::DartTestComponentController::Run ( std::vector< fuchsia::test::Invocation >  tests, fuchsia::test::RunOptions  options, fidl::InterfaceHandle< fuchsia::test::RunListener >  listener  )

override

|Suite| protocol implementation.

Definition at line 419 of file dart_test_component_controller.cc.

                                                          {
  std::vector<std::string> args;
  if (options.has_arguments()) {
    args = std::move(*options.mutable_arguments());
  }
 
  auto listener_proxy = listener.Bind();
 
  // We expect 1 test that will run all other tests in the test suite (i.e. a
  // single main.dart that calls out to all of the dart tests). If the dart
  // implementation in-tree changes, iterating over the invocations like so
  // will be able to handle that.
  for (auto it = tests.begin(); it != tests.end(); it++) {
    auto invocation = std::move(*it);
    std::string test_case_name;
    if (invocation.has_name()) {
      test_case_name = invocation.name();
    }
 
    // Create and out/err sockets and pass file descriptor for each to the
    // dart process so that logging can be forwarded to the test_manager.
    auto status = zx::socket::create(0, &out_, &out_client_);
    if (status != ZX_OK) {
      FML_LOG(FATAL) << "cannot create out socket: "
                     << zx_status_get_string(status);
    }
 
    status = fdio_fd_create(out_.release(), &stdout_fd_);
    if (status != ZX_OK) {
      FML_LOG(FATAL) << "failed to extract output fd: "
                     << zx_status_get_string(status);
    }
 
    status = zx::socket::create(0, &err_, &err_client_);
    if (status != ZX_OK) {
      FML_LOG(FATAL) << "cannot create error socket: "
                     << zx_status_get_string(status);
    }
 
    status = fdio_fd_create(err_.release(), &stderr_fd_);
    if (status != ZX_OK) {
      FML_LOG(FATAL) << "failed to extract error fd: "
                     << zx_status_get_string(status);
    }
 
    // Pass client end of out and err socket for test_manager to stream logs to
    // current terminal, via |fuchsia::test::StdHandles|.
    fuchsia::test::StdHandles std_handles;
    std_handles.set_out(std::move(out_client_));
    std_handles.set_err(std::move(err_client_));
 
    listener_proxy->OnTestCaseStarted(std::move(invocation),
                                      std::move(std_handles),
                                      case_listener_.NewRequest());
 
    // Run dart main and wait until exit code has been set before notifying of
    // test completion.
    auto dart_main_promise = fpromise::make_promise([&] { RunDartMain(); });
    auto dart_state = tonic::DartState::Current();
    executor_.schedule_task(std::move(dart_main_promise));
    while (!dart_state->has_set_return_code()) {
      loop_->Run(zx::deadline_after(kTestTimeout), true);
    }
 
    // Notify the test_manager that the test has completed.
    listener_proxy->OnFinished();
  }
 
  if (binding_.is_bound()) {
    // From the documentation for ComponentController, ZX_OK should be sent when
    // the ComponentController receives a termination request. However, if the
    // component exited with a non-zero return code, we indicate this by sending
    // an INTERNAL epitaph instead.
    //
    // TODO(fxb/86666): Communicate return code from the ComponentController
    // once v2 has support.
    if (return_code_ == 0) {
      binding_.Close(ZX_OK);
    } else {
      binding_.Close(zx_status_t(fuchsia::component::Error::INTERNAL));
    }
  }
 
  // Stop and kill the test component.
  Stop();
}

References args, tonic::DartState::Current(), and FML_LOG.

SetUp()

void dart_runner::DartTestComponentController::SetUp

(

)

Sets up the controller.

This should be called before |Run|.

Definition at line 155 of file dart_test_component_controller.cc.

                                        {
  // Name the thread after the url of the component being launched.
  zx::thread::self()->set_property(ZX_PROP_NAME, label_.c_str(), label_.size());
  Dart_SetThreadName(label_.c_str());
 
  if (!CreateAndBindNamespace()) {
    return;
  }
 
  if (SetUpFromAppSnapshot()) {
    FML_LOG(INFO) << url_ << " is running from an app snapshot";
  } else if (SetUpFromKernel()) {
    FML_LOG(INFO) << url_ << " is running from kernel";
  } else {
    FML_LOG(ERROR) << "Failed to set up component controller for " << url_;
    return;
  }
 
  // Serve |fuchsia::test::Suite| on outgoing directory.
  suite_context_ = sys::ComponentContext::Create();
  suite_context_->outgoing()->AddPublicService(this->GetHandler());
  suite_context_->outgoing()->Serve(
      std::move(*start_info_.mutable_outgoing_dir()), loop_->dispatcher());
 
  loop_->Run();
}

References FML_LOG, and GetHandler().

---

The documentation for this class was generated from the following files:

• shell/platform/fuchsia/dart_runner/dart_test_component_controller.h
• shell/platform/fuchsia/dart_runner/dart_test_component_controller.cc