github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2025-12-28 18:20:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move error messages from config-utils to their own file

Browse Source
This commit is contained in:
Michael B. Gale
2025-09-19 16:44:07 +01:00
parent 3305d21389
commit 6222edff53
4 changed files with 143 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/config-utils.test.ts
View File

@@ -12,6 +12,7 @@ import * as api from "./api-client";
import { CachingKind } from "./caching-utils";
import { createStubCodeQL } from "./codeql";
import * as configUtils from "./config-utils";
import * as errorMessages from "./error-messages";
import { Feature } from "./feature-flags";
import * as gitUtils from "./git-utils";
import { KnownLanguage, Language } from "./languages";
@@ -341,7 +342,7 @@ test("load input outside of workspace", async (t) => {
t.deepEqual(
err,
new ConfigurationError(
configUtils.getConfigFileOutsideWorkspaceErrorMessage(
errorMessages.getConfigFileOutsideWorkspaceErrorMessage(
path.join(tempDir, "../input"),
),
),
@@ -368,7 +369,7 @@ test("load non-local input with invalid repo syntax", async (t) => {
t.deepEqual(
err,
new ConfigurationError(
configUtils.getConfigFileRepoFormatInvalidMessage(
errorMessages.getConfigFileRepoFormatInvalidMessage(
"octo-org/codeql-config@main",
),
),
@@ -397,7 +398,7 @@ test("load non-existent input", async (t) => {
t.deepEqual(
err,
new ConfigurationError(
configUtils.getConfigFileDoesNotExistErrorMessage(
errorMessages.getConfigFileDoesNotExistErrorMessage(
path.join(tempDir, "input"),
),
),
@@ -604,7 +605,7 @@ test("Remote config handles the case where a directory is provided", async (t) =
t.deepEqual(
err,
new ConfigurationError(
configUtils.getConfigFileDirectoryGivenMessage(repoReference),
errorMessages.getConfigFileDirectoryGivenMessage(repoReference),
),
);
}
@@ -632,7 +633,7 @@ test("Invalid format of remote config handled correctly", async (t) => {
t.deepEqual(
err,
new ConfigurationError(
configUtils.getConfigFileFormatInvalidMessage(repoReference),
errorMessages.getConfigFileFormatInvalidMessage(repoReference),
),
);
}
@@ -660,7 +661,7 @@ test("No detected languages", async (t) => {
} catch (err) {
t.deepEqual(
err,
new ConfigurationError(configUtils.getNoLanguagesError()),
new ConfigurationError(errorMessages.getNoLanguagesError()),
);
}
});
@@ -683,7 +684,7 @@ test("Unknown languages", async (t) => {
t.deepEqual(
err,
new ConfigurationError(
configUtils.getUnknownLanguagesError(["rubbish", "english"]),
errorMessages.getUnknownLanguagesError(["rubbish", "english"]),
),
);
}
@@ -1097,28 +1098,28 @@ const mockRepositoryNwo = parseRepositoryNwo("owner/repo");
languagesInput: "",
languagesInRepository: ["html"],
expectedApiCall: true,
expectedError: configUtils.getNoLanguagesError(),
expectedError: errorMessages.getNoLanguagesError(),
},
{
name: "no languages",
languagesInput: "",
languagesInRepository: [],
expectedApiCall: true,
expectedError: configUtils.getNoLanguagesError(),
expectedError: errorMessages.getNoLanguagesError(),
},
{
name: "unrecognized languages from input",
languagesInput: "a, b, c, javascript",
languagesInRepository: [],
expectedApiCall: false,
expectedError: configUtils.getUnknownLanguagesError(["a", "b"]),
expectedError: errorMessages.getUnknownLanguagesError(["a", "b"]),
},
{
name: "extractors that aren't languages aren't included (specified)",
languagesInput: "html",
languagesInRepository: [],
expectedApiCall: false,
expectedError: configUtils.getUnknownLanguagesError(["html"]),
expectedError: errorMessages.getUnknownLanguagesError(["html"]),
},
{
name: "extractors that aren't languages aren't included (autodetected)",

102
src/config-utils.ts
View File

@@ -19,6 +19,7 @@ import { CachingKind, getCachingKind } from "./caching-utils";
import { type CodeQL } from "./codeql";
import { ExcludeQueryFilter, UserConfig } from "./config/db-config";
import { shouldPerformDiffInformedAnalysis } from "./diff-informed-analysis-utils";
import * as errorMessages from "./error-messages";
import { Feature, FeatureEnablement } from "./feature-flags";
import { getGitRoot, isAnalyzingDefaultBranch } from "./git-utils";
import { KnownLanguage, Language } from "./languages";
@@ -41,10 +42,6 @@ import {
export * from "./config/db-config";
// Property names from the user-supplied config file.
const PACKS_PROPERTY = "packs";
export type RegistryConfigWithCredentials = RegistryConfigNoCredentials & {
// Token to use when downloading packs from this registry.
token: string;
@@ -219,71 +216,6 @@ export interface Pack {
path?: string;
}
export function getPacksStrInvalid(
packStr: string,
configFile?: string,
): string {
return configFile
? getConfigFilePropertyError(
configFile,
PACKS_PROPERTY,
`"${packStr}" is not a valid pack`,
)
: `"${packStr}" is not a valid pack`;
}
export function getConfigFileOutsideWorkspaceErrorMessage(
configFile: string,
): string {
return `The configuration file "${configFile}" is outside of the workspace`;
}
export function getConfigFileDoesNotExistErrorMessage(
configFile: string,
): string {
return `The configuration file "${configFile}" does not exist`;
}
export function getConfigFileRepoFormatInvalidMessage(
configFile: string,
): string {
let error = `The configuration file "${configFile}" is not a supported remote file reference.`;
error += " Expected format <owner>/<repository>/<file-path>@<ref>";
return error;
}
export function getConfigFileFormatInvalidMessage(configFile: string): string {
return `The configuration file "${configFile}" could not be read`;
}
export function getConfigFileDirectoryGivenMessage(configFile: string): string {
return `The configuration file "${configFile}" looks like a directory, not a file`;
}
function getConfigFilePropertyError(
configFile: string | undefined,
property: string,
error: string,
): string {
if (configFile === undefined) {
return `The workflow property "${property}" is invalid: ${error}`;
} else {
return `The configuration file "${configFile}" is invalid: property "${property}" ${error}`;
}
}
export function getNoLanguagesError(): string {
return (
"Did not detect any languages to analyze. " +
"Please update input in workflow or check that GitHub detects the correct languages in your repository."
);
}
export function getUnknownLanguagesError(languages: string[]): string {
return `Did not recognize the following languages: ${languages.join(", ")}`;
}
export async function getSupportedLanguageMap(
codeql: CodeQL,
features: FeatureEnablement,
@@ -420,13 +352,15 @@ export async function getLanguages(
const languages = Array.from(languagesSet);
if (!autodetected && unknownLanguages.length > 0) {
throw new ConfigurationError(getUnknownLanguagesError(unknownLanguages));
throw new ConfigurationError(
errorMessages.getUnknownLanguagesError(unknownLanguages),
);
}
// If the languages parameter was not given and no languages were
// detected then fail here as this is a workflow configuration error.
if (languages.length === 0) {
throw new ConfigurationError(getNoLanguagesError());
throw new ConfigurationError(errorMessages.getNoLanguagesError());
}
if (autodetected) {
@@ -636,7 +570,7 @@ async function loadUserConfig(
// Error if the config file is now outside of the workspace
if (!(configFile + path.sep).startsWith(workspacePath + path.sep)) {
throw new ConfigurationError(
getConfigFileOutsideWorkspaceErrorMessage(configFile),
errorMessages.getConfigFileOutsideWorkspaceErrorMessage(configFile),
);
}
}
@@ -703,7 +637,7 @@ function parseQueriesFromInput(
: (rawQueriesInput?.trim() ?? "");
if (queriesInputCombines && trimmedInput.length === 0) {
throw new ConfigurationError(
getConfigFilePropertyError(
errorMessages.getConfigFilePropertyError(
undefined,
"queries",
"A '+' was used in the 'queries' input to specify that you wished to add some packs to your CodeQL analysis. However, no packs were specified. Please either remove the '+' or specify some packs.",
@@ -944,7 +878,7 @@ export function parsePacksFromInput(
rawPacksInput = rawPacksInput.trim().substring(1).trim();
if (!rawPacksInput) {
throw new ConfigurationError(
getConfigFilePropertyError(
errorMessages.getConfigFilePropertyError(
undefined,
"packs",
"A '+' was used in the 'packs' input to specify that you wished to add some packs to your CodeQL analysis. However, no packs were specified. Please either remove the '+' or specify some packs.",
@@ -981,7 +915,7 @@ export function parsePacksFromInput(
*/
export function parsePacksSpecification(packStr: string): Pack {
if (typeof packStr !== "string") {
throw new ConfigurationError(getPacksStrInvalid(packStr));
throw new ConfigurationError(errorMessages.getPacksStrInvalid(packStr));
}
packStr = packStr.trim();
@@ -1009,14 +943,14 @@ export function parsePacksSpecification(packStr: string): Pack {
: undefined;
if (!PACK_IDENTIFIER_PATTERN.test(packName)) {
throw new ConfigurationError(getPacksStrInvalid(packStr));
throw new ConfigurationError(errorMessages.getPacksStrInvalid(packStr));
}
if (version) {
try {
new semver.Range(version);
} catch {
// The range string is invalid. OK to ignore the caught error
throw new ConfigurationError(getPacksStrInvalid(packStr));
throw new ConfigurationError(errorMessages.getPacksStrInvalid(packStr));
}
}
@@ -1030,12 +964,12 @@ export function parsePacksSpecification(packStr: string): Pack {
path.normalize(packPath).split(path.sep).join("/") !==
packPath.split(path.sep).join("/"))
) {
throw new ConfigurationError(getPacksStrInvalid(packStr));
throw new ConfigurationError(errorMessages.getPacksStrInvalid(packStr));
}
if (!packPath && pathStart) {
// 0 length path
throw new ConfigurationError(getPacksStrInvalid(packStr));
throw new ConfigurationError(errorMessages.getPacksStrInvalid(packStr));
}
return {
@@ -1215,7 +1149,7 @@ function getLocalConfig(configFile: string): UserConfig {
// Error if the file does not exist
if (!fs.existsSync(configFile)) {
throw new ConfigurationError(
getConfigFileDoesNotExistErrorMessage(configFile),
errorMessages.getConfigFileDoesNotExistErrorMessage(configFile),
);
}
@@ -1234,7 +1168,7 @@ async function getRemoteConfig(
// 5 = 4 groups + the whole expression
if (pieces === null || pieces.groups === undefined || pieces.length < 5) {
throw new ConfigurationError(
getConfigFileRepoFormatInvalidMessage(configFile),
errorMessages.getConfigFileRepoFormatInvalidMessage(configFile),
);
}
@@ -1252,10 +1186,12 @@ async function getRemoteConfig(
fileContents = response.data.content;
} else if (Array.isArray(response.data)) {
throw new ConfigurationError(
getConfigFileDirectoryGivenMessage(configFile),
errorMessages.getConfigFileDirectoryGivenMessage(configFile),
);
} else {
throw new ConfigurationError(getConfigFileFormatInvalidMessage(configFile));
throw new ConfigurationError(
errorMessages.getConfigFileFormatInvalidMessage(configFile),
);
}
return yaml.load(

66
src/error-messages.ts Normal file
View File

@@ -0,0 +1,66 @@
const PACKS_PROPERTY = "packs";
export function getConfigFileOutsideWorkspaceErrorMessage(
configFile: string,
): string {
return `The configuration file "${configFile}" is outside of the workspace`;
}
export function getConfigFileDoesNotExistErrorMessage(
configFile: string,
): string {
return `The configuration file "${configFile}" does not exist`;
}
export function getConfigFileRepoFormatInvalidMessage(
configFile: string,
): string {
let error = `The configuration file "${configFile}" is not a supported remote file reference.`;
error += " Expected format <owner>/<repository>/<file-path>@<ref>";
return error;
}
export function getConfigFileFormatInvalidMessage(configFile: string): string {
return `The configuration file "${configFile}" could not be read`;
}
export function getConfigFileDirectoryGivenMessage(configFile: string): string {
return `The configuration file "${configFile}" looks like a directory, not a file`;
}
export function getConfigFilePropertyError(
configFile: string | undefined,
property: string,
error: string,
): string {
if (configFile === undefined) {
return `The workflow property "${property}" is invalid: ${error}`;
} else {
return `The configuration file "${configFile}" is invalid: property "${property}" ${error}`;
}
}
export function getPacksStrInvalid(
packStr: string,
configFile?: string,
): string {
return configFile
? getConfigFilePropertyError(
configFile,
PACKS_PROPERTY,
`"${packStr}" is not a valid pack`,
)
: `"${packStr}" is not a valid pack`;
}
export function getNoLanguagesError(): string {
return (
"Did not detect any languages to analyze. " +
"Please update input in workflow or check that GitHub detects the correct languages in your repository."
);
}
export function getUnknownLanguagesError(languages: string[]): string {
return `Did not recognize the following languages: ${languages.join(", ")}`;
}