flutter_embedder_test::FlutterEmbedderTest Class Reference

Inheritance diagram for flutter_embedder_test::FlutterEmbedderTest:

Public Member Functions
	FlutterEmbedderTest ()
bool	HasViewConnected (const fuchsia::ui::observation::geometry::ViewTreeWatcherPtr &view_tree_watcher, std::optional< fuchsia::ui::observation::geometry::WatchResponse > &watch_response, zx_koid_t view_ref_koid)
void	LaunchParentViewInRealm (const std::vector< std::string > &component_args={})
fuchsia_test_utils::Screenshot	TakeScreenshot ()
bool	TakeScreenshotUntil (fuchsia_test_utils::Pixel color, fit::function< void(std::map< fuchsia_test_utils::Pixel, uint32_t >)> callback=nullptr, zx::duration timeout=kTestTimeout)

Detailed Description

Definition at line 115 of file flutter-embedder-test.cc.

Constructor & Destructor Documentation

FlutterEmbedderTest()

flutter_embedder_test::FlutterEmbedderTest::FlutterEmbedderTest ( )

inline

Definition at line 118 of file flutter-embedder-test.cc.

      : realm_builder_(component_testing::RealmBuilder::Create()) {
    FML_VLOG(1) << "Setting up base realm";
    SetUpRealmBase();
 
    // Post a "just in case" quit task, if the test hangs.
    async::PostDelayedTask(
        dispatcher(),
        [] {
          FML_LOG(FATAL)
              << "\n\n>> Test did not complete in time, terminating.  <<\n\n";
        },
        kTestTimeout);
  }

References FML_LOG, and FML_VLOG.

Member Function Documentation

HasViewConnected()

bool flutter_embedder_test::FlutterEmbedderTest::HasViewConnected	(	const fuchsia::ui::observation::geometry::ViewTreeWatcherPtr &	view_tree_watcher,
		std::optional< fuchsia::ui::observation::geometry::WatchResponse > &	watch_response,
		zx_koid_t	view_ref_koid
	)

Definition at line 290 of file flutter-embedder-test.cc.

                             {
  std::optional<fuchsia::ui::observation::geometry::WatchResponse> watch_result;
  view_tree_watcher->Watch(
      [&watch_result](auto response) { watch_result = std::move(response); });
  FML_LOG(INFO) << "Waiting for view tree watch result";
  RunLoopUntil([&watch_result] { return watch_result.has_value(); });
  FML_LOG(INFO) << "Received for view tree watch result";
  if (CheckViewExistsInUpdates(watch_result->updates(), view_ref_koid)) {
    watch_response = std::move(watch_result);
  };
  return watch_response.has_value();
}

References FML_LOG.

Referenced by LaunchParentViewInRealm().

LaunchParentViewInRealm()

void flutter_embedder_test::FlutterEmbedderTest::LaunchParentViewInRealm

(

const std::vector< std::string > &

component_args = {}

)

Definition at line 308 of file flutter-embedder-test.cc.

                                                {
  FML_LOG(INFO) << "Launching parent-view";
 
  if (!component_args.empty()) {
    // Construct a args.csv file containing the specified comma-separated
    // component args.
    std::string csv;
    for (const auto& arg : component_args) {
      csv += arg + ',';
    }
    // Remove last comma.
    csv.pop_back();
 
    auto config_directory_contents = DirectoryContents();
    config_directory_contents.AddFile("args.csv", csv);
    realm_builder_.RouteReadOnlyDirectory("config-data", {kParentViewRef},
                                          std::move(config_directory_contents));
  }
  realm_ = std::make_unique<RealmRoot>(realm_builder_.Build());
 
  // Get the display information using the |fuchsia.ui.display.singleton.Info|.
  std::optional<bool> display_metrics_obtained;
  fuchsia::ui::display::singleton::InfoPtr display_info =
      realm_->component().Connect<fuchsia::ui::display::singleton::Info>();
  display_info->GetMetrics([this, &display_metrics_obtained](auto info) {
    display_width_ = info.extent_in_px().width;
    display_height_ = info.extent_in_px().height;
    display_metrics_obtained = true;
  });
  RunLoopUntil([&display_metrics_obtained] {
    return display_metrics_obtained.has_value();
  });
  FML_LOG(INFO) << "Got display_width " << display_width_ << " display_height "
                << display_height_;
 
  // Instruct Test UI Stack to present parent-view's View.
  std::optional<zx_koid_t> view_ref_koid;
  scene_provider_ =
      realm_->component().Connect<fuchsia::ui::test::scene::Controller>();
  scene_provider_.set_error_handler(
      [](auto) { FML_LOG(ERROR) << "Error from test scene provider"; });
  fuchsia::ui::test::scene::ControllerAttachClientViewRequest request;
  request.set_view_provider(
      realm_->component().Connect<fuchsia::ui::app::ViewProvider>());
  scene_provider_->RegisterViewTreeWatcher(view_tree_watcher_.NewRequest(),
                                           []() {});
  scene_provider_->AttachClientView(
      std::move(request), [&view_ref_koid](auto client_view_ref_koid) {
        view_ref_koid = client_view_ref_koid;
      });
 
  FML_LOG(INFO) << "Waiting for client view ref koid";
  RunLoopUntil([&view_ref_koid] { return view_ref_koid.has_value(); });
 
  // Wait for the client view to get attached to the view tree.
  std::optional<fuchsia::ui::observation::geometry::WatchResponse>
      watch_response;
  FML_LOG(INFO) << "Waiting for client view to render; koid is "
                << (view_ref_koid.has_value() ? view_ref_koid.value() : 0);
  RunLoopUntil([this, &watch_response, &view_ref_koid] {
    return HasViewConnected(view_tree_watcher_, watch_response, *view_ref_koid);
  });
  FML_LOG(INFO) << "Client view has rendered";
 
  screenshot_ =
      realm_->component().Connect<fuchsia::ui::composition::Screenshot>();
  FML_LOG(INFO) << "Launched parent-view";
}

References FML_LOG, and HasViewConnected().

TakeScreenshot()

fuchsia_test_utils::Screenshot flutter_embedder_test::FlutterEmbedderTest::TakeScreenshot

(

)

Definition at line 378 of file flutter-embedder-test.cc.

                                                                 {
  FML_LOG(INFO) << "Taking screenshot... ";
 
  fuchsia::ui::composition::ScreenshotTakeRequest request;
  request.set_format(fuchsia::ui::composition::ScreenshotFormat::BGRA_RAW);
 
  std::optional<fuchsia::ui::composition::ScreenshotTakeResponse> response;
  screenshot_->Take(std::move(request), [this, &response](auto screenshot) {
    response = std::move(screenshot);
    QuitLoop();
  });
 
  EXPECT_FALSE(RunLoopWithTimeout(kScreenshotTimeout))
      << "Timed out waiting for screenshot.";
  FML_LOG(INFO) << "Screenshot captured.";
 
  return fuchsia_test_utils::Screenshot(
      response->vmo(), display_width_, display_height_, /*display_rotation*/ 0);
}

References FML_LOG.

Referenced by TakeScreenshotUntil().

TakeScreenshotUntil()

bool flutter_embedder_test::FlutterEmbedderTest::TakeScreenshotUntil	(	fuchsia_test_utils::Pixel	color,
		fit::function< void(std::map< fuchsia_test_utils::Pixel, uint32_t >)>	callback = nullptr,
		zx::duration	timeout = kTestTimeout
	)

Definition at line 398 of file flutter-embedder-test.cc.

                        {
  return RunLoopWithTimeoutOrUntil(
      [this, &callback, &color] {
        auto screenshot = TakeScreenshot();
        auto histogram = screenshot.Histogram();
 
        bool color_found = histogram[color] > 0;
        if (color_found && callback != nullptr) {
          callback(std::move(histogram));
        }
        return color_found;
      },
      timeout);
}

References callback, and TakeScreenshot().

---

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

• shell/platform/fuchsia/flutter/tests/integration/embedder/flutter-embedder-test.cc