clean up and rename things to follow proper conventions

This commit is contained in:
Nick Fyson 2020-09-07 23:02:58 +01:00
parent 3e6d23928b
commit cc2dfaf5d8
18 changed files with 52 additions and 68 deletions

82
src/exec-wrapper.ts Normal file
View file

@ -0,0 +1,82 @@
import * as exec from '@actions/exec';
import * as im from '@actions/exec/lib/interfaces';
import {ErrorMatcher} from './error-matcher';
/**
* Wrapper for exec.exec which checks for specific return code and/or regex matches in console output.
* Output will be streamed to the live console as well as captured for subsequent processing.
* Returns promise with return code
*
* @param commandLine command to execute (can include additional args). Must be correctly escaped.
* @param matchers defines specific codes and/or regexes that should lead to return of a custom error
* @param args optional arguments for tool. Escaping is handled by the lib.
* @param options optional exec options. See ExecOptions
* @returns Promise<number> exit code
*/
export async function execErrorCatcher(commandLine: string, args?: string[],
matchers?: ErrorMatcher[],
options?: im.ExecOptions): Promise<number> {
let stdout = '';
let stderr = '';
let listeners = {
stdout: (data: Buffer) => {
stdout += data.toString();
if (options?.listeners?.stdout !== undefined) {
options.listeners.stdout(data);
} else {
// if no stdout listener was originally defined then we match default behavior of exec.exec
process.stdout.write(data);
}
},
stderr: (data: Buffer) => {
stderr += data.toString();
if (options?.listeners?.stderr !== undefined) {
options.listeners.stderr(data);
} else {
// if no stderr listener was originally defined then we match default behavior of exec.exec
process.stderr.write(data);
}
}
};
// we capture the original return code or error so that if no match is found we can duplicate the behavior
let returnState: Error|number;
try {
returnState = await exec.exec(
commandLine,
args,
{
...options, // pass original options first in order to override below
listeners: listeners,
ignoreReturnCode: true, // so we can check for specific codes using the matchers
});
} catch (e) {
returnState = e;
}
// if there is a zero return code then we do not apply the matchers
if (returnState === 0) return returnState;
if (matchers) {
for (const [customCode, regex, message] of matchers) {
if (customCode === returnState || regex && (regex.test(stderr) || regex.test(stdout)) ) {
throw new Error(message);
}
}
}
if (typeof returnState === 'number') {
// only if we were instructed to ignore the return code do we ever return it non-zero
if (options?.ignoreReturnCode) {
return returnState;
} else {
throw new Error(`The process \'${commandLine}\' failed with exit code ${returnState}`);
}
} else {
throw returnState;
}
}