File: translation_system_test.cpp

package info (click to toggle)
cataclysm-dda 0.H-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 710,808 kB
  • sloc: cpp: 524,019; python: 11,580; sh: 1,228; makefile: 1,169; xml: 507; javascript: 150; sql: 56; exp: 41; perl: 37
file content (264 lines) | stat: -rw-r--r-- 11,609 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
#include <cstring>
#include "cata_catch.h"
#include "filesystem.h"
#include "string_formatter.h"
#include "translation_document.h"
#include "translation_manager_impl.h"

#if defined(LOCALIZE)

static void LoadMODocument( const char *path )
{
    volatile TranslationDocument document( path );
}

TEST_CASE( "TranslationDocument_loads_valid_MO", "[translations]" )
{
    const char *path = "./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo";
    CAPTURE( path );
    REQUIRE( file_exist( fs::u8path( path ) ) );
    REQUIRE_NOTHROW( LoadMODocument( path ) );
}

TEST_CASE( "TranslationDocument_rejects_invalid_MO", "[translations]" )
{
    const char *path = "./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/INVALID_RAND.mo";
    CAPTURE( path );
    REQUIRE( file_exist( fs::u8path( path ) ) );
    REQUIRE_THROWS_AS( LoadMODocument( path ), InvalidTranslationDocumentException );
}

TEST_CASE( "TranslationDocument_loads_all_core_MO", "[translations]" )
{
    const std::unordered_set<std::string> languages =
        TranslationManager::GetInstance().GetAvailableLanguages();
    for( const std::string &lang : languages ) {
        const std::string path = string_format( "./lang/mo/%s/LC_MESSAGES/cataclysm-dda.mo", lang );
        CAPTURE( path );
        REQUIRE( file_exist( path ) );
        REQUIRE_NOTHROW( LoadMODocument( path.c_str() ) );
    }
}

TEST_CASE( "No_string_buffer_overlap_in_TranslationDocument", "[translations]" )
{
    const std::unordered_set<std::string> languages =
        TranslationManager::GetInstance().GetAvailableLanguages();
    for( const std::string &lang : languages ) {
        const std::string path = string_format( "./lang/mo/%s/LC_MESSAGES/cataclysm-dda.mo", lang );
        CAPTURE( path );
        REQUIRE( file_exist( path ) );
        TranslationDocument document( path );
        // The following code walks through every string contained in the MO document
        // So AddressSanitizer can also detect memory access violation if there is any
        const std::size_t n = document.Count();
        const char *last_ending = nullptr;
        for( std::size_t i = 0; i < n; i++ ) {
            const char *str = document.GetOriginalString( i );
            CHECK( last_ending < str );
            last_ending = str + std::strlen( str );
        }
        last_ending = nullptr;
        for( std::size_t i = 0; i < n; i++ ) {
            const char *str = document.GetTranslatedString( i );
            CHECK( last_ending < str );
            last_ending = str + std::strlen( str );
        }
    }
}

TEST_CASE( "TranslationDocument_loading_benchmark", "[.][benchmark][translations]" )
{
    BENCHMARK( "Load Russian" ) {
        return TranslationDocument( "./lang/mo/ru/LC_MESSAGES/cataclysm-dda.mo" );
    };
}

TEST_CASE( "TranslationManager_loading_benchmark", "[.][benchmark][translations]" )
{
    BENCHMARK( "Load Russian" ) {
        TranslationManager manager;
        manager.LoadDocuments( std::vector<std::string> {"./lang/mo/ru/LC_MESSAGES/cataclysm-dda.mo"} );
        return manager.Translate( "battery" );
    };
}

TEST_CASE( "TranslationManager_translate_benchmark", "[.][benchmark][translations]" )
{
    TranslationManager manager;

    // Russian
    REQUIRE( file_exist( fs::u8path( "./lang/mo/ru/LC_MESSAGES/cataclysm-dda.mo" ) ) );
    manager.LoadDocuments( std::vector<std::string> {"./lang/mo/ru/LC_MESSAGES/cataclysm-dda.mo"} );
    REQUIRE( strcmp( manager.Translate( "battery" ), "battery" ) != 0 );
    BENCHMARK( "Russian" ) {
        return manager.Translate( "battery" );
    };

    // Chinese
    REQUIRE( file_exist( fs::u8path( "./lang/mo/zh_CN/LC_MESSAGES/cataclysm-dda.mo" ) ) );
    manager.LoadDocuments( std::vector<std::string> {"./lang/mo/zh_CN/LC_MESSAGES/cataclysm-dda.mo"} );
    REQUIRE( strcmp( manager.Translate( "battery" ), "battery" ) != 0 );
    BENCHMARK( "Chinese" ) {
        return manager.Translate( "battery" );
    };

    // English
    manager.LoadDocuments( std::vector<std::string>() );
    REQUIRE( strcmp( manager.Translate( "battery" ), "battery" ) == 0 );
    BENCHMARK( "English" ) {
        return manager.Translate( "battery" );
    };
}

TEST_CASE( "TranslationManager_translates_message", "[translations]" )
{
    std::vector<std::string> files{"./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo"};
    TranslationManager manager;
    manager.LoadDocuments( files );
    std::string translated = manager.Translate( "battery" );
    CHECK( translated == "батарейка" );
}

TEST_CASE( "TranslationManager_returns_untranslated_message_as_is", "[translations]" )
{
    std::vector<std::string> files{"./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo"};
    TranslationManager manager;
    manager.LoadDocuments( files );
    const char *message = "__UnTrAnSlAtEd!!!__#";
    std::string translated = manager.Translate( message );
    CHECK( translated == message );
}

TEST_CASE( "TranslationManager_returns_empty_string_as_is", "[translations]" )
{
    std::vector<std::string> files{"./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo"};
    TranslationManager manager;
    manager.LoadDocuments( files );
    std::string translated = manager.Translate( "" );
    CHECK( translated.empty() );
}

TEST_CASE( "TranslationManager_translates_message_with_context", "[translations]" )
{
    std::vector<std::string> files{"./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo"};
    TranslationManager manager;
    manager.LoadDocuments( files );
    std::string translated_weapon_pike = manager.TranslateWithContext( "weapon", "pike" );
    CHECK( translated_weapon_pike == "пика" );
    std::string translated_fish_pike = manager.TranslateWithContext( "fish", "pike" );
    CHECK( translated_fish_pike == "щука" );
    std::string untranslated_unknown_pike = manager.TranslateWithContext( "!@#$", "pike" );
    CHECK( untranslated_unknown_pike == "pike" );
}

static void CheckPluralEvaluation( const TranslationPluralRulesEvaluator &evaluator,
                                   const std::function<std::size_t( std::size_t )> &ground_truth )
{
    for( std::size_t n = 0; n < 200; n++ ) {
        CHECK( evaluator.Evaluate( n ) == ground_truth( n ) );
    }
}

TEST_CASE( "TranslationPluralRulesEvaluator", "[translations]" )
{
    SECTION( "Arabic" ) {
        auto arabic_ground_truth = []( std::size_t n ) {
            return n == 0 ? 0 : n == 1 ? 1 : n == 2 ? 2 : n % 100 >= 3 && n % 100 <= 10 ? 3 : n % 100 >= 11 &&
                   n % 100 <= 99 ? 4 : 5;
        };
        const std::string arabic_rules =
            // NOLINTNEXTLINE(cata-text-style)
            "Plural-Forms: nplurals=6; plural=n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=11 && n%100<=99 ? 4 : 5;";
        TranslationPluralRulesEvaluator arabic_evaluator( arabic_rules );
        CheckPluralEvaluation( arabic_evaluator, arabic_ground_truth );
    }
    SECTION( "CJK" ) {
        auto cjk_ground_truth = []( std::size_t ) {
            return 0;
        };
        // NOLINTNEXTLINE(cata-text-style)
        const std::string cjk_rules = "Plural-Forms: nplurals=1; plural=0;";
        TranslationPluralRulesEvaluator cjk_evaluator( cjk_rules );
        CheckPluralEvaluation( cjk_evaluator, cjk_ground_truth );
    }
    SECTION( "Spanish" ) {
        auto spanish_ground_truth = []( std::size_t n ) {
            return n != 1;
        };
        // NOLINTNEXTLINE(cata-text-style)
        const std::string spanish_rules = "Plural-Forms: nplurals=2; plural=(n != 1);";
        TranslationPluralRulesEvaluator spanish_evaluator( spanish_rules );
        CheckPluralEvaluation( spanish_evaluator, spanish_ground_truth );
    }
    SECTION( "Russian" ) {
        auto russian_ground_truth = []( std::size_t n ) {
            return n % 10 == 1 && n % 100 != 11 ? 0 : n % 10 >= 2 && n % 10 <= 4 && ( n % 100 < 12 ||
                    n % 100 > 14 ) ? 1 : n % 10 == 0 || ( n % 10 >= 5 && n % 10 <= 9 ) || ( n % 100 >= 11 &&
                            n % 100 <= 14 ) ? 2 : 3;
        };
        const std::string russian_rules =
            // NOLINTNEXTLINE(cata-text-style)
            "Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || (n%100>=11 && n%100<=14)? 2 : 3);";
        TranslationPluralRulesEvaluator russian_evaluator( russian_rules );
        CheckPluralEvaluation( russian_evaluator, russian_ground_truth );
    }
}

TEST_CASE( "TranslationManager_translates_plural_messages", "[translations]" )
{
    SECTION( "English" ) {
        std::vector<std::string> files;
        TranslationManager manager;
        manager.LoadDocuments( files );
        std::string translated_0_battery = manager.TranslatePlural( "battery", "batteries", 0 );
        CHECK( translated_0_battery == "batteries" );
        std::string translated_1_battery = manager.TranslatePlural( "battery", "batteries", 1 );
        CHECK( translated_1_battery == "battery" );
        std::string translated_2_battery = manager.TranslatePlural( "battery", "batteries", 2 );
        CHECK( translated_2_battery == "batteries" );
        std::string translated_3_battery = manager.TranslatePlural( "battery", "batteries", 3 );
        CHECK( translated_3_battery == "batteries" );
        std::string translated_4_battery = manager.TranslatePlural( "battery", "batteries", 4 );
        CHECK( translated_4_battery == "batteries" );
    }

    SECTION( "Russian" ) {
        std::vector<std::string> files{"./data/mods/TEST_DATA/lang/mo/ru/LC_MESSAGES/TEST_DATA.mo"};
        TranslationManager manager;
        manager.LoadDocuments( files );
        std::string translated_0_battery = manager.TranslatePlural( "battery", "batteries", 0 );
        CHECK( translated_0_battery == "батареек" );
        std::string translated_1_battery = manager.TranslatePlural( "battery", "batteries", 1 );
        CHECK( translated_1_battery == "батарейка" );
        std::string translated_2_battery = manager.TranslatePlural( "battery", "batteries", 2 );
        CHECK( translated_2_battery == "батарейки" );
        std::string translated_3_battery = manager.TranslatePlural( "battery", "batteries", 3 );
        CHECK( translated_3_battery == "батарейки" );
        std::string translated_4_battery = manager.TranslatePlural( "battery", "batteries", 4 );
        CHECK( translated_4_battery == "батарейки" );
    }
}

TEST_CASE( "TranslationPluralRulesEvaluatorPerformance", "[.][benchmark][translations]" )
{
    TranslationManager manager;
    manager.LoadDocuments( std::vector<std::string> {"./lang/mo/ru/LC_MESSAGES/cataclysm-dda.mo"} );
    REQUIRE( strcmp( manager.TranslatePlural( "battery", "batteries", 1 ),
                     "батарейка" ) == 0 );
    BENCHMARK( "Russian plural rules evaluation" ) {
        return manager.TranslatePlural( "battery", "batteries", 1 );
    };
    manager.LoadDocuments( std::vector<std::string>() );
    REQUIRE( strcmp( manager.TranslatePlural( "battery", "batteries", 1 ), "battery" ) == 0 );
    BENCHMARK( "English plural rules evaluation" ) {
        return manager.TranslatePlural( "battery", "batteries", 1 );
    };
    manager.LoadDocuments( std::vector<std::string> {"./lang/mo/zh_CN/LC_MESSAGES/cataclysm-dda.mo"} );
    REQUIRE( strcmp( manager.TranslatePlural( "battery", "batteries", 1 ), "电池" ) == 0 );
    BENCHMARK( "Chinese plural rules evaluation" ) {
        return manager.TranslatePlural( "battery", "batteries", 1 );
    };
}

#endif