@keymanapp/developer-utils 18.0.120-alpha → 18.0.122-alpha

package/build/test/test-xml-utils.js

@@ -0,0 +1,152 @@
+/*
+ * Keyman is copyright (C) SIL Global. MIT License.
+ *
+ * Created by srl on 2024-09-27
+ *
+ * Test for abstraction for XML reading and writing
+ */
+
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{},n=(new Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="ad4ac8a8-5fd2-5481-9dfa-3c2c423a995f")}catch(e){}}();
+import { assert } from 'chai';
+import 'mocha';
+import { env } from 'node:process';
+import { readFileSync, writeFileSync } from 'node:fs';
+import { KeymanXMLReader, KeymanXMLWriter } from '../src/xml-utils.js';
+import { makePathToFixture } from './helpers/index.js';
+// if true, attempt to WRITE the fixtures
+const { GEN_XML_FIXTURES } = env;
+class Case {
+    type;
+    paths;
+}
+;
+const read_cases = [
+    {
+        type: 'keyboard3',
+        paths: [
+            // keyboards
+            'disp_maximal.xml',
+            'k_020_fr.xml',
+            'strs_invalid-illegal.xml',
+            'tran_fail-empty.xml',
+        ],
+    }, {
+        type: 'keyboardTest3',
+        paths: [
+            // keyboard test
+            'k_020_fr-test.xml',
+        ],
+    }, {
+        type: 'kvks',
+        paths: [
+            // kvks
+            'khmer_angkor.kvks',
+        ],
+    }, {
+        type: 'kps',
+        paths: [
+            // kps
+            'test_valid.kps',
+            // 'error_invalid_package_file.kps',
+        ],
+    }, {
+        type: 'kpj',
+        paths: [
+            // kpj
+            'khmer_angkor.kpj',
+        ],
+    },
+];
+const write_cases = [
+    {
+        type: 'kvks',
+        paths: [
+            // kvks
+            'khmer_angkor2.kvks', // similar to the 'read case' with the similar name, except for whitespace differences and the prologue
+        ],
+    },
+];
+/** read data, or null */
+function readData(path) {
+    try {
+        return readFileSync(path, 'utf-8');
+    }
+    catch (e) {
+        if (e?.code !== 'ENOENT')
+            console.error(`reading ${path}`, e);
+        return null;
+    }
+}
+function readJson(path) {
+    const data = readData(path);
+    if (data === null)
+        return null;
+    return JSON.parse(data);
+}
+function writeJson(path, data) {
+    writeFileSync(path, JSON.stringify(data, null, ' '));
+}
+describe(`XML Reader Test ${GEN_XML_FIXTURES && '(update mode!)' || ''}`, () => {
+    for (const c of read_cases) {
+        const { type, paths } = c;
+        describe(`test reading ${type}`, () => {
+            for (const path of paths) {
+                const xmlPath = makePathToFixture('xml', `${path}`);
+                const jsonPath = makePathToFixture('xml', `${path}.json`);
+                it(`read: xml/${path}`, () => {
+                    // get the string data
+                    const xml = readData(xmlPath);
+                    assert.ok(xml, `Could not read ${xmlPath}`);
+                    const reader = new KeymanXMLReader(type);
+                    assert.ok(reader);
+                    // now, parse. subsitute endings for Win
+                    const actual = reader.parse(xml.replace(/\r\n/g, '\n'));
+                    assert.ok(actual, `Parser failed on ${xmlPath}`);
+                    // get the expected
+                    const expect = readJson(jsonPath);
+                    if (GEN_XML_FIXTURES) {
+                        console.log(`GEN_XML_FIXTURES: writing ${jsonPath} from actual`);
+                        writeJson(jsonPath, actual);
+                    }
+                    else {
+                        assert.ok(expect, `Could not read ${jsonPath} - run with env GEN_XML_FIXTURES=1 to update.`);
+                        assert.deepEqual(actual, expect, `Mismatch of ${xmlPath} vs ${jsonPath}`);
+                    }
+                });
+            }
+        });
+    }
+});
+describe(`XML Writer Test ${GEN_XML_FIXTURES && '(update mode!)' || ''}`, () => {
+    for (const c of write_cases) {
+        const { type, paths } = c;
+        describe(`test writing ${type}`, () => {
+            const writer = new KeymanXMLWriter(type);
+            assert.ok(writer);
+            for (const path of paths) {
+                const jsonPath = makePathToFixture('xml', `${path}.json`);
+                const xmlPath = makePathToFixture('xml', `${path}`);
+                it(`write: xml/${path}`, () => {
+                    // get the object data
+                    const data = readJson(jsonPath);
+                    assert.ok(data, `Could not read input ${jsonPath}`);
+                    // now, write.
+                    const actual = writer.write(data);
+                    assert.ok(actual, `Writer failed on ${jsonPath}`);
+                    if (GEN_XML_FIXTURES) {
+                        console.log(`GEN_XML_FIXTURES: writing ${xmlPath} from actual`);
+                        writeFileSync(xmlPath, actual);
+                    }
+                    else {
+                        // get the expected data
+                        const expect = readData(xmlPath).replace(/\r\n/g, '\n');
+                        assert.ok(expect, `Could not read expected output ${xmlPath} - run with env=GEN_XML_FIXTURES=1 to update`);
+                        assert.deepEqual(actual.trim(), expect.trim(), `Mismatch of ${xmlPath} vs ${jsonPath}`);
+                    }
+                });
+            }
+        });
+    }
+});
+//# sourceMappingURL=test-xml-utils.js.map
+//# debugId=ad4ac8a8-5fd2-5481-9dfa-3c2c423a995f

package/build/test/test-xml-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-xml-utils.js","sources":["../../test/test-xml-utils.ts"],"sourceRoot":"","names":[],"mappings":"AAAA;;;;;;GAMG;;;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,OAAO,CAAC;AACf,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGtD,OAAO,EAAiB,eAAe,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtF,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,yCAAyC;AACzC,MAAM,EAAE,gBAAgB,EAAE,GAAG,GAAG,CAAC;AAEjC,MAAM,IAAI;IACR,IAAI,CAAgB;IACpB,KAAK,CAAW;CACjB;AAAA,CAAC;AAEF,MAAM,UAAU,GAAW;IACzB;QACE,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE;YACL,YAAY;YACZ,kBAAkB;YAClB,cAAc;YACd,0BAA0B;YAC1B,qBAAqB;SACtB;KACF,EAAE;QACD,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE;YACL,gBAAgB;YAChB,mBAAmB;SACpB;KACF,EAAE;QACD,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE;YACL,OAAO;YACP,mBAAmB;SACpB;KACF,EAAE;QACD,IAAI,EAAE,KAAK;QACX,KAAK,EAAE;YACL,MAAM;YACN,gBAAgB;YAChB,oCAAoC;SACrC;KACF,EAAE;QACD,IAAI,EAAE,KAAK;QACX,KAAK,EAAE;YACL,MAAM;YACN,kBAAkB;SACnB;KACF;CACF,CAAC;AAEF,MAAM,WAAW,GAAW;IAC1B;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE;YACL,OAAO;YACP,oBAAoB,EAAE,uGAAuG;SAC9H;KACF;CACF,CAAC;AAEF,yBAAyB;AACzB,SAAS,QAAQ,CAAC,IAAY;IAC5B,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,CAAC,EAAE,IAAI,KAAK,QAAQ;YAAE,OAAO,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;QAC9D,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,SAAS,SAAS,CAAC,IAAY,EAAE,IAAS;IACxC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,QAAQ,CAAC,mBAAmB,gBAAgB,IAAI,gBAAgB,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE;IAC7E,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,QAAQ,CAAC,gBAAgB,IAAI,EAAE,EAAE,GAAG,EAAE;YACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;gBACpD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;gBAC1D,EAAE,CAAC,aAAa,IAAI,EAAE,EAAE,GAAG,EAAE;oBAC3B,sBAAsB;oBACtB,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC9B,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,kBAAkB,OAAO,EAAE,CAAC,CAAC;oBAE5C,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;oBAElB,wCAAwC;oBACxC,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;oBACxD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,OAAO,EAAE,CAAC,CAAC;oBAEjD,mBAAmB;oBACnB,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAElC,IAAI,gBAAgB,EAAE,CAAC;wBACrB,OAAO,CAAC,GAAG,CAAC,6BAA6B,QAAQ,cAAc,CAAC,CAAC;wBACjE,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;oBAC9B,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,QAAQ,+CAA+C,CAAC,CAAC;wBAC7F,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,OAAO,OAAO,QAAQ,EAAE,CAAC,CAAC;oBAC5E,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC;AAGH,QAAQ,CAAC,mBAAmB,gBAAgB,IAAI,gBAAgB,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE;IAC7E,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;QAC5B,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAC1B,QAAQ,CAAC,gBAAgB,IAAI,EAAE,EAAE,GAAG,EAAE;YACpC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,QAAQ,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC;gBAC1D,MAAM,OAAO,GAAG,iBAAiB,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;gBACpD,EAAE,CAAC,cAAc,IAAI,EAAE,EAAE,GAAG,EAAE;oBAC5B,sBAAsB;oBACtB,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAChC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,wBAAwB,QAAQ,EAAE,CAAC,CAAC;oBAEpD,cAAc;oBACd,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAClC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,QAAQ,EAAE,CAAC,CAAC;oBAElD,IAAI,gBAAgB,EAAE,CAAC;wBACrB,OAAO,CAAC,GAAG,CAAC,6BAA6B,OAAO,cAAc,CAAC,CAAC;wBAChE,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBACjC,CAAC;yBAAM,CAAC;wBACN,wBAAwB;wBACxB,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;wBACxD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,kCAAkC,OAAO,8CAA8C,CAAC,CAAC;wBAC3G,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,eAAe,OAAO,OAAO,QAAQ,EAAE,CAAC,CAAC;oBAC1F,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC","debug_id":"ad4ac8a8-5fd2-5481-9dfa-3c2c423a995f"}