shell/platform/windows/flutter_windows_engine_unittests.cc - external/github.com/flutter/engine - Git at Google

 // Copyright 2013 The Flutter Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 #include "flutter/shell/platform/windows/flutter_windows_engine.h"

 #include "flutter/shell/platform/embedder/embedder.h"
 #include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
 #include "flutter/shell/platform/windows/testing/engine_modifier.h"
 #include "gtest/gtest.h"

 namespace flutter {
 namespace testing {

 namespace {
 // Returns an engine instance configured with dummy project path values.
 std::unique_ptr<FlutterWindowsEngine> GetTestEngine() {
   FlutterDesktopEngineProperties properties = {};
   properties.assets_path = L"C:\\foo\\flutter_assets";
   properties.icu_data_path = L"C:\\foo\\icudtl.dat";
   properties.aot_library_path = L"C:\\foo\\aot.so";

   std::vector<const char*> test_arguments = {"arg1", "arg2"};
   properties.dart_entrypoint_argc = test_arguments.size();
   properties.dart_entrypoint_argv = test_arguments.data();

   FlutterProjectBundle project(properties);
   auto engine = std::make_unique<FlutterWindowsEngine>(project);

   EngineModifier modifier(engine.get());
   // Force the non-AOT path unless overridden by the test.
   modifier.embedder_api().RunsAOTCompiledDartCode = []() { return false; };

   return engine;
 }
 }  // namespace

 TEST(FlutterWindowsEngine, RunDoesExpectedInitialization) {
   std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
   EngineModifier modifier(engine.get());

   // The engine should be run with expected configuration values.
   bool run_called = false;
   modifier.embedder_api().Run = MOCK_ENGINE_PROC(
       Run, ([&run_called, engine_instance = engine.get()](
                 size_t version, const FlutterRendererConfig* config,
                 const FlutterProjectArgs* args, void* user_data,
                 FLUTTER_API_SYMBOL(FlutterEngine) * engine_out) {
         run_called = true;
         *engine_out = reinterpret_cast<FLUTTER_API_SYMBOL(FlutterEngine)>(1);

         EXPECT_EQ(version, FLUTTER_ENGINE_VERSION);
         EXPECT_NE(config, nullptr);
         // We have an AngleSurfaceManager, so this should be using OpenGL.
         EXPECT_EQ(config->type, kOpenGL);
         EXPECT_EQ(user_data, engine_instance);
         // Spot-check arguments.
         EXPECT_STREQ(args->assets_path, "C:\\foo\\flutter_assets");
         EXPECT_STREQ(args->icu_data_path, "C:\\foo\\icudtl.dat");
         EXPECT_EQ(args->dart_entrypoint_argc, 2U);
         EXPECT_EQ(strcmp(args->dart_entrypoint_argv[0], "arg1"), 0);
         EXPECT_EQ(strcmp(args->dart_entrypoint_argv[1], "arg2"), 0);
         EXPECT_NE(args->platform_message_callback, nullptr);
         EXPECT_NE(args->custom_task_runners, nullptr);
         EXPECT_EQ(args->custom_dart_entrypoint, nullptr);

         return kSuccess;
       }));

   // It should send locale info.
   bool update_locales_called = false;
   modifier.embedder_api().UpdateLocales = MOCK_ENGINE_PROC(
       UpdateLocales,
       ([&update_locales_called](auto engine, const FlutterLocale** locales,
                                 size_t locales_count) {
         update_locales_called = true;

         EXPECT_GT(locales_count, 0);
         EXPECT_NE(locales, nullptr);

         return kSuccess;
       }));

   // And it should send initial settings info.
   bool settings_message_sent = false;
   modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
       SendPlatformMessage,
       ([&settings_message_sent](auto engine, auto message) {
         if (std::string(message->channel) == std::string("flutter/settings")) {
           settings_message_sent = true;
         }

         return kSuccess;
       }));

   // Set the AngleSurfaceManager to !nullptr to test ANGLE rendering.
   modifier.SetSurfaceManager(reinterpret_cast<AngleSurfaceManager*>(1));

   engine->RunWithEntrypoint(nullptr);

   EXPECT_TRUE(run_called);
   EXPECT_TRUE(update_locales_called);
   EXPECT_TRUE(settings_message_sent);

   // Ensure that deallocation doesn't call the actual Shutdown with the bogus
   // engine pointer that the overridden Run returned.
   modifier.embedder_api().Shutdown = [](auto engine) { return kSuccess; };
   modifier.ReleaseSurfaceManager();
 }

 TEST(FlutterWindowsEngine, RunWithoutANGLEUsesSoftware) {
   std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
   EngineModifier modifier(engine.get());

   // The engine should be run with expected configuration values.
   bool run_called = false;
   modifier.embedder_api().Run = MOCK_ENGINE_PROC(
       Run, ([&run_called, engine_instance = engine.get()](
                 size_t version, const FlutterRendererConfig* config,
                 const FlutterProjectArgs* args, void* user_data,
                 FLUTTER_API_SYMBOL(FlutterEngine) * engine_out) {
         run_called = true;
         *engine_out = reinterpret_cast<FLUTTER_API_SYMBOL(FlutterEngine)>(1);
         // We don't have an AngleSurfaceManager, so we should be using software.
         EXPECT_EQ(config->type, kSoftware);
         return kSuccess;
       }));

   // Stub out UpdateLocales and SendPlatformMessage as we don't have a fully
   // initialized engine instance.
   modifier.embedder_api().UpdateLocales = MOCK_ENGINE_PROC(
       UpdateLocales, ([](auto engine, const FlutterLocale** locales,
                          size_t locales_count) { return kSuccess; }));
   modifier.embedder_api().SendPlatformMessage =
       MOCK_ENGINE_PROC(SendPlatformMessage,
                        ([](auto engine, auto message) { return kSuccess; }));

   // Set the AngleSurfaceManager to nullptr to test software fallback path.
   modifier.SetSurfaceManager(nullptr);

   engine->RunWithEntrypoint(nullptr);

   EXPECT_TRUE(run_called);

   // Ensure that deallocation doesn't call the actual Shutdown with the bogus
   // engine pointer that the overridden Run returned.
   modifier.embedder_api().Shutdown = [](auto engine) { return kSuccess; };
 }

 TEST(FlutterWindowsEngine, SendPlatformMessageWithoutResponse) {
   std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
   EngineModifier modifier(engine.get());

   const char* channel = "test";
   const std::vector<uint8_t> test_message = {1, 2, 3, 4};

   // Without a response, SendPlatformMessage should be a simple pass-through.
   bool called = false;
   modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
       SendPlatformMessage, ([&called, test_message](auto engine, auto message) {
         called = true;
         EXPECT_STREQ(message->channel, "test");
         EXPECT_EQ(message->message_size, test_message.size());
         EXPECT_EQ(memcmp(message->message, test_message.data(),
                          message->message_size),
                   0);
         EXPECT_EQ(message->response_handle, nullptr);
         return kSuccess;
       }));

   engine->SendPlatformMessage(channel, test_message.data(), test_message.size(),
                               nullptr, nullptr);
   EXPECT_TRUE(called);
 }

 TEST(FlutterWindowsEngine, SendPlatformMessageWithResponse) {
   std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
   EngineModifier modifier(engine.get());

   const char* channel = "test";
   const std::vector<uint8_t> test_message = {1, 2, 3, 4};
   auto* dummy_response_handle =
       reinterpret_cast<FlutterPlatformMessageResponseHandle*>(5);
   const FlutterDesktopBinaryReply reply_handler = [](auto... args) {};
   void* reply_user_data = reinterpret_cast<void*>(6);

   // When a response is requested, a handle should be created, passed as part
   // of the message, and then released.
   bool create_response_handle_called = false;
   modifier.embedder_api().PlatformMessageCreateResponseHandle =
       MOCK_ENGINE_PROC(
           PlatformMessageCreateResponseHandle,
           ([&create_response_handle_called, &reply_handler, reply_user_data,
             dummy_response_handle](auto engine, auto reply, auto user_data,
                                    auto response_handle) {
             create_response_handle_called = true;
             EXPECT_EQ(reply, reply_handler);
             EXPECT_EQ(user_data, reply_user_data);
             EXPECT_NE(response_handle, nullptr);
             *response_handle = dummy_response_handle;
             return kSuccess;
           }));
   bool release_response_handle_called = false;
   modifier.embedder_api().PlatformMessageReleaseResponseHandle =
       MOCK_ENGINE_PROC(
           PlatformMessageReleaseResponseHandle,
           ([&release_response_handle_called, dummy_response_handle](
                auto engine, auto response_handle) {
             release_response_handle_called = true;
             EXPECT_EQ(response_handle, dummy_response_handle);
             return kSuccess;
           }));
   bool send_message_called = false;
   modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
       SendPlatformMessage, ([&send_message_called, test_message,
                              dummy_response_handle](auto engine, auto message) {
         send_message_called = true;
         EXPECT_STREQ(message->channel, "test");
         EXPECT_EQ(message->message_size, test_message.size());
         EXPECT_EQ(memcmp(message->message, test_message.data(),
                          message->message_size),
                   0);
         EXPECT_EQ(message->response_handle, dummy_response_handle);
         return kSuccess;
       }));

   engine->SendPlatformMessage(channel, test_message.data(), test_message.size(),
                               reply_handler, reply_user_data);
   EXPECT_TRUE(create_response_handle_called);
   EXPECT_TRUE(release_response_handle_called);
   EXPECT_TRUE(send_message_called);
 }

 TEST(FlutterWindowsEngine, DispatchSemanticsAction) {
   std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
   EngineModifier modifier(engine.get());

   bool called = false;
   std::string test_data = "Hello";
   modifier.embedder_api().DispatchSemanticsAction = MOCK_ENGINE_PROC(
       DispatchSemanticsAction,
       ([&called, &test_data](auto engine, auto target, auto action, auto data,
                              auto data_length) {
         called = true;
         EXPECT_EQ(target, 42);
         EXPECT_EQ(action, kFlutterSemanticsActionDismiss);
         EXPECT_EQ(memcmp(data, test_data.c_str(), test_data.size()), 0);
         EXPECT_EQ(data_length, test_data.size());
         return kSuccess;
       }));

   engine->DispatchSemanticsAction(
       42, kFlutterSemanticsActionDismiss,
       std::vector<uint8_t>(test_data.begin(), test_data.end()));
   EXPECT_TRUE(called);
 }

 }  // namespace testing
 }  // namespace flutter
	// Copyright 2013 The Flutter Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#include "flutter/shell/platform/windows/flutter_windows_engine.h"

	#include "flutter/shell/platform/embedder/embedder.h"
	#include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
	#include "flutter/shell/platform/windows/testing/engine_modifier.h"
	#include "gtest/gtest.h"

	namespace flutter {
	namespace testing {

	namespace {
	// Returns an engine instance configured with dummy project path values.
	std::unique_ptr<FlutterWindowsEngine> GetTestEngine() {
	FlutterDesktopEngineProperties properties = {};
	properties.assets_path = L"C:\\foo\\flutter_assets";
	properties.icu_data_path = L"C:\\foo\\icudtl.dat";
	properties.aot_library_path = L"C:\\foo\\aot.so";

	std::vector<const char*> test_arguments = {"arg1", "arg2"};
	properties.dart_entrypoint_argc = test_arguments.size();
	properties.dart_entrypoint_argv = test_arguments.data();

	FlutterProjectBundle project(properties);
	auto engine = std::make_unique<FlutterWindowsEngine>(project);

	EngineModifier modifier(engine.get());
	// Force the non-AOT path unless overridden by the test.
	modifier.embedder_api().RunsAOTCompiledDartCode = []() { return false; };

	return engine;
	}
	} // namespace

	TEST(FlutterWindowsEngine, RunDoesExpectedInitialization) {
	std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
	EngineModifier modifier(engine.get());

	// The engine should be run with expected configuration values.
	bool run_called = false;
	modifier.embedder_api().Run = MOCK_ENGINE_PROC(
	Run, ([&run_called, engine_instance = engine.get()](
	size_t version, const FlutterRendererConfig* config,
	const FlutterProjectArgs* args, void* user_data,
	FLUTTER_API_SYMBOL(FlutterEngine) * engine_out) {
	run_called = true;
	*engine_out = reinterpret_cast<FLUTTER_API_SYMBOL(FlutterEngine)>(1);

	EXPECT_EQ(version, FLUTTER_ENGINE_VERSION);
	EXPECT_NE(config, nullptr);
	// We have an AngleSurfaceManager, so this should be using OpenGL.
	EXPECT_EQ(config->type, kOpenGL);
	EXPECT_EQ(user_data, engine_instance);
	// Spot-check arguments.
	EXPECT_STREQ(args->assets_path, "C:\\foo\\flutter_assets");
	EXPECT_STREQ(args->icu_data_path, "C:\\foo\\icudtl.dat");
	EXPECT_EQ(args->dart_entrypoint_argc, 2U);
	EXPECT_EQ(strcmp(args->dart_entrypoint_argv[0], "arg1"), 0);
	EXPECT_EQ(strcmp(args->dart_entrypoint_argv[1], "arg2"), 0);
	EXPECT_NE(args->platform_message_callback, nullptr);
	EXPECT_NE(args->custom_task_runners, nullptr);
	EXPECT_EQ(args->custom_dart_entrypoint, nullptr);

	return kSuccess;
	}));

	// It should send locale info.
	bool update_locales_called = false;
	modifier.embedder_api().UpdateLocales = MOCK_ENGINE_PROC(
	UpdateLocales,
	([&update_locales_called](auto engine, const FlutterLocale** locales,
	size_t locales_count) {
	update_locales_called = true;

	EXPECT_GT(locales_count, 0);
	EXPECT_NE(locales, nullptr);

	return kSuccess;
	}));

	// And it should send initial settings info.
	bool settings_message_sent = false;
	modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
	SendPlatformMessage,
	([&settings_message_sent](auto engine, auto message) {
	if (std::string(message->channel) == std::string("flutter/settings")) {
	settings_message_sent = true;
	}

	return kSuccess;
	}));

	// Set the AngleSurfaceManager to !nullptr to test ANGLE rendering.
	modifier.SetSurfaceManager(reinterpret_cast<AngleSurfaceManager*>(1));

	engine->RunWithEntrypoint(nullptr);

	EXPECT_TRUE(run_called);
	EXPECT_TRUE(update_locales_called);
	EXPECT_TRUE(settings_message_sent);

	// Ensure that deallocation doesn't call the actual Shutdown with the bogus
	// engine pointer that the overridden Run returned.
	modifier.embedder_api().Shutdown = [](auto engine) { return kSuccess; };
	modifier.ReleaseSurfaceManager();
	}

	TEST(FlutterWindowsEngine, RunWithoutANGLEUsesSoftware) {
	std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
	EngineModifier modifier(engine.get());

	// The engine should be run with expected configuration values.
	bool run_called = false;
	modifier.embedder_api().Run = MOCK_ENGINE_PROC(
	Run, ([&run_called, engine_instance = engine.get()](
	size_t version, const FlutterRendererConfig* config,
	const FlutterProjectArgs* args, void* user_data,
	FLUTTER_API_SYMBOL(FlutterEngine) * engine_out) {
	run_called = true;
	*engine_out = reinterpret_cast<FLUTTER_API_SYMBOL(FlutterEngine)>(1);
	// We don't have an AngleSurfaceManager, so we should be using software.
	EXPECT_EQ(config->type, kSoftware);
	return kSuccess;
	}));

	// Stub out UpdateLocales and SendPlatformMessage as we don't have a fully
	// initialized engine instance.
	modifier.embedder_api().UpdateLocales = MOCK_ENGINE_PROC(
	UpdateLocales, ([](auto engine, const FlutterLocale** locales,
	size_t locales_count) { return kSuccess; }));
	modifier.embedder_api().SendPlatformMessage =
	MOCK_ENGINE_PROC(SendPlatformMessage,
	([](auto engine, auto message) { return kSuccess; }));

	// Set the AngleSurfaceManager to nullptr to test software fallback path.
	modifier.SetSurfaceManager(nullptr);

	engine->RunWithEntrypoint(nullptr);

	EXPECT_TRUE(run_called);

	// Ensure that deallocation doesn't call the actual Shutdown with the bogus
	// engine pointer that the overridden Run returned.
	modifier.embedder_api().Shutdown = [](auto engine) { return kSuccess; };
	}

	TEST(FlutterWindowsEngine, SendPlatformMessageWithoutResponse) {
	std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
	EngineModifier modifier(engine.get());

	const char* channel = "test";
	const std::vector<uint8_t> test_message = {1, 2, 3, 4};

	// Without a response, SendPlatformMessage should be a simple pass-through.
	bool called = false;
	modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
	SendPlatformMessage, ([&called, test_message](auto engine, auto message) {
	called = true;
	EXPECT_STREQ(message->channel, "test");
	EXPECT_EQ(message->message_size, test_message.size());
	EXPECT_EQ(memcmp(message->message, test_message.data(),
	message->message_size),
	0);
	EXPECT_EQ(message->response_handle, nullptr);
	return kSuccess;
	}));

	engine->SendPlatformMessage(channel, test_message.data(), test_message.size(),
	nullptr, nullptr);
	EXPECT_TRUE(called);
	}

	TEST(FlutterWindowsEngine, SendPlatformMessageWithResponse) {
	std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
	EngineModifier modifier(engine.get());

	const char* channel = "test";
	const std::vector<uint8_t> test_message = {1, 2, 3, 4};
	auto* dummy_response_handle =
	reinterpret_cast<FlutterPlatformMessageResponseHandle*>(5);
	const FlutterDesktopBinaryReply reply_handler = [](auto... args) {};
	void* reply_user_data = reinterpret_cast<void*>(6);

	// When a response is requested, a handle should be created, passed as part
	// of the message, and then released.
	bool create_response_handle_called = false;
	modifier.embedder_api().PlatformMessageCreateResponseHandle =
	MOCK_ENGINE_PROC(
	PlatformMessageCreateResponseHandle,
	([&create_response_handle_called, &reply_handler, reply_user_data,
	dummy_response_handle](auto engine, auto reply, auto user_data,
	auto response_handle) {
	create_response_handle_called = true;
	EXPECT_EQ(reply, reply_handler);
	EXPECT_EQ(user_data, reply_user_data);
	EXPECT_NE(response_handle, nullptr);
	*response_handle = dummy_response_handle;
	return kSuccess;
	}));
	bool release_response_handle_called = false;
	modifier.embedder_api().PlatformMessageReleaseResponseHandle =
	MOCK_ENGINE_PROC(
	PlatformMessageReleaseResponseHandle,
	([&release_response_handle_called, dummy_response_handle](
	auto engine, auto response_handle) {
	release_response_handle_called = true;
	EXPECT_EQ(response_handle, dummy_response_handle);
	return kSuccess;
	}));
	bool send_message_called = false;
	modifier.embedder_api().SendPlatformMessage = MOCK_ENGINE_PROC(
	SendPlatformMessage, ([&send_message_called, test_message,
	dummy_response_handle](auto engine, auto message) {
	send_message_called = true;
	EXPECT_STREQ(message->channel, "test");
	EXPECT_EQ(message->message_size, test_message.size());
	EXPECT_EQ(memcmp(message->message, test_message.data(),
	message->message_size),
	0);
	EXPECT_EQ(message->response_handle, dummy_response_handle);
	return kSuccess;
	}));

	engine->SendPlatformMessage(channel, test_message.data(), test_message.size(),
	reply_handler, reply_user_data);
	EXPECT_TRUE(create_response_handle_called);
	EXPECT_TRUE(release_response_handle_called);
	EXPECT_TRUE(send_message_called);
	}

	TEST(FlutterWindowsEngine, DispatchSemanticsAction) {
	std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
	EngineModifier modifier(engine.get());

	bool called = false;
	std::string test_data = "Hello";
	modifier.embedder_api().DispatchSemanticsAction = MOCK_ENGINE_PROC(
	DispatchSemanticsAction,
	([&called, &test_data](auto engine, auto target, auto action, auto data,
	auto data_length) {
	called = true;
	EXPECT_EQ(target, 42);
	EXPECT_EQ(action, kFlutterSemanticsActionDismiss);
	EXPECT_EQ(memcmp(data, test_data.c_str(), test_data.size()), 0);
	EXPECT_EQ(data_length, test_data.size());
	return kSuccess;
	}));

	engine->DispatchSemanticsAction(
	42, kFlutterSemanticsActionDismiss,
	std::vector<uint8_t>(test_data.begin(), test_data.end()));
	EXPECT_TRUE(called);
	}

	} // namespace testing
	} // namespace flutter