robojerk/codeql-action

Refactor configuration errors (#2105)

Browse source 
Refactor the existing classes of configuration errors into their own file; consolidate the place we check for configuration errors into `codeql.ts`, where the actual command invocations happen.

Also, rename the `UserError` type to `ConfigurationError` to standardize on a single term.
This commit is contained in:
Angela P Wen 2024-02-08 09:20:03 -08:00 • committed by GitHub
parent fc9f9e5ef9
commit 1515e2bb20
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
54 changed files with 654 additions and 502 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/config-utils.test.ts
View file

@ -26,7 +26,7 @@ import {
GitHubVariant,
GitHubVersion,
prettyPrintPack,
UserError,
ConfigurationError,
withTmpDir,
} from "./util";
@ -219,7 +219,7 @@ test("load input outside of workspace", async (t) => {
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getConfigFileOutsideWorkspaceErrorMessage(
path.join(tempDir, "../input"),
),
@ -247,7 +247,7 @@ test("load non-local input with invalid repo syntax", async (t) => {
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getConfigFileRepoFormatInvalidMessage(
"octo-org/codeql-config@main",
),
@ -277,7 +277,7 @@ test("load non-existent input", async (t) => {
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getConfigFileDoesNotExistErrorMessage(
path.join(tempDir, "input"),
),
@ -517,7 +517,7 @@ test("Remote config handles the case where a directory is provided", async (t) =
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getConfigFileDirectoryGivenMessage(repoReference),
),
);
@ -546,7 +546,7 @@ test("Invalid format of remote config handled correctly", async (t) => {
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getConfigFileFormatInvalidMessage(repoReference),
),
);
@ -576,7 +576,10 @@ test("No detected languages", async (t) => {
);
throw new Error("initConfig did not throw error");
} catch (err) {
t.deepEqual(err, new UserError(configUtils.getNoLanguagesError()));
t.deepEqual(
err,
new ConfigurationError(configUtils.getNoLanguagesError()),
);
}
});
});
@ -598,7 +601,7 @@ test("Unknown languages", async (t) => {
} catch (err) {
t.deepEqual(
err,
new UserError(
new ConfigurationError(
configUtils.getUnknownLanguagesError(["rubbish", "english"]),
),
);