mirror of
https://github.com/github/codeql-action.git
synced 2026-05-08 14:50:21 +00:00
Nick Fyson
40 lines
1.6 KiB
TypeScript
40 lines
1.6 KiB
TypeScript
// defines properties to match against the result of executed commands,
|
|
// and a custom error to return when a match is found
|
|
export interface ErrorMatcher {
|
|
exitCode?: number; // exit code of the run process
|
|
outputRegex?: RegExp; // pattern to match against either stdout or stderr
|
|
message: string; // the error message that will be thrown for a matching process
|
|
}
|
|
|
|
// exported only for testing purposes
|
|
export const namedMatchersForTesting: { [key: string]: ErrorMatcher } = {
|
|
/*
|
|
In due course it may be possible to remove the regex, if/when javascript also exits with code 32.
|
|
*/
|
|
noSourceCodeFound: {
|
|
exitCode: 32,
|
|
outputRegex: new RegExp("No JavaScript or TypeScript code found\\."),
|
|
message:
|
|
"No code found during the build. Please see:\n" +
|
|
"https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning#no-code-found-during-the-build",
|
|
},
|
|
|
|
queryTimeout: {
|
|
exitCode: 33,
|
|
message:
|
|
"One or more query evaluations timed out. Please see:\n" +
|
|
"Not sure if there's a good place to currently send people?", // TODO find where we should send people for this error.
|
|
},
|
|
|
|
outOfMemory: {
|
|
exitCode: 99,
|
|
outputRegex: new RegExp("Operation ran out of memory\\."),
|
|
message:
|
|
"The CodeQL CLI ran out of memory. Please see:\n" +
|
|
"https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning#error-out-of-disk-or-out-of-memory",
|
|
},
|
|
};
|
|
|
|
// we collapse the matches into an array for use in execErrorCatcher
|
|
export const errorMatchers = Object.values(namedMatchersForTesting);
|