Skip to content

Commit

Permalink
fix: make sure the error code is correctly set (#619)
Browse files Browse the repository at this point in the history 
The error code should be set if:
`check` fails to find files or has errors
`trace` fails to find a word in any dictionary
  • Loading branch information
@Jason3S
Jason3S committed Nov 19, 2020
1 parent 11662d7 commit 09e358c
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 68 deletions.
112 changes: 51 additions & 61 deletions packages/cspell/src/app.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,72 +22,62 @@ function pathSamples(...parts: string[]): string {

// [message, args, resolve, error, log, info]
type ErrorCheck = undefined | jest.Constructable | string | RegExp;
type Test = [string, string[], ErrorCheck, boolean, boolean, boolean];

const tests: Test[] = [
t('test app no-args', [], 'outputHelp', true, true, false),
t('test app current_file', [__filename], undefined, true, false, false),
t('test app current_file languageId', [__filename, '--languageId=typescript'], undefined, true, false, false),
t('test app trace hello', ['trace', 'hello'], undefined, false, true, false),
t('test app check LICENSE', ['check', pathRoot('LICENSE')], undefined, false, true, false),
t('test app check missing', ['check', pathRoot('missing-file.txt')], undefined, true, true, false),
t('test app LICENSE', [pathRoot('LICENSE')], undefined, true, false, false),
t('test app samples/Dutch.txt', [pathSamples('Dutch.txt')], app.CheckFailed, true, true, false),
t('test app current_file --verbose', ['--verbose', __filename], undefined, true, false, true),
t('test app bad config', ['-c', __filename, __filename], app.CheckFailed, true, false, false),
t('test app must find', ['*.not', '--must-find-files'], app.CheckFailed, true, false, false),
t('test app cspell-bad.json', ['-c', pathSamples('cspell-bad.json'), __filename], undefined, true, false, false),
t(
'test app cspell-import-missing.json',
['-c', pathSamples('linked/cspell-import-missing.json'), __filename],
app.CheckFailed,
true,
false,
false
),
];
interface TestCase {
msg: string;
testArgs: string[];
errorCheck: ErrorCheck;
eError: boolean;
eLog: boolean;
eInfo: boolean;
}

describe('Validate cli', () => {
let current = '';

test.each(tests)(
'%s',
async (msg, testArgs: string[], errorCheck: ErrorCheck, eError: boolean, eLog: boolean, eInfo: boolean) => {
expect(current).toBe('');
current = msg;
const commander = getCommander();
const error = jest.spyOn(console, 'error').mockImplementation();
const log = jest.spyOn(console, 'log').mockImplementation();
const info = jest.spyOn(console, 'info').mockImplementation();
const args = argv(...testArgs);
try {
const result = app.run(commander, args);
if (!errorCheck) {
await expect(result).resolves.toBeUndefined();
} else {
await expect(result).rejects.toThrowError(errorCheck);
}
eError ? expect(error).toHaveBeenCalled() : expect(error).not.toHaveBeenCalled();
eLog ? expect(log).toHaveBeenCalled() : expect(log).not.toHaveBeenCalled();
eInfo ? expect(info).toHaveBeenCalled() : expect(info).not.toHaveBeenCalled();
expect(current).toBe(msg);
} finally {
info.mockRestore();
log.mockRestore();
error.mockRestore();
current = '';
test.each`
msg | testArgs | errorCheck | eError | eLog | eInfo
${'no-args'} | ${[]} | ${'outputHelp'} | ${true} | ${true} | ${false}
${'current_file'} | ${[__filename]} | ${undefined} | ${true} | ${false} | ${false}
${'with spelling errors'} | ${[pathSamples('Dutch.txt')]} | ${app.CheckFailed} | ${true} | ${true} | ${false}
${'current_file languageId'} | ${[__filename, '--languageId=typescript']} | ${undefined} | ${true} | ${false} | ${false}
${'trace hello'} | ${['trace', 'hello']} | ${undefined} | ${false} | ${true} | ${false}
${'trace not-in-any-dictionary'} | ${['trace', 'not-in-any-dictionary']} | ${app.CheckFailed} | ${true} | ${true} | ${false}
${'check LICENSE'} | ${['check', pathRoot('LICENSE')]} | ${undefined} | ${false} | ${true} | ${false}
${'check missing'} | ${['check', pathRoot('missing-file.txt')]} | ${app.CheckFailed} | ${true} | ${true} | ${false}
${'LICENSE'} | ${[pathRoot('LICENSE')]} | ${undefined} | ${true} | ${false} | ${false}
${'samples/Dutch.txt'} | ${[pathSamples('Dutch.txt')]} | ${app.CheckFailed} | ${true} | ${true} | ${false}
${'current_file --verbose'} | ${['--verbose', __filename]} | ${undefined} | ${true} | ${false} | ${true}
${'bad config'} | ${['-c', __filename, __filename]} | ${app.CheckFailed} | ${true} | ${false} | ${false}
${'not found error by default'} | ${['*.not']} | ${app.CheckFailed} | ${true} | ${false} | ${false}
${'must find with error'} | ${['*.not', '--must-find-files']} | ${app.CheckFailed} | ${true} | ${false} | ${false}
${'must find force no error'} | ${['*.not', '--no-must-find-files']} | ${undefined} | ${true} | ${false} | ${false}
${'cspell-bad.json'} | ${['-c', pathSamples('cspell-bad.json'), __filename]} | ${undefined} | ${true} | ${false} | ${false}
${'cspell-import-missing.json'} | ${['-c', pathSamples('linked/cspell-import-missing.json'), __filename]} | ${app.CheckFailed} | ${true} | ${false} | ${false}
`('app $msg $testArgs', async ({ msg, testArgs, errorCheck, eError, eLog, eInfo }: TestCase) => {
expect(current).toBe('');
current = msg;
const commander = getCommander();
const error = jest.spyOn(console, 'error').mockName('console.error').mockImplementation();
const log = jest.spyOn(console, 'log').mockName('console.log').mockImplementation();
const info = jest.spyOn(console, 'info').mockName('console.info').mockImplementation();
const args = argv(...testArgs);
try {
const result = app.run(commander, args);
if (!errorCheck) {
await expect(result).resolves.toBeUndefined();
} else {
await expect(result).rejects.toThrowError(errorCheck);
}
eError ? expect(error).toHaveBeenCalled() : expect(error).not.toHaveBeenCalled();
eLog ? expect(log).toHaveBeenCalled() : expect(log).not.toHaveBeenCalled();
eInfo ? expect(info).toHaveBeenCalled() : expect(info).not.toHaveBeenCalled();
expect(current).toBe(msg);
} finally {
info.mockRestore();
log.mockRestore();
error.mockRestore();
current = '';
}
);
});
});

function t(
msg: string,
args: string[],
errorCheck: ErrorCheck,
emitError: boolean,
emitLog: boolean,
emitInfo: boolean
): Test {
return [msg, args, errorCheck, emitError, emitLog, emitInfo];
}
28 changes: 21 additions & 7 deletions packages/cspell/src/app.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,12 +162,15 @@ export async function run(program?: commander.Command, argv?: string[]): Promise
.option('--no-color', 'Turn off color.')
.option('--color', 'Force color')
.arguments('<words...>')
.action((words: string[], options: TraceCommandOptions) => {
.action(async (words: string[], options: TraceCommandOptions) => {
showHelp = false;
return App.trace(words, options).then((result) => {
result.forEach(emitTraceResult);
return;
});
const results = await App.trace(words, options);
results.forEach(emitTraceResult);
const numFound = results.reduce((n, r) => n + (r.found ? 1 : 0), 0);
if (!numFound) {
console.error('No matches found');
throw new CheckFailed('no matches', 1);
}
});

type CheckCommandOptions = BaseOptions;
Expand All @@ -182,11 +185,13 @@ export async function run(program?: commander.Command, argv?: string[]): Promise
.option('--color', 'Force color')
.action(async (files: string[], options: CheckCommandOptions) => {
showHelp = false;

let issueCount = 0;
let fileCount = 0;
for (const filename of files) {
console.log(chalk.yellowBright(`Check file: ${filename}`));
console.log();
try {
fileCount++;
const result = await checkText(filename, options);
for (const item of result.items) {
const fn =
Expand All @@ -197,13 +202,22 @@ export async function run(program?: commander.Command, argv?: string[]): Promise
: chalk.whiteBright;
const t = fn(item.text);
process.stdout.write(t);
issueCount += item.isError ? 1 : 0;
}
console.log();
} catch (e) {
console.error(`Failed to read "${filename}"`);
console.error(`File not found "${filename}"`);
throw new CheckFailed('File not found', 1);
}
console.log();
}
if (issueCount) {
throw new CheckFailed('Issues found', 1);
}
if (!fileCount) {
console.error('No files found');
throw new CheckFailed('No files found', 1);
}
});

/*
Expand Down

0 comments on commit 09e358c

Please sign in to comment.