aboutsummaryrefslogtreecommitdiff
path: root/test/dictionary-data.test.js
blob: 9f8ba6f0c7656385541ed8eaed8311693749ed75 (plain)
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
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

import {readFileSync} from 'fs';
import {fileURLToPath} from 'node:url';
import path from 'path';
import {describe} from 'vitest';
import {parseJson} from '../dev/json.js';
import {createTranslatorTest} from './fixtures/translator-test.js';
import {createTestAnkiNoteData, getTemplateRenderResults} from './utilities/anki.js';
import {createFindOptions} from './utilities/translator.js';

const dirname = path.dirname(fileURLToPath(import.meta.url));
const dictionaryName = 'Test Dictionary 2';
const test = await createTranslatorTest(void 0, path.join(dirname, 'data/dictionaries/valid-dictionary1'), dictionaryName);

describe('Dictionary data', () => {
    const testInputsFilePath = path.join(dirname, 'data/translator-test-inputs.json');
    /** @type {import('test/translator').TranslatorTestInputs} */
    const {optionsPresets, tests} = parseJson(readFileSync(testInputsFilePath, {encoding: 'utf8'}));

    const testResults1FilePath = path.join(dirname, 'data/translator-test-results.json');
    const testResults2FilePath = path.join(dirname, 'data/translator-test-results-note-data1.json');
    const testResults3FilePath = path.join(dirname, 'data/anki-note-builder-test-results.json');

    /** @type {import('test/translator').TranslatorTestResults} */
    const expectedResults1 = parseJson(readFileSync(testResults1FilePath, {encoding: 'utf8'}));
    /** @type {import('test/translator').TranslatorTestNoteDataResults} */
    const expectedResults2 = parseJson(readFileSync(testResults2FilePath, {encoding: 'utf8'}));
    /** @type {import('test/translator').AnkiNoteBuilderTestResults} */
    const expectedResults3 = parseJson(readFileSync(testResults3FilePath, {encoding: 'utf8'}));

    const template = readFileSync(path.join(dirname, '../ext/data/templates/default-anki-field-templates.handlebars'), {encoding: 'utf8'});

    const testCases = tests.map((data, i) => ({
        data,
        expected1: expectedResults1[i],
        expected2: expectedResults2[i],
        expected3: expectedResults3[i]
    }));
    describe.each(testCases)('Test %#: $data.name', ({data, expected1, expected2, expected3}) => {
        test('Test', async ({window, translator, expect}) => {
            // The window property needs to be referenced for it to be initialized.
            // It is needed for DOM access for structured content.
            void window;
            switch (data.func) {
                case 'findTerms':
                    {
                        const {mode, text} = data;
                        /** @type {import('translation').FindTermsOptions} */
                        const options = createFindOptions(dictionaryName, optionsPresets, data.options);
                        const {dictionaryEntries, originalTextLength} = await translator.findTerms(mode, text, options);
                        const renderResults = mode !== 'simple' ? await getTemplateRenderResults(dictionaryEntries, 'terms', mode, template, expect) : null;
                        const noteDataList = mode !== 'simple' ? dictionaryEntries.map((dictionaryEntry) => createTestAnkiNoteData(dictionaryEntry, mode)) : null;
                        expect.soft(originalTextLength).toStrictEqual(expected1.originalTextLength);
                        expect.soft(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
                        expect.soft(noteDataList).toEqual(expected2.noteDataList);
                        expect.soft(renderResults).toStrictEqual(expected3.results);
                    }
                    break;
                case 'findKanji':
                    {
                        const {text} = data;
                        /** @type {import('translation').FindKanjiOptions} */
                        const options = createFindOptions(dictionaryName, optionsPresets, data.options);
                        const dictionaryEntries = await translator.findKanji(text, options);
                        const renderResults = await getTemplateRenderResults(dictionaryEntries, 'kanji', 'split', template, expect);
                        const noteDataList = dictionaryEntries.map((dictionaryEntry) => createTestAnkiNoteData(dictionaryEntry, 'split'));
                        expect.soft(dictionaryEntries).toStrictEqual(expected1.dictionaryEntries);
                        expect.soft(noteDataList).toEqual(expected2.noteDataList);
                        expect.soft(renderResults).toStrictEqual(expected3.results);
                    }
                    break;
            }
        });
    });
});