mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-10 02:45:32 +00:00
efad936105
Add a KMX+ file reader and tests, including a round-trip builder:reader test. Move basic-17.txt, basic-19.txt, and basic.xml to common test resources folder so they can be used by unit tests in common and developer. Test-bot: skip
74 lines
3 KiB
TypeScript
74 lines
3 KiB
TypeScript
import 'mocha';
|
|
import { assert } from 'chai';
|
|
import { checkMessages, compileKeyboard, compilerTestOptions, makePathToCommonFixture } from './helpers/index.js';
|
|
import { KMX } from '@keymanapp/common-types';
|
|
import KEYMAN_VERSION from '@keymanapp/keyman-version';
|
|
|
|
import KMXFile = KMX.KMXFile;
|
|
|
|
describe('kmx metadata compiler', function () {
|
|
this.slow(500); // 0.5 sec -- json schema validation takes a while
|
|
|
|
it('should compile metadata with debug and compiler version', async function() {
|
|
const inputFilename = makePathToCommonFixture('keyboards', 'kmx-plus', 'basic.xml');
|
|
|
|
// Compile the keyboard
|
|
const kmx = await compileKeyboard(inputFilename, {...compilerTestOptions, saveDebug:true, shouldAddCompilerVersion:true});
|
|
checkMessages();
|
|
assert.isNotNull(kmx);
|
|
|
|
// Order of stores is not significant in kmx spec, but kmxplus compiler will
|
|
// always store according to dwSystemID binary order for non-zero
|
|
// dwSystemID, then by dpName binary order, and finally by dpString binary
|
|
// order
|
|
|
|
// TSS_NAME = 7
|
|
// TSS_COMPILEDVERSION = 20
|
|
// TSS_KEYBOARDVERSION = 36
|
|
// TSS_TARGETS = 38
|
|
|
|
assert.equal(kmx.keyboard.stores[0].dpName, '&NAME');
|
|
assert.equal(kmx.keyboard.stores[0].dpString, 'TestKbd');
|
|
assert.equal(kmx.keyboard.stores[0].dwSystemID, KMXFile.TSS_NAME);
|
|
|
|
assert.equal(kmx.keyboard.stores[1].dpName, '');
|
|
assert.equal(kmx.keyboard.stores[1].dpString, KEYMAN_VERSION.VERSION_WITH_TAG);
|
|
assert.equal(kmx.keyboard.stores[1].dwSystemID, KMXFile.TSS_COMPILEDVERSION);
|
|
|
|
assert.equal(kmx.keyboard.stores[2].dpName, '&KEYBOARDVERSION');
|
|
assert.equal(kmx.keyboard.stores[2].dpString, '1.0.0');
|
|
assert.equal(kmx.keyboard.stores[2].dwSystemID, KMXFile.TSS_KEYBOARDVERSION);
|
|
|
|
assert.equal(kmx.keyboard.stores[3].dpName, '&TARGETS');
|
|
assert.equal(kmx.keyboard.stores[3].dpString, 'desktop');
|
|
assert.equal(kmx.keyboard.stores[3].dwSystemID, KMXFile.TSS_TARGETS);
|
|
});
|
|
|
|
it('should compile metadata with no compiler version', async function() {
|
|
const inputFilename = makePathToCommonFixture('keyboards', 'kmx-plus', 'basic.xml');
|
|
|
|
// Compile the keyboard
|
|
const kmx = await compileKeyboard(inputFilename, {...compilerTestOptions, saveDebug:true, shouldAddCompilerVersion:false});
|
|
checkMessages();
|
|
assert.isNotNull(kmx);
|
|
|
|
// TSS_NAME = 7
|
|
// -- TSS_COMPILEDVERSION = 20 -- not included with addCompilerVersion = false
|
|
// TSS_KEYBOARDVERSION = 36
|
|
// TSS_TARGETS = 38
|
|
|
|
assert.equal(kmx.keyboard.stores[0].dpName, '&NAME');
|
|
assert.equal(kmx.keyboard.stores[0].dpString, 'TestKbd');
|
|
assert.equal(kmx.keyboard.stores[0].dwSystemID, KMXFile.TSS_NAME);
|
|
|
|
assert.equal(kmx.keyboard.stores[1].dpName, '&KEYBOARDVERSION');
|
|
assert.equal(kmx.keyboard.stores[1].dpString, '1.0.0');
|
|
assert.equal(kmx.keyboard.stores[1].dwSystemID, KMXFile.TSS_KEYBOARDVERSION);
|
|
|
|
assert.equal(kmx.keyboard.stores[2].dpName, '&TARGETS');
|
|
assert.equal(kmx.keyboard.stores[2].dpString, 'desktop');
|
|
assert.equal(kmx.keyboard.stores[2].dwSystemID, KMXFile.TSS_TARGETS);
|
|
});
|
|
|
|
});
|
|
|