#include #include #include #include #include #include #include #include #include #include #include #include #include "ibusimcontext.h" #include "keycodes.h" #include "keymanutil.h" #include "KeymanSystemServiceClient.h" #include "kmx_test_source.hpp" #include "testmodule.h" typedef struct { IBusBus *bus; GtkIMContext *context; IBusIMContext *ibuscontext; } IBusKeymanTestsFixture; typedef struct { char *test_name; char *test_path; const char *skip_reason; gboolean use_surrounding_text; } TestData; static gboolean loaded = FALSE; static gboolean use_wayland = FALSE; static GdkWindow *window = NULL; static GMainLoop *thread_loop = NULL; static GTypeModule *module = NULL; gboolean testing = TRUE; static void module_register(GTypeModule *module) { ibus_im_context_register_type(module); } void destroy(GtkWidget *widget, gpointer data) { gtk_main_quit(); } static void ibus_keyman_tests_fixture_set_up(IBusKeymanTestsFixture *fixture, gconstpointer user_data) { IBusIMContextClass *classClass; if (!window) { GtkWidget *widget = gtk_window_new(GTK_WINDOW_TOPLEVEL); g_signal_connect(widget, "destroy", G_CALLBACK(destroy), NULL); window = gtk_widget_get_window(widget); } if (!loaded) { ibus_init(); module = test_module_new(module_register); g_assert_nonnull(module); /* Not loaded until we call ref for the first time */ classClass = static_cast(g_type_class_peek(IBUS_TYPE_IM_CONTEXT)); g_assert_null(classClass); loaded = TRUE; } fixture->bus = ibus_bus_new(); } static void ibus_keyman_tests_fixture_tear_down(IBusKeymanTestsFixture *fixture, gconstpointer user_data) { if (thread_loop) { g_main_loop_unref(thread_loop); thread_loop = NULL; } g_clear_object(&fixture->bus); g_clear_object(&fixture->context); auto data = (TestData *)user_data; g_free(data->test_name); g_free(data->test_path); delete data; } static void set_caps_lock_state(IBusKeymanTestsFixture *fixture, bool caps_lock_on) { set_capslock_indicator((guint32)caps_lock_on); } static bool get_caps_lock_state(IBusKeymanTestsFixture *fixture) { return get_capslock_indicator(); } static void switch_keyboard(IBusKeymanTestsFixture *fixture, const gchar *keyboard) { ibus_bus_set_global_engine(fixture->bus, keyboard); IBusEngineDesc *desc = ibus_bus_get_global_engine(fixture->bus); g_object_ref_sink(desc); // g_debug("Switched to engine: '%s'", ibus_engine_desc_get_name(desc)); g_assert_cmpstr(keyboard, ==, ibus_engine_desc_get_name(desc)); g_clear_object(&desc); if (thread_loop) { g_main_loop_unref(thread_loop); thread_loop = NULL; } if (fixture->context) { g_clear_object(&fixture->context); } fixture->ibuscontext = ibus_im_context_new(); fixture->context = (GtkIMContext *)fixture->ibuscontext; thread_loop = g_main_loop_new(NULL, TRUE); ibus_im_test_set_thread_loop(fixture->ibuscontext, thread_loop); } template std::string string_format(const std::string &format, Args... args) { // from https://stackoverflow.com/a/26221725/487503 int size_s = std::snprintf(nullptr, 0, format.c_str(), args...) + 1; // Extra space for '\0' if (size_s <= 0) { throw std::runtime_error("Error during formatting."); } auto size = static_cast(size_s); auto buf = std::make_unique(size); std::snprintf(buf.get(), size, format.c_str(), args...); return std::string(buf.get(), buf.get() + size - 1); // We don't want the '\0' inside } static unsigned short vk_to_keycode(unsigned short vk) { for (int i = 0; i < (int)sizeof(keycode_to_vk); i++) { if (keycode_to_vk[i] == vk) return i; } return -1; } #define KEYMAN_LCTRL 29 // 0x1D #define KEYMAN_LALT 56 // 0x38 #define KEYMAN_RCTRL 97 // 0x61 #define KEYMAN_RALT 100 // 0x64 typedef struct { guint modifiers_keydown; guint modifiers_keyup; guint keyval; guint16 keycode; guint is_modifier; } gdk_key_event; static gdk_key_event get_key_event_for_modifier(guint modifier, guint & prev_modifiers, guint keyval, guint keycode) { gdk_key_event event; event.modifiers_keydown = prev_modifiers; event.modifiers_keyup = prev_modifiers | modifier | IBUS_RELEASE_MASK; prev_modifiers |= modifier; event.keyval = keyval; event.keycode = keycode; event.is_modifier = 1; return event; } static bool is_modifier(guint16 keycode) { switch (keycode) { case KEY_LEFTSHIFT: case KEY_RIGHTSHIFT: case KEY_LEFTALT: case KEY_RIGHTALT: case KEY_LEFTCTRL: case KEY_RIGHTCTRL: case KEY_CAPSLOCK: return true; } return false; } static std::list get_involved_keys(IBusKeymanTestsFixture *fixture, km::tests::key_event test_event) { guint modifiers = 0; if (get_caps_lock_state(fixture)) { modifiers = IBUS_LOCK_MASK; } // process all modifiers std::list result; if (test_event.modifier_state & KM_CORE_MODIFIER_SHIFT) { // we don't distinguish between R and L Shift result.push_back(get_key_event_for_modifier(IBUS_SHIFT_MASK, modifiers, GDK_KEY_Shift_L, KEY_LEFTSHIFT)); } if (test_event.modifier_state & KM_CORE_MODIFIER_ALT || test_event.modifier_state & KM_CORE_MODIFIER_LALT) { result.push_back(get_key_event_for_modifier(IBUS_MOD1_MASK, modifiers, GDK_KEY_Alt_L, KEY_LEFTALT)); } if (test_event.modifier_state & KM_CORE_MODIFIER_RALT) { if (test_event.vk == KEYMAN_RALT) result.push_back(get_key_event_for_modifier(IBUS_MOD1_MASK, modifiers, GDK_KEY_Alt_R, KEY_RIGHTALT)); else result.push_back(get_key_event_for_modifier(IBUS_MOD5_MASK, modifiers, GDK_KEY_Alt_R, KEY_RIGHTALT)); } if (test_event.modifier_state & KM_CORE_MODIFIER_CTRL || test_event.modifier_state & KM_CORE_MODIFIER_LCTRL) { result.push_back(get_key_event_for_modifier(IBUS_CONTROL_MASK, modifiers, GDK_KEY_Control_L, KEY_LEFTCTRL)); } if (test_event.modifier_state & KM_CORE_MODIFIER_RCTRL) { result.push_back(get_key_event_for_modifier(IBUS_CONTROL_MASK, modifiers, GDK_KEY_Control_R, KEY_RIGHTCTRL)); } // process key guint keyval = (test_event.modifier_state & KM_CORE_MODIFIER_SHIFT) ? gdk_keyval_to_upper(test_event.vk) : gdk_keyval_to_lower(test_event.vk); // REVIEW: the keyval we use here are not correct for < 0x20 and >= 0x7f // See /usr/include/X11/keysymdef.h and /usr/include/ibus-1.0/ibuskeysyms.h // Currently this is not a problem because we don't use keyval, but if that ever changes we // should be aware that our test behaves different than the real client. gdk_key_event event; event.modifiers_keydown = modifiers; event.modifiers_keyup = modifiers | IBUS_RELEASE_MASK; event.keyval = keyval; event.keycode = vk_to_keycode(test_event.vk); event.is_modifier = is_modifier(event.keycode); result.push_back(event); return result; } static std::list get_context_keys(std::u16string context) { std::list result; for (auto c = context.begin(); c != context.end(); c++) { gchar utf8[6]; if (g_unichar_to_utf8((gunichar)*c, utf8) != 1 || utf8[0] < 32 || utf8[0] > 127) { g_assertion_message_cmpstr( G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, "We can only deal with ASCII characters in the context", utf8, "", ""); } result.push_back( {km::core::kmx::s_char_to_vkey[(int)utf8[0] - 32].vk, (uint16_t)(km::core::kmx::s_char_to_vkey[(int)utf8[0] - 32].shifted ? KM_CORE_MODIFIER_SHIFT : 0)}); } return result; } static void press_keys(IBusKeymanTestsFixture *fixture, km::tests::KmxTestSource & test_source,km::tests::key_event key_event) { auto involved_keys = get_involved_keys(fixture, key_event); // press and hold the individual modifier keys, finally the actual key std::stack keys_to_release; for (auto key = involved_keys.begin(); key != involved_keys.end(); key++) { bool old_caps_lock = get_caps_lock_state(fixture); guint lock_modifier = 0; // KEY_CAPSLOCK behaves a bit strange: // If capslock is off: // - on keypress we turn on capslock, but the modifier is still not set. // - The LOCK_MASK modifier gets set on release. // When capslock is already on: // - the LOCK_MASK modifier is set on both keypress and release // - capslock gets turned off on release if (key->keycode == KEY_CAPSLOCK && !old_caps_lock) { set_caps_lock_state(fixture, true); lock_modifier = IBUS_LOCK_MASK; } GdkEventKey keyEvent = { .type = GDK_KEY_PRESS, .window = window, .send_event = 0, .time = 0, .state = key->modifiers_keydown, .keyval = key->keyval, .length = 0, .string = NULL, .hardware_keycode = key->keycode, .group = 0, .is_modifier = key->is_modifier}; gtk_im_context_filter_keypress(fixture->context, &keyEvent); keyEvent.type = GDK_KEY_RELEASE; keyEvent.state = key->modifiers_keyup | lock_modifier; keys_to_release.push(keyEvent); if (key->keycode == KEY_CAPSLOCK && old_caps_lock) { set_caps_lock_state(fixture, false); } } // then release the keys in reverse order while (!keys_to_release.empty()) { auto keyEvent = keys_to_release.top(); gtk_im_context_filter_keypress(fixture->context, &keyEvent); keys_to_release.pop(); } } static void test_source(IBusKeymanTestsFixture *fixture, gconstpointer user_data) { auto data = (TestData*)user_data; auto sourcefile = string_format("%s.kmn", data->test_path); auto kmxfile = string_format("und:%s.kmx", data->test_path); ibus_im_test_set_surrounding_text_supported(data->use_surrounding_text); km::tests::KmxTestSource test_source; std::string keys = ""; std::u16string expected = u"", expected_context = u"", context = u""; km::tests::kmx_options options; bool expected_beep = false; // NOTE: we don't verify expected beeps since engine.c directly calls a gdk method so we // don't know when it gets called. g_assert_cmpint(test_source.load_source(sourcefile.c_str(), keys, expected, expected_context, context, options, expected_beep), ==, 0); for (auto & option : options) { if (option.type == km::tests::KOT_INPUT) { auto key = g_utf16_to_utf8((gunichar2 *)option.key.c_str(), option.key.length(), NULL, NULL, NULL); auto value = g_utf16_to_utf8((gunichar2 *)option.value.c_str(), option.value.length(), NULL, NULL, NULL); keyman_put_keyboard_options_todconf(data->test_name, data->test_name, key, value); } } g_settings_sync(); switch_keyboard(fixture, kmxfile.c_str()); if (test_source.caps_lock_state() != get_caps_lock_state(fixture)) { set_caps_lock_state(fixture, test_source.caps_lock_state()); } auto contextKeys = get_context_keys(context); for (auto k = contextKeys.begin(); k != contextKeys.end(); k++) { press_keys(fixture, test_source, *k); } gtk_im_context_focus_in(fixture->context); for (auto p = test_source.next_key(keys); p.vk != 0; p = test_source.next_key(keys)) { press_keys(fixture, test_source, p); } if (expected.length() == 0) { g_assert_null(ibus_im_test_get_text(fixture->ibuscontext)); } else { auto expectedText = g_utf16_to_utf8((gunichar2*)expected.c_str(), expected.length(), NULL, NULL, NULL); g_assert_cmpstr(ibus_im_test_get_text(fixture->ibuscontext), ==, expectedText); } // Cleanup g_settings_sync(); } static void test_skip(IBusKeymanTestsFixture *fixture, gconstpointer user_data) { auto data = (TestData *)user_data; g_test_skip(data->skip_reason); } void print_usage() { printf("Usage: %s --directory [--surrounding-text] [--no-surrounding-text] [--wayland|--x11] test1 [test2 ...]\n\n", g_get_prgname()); printf("Arguments:\n"); printf("\t--wayland\tRun tests on Wayland\n"); printf("\t--x11\tRun tests on X11\n"); printf("\t--surrounding-text\tRun tests with surrounding text support\n"); printf("\t--no-surrounding-text\tRun tests without surrounding text support\n"); printf("\nIf neither --surrounding-text nor --no-surrounding-text are specified then the tests run with both settings.\n"); } void add_test(const char* directory, const char* filename, gboolean use_surrounding_text, const char* skip_reason, bool useWayland) { auto file = g_file_new_for_commandline_arg(filename); auto testfilebase = g_file_get_basename(file); auto testname = g_string_new(NULL); g_string_append_printf( testname, "/%s/integration-tests/%s/%s", useWayland ? "wayland" : "x11", use_surrounding_text ? "surrounding-text" : "no-surrounding-text", testfilebase); auto testfile = g_file_new_build_filename(directory, testfilebase, NULL); auto testdata = new TestData(); testdata->test_name = strdup(filename); testdata->test_path = g_file_get_parse_name(testfile); testdata->use_surrounding_text = use_surrounding_text; testdata->skip_reason = skip_reason; g_test_add( testname->str, IBusKeymanTestsFixture, testdata, ibus_keyman_tests_fixture_set_up, skip_reason ? test_skip : test_source, ibus_keyman_tests_fixture_tear_down); g_object_unref(file); g_object_unref(testfile); g_string_free(testname, TRUE); } int main(int argc, char *argv[]) { gtk_init(&argc, &argv); g_test_init(&argc, &argv, NULL); g_test_set_nonfatal_assertions(); if (argc < 4) { print_usage(); return 1; } int iArg; char *directory = NULL; bool argWayland = false; bool argX11 = false; bool seenDirectory = false; bool seenSurroundingTextOption = false; bool runSurroundingTextTests = true; bool runNoSurroundingTextTests = true; for (iArg = 1; iArg < argc; iArg++) { if (strcmp(argv[iArg], "--directory") == 0 && iArg + 1 < argc) { iArg++; directory = argv[iArg]; seenDirectory = true; } else if (strcmp(argv[iArg], "--wayland") == 0) { argWayland = true; } else if (strcmp(argv[iArg], "--x11") == 0) { argX11 = true; } else if (strcmp(argv[iArg], "--surrounding-text") == 0) { if (!seenSurroundingTextOption) { runNoSurroundingTextTests = false; } runSurroundingTextTests = true; seenSurroundingTextOption = true; } else if (strcmp(argv[iArg], "--no-surrounding-text") == 0) { if (!seenSurroundingTextOption) { runSurroundingTextTests = false; } runNoSurroundingTextTests = true; seenSurroundingTextOption = true; } else if (!seenDirectory) { print_usage(); return 2; } else { break; } } if (argWayland && argX11) { printf("ERROR: --wayland and --x11 can't both be specified"); print_usage(); return 2; } use_wayland = argWayland; int nTests = argc - iArg; char **tests = &argv[iArg]; // Add tests for (int i = 0; i < nTests; i++) { auto filename = g_string_new(tests[i]); if (strstr(filename->str, ".kmx") || strstr(filename->str, ".kmn")) { g_string_truncate(filename, filename->len - 4); } // Check for tests to skip - #3345 const char *skipReason = NULL; if (strcmp(filename->str, "k_026___system_stores") == 0 || strcmp(filename->str, "k_027___system_stores_2") == 0) { skipReason = "mnemonic keyboards are not yet supported on Linux (#3345)"; } if (runSurroundingTextTests) { add_test(directory, filename->str, TRUE, skipReason, use_wayland); } if (runNoSurroundingTextTests) { add_test(directory, filename->str, FALSE, skipReason, use_wayland); } g_string_free(filename, TRUE); } // Run tests int retVal = g_test_run(); test_module_unuse(module); return retVal; }