spiegel-keyman/common/engine/keyboardprocessor/tests/unit/kmnkbd/options_api.cpp

/*
  Copyright:    © 2018 SIL International.
  Description:  Tests for the context API family of functions.
  Create Date:  30 Oct 2018
  Authors:      Tim Eves (TSE)
*/
#include <cstdlib>
#include <string>

#include <keyman/keyboardprocessor.h>

#include "option.hpp"
#include "state.hpp"

#define   try_status(expr) \
{auto __s = (expr); if (__s != KM_KBP_STATUS_OK) std::exit(100*__LINE__+__s);}

namespace
{
  km_kbp_option_item const test_env[] =
  {
    {u"isdummy",   u"yes", 0},
    {u"testing",   u"maybe", 0},
    KM_KBP_OPTIONS_END
  };

  km_kbp_option_item const test_kb[] =
  {
    {u"hello",     u"world", 0},
    KM_KBP_OPTIONS_END
  };

  km_kbp_option_item test_opts[] =
  {
    {u"isdummy",   u"no", KM_KBP_OPT_ENVIRONMENT},
    {u"hello",     u"globe", KM_KBP_OPT_KEYBOARD},
    KM_KBP_OPTIONS_END
  };

  km_kbp_option_item bad_key_opts[] =
  {
    {u"isdumber",   u"yes!", KM_KBP_OPT_ENVIRONMENT},
    KM_KBP_OPTIONS_END
  };

  km_kbp_option_item bad_scope_opts[] =
  {
    {u"hello",   u"!", KM_KBP_OPT_UNKNOWN},
    KM_KBP_OPTIONS_END
  };

  km_kbp_option_item const empty_options_list[] = {KM_KBP_OPTIONS_END};

#if 0
  km::kbp::state mock_state(test_kb, test_env);
  km::kbp::state empty_state(empty_options_list, empty_options_list);
#endif

  std::string get_json_doc(km_kbp_state * const state)
  {
    size_t sz = 0;
    try_status(km_kbp_state_options_to_json(state, nullptr, &sz));
    std::string buf(sz-1, 0);
    try_status(km_kbp_state_options_to_json(state, &buf[0], &sz));

    return buf;
  }

  #define assert_lookup_equals(k,v,s) {if (!_assert_lookup_equals(k,v,s)) return __LINE__; }
  bool _assert_lookup_equals(std::u16string const key, std::u16string value, km_kbp_option_scope scope)
  {
#if 0
    km_kbp_cp const * ret = nullptr;
    auto s = km_kbp_state_option_lookup(api_mock_options, scope,
                                         key.c_str(),
                                         &ret);
    bool v = s == KM_KBP_STATUS_OK && ret == value;
    return v;
#else
    return true;
#endif
  }

constexpr char const *empty_json = "\
{\n\
    \"keyboard\" : {},\n\
    \"environment\" : {},\n\
    \"saved\" : {\n\
        \"keyboard\" : {},\n\
        \"environment\" : {}\n\
    }\n\
}\n";

constexpr char const *mock_json = "\
{\n\
    \"keyboard\" : {\n\
        \"hello\" : \"world\"\n\
    },\n\
    \"environment\" : {\n\
        \"isdummy\" : \"yes\",\n\
        \"testing\" : \"maybe\"\n\
    },\n\
    \"saved\" : {\n\
        \"keyboard\" : {\n\
            \"hello\" : \"globe\"\n\
        },\n\
        \"environment\" : {\n\
            \"isdummy\" : \"no\"\n\
        }\n\
    }\n\
}\n";

}

int main(int, char * [])
{
#if 0
  // Simple sanity tests on an empty options.
  if (km_kbp_options_list_size(empty_options_list) != 0)
    return __LINE__;
  km_kbp_cp const *value;
  auto s = km_kbp_options_lookup(api_empty_options,
                                     KM_KBP_OPT_ENVIRONMENT,
                                     u"isdummy", &value);
  if (s != KM_KBP_STATUS_KEY_ERROR) return __LINE__;
  if (get_json_doc(api_empty_options) != empty_json) return __LINE__;

  // Lets update data.
  assert_lookup_equals(u"isdummy", u"yes", KM_KBP_OPT_ENVIRONMENT);
  assert_lookup_equals(u"hello", u"world", KM_KBP_OPT_KEYBOARD);
  try_status(km_kbp_options_update(api_mock_options, test_opts));
  assert_lookup_equals(u"isdummy", u"no", KM_KBP_OPT_ENVIRONMENT);
  assert_lookup_equals(u"hello", u"globe", KM_KBP_OPT_KEYBOARD);

  // Test writing of non-exitent keys
  if (km_kbp_options_update(api_mock_options, bad_key_opts)
      != KM_KBP_STATUS_KEY_ERROR)
    return __LINE__;

  if (km_kbp_options_update(api_mock_options, bad_scope_opts)
      != KM_KBP_STATUS_INVALID_ARGUMENT)
    return __LINE__;

  // Create a single entry options set for testing fuller json output.
  // Because the underlying data structure is unordered there is no way define
  // a static json test document that will be consistently sorted across
  // runtimes or platforms.
  if (get_json_doc(api_mock_options) != mock_json) return __LINE__;
#endif

  return 0;
}