spiegel-keyman/core/tests/unit/api/state_api.tests.cpp
Marc Durdin d61e5bbb18 refactor(core): clean up unit tests
Consolidate test frameworks and cleanup, including:
* all tests use Google Test
* reorganize folders, esp. kmnkbd -> api
* move all api tests into api folder
* replace references to test_assert or test_color with gtest equivalents
* leverage gtest patterns to remove boilerplate code
* dramatically simplify meson.build files and localize variables
* move shared helper code into helpers/ folder
* make test names unique and add gtest protocol for reporting back to
  teamcity

Fixes:
* CLDR test keyboards had invalid unicodeset escapes (needs to be raised
  upstream also) - was not failing tests because files were not loading
  but returning success

Test-bot: skip
2026-04-28 12:17:44 +02:00

129 lines
4.7 KiB
C++

/*
* Keyman is copyright (C) SIL International. MIT License.
*
* Created by Tim Eves on 2018-10-30
*
* Keyman Core - state API unit tests
*/
#include <cstdlib>
#include <cstring>
#include <iostream>
#include <string>
#include "keyman_core.h"
#include "path.hpp"
#include "state.hpp"
#include "mock/mock_processor.hpp"
#include "../helpers/core_test_helpers.h"
#if defined(__GNUC__) || defined(__clang__)
#define PRAGMA(X) _Pragma(#X)
#define DISABLE_WARNING_PUSH PRAGMA(GCC diagnostic push)
#define DISABLE_WARNING_POP PRAGMA(GCC diagnostic pop)
#define DISABLE_WARNING(W) PRAGMA(GCC diagnostic ignored #W)
#define DISABLE_WARNING_TYPE_LIMITS DISABLE_WARNING(-Wtype-limits)
#else
#define DISABLE_WARNING_PUSH
#define DISABLE_WARNING_POP
#define DISABLE_WARNING_TYPE_LIMITS
#endif
namespace
{
km_core_option_item test_env_opts[] =
{
{u"hello", u"world", 0},
KM_CORE_OPTIONS_END
};
constexpr km_core_option_item const expected_persist_opt = {
u"test_keyboard_option",
u"F2 pressed test save.",
KM_CORE_OPT_KEYBOARD
};
extern "C"
{
uint8_t test_imx_callback(km_core_state *state, uint32_t imx_id, void *callback_object){
// does nothing;
return 1;
}
};
} // namespace
TEST(StateApiTests, TestStateApi) {
km_core_keyboard * test_kb = nullptr;
km_core_state * test_state = nullptr,
* test_clone = nullptr;
test_kb = (km_core_keyboard *)new km::core::mock_processor(km::core::path("dummy.mock"));
// Simple sanity tests.
ASSERT_STATUS_OK(km_core_state_create(test_kb, test_env_opts, &test_state));
ASSERT_STATUS_OK(km_core_state_clone(test_state, &test_clone));
// Check sub objects have been copied and not shared.
ASSERT_NE(km_core_state_context(test_state), km_core_state_context(test_clone));
size_t n_actions = 0;
ASSERT_FALSE(km_core_state_action_items(test_state, &n_actions) == nullptr
&& n_actions != 0);
// Check registering platform engine callback
km_core_state_imx_register_callback(test_state, test_imx_callback, nullptr);
km_core_state_imx_deregister_callback(test_state);
// Lets add data and do some basic checks of options and km_core_context
km_core_context_item *citems = nullptr;
ASSERT_STATUS_OK(context_items_from_utf16(u"Hello 😁", &citems));
ASSERT_STATUS_OK(km_core_context_set(km_core_state_context(test_state), citems));
km_core_context_items_dispose(citems);
ASSERT_EQ(km_core_context_length(km_core_state_context(test_state)), 7);
ASSERT_EQ(km_core_context_length(km_core_state_context(test_clone)), 0);
// Overwrite some data.
km_core_option_item new_opt[] = {
{u"hello", u"globe", KM_CORE_OPT_ENVIRONMENT},
KM_CORE_OPTIONS_END};
ASSERT_STATUS_OK(km_core_state_options_update(test_clone, new_opt));
// Test the engine
auto attrs = km_core_get_engine_attrs(test_state);
DISABLE_WARNING_PUSH
DISABLE_WARNING_TYPE_LIMITS
// Check the lib supplies our required interface.
ASSERT_FALSE(attrs->current - attrs->age > KM_CORE_LIB_CURRENT
|| attrs->current < KM_CORE_LIB_CURRENT);
ASSERT_FALSE(attrs->max_context < 16);
DISABLE_WARNING_POP
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_S,
KM_CORE_MODIFIER_SHIFT, 1, KM_CORE_EVENT_FLAG_DEFAULT));
ASSERT_TRUE(km::tests::action_items(test_state, {{KM_CORE_IT_CHAR, {0,}, {km_core_usv('S')}}, {KM_CORE_IT_END}}));
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_I,
KM_CORE_MODIFIER_SHIFT, 1, KM_CORE_EVENT_FLAG_DEFAULT));
ASSERT_TRUE(km::tests::action_items(test_state, {{KM_CORE_IT_CHAR, {0,}, {km_core_usv('I')}}, {KM_CORE_IT_END}}));
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_L, 0, 1, KM_CORE_EVENT_FLAG_DEFAULT));
ASSERT_TRUE(km::tests::action_items(test_state, {{KM_CORE_IT_CHAR, {0,}, {km_core_usv('l')}}, {KM_CORE_IT_END}}));
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_BKSP, 0, 1, KM_CORE_EVENT_FLAG_DEFAULT));
ASSERT_TRUE(km::tests::action_items(test_state, {{KM_CORE_IT_BACK, {0,}, {0}}, {KM_CORE_IT_END}}));
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_L,
KM_CORE_MODIFIER_SHIFT, 1, KM_CORE_EVENT_FLAG_DEFAULT));
ASSERT_TRUE(km::tests::action_items(test_state, {{KM_CORE_IT_CHAR, {0,}, {km_core_usv('L')}}, {KM_CORE_IT_END}}));
ASSERT_STATUS_OK(km_core_process_event(test_state, KM_CORE_VKEY_F2, 0, 1, KM_CORE_EVENT_FLAG_DEFAULT));
km_core_action_item action = {KM_CORE_IT_PERSIST_OPT, {0,}, };
action.option = &expected_persist_opt;
ASSERT_TRUE(km::tests::action_items(test_state, {action, {KM_CORE_IT_END}}));
// Destroy them
km_core_state_dispose(test_state);
km_core_state_dispose(test_clone);
km_core_keyboard_dispose(test_kb);
}