fl_platform_plugin_test.cc File Reference

#include <gtk/gtk.h>
#include "flutter/shell/platform/linux/fl_binary_messenger_private.h"
#include "flutter/shell/platform/linux/fl_method_codec_private.h"
#include "flutter/shell/platform/linux/fl_platform_plugin.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_json_method_codec.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_method_codec.h"
#include "flutter/shell/platform/linux/testing/fl_test.h"
#include "flutter/shell/platform/linux/testing/mock_binary_messenger.h"
#include "flutter/testing/testing.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"

Go to the source code of this file.

Classes
class	MethodCallMatcher

Functions
	MATCHER_P (SuccessResponse, result, "")
static ::testing::Matcher< GBytes * >	MethodCall (const std::string &name, ::testing::Matcher< FlValue * > args)
	MATCHER_P (FlValueEq, value, "equal to "+::testing::PrintToString(value))
	G_DECLARE_FINAL_TYPE (FlTestApplication, fl_test_application, FL, TEST_APPLICATION, GtkApplication) struct _FlTestApplication
	G_DEFINE_TYPE (FlTestApplication, fl_test_application, gtk_application_get_type()) static void fl_test_application_startup(GApplication *application)
static void	fl_test_application_activate (GApplication *application)
static void	fl_test_application_dispose (GObject *object)
static void	fl_test_application_class_init (FlTestApplicationClass *klass)
static void	fl_test_application_init (FlTestApplication *self)
FlTestApplication *	fl_test_application_new (gboolean *dispose_called)
	TEST (FlPlatformPluginTest, PlaySound)
	TEST (FlPlatformPluginTest, ExitApplication)
	TEST (FlPlatformPluginTest, ExitApplicationDispose)

Function Documentation

fl_test_application_activate()

static void fl_test_application_activate ( GApplication *  application )

static

Definition at line 116 of file fl_platform_plugin_test.cc.

                                                                    {
  G_APPLICATION_CLASS(fl_test_application_parent_class)->activate(application);
 
  ::testing::NiceMock<flutter::testing::MockBinaryMessenger> messenger;
  g_autoptr(FlPlatformPlugin) plugin = fl_platform_plugin_new(messenger);
  EXPECT_NE(plugin, nullptr);
  g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
 
  g_autoptr(FlValue) exit_result = fl_value_new_map();
  fl_value_set_string_take(exit_result, "response",
                           fl_value_new_string("exit"));
  EXPECT_CALL(messenger,
              fl_binary_messenger_send_response(
                  ::testing::Eq<FlBinaryMessenger*>(messenger), ::testing::_,
                  SuccessResponse(exit_result), ::testing::_))
      .WillOnce(::testing::Return(true));
 
  // Request app exit.
  g_autoptr(FlValue) args = fl_value_new_map();
  fl_value_set_string_take(args, "type", fl_value_new_string("required"));
  g_autoptr(GBytes) message = fl_method_codec_encode_method_call(
      FL_METHOD_CODEC(codec), "System.exitApplication", args, nullptr);
  messenger.ReceiveMessage("flutter/platform", message);
}

References args, fl_binary_messenger_send_response(), fl_json_method_codec_new(), fl_method_codec_encode_method_call(), fl_platform_plugin_new(), fl_value_new_map(), fl_value_new_string(), and fl_value_set_string_take().

Referenced by fl_test_application_class_init().

fl_test_application_class_init()

static void fl_test_application_class_init ( FlTestApplicationClass *  klass )

static

Definition at line 149 of file fl_platform_plugin_test.cc.

                                                                          {
  G_OBJECT_CLASS(klass)->dispose = fl_test_application_dispose;
  G_APPLICATION_CLASS(klass)->startup = fl_test_application_startup;
  G_APPLICATION_CLASS(klass)->activate = fl_test_application_activate;
}

References fl_test_application_activate(), and fl_test_application_dispose().

fl_test_application_dispose()

static void fl_test_application_dispose ( GObject *  object )

static

Definition at line 141 of file fl_platform_plugin_test.cc.

                                                         {
  FlTestApplication* self = FL_TEST_APPLICATION(object);
 
  *self->dispose_called = true;
 
  G_OBJECT_CLASS(fl_test_application_parent_class)->dispose(object);
}

Referenced by fl_test_application_class_init().

fl_test_application_init()

static void fl_test_application_init ( FlTestApplication *  self )

static

Definition at line 155 of file fl_platform_plugin_test.cc.

{}

fl_test_application_new()

FlTestApplication* fl_test_application_new

(

gboolean *

dispose_called

)

Definition at line 157 of file fl_platform_plugin_test.cc.

                                                                     {
  FlTestApplication* self = FL_TEST_APPLICATION(
      g_object_new(fl_test_application_get_type(), nullptr));
 
  // Don't try and register on D-Bus.
  g_application_set_application_id(G_APPLICATION(self), "dev.flutter.GtkTest");
  g_application_set_flags(G_APPLICATION(self), G_APPLICATION_NON_UNIQUE);
 
  // Added to stop compiler complaining about an unused function.
  FL_IS_TEST_APPLICATION(self);
 
  self->dispose_called = dispose_called;
 
  return self;
}

Referenced by TEST().

G_DECLARE_FINAL_TYPE()

G_DECLARE_FINAL_TYPE	(	FlTestApplication	,
		fl_test_application	,
		FL	,
		TEST_APPLICATION	,
		GtkApplication
	)

Definition at line 92 of file fl_platform_plugin_test.cc.

                          {
  GtkApplication parent_instance;
  gboolean* dispose_called;
};

G_DEFINE_TYPE()

G_DEFINE_TYPE	(	FlTestApplication	,
		fl_test_application	,
		gtk_application_get_type()
	)

Definition at line 103 of file fl_platform_plugin_test.cc.

                                                                   {
  G_APPLICATION_CLASS(fl_test_application_parent_class)->startup(application);
 
  // Add a window to this application, which will hold a reference to the
  // application and stop it disposing. See
  // https://gitlab.gnome.org/GNOME/gtk/-/issues/6190
  gtk_application_window_new(GTK_APPLICATION(application));
}

MATCHER_P() [1/2]

MATCHER_P	(	FlValueEq	,
		value	,
		"equal to "+	::testing::PrintToStringvalue
	)

Definition at line 88 of file fl_platform_plugin_test.cc.

                                                                       {
  return fl_value_equal(arg, value);
}

References fl_value_equal(), and value.

MATCHER_P() [2/2]

MATCHER_P	(	SuccessResponse	,
		result	,
		""
	)

Definition at line 19 of file fl_platform_plugin_test.cc.

                                       {
  g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
  g_autoptr(FlMethodResponse) response =
      fl_method_codec_decode_response(FL_METHOD_CODEC(codec), arg, nullptr);
  if (fl_value_equal(fl_method_response_get_result(response, nullptr),
                     result)) {
    return true;
  }
  *result_listener << ::testing::PrintToString(response);
  return false;
}

References fl_json_method_codec_new(), fl_method_codec_decode_response(), fl_method_response_get_result(), fl_value_equal(), and result.

MethodCall()

static ::testing::Matcher<GBytes*> MethodCall	(	const std::string &	name,
		::testing::Matcher< FlValue * >	args
	)

Definition at line 82 of file fl_platform_plugin_test.cc.

                                   {
  return MethodCallMatcher(::testing::StrEq(name), std::move(args));
}

References args.

Referenced by TEST().

TEST() [1/3]

TEST	(	FlPlatformPluginTest	,
		ExitApplication
	)

Definition at line 193 of file fl_platform_plugin_test.cc.

                                            {
  ::testing::NiceMock<flutter::testing::MockBinaryMessenger> messenger;
 
  g_autoptr(FlPlatformPlugin) plugin = fl_platform_plugin_new(messenger);
  EXPECT_NE(plugin, nullptr);
  g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
 
  g_autoptr(FlValue) null = fl_value_new_null();
  ON_CALL(messenger, fl_binary_messenger_send_response(
                         ::testing::Eq<FlBinaryMessenger*>(messenger),
                         ::testing::_, SuccessResponse(null), ::testing::_))
      .WillByDefault(testing::Return(TRUE));
 
  // Indicate that the binding is initialized.
  g_autoptr(GError) error = nullptr;
  g_autoptr(GBytes) init_message = fl_method_codec_encode_method_call(
      FL_METHOD_CODEC(codec), "System.initializationComplete", nullptr, &error);
  messenger.ReceiveMessage("flutter/platform", init_message);
 
  g_autoptr(FlValue) request_args = fl_value_new_map();
  fl_value_set_string_take(request_args, "type",
                           fl_value_new_string("cancelable"));
  EXPECT_CALL(messenger,
              fl_binary_messenger_send_on_channel(
                  ::testing::Eq<FlBinaryMessenger*>(messenger),
                  ::testing::StrEq("flutter/platform"),
                  MethodCall("System.requestAppExit", FlValueEq(request_args)),
                  ::testing::_, ::testing::_, ::testing::_));
 
  g_autoptr(FlValue) args = fl_value_new_map();
  fl_value_set_string_take(args, "type", fl_value_new_string("cancelable"));
  g_autoptr(GBytes) message = fl_method_codec_encode_method_call(
      FL_METHOD_CODEC(codec), "System.exitApplication", args, nullptr);
  messenger.ReceiveMessage("flutter/platform", message);
}

References args, error, fl_binary_messenger_send_on_channel(), fl_binary_messenger_send_response(), fl_json_method_codec_new(), fl_method_codec_encode_method_call(), fl_platform_plugin_new(), fl_value_new_map(), fl_value_new_null(), fl_value_new_string(), fl_value_set_string_take(), MethodCall(), and TRUE.

TEST() [2/3]

TEST	(	FlPlatformPluginTest	,
		ExitApplicationDispose
	)

Definition at line 229 of file fl_platform_plugin_test.cc.

                                                   {
  gtk_init(0, nullptr);
 
  gboolean dispose_called = false;
  FlTestApplication* application = fl_test_application_new(&dispose_called);
 
  // Run the application, it will quit after startup.
  g_application_run(G_APPLICATION(application), 0, nullptr);
 
  EXPECT_FALSE(dispose_called);
  g_object_unref(application);
  EXPECT_TRUE(dispose_called);
}

References fl_test_application_new().

TEST() [3/3]

TEST	(	FlPlatformPluginTest	,
		PlaySound
	)

Definition at line 173 of file fl_platform_plugin_test.cc.

                                      {
  ::testing::NiceMock<flutter::testing::MockBinaryMessenger> messenger;
 
  g_autoptr(FlPlatformPlugin) plugin = fl_platform_plugin_new(messenger);
  EXPECT_NE(plugin, nullptr);
 
  g_autoptr(FlValue) args = fl_value_new_string("SystemSoundType.alert");
  g_autoptr(FlJsonMethodCodec) codec = fl_json_method_codec_new();
  g_autoptr(GBytes) message = fl_method_codec_encode_method_call(
      FL_METHOD_CODEC(codec), "SystemSound.play", args, nullptr);
 
  g_autoptr(FlValue) null = fl_value_new_null();
  EXPECT_CALL(messenger, fl_binary_messenger_send_response(
                             ::testing::Eq<FlBinaryMessenger*>(messenger),
                             ::testing::_, SuccessResponse(null), ::testing::_))
      .WillOnce(::testing::Return(true));
 
  messenger.ReceiveMessage("flutter/platform", message);
}

References args, fl_binary_messenger_send_response(), fl_json_method_codec_new(), fl_method_codec_encode_method_call(), fl_platform_plugin_new(), fl_value_new_null(), and fl_value_new_string().