erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-10-07 22:47:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Merge pull request #10756 from keymanapp/chore/developer/kmc-unit-test-infrastructure-messages

Browse source 
chore(developer): add infrastructure messages tests
This commit is contained in:
Marc Durdin 2024-02-19 06:00:50 +07:00 • committed by GitHub
commit 1b22019941
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 200 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
developer/src/kmc/src/commands/analyze.ts
View file

@ -121,3 +121,10 @@ async function analyzeOskRewritePua(callbacks: CompilerCallbacks, filenames: str
return true;
});
}
/**
* these are exported only for unit tests, do not use
*/
export const analyzeUnitTestEndpoints = {
analyzeOskCharUse
};

1
developer/src/kmc/test/fixtures/analyze/error_unknown_file_format.xxx vendored Normal file
View file

@ -0,0 +1 @@
This is a file used to test the unknown file format error (see test-infrastructureMessages.ts)

1
developer/src/kmc/test/fixtures/invalid-keyboards/error_file_type_not_recognized.xxx vendored Normal file
View file

@ -0,0 +1 @@
This is a file used to test the unrecognised file type error (see test-infrastructureMessages.ts)

1
developer/src/kmc/test/fixtures/invalid-projects/build vendored Normal file
View file

@ -0,0 +1 @@
This is a file used to test the cannot create folder error (see test-infrastructureMessages.ts)

24
developer/src/kmc/test/fixtures/invalid-projects/error_file_type_not_found__keyboard.kpj vendored Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<KeymanDeveloperProject>
<Options>
<BuildPath>$PROJECTPATH</BuildPath>
<CompilerWarningsAsErrors>False</CompilerWarningsAsErrors>
<WarnDeprecatedCode>False</WarnDeprecatedCode>
<CheckFilenameConventions>False</CheckFilenameConventions>
<ProjectType>keyboard</ProjectType>
</Options>
<Files>
<File>
<ID>error_file_type_not_found_kbd_1</ID>
<Filename>error_file_type_not_found__keyboard.kmn</Filename>
<Filepath>error_file_type_not_found__keyboard.kmn</Filepath>
<FileVersion>1.0</FileVersion>
<FileType>.kmn</FileType>
<Details>
<Name>error_file_type_not_found__keyboard</Name>
<Copyright>Copyright (C) Keyman Team</Copyright>
</Details>
</File>
<!-- ERROR_FileTypeNotFound (BuildKeyboardInfo) -->
</Files>
</KeymanDeveloperProject>

24
developer/src/kmc/test/fixtures/invalid-projects/error_file_type_not_found__model_kps.kpj vendored Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<KeymanDeveloperProject>
<Options>
<BuildPath>$PROJECTPATH</BuildPath>
<CompilerWarningsAsErrors>False</CompilerWarningsAsErrors>
<WarnDeprecatedCode>False</WarnDeprecatedCode>
<CheckFilenameConventions>False</CheckFilenameConventions>
<ProjectType>lexicalmodel</ProjectType>
</Options>
<Files>
<File>
<ID>error_file_type_not_found_mdl_kps_1</ID>
<Filename>error_file_type_not_found__model_kps.model.ts</Filename>
<Filepath>error_file_type_not_found__model_kps.model.ts</Filepath>
<FileVersion></FileVersion>
<FileType>.model.ts</FileType>
<Details>
<Name>error_file_type_not_found__model_kps</Name>
<Copyright>Copyright (C) Keyman Team</Copyright>
</Details>
</File>
<!-- ERROR_FileTypeNotFound (BuildModelInfo; .kps) -->
</Files>
</KeymanDeveloperProject>

24
developer/src/kmc/test/fixtures/invalid-projects/error_file_type_not_found__model_ts.kpj vendored Normal file
View file

@ -0,0 +1,24 @@
<?xml version="1.0" encoding="utf-8"?>
<KeymanDeveloperProject>
<Options>
<BuildPath>$PROJECTPATH</BuildPath>
<CompilerWarningsAsErrors>False</CompilerWarningsAsErrors>
<WarnDeprecatedCode>False</WarnDeprecatedCode>
<CheckFilenameConventions>False</CheckFilenameConventions>
<ProjectType>lexicalmodel</ProjectType>
</Options>
<Files>
<!-- ERROR_FileTypeNotFound (BuildModelInfo; .model.ts) -->
<File>
<ID>error_file_type_not_found_mdl_mdl_2</ID>
<Filename>error_file_type_not_found__model_ts.kps</Filename>
<Filepath>error_file_type_not_found__model_ts.kps</Filepath>
<FileVersion></FileVersion>
<FileType>.kps</FileType>
<Details>
<Name>error_file_type_not_found__model_ts</Name>
<Copyright>Copyright (C) Keyman Team</Copyright>
</Details>
</File>
</Files>
</KeymanDeveloperProject>

1
developer/src/kmc/test/fixtures/invalid-projects/error_invalid_project_file.kpj vendored Normal file
View file

@ -0,0 +1 @@
This is a file used to test the invalid project file error (see test-infrastructureMessages.ts)

1
developer/src/kmc/test/fixtures/invalid-projects/error_not_a_project_file.xxx vendored Normal file
View file

@ -0,0 +1 @@
This is a file used to test the not a project file error (see test-infrastructureMessages.ts)

0
developer/src/kmc/test/fixtures/no-source-folder/.gitkeep vendored Normal file
View file

124
developer/src/kmc/test/test-infrastructureMessages.ts
View file

@ -4,11 +4,15 @@ import { InfrastructureMessages } from '../src/messages/infrastructureMessages.j
import { verifyCompilerMessagesObject } from '@keymanapp/developer-test-helpers';
import { makePathToFixture } from './helpers/index.js';
import { NodeCompilerCallbacks } from '../src/util/NodeCompilerCallbacks.js';
import { CompilerErrorNamespace, CompilerEvent } from '@keymanapp/common-types';
import { CompilerErrorNamespace, CompilerEvent, KeymanFileTypes } from '@keymanapp/common-types';
import { unitTestEndpoints } from '../src/commands/build.js';
import { KmnCompilerMessages } from '@keymanapp/kmc-kmn';
import { clearOptions } from '@keymanapp/developer-utils';
import { loadProject } from '../src/util/projectLoader.js';
import { defaultCompilerOptions, CompilerOptions} from '@keymanapp/common-types';
import { analyzeUnitTestEndpoints } from '../src/commands/analyze.js';
import { BuildKeyboardInfo } from '../src/commands/buildClasses/BuildKeyboardInfo.js';
import { BuildModelInfo } from '../src/commands/buildClasses/BuildModelInfo.js';
describe('InfrastructureMessages', function () {
@ -36,34 +40,47 @@ describe('InfrastructureMessages', function () {
assert.instanceOf<Error>(ncb.messages[0].exceptionVar, Error);
});
/*
// ERROR_FileDoesNotExist
it('should generate ERROR_FileDoesNotExist if a file does not exist', async function() {
await testForMessage(this, ['invalid-keyboards', 'error_file_does_not_exist.kmn'], CompilerMessages.ERROR_FileDoesNotExist);
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await unitTestEndpoints.build(makePathToFixture('invalid-keyboards', 'Error_File_Does_Not_Exist.kmn'), '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_FileDoesNotExist),
'ERROR_FileDoesNotExist not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_FileTypeNotRecognized
it('should generate ERROR_FileTypeNotRecognized if a file is not a recognized type', async function() {
await testForMessage(this, ['invalid-keyboards', 'error_file_type_not_recognized.xxx'], CompilerMessages.ERROR_FileTypeNotRecognized);
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await unitTestEndpoints.build(makePathToFixture('invalid-keyboards', 'error_file_type_not_recognized.xxx'), '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_FileTypeNotRecognized),
'ERROR_FileTypeNotRecognized not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_OutFileNotValidForProjects
it('should generate ERROR_OutFileNotValidForProjects if an output file is specified for a project build', async function() {
await testForMessage(this, ['invalid-keyboards', 'error_out_file_not_valid_for_projects.kpj'], CompilerMessages.ERROR_OutFileNotValidForProjects);
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
const projectPath = makePathToFixture('kpj-2.0/khmer_angkor', 'khmer_angkor.kpj');
const outFilePath = makePathToFixture('kpj-2.0/khmer_angkor', 'khmer_angkor.kmx');
const options: CompilerOptions = {...defaultCompilerOptions};
await unitTestEndpoints.build(projectPath, outFilePath, ncb, options);
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_OutFileNotValidForProjects),
'ERROR_OutFileNotValidForProjects not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_InvalidProjectFile
it('should generate ERROR_InvalidProjectFile if a project file is invalid', async function() {
await testForMessage(this, ['invalid-keyboards', 'error_invalid_project_file.kpj'], CompilerMessages.ERROR_InvalidProjectFile);
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await unitTestEndpoints.build(makePathToFixture('invalid-projects', 'error_invalid_project_file.kpj'), '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_InvalidProjectFile),
'ERROR_InvalidProjectFile not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
*/
// ERROR_InvalidProjectFolder (invalid source folder)
it('should generate ERROR_InvalidProjectFolder if there are no valid file types in the source folder when generating a default project file', async function() {
const projectPath = makePathToFixture('invalid-source-folder', 'error_invalid_project_folder.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
@ -72,6 +89,93 @@ describe('InfrastructureMessages', function () {
`ERROR_FileTypeNotFound not generated, instead got: `+JSON.stringify(ncb.messages,null,2));
});
// ERROR_NotAProjectFile
it('should generate ERROR_NotAProjectFile if a project file is not the correct type', async function() {
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
const projectPath = makePathToFixture('invalid-projects', 'error_not_a_project_file.xxx')
loadProject(projectPath, ncb);
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_NotAProjectFile),
'ERROR_NotAProjectFile not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_UnknownFileFormat
it('should generate ERROR_UnknownFileFormat if an analyze osk-char-use mapping file is not the correct type', async function() {
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
const options = {mappingFile: makePathToFixture('analyze', 'error_unknown_file_format.xxx')};
await analyzeUnitTestEndpoints.analyzeOskCharUse(ncb, [], options);
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_UnknownFileFormat),
'ERROR_UnknownFileFormat not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_FileTypeNotFound (BuildKeyboardInfo)
it('should generate ERROR_FileTypeNotFound if a project file does not contain a .kps file entry (BuildKeyboardInfo)', async function() {
const buildKeyboardInfo = new BuildKeyboardInfo();
const projectPath = makePathToFixture('invalid-projects', 'error_file_type_not_found__keyboard.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await buildKeyboardInfo.build(projectPath, '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_FileTypeNotFound),
'ERROR_FileTypeNotFound not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_FileTypeNotFound (BuildModelInfo; .model.ts)
it('should generate ERROR_FileTypeNotFound if a project file does not contain a .model.ts file entry (BuildModelInfo)', async function() {
const buildModelInfo = new BuildModelInfo();
const projectPath = makePathToFixture('invalid-projects', 'error_file_type_not_found__model_ts.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await buildModelInfo.build(projectPath, '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_FileTypeNotFound),
'ERROR_FileTypeNotFound not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
assert.isTrue(nodeCompilerMessage(ncb, InfrastructureMessages.ERROR_FileTypeNotFound).includes(KeymanFileTypes.Source.Model),
KeymanFileTypes.Source.Model+' not found in the message');
});
// ERROR_FileTypeNotFound (BuildModelInfo; .kps)
it('should generate ERROR_FileTypeNotFound if a project file does not contain a .kps file entry (BuildModelInfo)', async function() {
const buildModelInfo = new BuildModelInfo();
const projectPath = makePathToFixture('invalid-projects', 'error_file_type_not_found__model_kps.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
await buildModelInfo.build(projectPath, '', ncb, {});
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_FileTypeNotFound),
'ERROR_FileTypeNotFound not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
assert.isTrue(nodeCompilerMessage(ncb, InfrastructureMessages.ERROR_FileTypeNotFound).includes(KeymanFileTypes.Source.Package),
KeymanFileTypes.Source.Package+' not found in the message');
});
// ERROR_InvalidProjectFolder (no source folder)
it('should generate ERROR_InvalidProjectFolder if there is no source folder when generating a default project file', async function() {
const projectPath = makePathToFixture('no-source-folder', 'error_invalid_project_folder.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
loadProject(projectPath, ncb);
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_InvalidProjectFolder),
'ERROR_InvalidProjectFolder not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_InvalidProjectFolder (invalid source folder)
it('should generate ERROR_InvalidProjectFolder if there are no valid file types in the source folder when generating a default project file', async function() {
const projectPath = makePathToFixture('invalid-source-folder', 'error_invalid_project_folder.kpj')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
loadProject(projectPath, ncb);
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_InvalidProjectFolder),
'ERROR_InvalidProjectFolder not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// ERROR_CannotCreateFolder
it('should generate ERROR_CannotCreateFolder if the output folder cannot be created', async function() {
const buildKeyboardInfo = new BuildKeyboardInfo();
const targetFilename = makePathToFixture('invalid-projects', 'build', 'error_cannot_create_folder.xxx')
const ncb = new NodeCompilerCallbacks({logLevel: 'silent'});
buildKeyboardInfo['createOutputFolder'](targetFilename, ncb); // call private method
assert.isTrue(ncb.hasMessage(InfrastructureMessages.ERROR_CannotCreateFolder),
'ERROR_CannotCreateFolder not generated, instead got: '+JSON.stringify(ncb.messages,null,2));
});
// HINT_FilenameHasDifferingCase
it('should generate HINT_FilenameHasDifferingCase if a referenced file has differing case', async function() {
@ -117,4 +221,8 @@ function assertMessagesEqual(actualMessages: CompilerEvent[], expectedMessages:
assert.deepEqual(actualMessages.map(m => m.code), expectedMessages,
`actual callbacks.messages:\n${JSON.stringify(actualMessages,null,2)}\n\n`+
`did not match expected:\n${JSON.stringify(expectedMessages,null,2)}\n\n`);
}
function nodeCompilerMessage(ncb: NodeCompilerCallbacks, code: number): string {
return ncb.messages.find((item) => item.code == code).message ?? '';
}