Skip to content

An OpenMW mod that lets you play the whole Elder Scrolls III: Morrowind as a top-down isometric game — with full online co-op or MMO modes.

C++
12.9 KB
Raw Blame
#include <gmock/gmock.h>
#include <gtest/gtest.h>

#include <components/files/fixedpath.hpp>
#include <components/l10n/manager.hpp>
#include <components/lua/l10n.hpp>
#include <components/lua/luastate.hpp>
#include <components/testing/util.hpp>

namespace
{
    using namespace testing;
    using namespace TestingOpenMW;

    template <typename T>
    T get(sol::state_view& lua, const std::string& luaCode)
    {
        return lua.safe_script("return " + luaCode).get<T>();
    }

    constexpr VFS::Path::NormalizedView test1EnPath("l10n/test1/en.yaml");
    constexpr VFS::Path::NormalizedView test1EnUsPath("l10n/test1/en_us.yaml");
    constexpr VFS::Path::NormalizedView test1DePath("l10n/test1/de.yaml");
    constexpr VFS::Path::NormalizedView test2EnPath("l10n/test2/en.yaml");
    constexpr VFS::Path::NormalizedView test3EnPath("l10n/test3/en.yaml");
    constexpr VFS::Path::NormalizedView test3DePath("l10n/test3/de.yaml");
    constexpr VFS::Path::NormalizedView test4RuPath("l10n/test4/ru.yaml");
    constexpr VFS::Path::NormalizedView test4EnPath("l10n/test4/en.yaml");
    constexpr VFS::Path::NormalizedView test5GmstPath("l10n/test5/gmst.yaml");
    constexpr VFS::Path::NormalizedView test5EnPath("l10n/test5/en.yaml");

    VFSTestFile invalidScript("not a script");
    VFSTestFile incorrectScript(
        "return { incorrectSection = {}, engineHandlers = { incorrectHandler = function() end } }");
    VFSTestFile emptyScript("");

    VFSTestFile test1En(R"X(
good_morning: "Good morning."
you_have_arrows: |-
  {count, plural,
    =0{You have no arrows.}
    one{You have one arrow.}
    other{You have {count} arrows.}
  }
pc_must_come: |-
  {PCGender, select,
     male {He is}
     female {She is}
     other {They are}
  } coming with us.
quest_completion: "The quest is {done, number, percent} complete."
ordinal: "You came in {num, ordinal} place."
spellout: "There {num, plural, one{is {num, spellout} thing} other{are {num, spellout} things}}."
duration: "It took {num, duration}"
numbers: "{int} and {double, number, integer} are integers, but {double} is a double"
rounding: "{value, number, :: .00}"
)X");

    VFSTestFile test1De(R"X(
good_morning: "Guten Morgen."
you_have_arrows: |-
  {count, plural,
    one{Du hast ein Pfeil.}
    other{Du hast {count} Pfeile.}
  }
"Hello {name}!": "Hallo {name}!"
)X");

    VFSTestFile test1EnUS(R"X(
currency: "You have {money, number, currency}"
)X");

    VFSTestFile test2En(R"X(
good_morning: "Morning!"
you_have_arrows: "Arrows count: {count}"
)X");

    VFSTestFile test4Ru(R"X(
skill_increase: "Ваш навык {навык} увеличился до {value}"
acrobatics: "Акробатика"
)X");

    VFSTestFile test4En(R"X(
stat_increase: "Your {stat} has increased to {value}"
speed: "Speed"
)X");

    VFSTestFile test5(R"X(
string: "sSimpleString"
format_string: "sFormatString"
inject_string: "sStringInjection"
not_found: "sNoSuchString"
no_gmst:
    pattern: "Hello world"
interpreted_string:
    pattern: "{gmst:sFormatString} {sSimpleString} {gmst:sFormatString}"
    variables:
        - ["a", "b"]
        - ["b", "a"]
plural_string:
    pattern: |-
        {count, plural,
            one{{gmst:sSimpleString}}
            other{{gmst:sFormatString}}
        }
    variables:
        - []
        - ["count", "count"]
unnamed_string:
    pattern: "{gmst:sFormatString}"
)X");

    struct LuaL10nTest : Test
    {
        std::unique_ptr<VFS::Manager> mVFS = createTestVFS({
            { test1EnPath, &test1En },
            { test1EnUsPath, &test1EnUS },
            { test1DePath, &test1De },
            { test2EnPath, &test2En },
            { test3EnPath, &test1En },
            { test3DePath, &test1De },
            { test4RuPath, &test4Ru },
            { test4EnPath, &test4En },
            { test5GmstPath, &test5 },
            { test5EnPath, &test5 },
        });

        LuaUtil::ScriptsConfiguration mCfg;
    };

    TEST_F(LuaL10nTest, L10n)
    {
        LuaUtil::LuaState lua{ mVFS.get(), &mCfg };
        lua.protectedCall([&](LuaUtil::LuaView& view) {
            sol::state_view& l = view.sol();
            internal::CaptureStdout();
            L10n::Manager l10nManager(mVFS.get());
            l10nManager.setPreferredLocales({ "de", "en" });
            EXPECT_THAT(internal::GetCapturedStdout(), "Preferred locales: gmst de en\n");

            l["l10n"] = LuaUtil::initL10nLoader(l, &l10nManager);

            internal::CaptureStdout();
            l.safe_script("t1 = l10n('Test1')");
            EXPECT_THAT(internal::GetCapturedStdout(),
                "Language file \"l10n/Test1/de.yaml\" is enabled\n"
                "Language file \"l10n/Test1/en.yaml\" is enabled\n");

            internal::CaptureStdout();
            l.safe_script("t2 = l10n('Test2')");
            {
                std::string output = internal::GetCapturedStdout();
                EXPECT_THAT(output, HasSubstr("Language file \"l10n/Test2/en.yaml\" is enabled"));
            }

            EXPECT_EQ(get<std::string>(l, "t1('good_morning')"), "Guten Morgen.");
            EXPECT_EQ(get<std::string>(l, "t1('you_have_arrows', {count=1})"), "Du hast ein Pfeil.");
            EXPECT_EQ(get<std::string>(l, "t1('you_have_arrows', {count=5})"), "Du hast 5 Pfeile.");
            EXPECT_EQ(get<std::string>(l, "t1('Hello {name}!', {name='World'})"), "Hallo World!");
            EXPECT_EQ(get<std::string>(l, "t2('good_morning')"), "Morning!");
            EXPECT_EQ(get<std::string>(l, "t2('you_have_arrows', {count=3})"), "Arrows count: 3");

            internal::CaptureStdout();
            l10nManager.setPreferredLocales({ "en", "de" });
            EXPECT_THAT(internal::GetCapturedStdout(),
                "Preferred locales: gmst en de\n"
                "Language file \"l10n/Test1/en.yaml\" is enabled\n"
                "Language file \"l10n/Test1/de.yaml\" is enabled\n"
                "Language file \"l10n/Test2/en.yaml\" is enabled\n");

            EXPECT_EQ(get<std::string>(l, "t1('good_morning')"), "Good morning.");
            EXPECT_EQ(get<std::string>(l, "t1('you_have_arrows', {count=1})"), "You have one arrow.");
            EXPECT_EQ(get<std::string>(l, "t1('you_have_arrows', {count=5})"), "You have 5 arrows.");
            EXPECT_EQ(get<std::string>(l, "t1('pc_must_come', {PCGender=\"male\"})"), "He is coming with us.");
            EXPECT_EQ(get<std::string>(l, "t1('pc_must_come', {PCGender=\"female\"})"), "She is coming with us.");
            EXPECT_EQ(get<std::string>(l, "t1('pc_must_come', {PCGender=\"blah\"})"), "They are coming with us.");
            EXPECT_EQ(get<std::string>(l, "t1('pc_must_come', {PCGender=\"other\"})"), "They are coming with us.");
            EXPECT_EQ(get<std::string>(l, "t1('quest_completion', {done=0.1})"), "The quest is 10% complete.");
            EXPECT_EQ(get<std::string>(l, "t1('quest_completion', {done=1})"), "The quest is 100% complete.");
            EXPECT_EQ(get<std::string>(l, "t1('ordinal', {num=1})"), "You came in 1st place.");
            EXPECT_EQ(get<std::string>(l, "t1('ordinal', {num=100})"), "You came in 100th place.");
            EXPECT_EQ(get<std::string>(l, "t1('spellout', {num=1})"), "There is one thing.");
            EXPECT_EQ(get<std::string>(l, "t1('spellout', {num=100})"), "There are one hundred things.");
            EXPECT_EQ(get<std::string>(l, "t1('duration', {num=100})"), "It took 1:40");
            EXPECT_EQ(get<std::string>(l, "t1('numbers', {int=123, double=123.456})"),
                "123 and 123 are integers, but 123.456 is a double");
            EXPECT_EQ(get<std::string>(l, "t1('rounding', {value=123.456789})"), "123.46");
            // Check that failed messages display the key instead of an empty string
            EXPECT_EQ(get<std::string>(l, "t1('{mismatched_braces')"), "{mismatched_braces");
            EXPECT_EQ(get<std::string>(l, "t1('{unknown_arg}')"), "{unknown_arg}");
            EXPECT_EQ(get<std::string>(l, "t1('{num, integer}', {num=1})"), "{num, integer}");
            // Doesn't give a valid currency symbol with `en`. Not that openmw is designed for real world currency.
            l10nManager.setPreferredLocales({ "en-US", "de" });
            EXPECT_EQ(get<std::string>(l, "t1('currency', {money=10000.10})"), "You have $10,000.10");
            // Note: Not defined in English localisation file, so we fall back to the German before falling back to the
            // key
            EXPECT_EQ(get<std::string>(l, "t1('Hello {name}!', {name='World'})"), "Hallo World!");
            EXPECT_EQ(get<std::string>(l, "t2('good_morning')"), "Morning!");
            EXPECT_EQ(get<std::string>(l, "t2('you_have_arrows', {count=3})"), "Arrows count: 3");

            // Test that locales with variants and country codes fall back to more generic locales
            internal::CaptureStdout();
            l10nManager.setPreferredLocales({ "en-GB-oed", "de" });
            EXPECT_THAT(internal::GetCapturedStdout(),
                "Preferred locales: gmst en_GB_OED de\n"
                "Language file \"l10n/Test1/en.yaml\" is enabled\n"
                "Language file \"l10n/Test1/de.yaml\" is enabled\n"
                "Language file \"l10n/Test2/en.yaml\" is enabled\n");
            EXPECT_EQ(get<std::string>(l, "t2('you_have_arrows', {count=3})"), "Arrows count: 3");

            // Test setting fallback language
            l.safe_script("t3 = l10n('Test3', 'de')");
            l10nManager.setPreferredLocales({ "en" });
            EXPECT_EQ(get<std::string>(l, "t3('Hello {name}!', {name='World'})"), "Hallo World!");

            // Test that formatting arguments use a correct encoding
            l.safe_script("t4 = l10n('Test4', 'ru')");
            l10nManager.setPreferredLocales({ "ru", "en" });
            EXPECT_EQ(get<std::string>(l, "t4('skill_increase', {навык='Акробатика', value=100})"),
                "Ваш навык Акробатика увеличился до 100");
            EXPECT_EQ(get<std::string>(l, "t4('skill_increase', {навык=t4('acrobatics'), value=100})"),
                "Ваш навык Акробатика увеличился до 100");
            EXPECT_EQ(get<std::string>(l, "t4('stat_increase', {stat='Speed', value=100})"),
                "Your Speed has increased to 100");
            EXPECT_EQ(get<std::string>(l, "t4('stat_increase', {stat=t4('speed'), value=100})"),
                "Your Speed has increased to 100");
        });
    }

    TEST_F(LuaL10nTest, L10nGMST)
    {
        LuaUtil::LuaState lua{ mVFS.get(), &mCfg };
        lua.protectedCall([&](LuaUtil::LuaView& view) {
            sol::state_view& l = view.sol();
            L10n::Manager l10nManager(mVFS.get());
            const std::map<std::string_view, std::string, Misc::StringUtils::CiComp> gmsts{
                { "sSimpleString", "Hello it's the world" },
                { "sFormatString", "You have %i %s" },
                { "sStringInjection", "{a}" },
            };
            l10nManager.setGmstLoader([&](std::string_view gmst) -> const std::string* {
                auto it = gmsts.find(gmst);
                if (it != gmsts.end())
                    return &it->second;
                return nullptr;
            });

            internal::CaptureStdout();
            l10nManager.setPreferredLocales({ "en" });
            EXPECT_THAT(internal::GetCapturedStdout(), "Preferred locales: gmst en\n");

            l["l10n"] = LuaUtil::initL10nLoader(l, &l10nManager);
            l.safe_script("t5 = l10n('Test5')");

            EXPECT_EQ(get<std::string>(l, "t5('string')"), "Hello it's the world");
            EXPECT_EQ(get<std::string>(l, "t5('format_string')"), "You have %i %s");
            EXPECT_EQ(get<std::string>(l, "t5('format_string', { i = 1, s = 'a' })"), "You have %i %s");
            EXPECT_EQ(
                get<std::string>(l, "t5('interpreted_string')"), "You have {a} {b} {sSimpleString} You have {b} {a}");
            EXPECT_EQ(get<std::string>(l, "t5('interpreted_string', { a = 1, b = 2, sSimpleString = 3 })"),
                "You have 1 2 3 You have 2 1");
            EXPECT_EQ(get<std::string>(l, "t5('inject_string')"), "{a}");
            EXPECT_EQ(get<std::string>(l, "t5('inject_string', { a = 1 })"), "{a}");
            EXPECT_EQ(get<std::string>(l, "t5('plural_string', { count = 1 })"), "Hello it's the world");
            EXPECT_EQ(get<std::string>(l, "t5('plural_string', { count = 2 })"), "You have 2 2");
            EXPECT_EQ(get<std::string>(l, "t5('unnamed_string')"), "You have {0} {1}");
            EXPECT_EQ(get<std::string>(l, "t5('unnamed_string', { ['0'] = 'a', ['1'] = 'b' })"), "You have a b");
            EXPECT_EQ(get<std::string>(l, "t5('no_gmst')"), "Hello world");
            EXPECT_EQ(get<std::string>(l, "t5('not_found')"), "GMST:sNoSuchString");

            l10nManager.setPreferredLocales({ "en" }, false);
            EXPECT_EQ(get<std::string>(l, "t5('string')"), "sSimpleString");
            EXPECT_EQ(get<std::string>(l, "t5('format_string')"), "sFormatString");
            EXPECT_EQ(get<std::string>(l, "t5('not_found')"), "sNoSuchString");
        });
    }
}