#include <portable_ui_test.h>

Inheritance diagram for fuchsia_test_utils::PortableUITest:

Public Member Functions
void	SetUp (bool build_realm=true)

void	BuildRealm ()

void	LaunchClient ()

void	LaunchClientWithEmbeddedView ()

bool	HasViewConnected (zx_koid_t view_ref_koid)

void	RegisterTouchScreen ()

void	RegisterMouse ()

void	RegisterKeyboard ()

void	InjectTap (int32_t x, int32_t y)

void	SimulateMouseEvent (std::vector< fuchsia::ui::test::input::MouseButton > pressed_buttons, int movement_x, int movement_y)

void	SimulateMouseScroll (std::vector< fuchsia::ui::test::input::MouseButton > pressed_buttons, int scroll_x, int scroll_y, bool use_physical_units=false)

void	SimulateTextEntry (std::string text)

Static Public Attributes
static constexpr auto	kVulkanLoaderServiceName

static constexpr auto	kPosixSocketProviderName

static constexpr auto	kPointerInjectorRegistryName

static constexpr auto	kTestUIStack = "ui"

static constexpr auto	kTestUIStackRef

static constexpr auto	kFlutterJitRunner = "flutter_jit_runner"

static constexpr auto	kFlutterJitRunnerRef

static constexpr auto	kFlutterJitRunnerUrl

static constexpr auto	kFlutterRunnerEnvironment = "flutter_runner_env"

Protected Member Functions
component_testing::RealmBuilder *	realm_builder ()

component_testing::RealmRoot *	realm_root ()

int	touch_injection_request_count () const

Protected Attributes
uint32_t	display_width_ = 0

uint32_t	display_height_ = 0

Private Member Functions
virtual void	ExtendRealm ()=0

virtual std::string	GetTestUIStackUrl ()=0

Detailed Description

Definition at line 24 of file portable_ui_test.h.

Member Function Documentation

◆ BuildRealm()

void fuchsia_test_utils::PortableUITest::BuildRealm ( )

Definition at line 44 of file portable_ui_test.cc.

                                {
  realm_ = std::make_unique<RealmRoot>(realm_builder_.Build());
}

◆ ExtendRealm()

virtual void fuchsia_test_utils::PortableUITest::ExtendRealm ( )

privatepure virtual

◆ GetTestUIStackUrl()

virtual std::string fuchsia_test_utils::PortableUITest::GetTestUIStackUrl ( )

privatepure virtual

◆ HasViewConnected()

bool fuchsia_test_utils::PortableUITest::HasViewConnected ( zx_koid_t view_ref_koid )

Definition at line 147 of file portable_ui_test.cc.

                                                             {
  return last_view_tree_snapshot_.has_value() &&
         CheckViewExistsInSnapshot(*last_view_tree_snapshot_, view_ref_koid);
}

◆ InjectTap()

void fuchsia_test_utils::PortableUITest::InjectTap	(	int32_t	x,
		int32_t	y
	)

Definition at line 281 of file portable_ui_test.cc.

                                                   {
  fuchsia::ui::test::input::TouchScreenSimulateTapRequest tap_request;
  tap_request.mutable_tap_location()->x = x;
  tap_request.mutable_tap_location()->y = y;
 
  FML_LOG(INFO) << "Injecting tap at (" << tap_request.tap_location().x << ", "
                << tap_request.tap_location().y << ")";
  fake_touchscreen_->SimulateTap(std::move(tap_request), [this]() {
    ++touch_injection_request_count_;
    FML_LOG(INFO) << "*** Tap injected, count: "
                  << touch_injection_request_count_;
  });
}

◆ LaunchClient()

void fuchsia_test_utils::PortableUITest::LaunchClient ( )

Definition at line 152 of file portable_ui_test.cc.

                                  {
  scene_provider_ =
      realm_->component().Connect<fuchsia::ui::test::scene::Controller>();
  scene_provider_.set_error_handler([](auto) {
    FML_LOG(ERROR) << "Error from test scene provider: "
                   << &zx_status_get_string;
  });
 
  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), [this](auto client_view_ref_koid) {
        client_root_view_ref_koid_ = client_view_ref_koid;
      });
 
  FML_LOG(INFO) << "Waiting for client view ref koid";
  RunLoopUntil([this] { return client_root_view_ref_koid_.has_value(); });
 
  WatchViewGeometry();
 
  FML_LOG(INFO) << "Waiting for client view to connect";
  // Wait for the client view to get attached to the view tree.
  RunLoopUntil(
      [this] { return HasViewConnected(*client_root_view_ref_koid_); });
  FML_LOG(INFO) << "Client view has rendered";
}

◆ LaunchClientWithEmbeddedView()

void fuchsia_test_utils::PortableUITest::LaunchClientWithEmbeddedView ( )

Definition at line 182 of file portable_ui_test.cc.

                                                  {
  LaunchClient();
  // At this point, the parent view must have rendered, so we just need to wait
  // for the embedded view.
  RunLoopUntil([this] {
    if (!last_view_tree_snapshot_.has_value() ||
        !last_view_tree_snapshot_->has_views()) {
      return false;
    }
 
    if (!client_root_view_ref_koid_.has_value()) {
      return false;
    }
 
    for (const auto& view : last_view_tree_snapshot_->views()) {
      if (!view.has_view_ref_koid() ||
          view.view_ref_koid() != *client_root_view_ref_koid_) {
        continue;
      }
 
      if (view.children().empty()) {
        return false;
      }
 
      // NOTE: We can't rely on the presence of the child view in
      // `view.children()` to guarantee that it has rendered. The child view
      // also needs to be present in `last_view_tree_snapshot_->views`.
      return std::count_if(
                 last_view_tree_snapshot_->views().begin(),
                 last_view_tree_snapshot_->views().end(),
                 [view_to_find =
                      view.children().back()](const auto& view_to_check) {
                   return view_to_check.has_view_ref_koid() &&
                          view_to_check.view_ref_koid() == view_to_find;
                 }) > 0;
    }
 
    return false;
  });
 
  FML_LOG(INFO) << "Embedded view has rendered";
}

◆ realm_builder()

component_testing::RealmBuilder * fuchsia_test_utils::PortableUITest::realm_builder ( )

inlineprotected

Definition at line 99 of file portable_ui_test.h.

99{ return &realm_builder_; }

◆ realm_root()

component_testing::RealmRoot * fuchsia_test_utils::PortableUITest::realm_root ( )

inlineprotected

Definition at line 100 of file portable_ui_test.h.

100{ return realm_.get(); }

◆ RegisterKeyboard()

void fuchsia_test_utils::PortableUITest::RegisterKeyboard ( )

Definition at line 262 of file portable_ui_test.cc.

                                      {
  FML_LOG(INFO) << "Registering fake keyboard";
  input_registry_ =
      realm_->component().Connect<fuchsia::ui::test::input::Registry>();
  input_registry_.set_error_handler([](auto) {
    FML_LOG(ERROR) << "Error from input helper: " << &zx_status_get_string;
  });
 
  bool keyboard_registered = false;
  fuchsia::ui::test::input::RegistryRegisterKeyboardRequest request;
  request.set_device(fake_keyboard_.NewRequest());
  input_registry_->RegisterKeyboard(
      std::move(request),
      [&keyboard_registered]() { keyboard_registered = true; });
 
  RunLoopUntil([&keyboard_registered] { return keyboard_registered; });
  FML_LOG(INFO) << "Keyboard registered";
}

◆ RegisterMouse()

void fuchsia_test_utils::PortableUITest::RegisterMouse ( )

Definition at line 244 of file portable_ui_test.cc.

                                   {
  FML_LOG(INFO) << "Registering fake mouse";
  input_registry_ =
      realm_->component().Connect<fuchsia::ui::test::input::Registry>();
  input_registry_.set_error_handler([](auto) {
    FML_LOG(ERROR) << "Error from input helper: " << &zx_status_get_string;
  });
 
  bool mouse_registered = false;
  fuchsia::ui::test::input::RegistryRegisterMouseRequest request;
  request.set_device(fake_mouse_.NewRequest());
  input_registry_->RegisterMouse(
      std::move(request), [&mouse_registered]() { mouse_registered = true; });
 
  RunLoopUntil([&mouse_registered] { return mouse_registered; });
  FML_LOG(INFO) << "Mouse registered";
}

◆ RegisterTouchScreen()

void fuchsia_test_utils::PortableUITest::RegisterTouchScreen ( )

Definition at line 225 of file portable_ui_test.cc.

                                         {
  FML_LOG(INFO) << "Registering fake touch screen";
  input_registry_ =
      realm_->component().Connect<fuchsia::ui::test::input::Registry>();
  input_registry_.set_error_handler([](auto) {
    FML_LOG(ERROR) << "Error from input helper: " << &zx_status_get_string;
  });
 
  bool touchscreen_registered = false;
  fuchsia::ui::test::input::RegistryRegisterTouchScreenRequest request;
  request.set_device(fake_touchscreen_.NewRequest());
  input_registry_->RegisterTouchScreen(
      std::move(request),
      [&touchscreen_registered]() { touchscreen_registered = true; });
 
  RunLoopUntil([&touchscreen_registered] { return touchscreen_registered; });
  FML_LOG(INFO) << "Touchscreen registered";
}

◆ SetUp()

void fuchsia_test_utils::PortableUITest::SetUp ( bool build_realm = true )

Definition at line 35 of file portable_ui_test.cc.

                                           {
  SetUpRealmBase();
  ExtendRealm();
 
  if (build_realm) {
    BuildRealm();
  }
}

◆ SimulateMouseEvent()

void fuchsia_test_utils::PortableUITest::SimulateMouseEvent	(	std::vector< fuchsia::ui::test::input::MouseButton >	pressed_buttons,
		int	movement_x,
		int	movement_y
	)

Definition at line 295 of file portable_ui_test.cc.

                    {
  fuchsia::ui::test::input::MouseSimulateMouseEventRequest request;
  request.set_pressed_buttons(std::move(pressed_buttons));
  request.set_movement_x(movement_x);
  request.set_movement_y(movement_y);
 
  FML_LOG(INFO) << "Injecting mouse input";
 
  fake_mouse_->SimulateMouseEvent(
      std::move(request), [] { FML_LOG(INFO) << "Mouse event injected"; });
}

◆ SimulateMouseScroll()

void fuchsia_test_utils::PortableUITest::SimulateMouseScroll	(	std::vector< fuchsia::ui::test::input::MouseButton >	pressed_buttons,
		int	scroll_x,
		int	scroll_y,
		bool	use_physical_units = `false`
	)

Definition at line 310 of file portable_ui_test.cc.

                             {
  FML_LOG(INFO) << "Requesting mouse scroll";
  fuchsia::ui::test::input::MouseSimulateMouseEventRequest request;
  request.set_pressed_buttons(std::move(pressed_buttons));
  if (use_physical_units) {
    request.set_scroll_h_physical_pixel(scroll_x);
    request.set_scroll_v_physical_pixel(scroll_y);
  } else {
    request.set_scroll_h_detent(scroll_x);
    request.set_scroll_v_detent(scroll_y);
  }
 
  fake_mouse_->SimulateMouseEvent(std::move(request), [] {
    FML_LOG(INFO) << "Mouse scroll event injected";
  });
}

◆ SimulateTextEntry()

void fuchsia_test_utils::PortableUITest::SimulateTextEntry ( std::string text )

Definition at line 331 of file portable_ui_test.cc.

                                                     {
  FML_LOG(INFO) << "Sending text request";
  bool done = false;
 
  fuchsia::ui::test::input::KeyboardSimulateUsAsciiTextEntryRequest request;
  request.set_text(text);
  fake_keyboard_->SimulateUsAsciiTextEntry(std::move(request),
                                           [&done]() { done = true; });
 
  RunLoopUntil([&] { return done; });
  FML_LOG(INFO) << "Text request sent";
}

◆ touch_injection_request_count()

int fuchsia_test_utils::PortableUITest::touch_injection_request_count ( ) const

inlineprotected

Definition at line 105 of file portable_ui_test.h.

                                            {
    return touch_injection_request_count_;
  }

Member Data Documentation

◆ display_height_

uint32_t fuchsia_test_utils::PortableUITest::display_height_ = 0

protected

Definition at line 103 of file portable_ui_test.h.

◆ display_width_

uint32_t fuchsia_test_utils::PortableUITest::display_width_ = 0

protected

Definition at line 102 of file portable_ui_test.h.

◆ kFlutterJitRunner

constexpr auto fuchsia_test_utils::PortableUITest::kFlutterJitRunner = "flutter_jit_runner"

staticconstexpr

Definition at line 39 of file portable_ui_test.h.

◆ kFlutterJitRunnerRef

constexpr auto fuchsia_test_utils::PortableUITest::kFlutterJitRunnerRef

staticconstexpr

Initial value:

=

component_testing::ChildRef{kFlutterJitRunner}

fuchsia_test_utils::PortableUITest::kFlutterJitRunner

static constexpr auto kFlutterJitRunner

Definition: portable_ui_test.h:39

Definition at line 40 of file portable_ui_test.h.

◆ kFlutterJitRunnerUrl

constexpr auto fuchsia_test_utils::PortableUITest::kFlutterJitRunnerUrl

staticconstexpr

Initial value:

=
      "fuchsia-pkg://fuchsia.com/oot_flutter_jit_runner#meta/"
      "flutter_jit_runner.cm"

Definition at line 42 of file portable_ui_test.h.

◆ kFlutterRunnerEnvironment

constexpr auto fuchsia_test_utils::PortableUITest::kFlutterRunnerEnvironment = "flutter_runner_env"

staticconstexpr

Definition at line 45 of file portable_ui_test.h.

◆ kPointerInjectorRegistryName

constexpr auto fuchsia_test_utils::PortableUITest::kPointerInjectorRegistryName

staticconstexpr

Initial value:

=

"fuchsia.ui.pointerinjector.Registry"

Definition at line 32 of file portable_ui_test.h.

◆ kPosixSocketProviderName

constexpr auto fuchsia_test_utils::PortableUITest::kPosixSocketProviderName

staticconstexpr

Initial value:

=

"fuchsia.posix.socket.Provider"

Definition at line 30 of file portable_ui_test.h.

◆ kTestUIStack

constexpr auto fuchsia_test_utils::PortableUITest::kTestUIStack = "ui"

staticconstexpr

Definition at line 36 of file portable_ui_test.h.

◆ kTestUIStackRef

constexpr auto fuchsia_test_utils::PortableUITest::kTestUIStackRef

staticconstexpr

Initial value:

=

component_testing::ChildRef{kTestUIStack}

fuchsia_test_utils::PortableUITest::kTestUIStack

static constexpr auto kTestUIStack

Definition: portable_ui_test.h:36

Definition at line 37 of file portable_ui_test.h.

◆ kVulkanLoaderServiceName

constexpr auto fuchsia_test_utils::PortableUITest::kVulkanLoaderServiceName

staticconstexpr

Initial value:

=

"fuchsia.vulkan.loader.Loader"

Definition at line 28 of file portable_ui_test.h.

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

shell/platform/fuchsia/flutter/tests/integration/utils/portable_ui_test.h
shell/platform/fuchsia/flutter/tests/integration/utils/portable_ui_test.cc

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ BuildRealm()

◆ ExtendRealm()

◆ GetTestUIStackUrl()

◆ HasViewConnected()

◆ InjectTap()

◆ LaunchClient()

◆ LaunchClientWithEmbeddedView()

◆ realm_builder()

◆ realm_root()

◆ RegisterKeyboard()

◆ RegisterMouse()

◆ RegisterTouchScreen()

◆ SetUp()

◆ SimulateMouseEvent()

◆ SimulateMouseScroll()

◆ SimulateTextEntry()

◆ touch_injection_request_count()

Member Data Documentation

◆ display_height_

◆ display_width_

◆ kFlutterJitRunner

◆ kFlutterJitRunnerRef

◆ kFlutterJitRunnerUrl

◆ kFlutterRunnerEnvironment

◆ kPointerInjectorRegistryName

◆ kPosixSocketProviderName

◆ kTestUIStack

◆ kTestUIStackRef

◆ kVulkanLoaderServiceName