8 #include <wrl/client.h>
11 #include "flutter/fml/synchronization/count_down_latch.h"
12 #include "flutter/fml/synchronization/waitable_event.h"
14 #include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
16 #include "flutter/shell/platform/windows/testing/engine_modifier.h"
17 #include "flutter/shell/platform/windows/testing/windows_test.h"
18 #include "flutter/shell/platform/windows/testing/windows_test_config_builder.h"
19 #include "flutter/shell/platform/windows/testing/windows_test_context.h"
21 #include "flutter/testing/stream_capture.h"
22 #include "gmock/gmock.h"
23 #include "gtest/gtest.h"
24 #include "third_party/tonic/converter/dart_converter.h"
32 class HalfBrokenEGLManager :
public egl::Manager {
36 std::unique_ptr<egl::WindowSurface>
37 CreateWindowSurface(HWND hwnd,
size_t width,
size_t height)
override {
42 class MockWindowsLifecycleManager :
public WindowsLifecycleManager {
54 if (::GetMessage(&msg,
nullptr, 0, 0)) {
55 ::TranslateMessage(&msg);
56 ::DispatchMessage(&msg);
64 TEST(WindowsNoFixtureTest, GetTextureRegistrar) {
69 ASSERT_NE(engine,
nullptr);
71 EXPECT_NE(texture_registrar,
nullptr);
77 auto& context = GetContext();
78 WindowsConfigBuilder builder(context);
79 ViewControllerPtr controller{builder.Run()};
80 ASSERT_NE(controller,
nullptr);
84 TEST_F(WindowsTest, LaunchMainHasNoOutput) {
87 StreamCapture stderr_capture(&std::cerr);
89 auto& context = GetContext();
90 WindowsConfigBuilder builder(context);
91 ViewControllerPtr controller{builder.Run()};
92 ASSERT_NE(controller,
nullptr);
94 stderr_capture.Stop();
97 EXPECT_TRUE(stderr_capture.GetOutput().empty());
101 TEST_F(WindowsTest, LaunchCustomEntrypoint) {
102 auto& context = GetContext();
103 WindowsConfigBuilder builder(context);
104 builder.SetDartEntrypoint(
"customEntrypoint");
105 ViewControllerPtr controller{builder.Run()};
106 ASSERT_NE(controller,
nullptr);
114 TEST_F(WindowsTest, LaunchCustomEntrypointInEngineRunInvocation) {
115 auto& context = GetContext();
116 WindowsConfigBuilder builder(context);
117 EnginePtr engine{builder.InitializeEngine()};
118 ASSERT_NE(engine,
nullptr);
124 TEST_F(WindowsTest, LaunchHeadlessEngine) {
125 auto& context = GetContext();
126 WindowsConfigBuilder builder(context);
127 builder.SetDartEntrypoint(
"signalViewIds");
128 EnginePtr engine{builder.RunHeadless()};
129 ASSERT_NE(engine,
nullptr);
131 std::string view_ids;
132 bool signaled =
false;
133 context.AddNativeFunction(
134 "SignalStringValue", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
135 auto handle = Dart_GetNativeArgument(args, 0);
136 ASSERT_FALSE(Dart_IsError(handle));
137 view_ids = tonic::DartConverter<std::string>::FromDart(handle);
141 ViewControllerPtr controller{builder.Run()};
142 ASSERT_NE(controller,
nullptr);
149 EXPECT_EQ(view_ids,
"View IDs: [0]");
153 TEST_F(WindowsTest, EngineCanTransitionToHeadless) {
154 auto& context = GetContext();
155 WindowsConfigBuilder builder(context);
156 EnginePtr engine{builder.RunHeadless()};
157 ASSERT_NE(engine,
nullptr);
163 ViewControllerPtr controller{
166 ASSERT_NE(controller,
nullptr);
170 ASSERT_NE(engine,
nullptr);
173 ASSERT_TRUE(engine_ptr->running());
177 TEST_F(WindowsTest, LaunchRefreshesAccessibility) {
178 auto& context = GetContext();
179 WindowsConfigBuilder builder(context);
180 EnginePtr engine{builder.InitializeEngine()};
181 EngineModifier modifier{
186 UpdateAccessibilityFeatures, ([&called](
auto engine,
auto flags) {
191 ViewControllerPtr controller{
202 TEST_F(WindowsTest, LaunchConflictingCustomEntrypoints) {
203 auto& context = GetContext();
204 WindowsConfigBuilder builder(context);
205 builder.SetDartEntrypoint(
"customEntrypoint");
206 EnginePtr engine{builder.InitializeEngine()};
207 ASSERT_NE(engine,
nullptr);
213 TEST_F(WindowsTest, VerifyNativeFunction) {
214 auto& context = GetContext();
215 WindowsConfigBuilder builder(context);
216 builder.SetDartEntrypoint(
"verifyNativeFunction");
218 bool signaled =
false;
220 CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) { signaled =
true; });
221 context.AddNativeFunction(
"Signal", native_entry);
223 ViewControllerPtr controller{builder.Run()};
224 ASSERT_NE(controller,
nullptr);
234 TEST_F(WindowsTest, VerifyNativeFunctionWithParameters) {
235 auto& context = GetContext();
236 WindowsConfigBuilder builder(context);
237 builder.SetDartEntrypoint(
"verifyNativeFunctionWithParameters");
239 bool bool_value =
false;
240 bool signaled =
false;
241 auto native_entry = CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
242 auto handle = Dart_GetNativeBooleanArgument(args, 0, &bool_value);
243 ASSERT_FALSE(Dart_IsError(handle));
246 context.AddNativeFunction(
"SignalBoolValue", native_entry);
248 ViewControllerPtr controller{builder.Run()};
249 ASSERT_NE(controller,
nullptr);
255 EXPECT_TRUE(bool_value);
259 TEST_F(WindowsTest, PlatformExecutable) {
260 auto& context = GetContext();
261 WindowsConfigBuilder builder(context);
262 builder.SetDartEntrypoint(
"readPlatformExecutable");
264 std::string executable_name;
265 bool signaled =
false;
266 auto native_entry = CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
267 auto handle = Dart_GetNativeArgument(args, 0);
268 ASSERT_FALSE(Dart_IsError(handle));
269 executable_name = tonic::DartConverter<std::string>::FromDart(handle);
272 context.AddNativeFunction(
"SignalStringValue", native_entry);
274 ViewControllerPtr controller{builder.Run()};
275 ASSERT_NE(controller,
nullptr);
281 EXPECT_EQ(executable_name,
"flutter_windows_unittests.exe");
286 TEST_F(WindowsTest, VerifyNativeFunctionWithReturn) {
287 auto& context = GetContext();
288 WindowsConfigBuilder builder(context);
289 builder.SetDartEntrypoint(
"verifyNativeFunctionWithReturn");
291 bool bool_value_to_return =
true;
293 auto bool_return_entry = CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
294 Dart_SetBooleanReturnValue(args, bool_value_to_return);
297 context.AddNativeFunction(
"SignalBoolReturn", bool_return_entry);
299 bool bool_value_passed =
false;
300 auto bool_pass_entry = CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
301 auto handle = Dart_GetNativeBooleanArgument(args, 0, &bool_value_passed);
302 ASSERT_FALSE(Dart_IsError(handle));
305 context.AddNativeFunction(
"SignalBoolValue", bool_pass_entry);
307 ViewControllerPtr controller{builder.Run()};
308 ASSERT_NE(controller,
nullptr);
314 EXPECT_TRUE(bool_value_passed);
320 fml::AutoResetWaitableEvent frame_scheduled_latch;
321 std::thread::id thread_id;
326 auto platform_thread = std::make_unique<fml::Thread>(
"test_platform_thread");
327 platform_thread->GetTaskRunner()->PostTask([&]() {
328 captures.thread_id = std::this_thread::get_id();
330 auto& context = GetContext();
331 WindowsConfigBuilder builder(context);
332 builder.SetDartEntrypoint(
"drawHelloWorld");
334 auto native_entry = CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
335 captures.frame_scheduled_latch.Signal();
337 context.AddNativeFunction(
"NotifyFirstFrameScheduled", native_entry);
339 ViewControllerPtr controller{builder.Run()};
340 EXPECT_NE(controller,
nullptr);
347 auto captures =
static_cast<Captures*
>(
user_data);
349 EXPECT_TRUE(captures->frame_scheduled_latch.IsSignaledForTest());
352 EXPECT_EQ(std::this_thread::get_id(), captures->thread_id);
355 captures->done =
true;
360 while (!captures.done) {
366 platform_thread->Join();
372 auto& context = GetContext();
373 WindowsConfigBuilder builder(context);
374 builder.SetDartEntrypoint(
"renderImplicitView");
376 EnginePtr engine{builder.RunHeadless()};
377 ASSERT_NE(engine,
nullptr);
384 auto done = reinterpret_cast<std::atomic<bool>*>(user_data);
393 FlutterWindowMetricsEvent metrics = {};
394 metrics.struct_size =
sizeof(FlutterWindowMetricsEvent);
396 metrics.height = 100;
397 metrics.pixel_ratio = 1.0;
399 engine_ptr->SendWindowMetricsEvent(metrics);
409 auto& context = GetContext();
410 WindowsConfigBuilder builder(context);
411 ViewControllerPtr controller{builder.Run()};
412 ASSERT_NE(controller,
nullptr);
419 TEST_F(WindowsTest, GetGraphicsAdapter) {
420 auto& context = GetContext();
421 WindowsConfigBuilder builder(context);
422 ViewControllerPtr controller{builder.Run()};
423 ASSERT_NE(controller,
nullptr);
426 Microsoft::WRL::ComPtr<IDXGIAdapter> dxgi_adapter;
428 ASSERT_NE(dxgi_adapter,
nullptr);
429 DXGI_ADAPTER_DESC desc{};
430 ASSERT_TRUE(SUCCEEDED(dxgi_adapter->GetDesc(&desc)));
433 TEST_F(WindowsTest, GetGraphicsAdapterWithLowPowerPreference) {
436 GTEST_SKIP() <<
"Not able to find low power GPU, nothing to check.";
439 auto& context = GetContext();
440 WindowsConfigBuilder builder(context);
442 ViewControllerPtr controller{builder.Run()};
443 ASSERT_NE(controller,
nullptr);
446 Microsoft::WRL::ComPtr<IDXGIAdapter> dxgi_adapter;
448 ASSERT_NE(dxgi_adapter,
nullptr);
449 DXGI_ADAPTER_DESC desc{};
450 ASSERT_TRUE(SUCCEEDED(dxgi_adapter->GetDesc(&desc)));
451 ASSERT_EQ(desc.AdapterLuid.HighPart, luid->HighPart);
452 ASSERT_EQ(desc.AdapterLuid.LowPart, luid->LowPart);
456 TEST_F(WindowsTest, PluginRegistrarGetImplicitView) {
457 auto& context = GetContext();
458 WindowsConfigBuilder builder(context);
459 ViewControllerPtr controller{builder.Run()};
460 ASSERT_NE(controller,
nullptr);
469 ASSERT_NE(implicit_view,
nullptr);
472 TEST_F(WindowsTest, PluginRegistrarGetView) {
473 auto& context = GetContext();
474 WindowsConfigBuilder builder(context);
475 ViewControllerPtr controller{builder.Run()};
476 ASSERT_NE(controller,
nullptr);
491 ASSERT_NE(view,
nullptr);
492 ASSERT_EQ(view_123,
nullptr);
495 TEST_F(WindowsTest, PluginRegistrarGetViewHeadless) {
496 auto& context = GetContext();
497 WindowsConfigBuilder builder(context);
498 EnginePtr engine{builder.RunHeadless()};
499 ASSERT_NE(engine,
nullptr);
509 ASSERT_EQ(implicit_view,
nullptr);
510 ASSERT_EQ(view_123,
nullptr);
516 auto& context = GetContext();
517 WindowsConfigBuilder builder(context);
518 EnginePtr engine{builder.InitializeEngine()};
519 EngineModifier modifier{
522 auto egl_manager = std::make_unique<HalfBrokenEGLManager>();
523 ASSERT_TRUE(egl_manager->IsValid());
524 modifier.SetEGLManager(std::move(egl_manager));
526 ViewControllerPtr controller{
529 ASSERT_NE(controller,
nullptr);
534 auto& context = GetContext();
535 WindowsConfigBuilder builder(context);
536 EnginePtr engine{builder.InitializeEngine()};
538 EngineModifier modifier{windows_engine};
540 auto lifecycle_manager =
541 std::make_unique<MockWindowsLifecycleManager>(windows_engine);
542 auto lifecycle_manager_ptr = lifecycle_manager.get();
543 modifier.SetLifecycleManager(std::move(lifecycle_manager));
545 EXPECT_CALL(*lifecycle_manager_ptr,
548 lifecycle_manager_ptr->WindowsLifecycleManager::SetLifecycleState(
552 EXPECT_CALL(*lifecycle_manager_ptr,
555 lifecycle_manager_ptr->WindowsLifecycleManager::SetLifecycleState(
563 ViewControllerPtr controller{
568 ASSERT_NE(view,
nullptr);
571 ASSERT_NE(hwnd,
nullptr);
576 ::MoveWindow(hwnd, 0, 0, 100, 100,
579 while (lifecycle_manager_ptr->IsUpdateStateScheduled()) {
586 while (lifecycle_manager_ptr->IsUpdateStateScheduled()) {
591 TEST_F(WindowsTest, GetKeyboardStateHeadless) {
592 auto& context = GetContext();
593 WindowsConfigBuilder builder(context);
594 builder.SetDartEntrypoint(
"sendGetKeyboardState");
596 std::atomic<bool> done =
false;
597 context.AddNativeFunction(
598 "SignalStringValue", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
599 auto handle = Dart_GetNativeArgument(args, 0);
600 ASSERT_FALSE(Dart_IsError(handle));
601 auto value = tonic::DartConverter<std::string>::FromDart(handle);
602 EXPECT_EQ(value,
"Success");
606 ViewControllerPtr controller{builder.Run()};
607 ASSERT_NE(controller,
nullptr);
619 std::string view_ids;
621 auto& context = GetContext();
622 WindowsConfigBuilder builder(context);
623 builder.SetDartEntrypoint(
"onMetricsChangedSignalViewIds");
626 context.AddNativeFunction(
628 CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) { ready =
true; }));
630 context.AddNativeFunction(
631 "SignalStringValue", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
632 auto handle = Dart_GetNativeArgument(args, 0);
633 ASSERT_FALSE(Dart_IsError(handle));
635 std::scoped_lock lock{mutex};
636 view_ids = tonic::DartConverter<std::string>::FromDart(handle);
640 ViewControllerPtr first_controller{builder.Run()};
641 ASSERT_NE(first_controller,
nullptr);
651 properties.
width = 100;
653 ViewControllerPtr second_controller{
655 ASSERT_NE(second_controller,
nullptr);
660 std::scoped_lock lock{mutex};
661 if (view_ids ==
"View IDs: [0, 1]") {
668 second_controller.reset();
671 std::scoped_lock lock{mutex};
672 if (view_ids ==
"View IDs: [0]") {
679 auto& context = GetContext();
680 WindowsConfigBuilder builder(context);
681 builder.SetDartEntrypoint(
"testEngineId");
683 std::optional<int64_t> engineId;
684 context.AddNativeFunction(
685 "NotifyEngineId", CREATE_NATIVE_ENTRY([&](Dart_NativeArguments args) {
686 const auto argument = Dart_GetNativeArgument(args, 0);
687 if (!Dart_IsNull(argument)) {
688 const auto handle = tonic::DartConverter<int64_t>::FromDart(argument);
693 ViewControllerPtr first_controller{builder.Run()};
694 ASSERT_NE(first_controller,
nullptr);
696 while (!engineId.has_value()) {
void UpdateAccessibilityFeatures()
WindowsLifecycleManager(FlutterWindowsEngine *engine)
virtual void SetLifecycleState(AppLifecycleState state)
static std::optional< LUID > GetLowPowerGpuLuid()
MOCK_METHOD(void, Quit,(std::optional< HWND >, std::optional< WPARAM >, std::optional< LPARAM >, UINT),(override))
MockWindowsLifecycleManager(FlutterWindowsEngine *engine)
FlutterDesktopEngineRef FlutterDesktopEngineCreate(const FlutterDesktopEngineProperties *engine_properties)
FLUTTER_EXPORT FlutterDesktopEngineRef FlutterDesktopEngineForId(int64_t engine_id)
FlutterDesktopViewRef FlutterDesktopPluginRegistrarGetViewById(FlutterDesktopPluginRegistrarRef registrar, FlutterDesktopViewId view_id)
FlutterDesktopPluginRegistrarRef FlutterDesktopEngineGetPluginRegistrar(FlutterDesktopEngineRef engine, const char *plugin_name)
FlutterDesktopViewControllerRef FlutterDesktopViewControllerCreate(int width, int height, FlutterDesktopEngineRef engine)
bool FlutterDesktopEngineDestroy(FlutterDesktopEngineRef engine_ref)
FlutterDesktopTextureRegistrarRef FlutterDesktopEngineGetTextureRegistrar(FlutterDesktopEngineRef engine)
IDXGIAdapter * FlutterDesktopViewGetGraphicsAdapter(FlutterDesktopViewRef view)
FlutterDesktopViewId FlutterDesktopViewControllerGetViewId(FlutterDesktopViewControllerRef ref)
FlutterDesktopEngineRef FlutterDesktopViewControllerGetEngine(FlutterDesktopViewControllerRef ref)
void FlutterDesktopEngineSetNextFrameCallback(FlutterDesktopEngineRef engine, VoidCallback callback, void *user_data)
HWND FlutterDesktopViewGetHWND(FlutterDesktopViewRef view)
FlutterDesktopViewRef FlutterDesktopViewControllerGetView(FlutterDesktopViewControllerRef ref)
FlutterDesktopViewRef FlutterDesktopPluginRegistrarGetView(FlutterDesktopPluginRegistrarRef registrar)
FlutterDesktopViewControllerRef FlutterDesktopEngineCreateViewController(FlutterDesktopEngineRef engine, const FlutterDesktopViewControllerProperties *properties)
bool FlutterDesktopEngineRun(FlutterDesktopEngineRef engine, const char *entry_point)
struct FlutterDesktopEngine * FlutterDesktopEngineRef
int64_t FlutterDesktopViewId
struct FlutterDesktopView * FlutterDesktopViewRef
TEST(AccessibilityBridgeWindows, GetParent)
TEST_F(CompositorOpenGLTest, CreateBackingStore)
constexpr FlutterViewId kImplicitViewId
const wchar_t * icu_data_path
const wchar_t * assets_path