mirror of
https://github.com/github/codeql-action.git
synced 2025-12-08 16:58:06 +08:00
613 lines
29 KiB
JavaScript
Generated
613 lines
29 KiB
JavaScript
Generated
"use strict";
|
|
var __importStar = (this && this.__importStar) || function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
|
|
result["default"] = mod;
|
|
return result;
|
|
};
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const github = __importStar(require("@actions/github"));
|
|
const ava_1 = __importDefault(require("ava"));
|
|
const fs = __importStar(require("fs"));
|
|
const path = __importStar(require("path"));
|
|
const sinon_1 = __importDefault(require("sinon"));
|
|
const api = __importStar(require("./api-client"));
|
|
const codeql_1 = require("./codeql");
|
|
const configUtils = __importStar(require("./config-utils"));
|
|
const languages_1 = require("./languages");
|
|
const logging_1 = require("./logging");
|
|
const testing_utils_1 = require("./testing-utils");
|
|
const util = __importStar(require("./util"));
|
|
testing_utils_1.setupTests(ava_1.default);
|
|
// Returns the filepath of the newly-created file
|
|
function createConfigFile(inputFileContents, tmpDir) {
|
|
const configFilePath = path.join(tmpDir, "input");
|
|
fs.writeFileSync(configFilePath, inputFileContents, "utf8");
|
|
return configFilePath;
|
|
}
|
|
function mockGetContents(content) {
|
|
// Passing an auth token is required, so we just use a dummy value
|
|
const client = new github.GitHub("123");
|
|
const response = {
|
|
data: content,
|
|
};
|
|
const spyGetContents = sinon_1.default
|
|
.stub(client.repos, "getContents")
|
|
.resolves(response);
|
|
sinon_1.default.stub(api, "getApiClient").value(() => client);
|
|
return spyGetContents;
|
|
}
|
|
function mockListLanguages(languages) {
|
|
// Passing an auth token is required, so we just use a dummy value
|
|
const client = new github.GitHub("123");
|
|
const response = {
|
|
data: {},
|
|
};
|
|
for (const language of languages) {
|
|
response.data[language] = 123;
|
|
}
|
|
sinon_1.default.stub(client.repos, "listLanguages").resolves(response);
|
|
sinon_1.default.stub(api, "getApiClient").value(() => client);
|
|
}
|
|
ava_1.default("load empty config", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const logger = logging_1.getRunnerLogger(true);
|
|
const languages = "javascript,python";
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries() {
|
|
return {
|
|
byLanguage: {},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
const config = await configUtils.initConfig(languages, undefined, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logger);
|
|
t.deepEqual(config, await configUtils.getDefaultConfig(languages, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logger));
|
|
});
|
|
});
|
|
ava_1.default("loading config saves config", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const logger = logging_1.getRunnerLogger(true);
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries() {
|
|
return {
|
|
byLanguage: {},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
// Sanity check the saved config file does not already exist
|
|
t.false(fs.existsSync(configUtils.getPathToParsedConfigFile(tmpDir)));
|
|
// Sanity check that getConfig returns undefined before we have called initConfig
|
|
t.deepEqual(await configUtils.getConfig(tmpDir, logger), undefined);
|
|
const config1 = await configUtils.initConfig("javascript,python", undefined, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logger);
|
|
// The saved config file should now exist
|
|
t.true(fs.existsSync(configUtils.getPathToParsedConfigFile(tmpDir)));
|
|
// And that same newly-initialised config should now be returned by getConfig
|
|
const config2 = await configUtils.getConfig(tmpDir, logger);
|
|
t.deepEqual(config1, config2);
|
|
});
|
|
});
|
|
ava_1.default("load input outside of workspace", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
try {
|
|
await configUtils.initConfig(undefined, undefined, "../input", { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getConfigFileOutsideWorkspaceErrorMessage(path.join(tmpDir, "../input"))));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("load non-local input with invalid repo syntax", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
// no filename given, just a repo
|
|
const configFile = "octo-org/codeql-config@main";
|
|
try {
|
|
await configUtils.initConfig(undefined, undefined, configFile, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getConfigFileRepoFormatInvalidMessage("octo-org/codeql-config@main")));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("load non-existent input", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const languages = "javascript";
|
|
const configFile = "input";
|
|
t.false(fs.existsSync(path.join(tmpDir, configFile)));
|
|
try {
|
|
await configUtils.initConfig(languages, undefined, configFile, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getConfigFileDoesNotExistErrorMessage(path.join(tmpDir, "input"))));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("load non-empty input", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries() {
|
|
return {
|
|
byLanguage: {
|
|
javascript: {
|
|
"/foo/a.ql": {},
|
|
"/bar/b.ql": {},
|
|
},
|
|
},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
// Just create a generic config object with non-default values for all fields
|
|
const inputFileContents = `
|
|
name: my config
|
|
disable-default-queries: true
|
|
queries:
|
|
- uses: ./foo
|
|
paths-ignore:
|
|
- a
|
|
- b
|
|
paths:
|
|
- c/d`;
|
|
fs.mkdirSync(path.join(tmpDir, "foo"));
|
|
// And the config we expect it to parse to
|
|
const expectedConfig = {
|
|
languages: [languages_1.Language.javascript],
|
|
queries: { javascript: ["/foo/a.ql", "/bar/b.ql"] },
|
|
pathsIgnore: ["a", "b"],
|
|
paths: ["c/d"],
|
|
originalUserInput: {
|
|
name: "my config",
|
|
"disable-default-queries": true,
|
|
queries: [{ uses: "./foo" }],
|
|
"paths-ignore": ["a", "b"],
|
|
paths: ["c/d"],
|
|
},
|
|
tempDir: tmpDir,
|
|
toolCacheDir: tmpDir,
|
|
codeQLCmd: codeQL.getPath(),
|
|
};
|
|
const languages = "javascript";
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
const actualConfig = await configUtils.initConfig(languages, undefined, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Should exactly equal the object we constructed earlier
|
|
t.deepEqual(actualConfig, expectedConfig);
|
|
});
|
|
});
|
|
ava_1.default("Default queries are used", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
// Check that the default behaviour is to add the default queries.
|
|
// In this case if a config file is specified but does not include
|
|
// the disable-default-queries field.
|
|
// We determine this by whether CodeQL.resolveQueries is called
|
|
// with the correct arguments.
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return {
|
|
byLanguage: {
|
|
javascript: {
|
|
"foo.ql": {},
|
|
},
|
|
},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
// The important point of this config is that it doesn't specify
|
|
// the disable-default-queries field.
|
|
// Any other details are hopefully irrelevant for this tetst.
|
|
const inputFileContents = `
|
|
paths:
|
|
- foo`;
|
|
fs.mkdirSync(path.join(tmpDir, "foo"));
|
|
const languages = "javascript";
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
await configUtils.initConfig(languages, undefined, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolve queries was called correctly
|
|
t.deepEqual(resolveQueriesArgs.length, 1);
|
|
t.deepEqual(resolveQueriesArgs[0].queries, [
|
|
"javascript-code-scanning.qls",
|
|
]);
|
|
t.deepEqual(resolveQueriesArgs[0].extraSearchPath, undefined);
|
|
});
|
|
});
|
|
/**
|
|
* Returns the provided queries, just in the right format for a resolved query
|
|
* This way we can test by seeing which returned items are in the final
|
|
* configuration.
|
|
*/
|
|
function queriesToResolvedQueryForm(queries) {
|
|
const dummyResolvedQueries = {};
|
|
queries.forEach((q) => {
|
|
dummyResolvedQueries[q] = {};
|
|
});
|
|
return {
|
|
byLanguage: {
|
|
javascript: dummyResolvedQueries,
|
|
},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
}
|
|
ava_1.default("Queries can be specified in config file", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const inputFileContents = `
|
|
name: my config
|
|
queries:
|
|
- uses: ./foo`;
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
fs.mkdirSync(path.join(tmpDir, "foo"));
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return queriesToResolvedQueryForm(queries);
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const config = await configUtils.initConfig(languages, undefined, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolveQueries was called correctly
|
|
// It'll be called once for the default queries
|
|
// and once for `./foo` from the config file.
|
|
t.deepEqual(resolveQueriesArgs.length, 2);
|
|
t.deepEqual(resolveQueriesArgs[1].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[1].queries[0], /.*\/foo$/);
|
|
// Now check that the end result contains the default queries and the query from config
|
|
t.deepEqual(config.queries["javascript"].length, 2);
|
|
t.regex(config.queries["javascript"][0], /javascript-code-scanning.qls$/);
|
|
t.regex(config.queries["javascript"][1], /.*\/foo$/);
|
|
});
|
|
});
|
|
ava_1.default("Queries from config file can be overridden in workflow file", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const inputFileContents = `
|
|
name: my config
|
|
queries:
|
|
- uses: ./foo`;
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
// This config item should take precedence over the config file but shouldn't affect the default queries.
|
|
const queries = "./override";
|
|
fs.mkdirSync(path.join(tmpDir, "foo"));
|
|
fs.mkdirSync(path.join(tmpDir, "override"));
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return queriesToResolvedQueryForm(queries);
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const config = await configUtils.initConfig(languages, queries, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolveQueries was called correctly
|
|
// It'll be called once for the default queries and once for `./override`,
|
|
// but won't be called for './foo' from the config file.
|
|
t.deepEqual(resolveQueriesArgs.length, 2);
|
|
t.deepEqual(resolveQueriesArgs[1].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[1].queries[0], /.*\/override$/);
|
|
// Now check that the end result contains only the default queries and the override query
|
|
t.deepEqual(config.queries["javascript"].length, 2);
|
|
t.regex(config.queries["javascript"][0], /javascript-code-scanning.qls$/);
|
|
t.regex(config.queries["javascript"][1], /.*\/override$/);
|
|
});
|
|
});
|
|
ava_1.default("Queries in workflow file can be used in tandem with the 'disable default queries' option", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
process.env["RUNNER_TEMP"] = tmpDir;
|
|
process.env["GITHUB_WORKSPACE"] = tmpDir;
|
|
const inputFileContents = `
|
|
name: my config
|
|
disable-default-queries: true`;
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
const queries = "./workflow-query";
|
|
fs.mkdirSync(path.join(tmpDir, "workflow-query"));
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return queriesToResolvedQueryForm(queries);
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const config = await configUtils.initConfig(languages, queries, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolveQueries was called correctly
|
|
// It'll be called once for `./workflow-query`,
|
|
// but won't be called for the default one since that was disabled
|
|
t.deepEqual(resolveQueriesArgs.length, 1);
|
|
t.deepEqual(resolveQueriesArgs[0].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[0].queries[0], /.*\/workflow-query$/);
|
|
// Now check that the end result contains only the workflow query, and not the default one
|
|
t.deepEqual(config.queries["javascript"].length, 1);
|
|
t.regex(config.queries["javascript"][0], /.*\/workflow-query$/);
|
|
});
|
|
});
|
|
ava_1.default("Multiple queries can be specified in workflow file, no config file required", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
fs.mkdirSync(path.join(tmpDir, "override1"));
|
|
fs.mkdirSync(path.join(tmpDir, "override2"));
|
|
const queries = "./override1,./override2";
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return queriesToResolvedQueryForm(queries);
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const config = await configUtils.initConfig(languages, queries, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolveQueries was called correctly:
|
|
// It'll be called once for the default queries,
|
|
// and then once for each of the two queries from the workflow
|
|
t.deepEqual(resolveQueriesArgs.length, 3);
|
|
t.deepEqual(resolveQueriesArgs[1].queries.length, 1);
|
|
t.deepEqual(resolveQueriesArgs[2].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[1].queries[0], /.*\/override1$/);
|
|
t.regex(resolveQueriesArgs[2].queries[0], /.*\/override2$/);
|
|
// Now check that the end result contains both the queries from the workflow, as well as the defaults
|
|
t.deepEqual(config.queries["javascript"].length, 3);
|
|
t.regex(config.queries["javascript"][0], /javascript-code-scanning.qls$/);
|
|
t.regex(config.queries["javascript"][1], /.*\/override1$/);
|
|
t.regex(config.queries["javascript"][2], /.*\/override2$/);
|
|
});
|
|
});
|
|
ava_1.default("Queries in workflow file can be added to the set of queries without overriding config file", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
process.env["RUNNER_TEMP"] = tmpDir;
|
|
process.env["GITHUB_WORKSPACE"] = tmpDir;
|
|
const inputFileContents = `
|
|
name: my config
|
|
queries:
|
|
- uses: ./foo`;
|
|
const configFilePath = createConfigFile(inputFileContents, tmpDir);
|
|
// These queries shouldn't override anything, because the value is prefixed with "+"
|
|
const queries = "+./additional1,./additional2";
|
|
fs.mkdirSync(path.join(tmpDir, "foo"));
|
|
fs.mkdirSync(path.join(tmpDir, "additional1"));
|
|
fs.mkdirSync(path.join(tmpDir, "additional2"));
|
|
const resolveQueriesArgs = [];
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(queries, extraSearchPath) {
|
|
resolveQueriesArgs.push({ queries, extraSearchPath });
|
|
return queriesToResolvedQueryForm(queries);
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const config = await configUtils.initConfig(languages, queries, configFilePath, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
// Check resolveQueries was called correctly
|
|
// It'll be called once for the default queries,
|
|
// once for each of additional1 and additional2,
|
|
// and once for './foo' from the config file
|
|
t.deepEqual(resolveQueriesArgs.length, 4);
|
|
t.deepEqual(resolveQueriesArgs[1].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[1].queries[0], /.*\/additional1$/);
|
|
t.deepEqual(resolveQueriesArgs[2].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[2].queries[0], /.*\/additional2$/);
|
|
t.deepEqual(resolveQueriesArgs[3].queries.length, 1);
|
|
t.regex(resolveQueriesArgs[3].queries[0], /.*\/foo$/);
|
|
// Now check that the end result contains all the queries
|
|
t.deepEqual(config.queries["javascript"].length, 4);
|
|
t.regex(config.queries["javascript"][0], /javascript-code-scanning.qls$/);
|
|
t.regex(config.queries["javascript"][1], /.*\/additional1$/);
|
|
t.regex(config.queries["javascript"][2], /.*\/additional2$/);
|
|
t.regex(config.queries["javascript"][3], /.*\/foo$/);
|
|
});
|
|
});
|
|
ava_1.default("Invalid queries in workflow file handled correctly", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const queries = "foo/bar@v1@v3";
|
|
const languages = "javascript";
|
|
// This function just needs to be type-correct; it doesn't need to do anything,
|
|
// since we're deliberately passing in invalid data
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries(_queries, _extraSearchPath) {
|
|
return {
|
|
byLanguage: {
|
|
javascript: {},
|
|
},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
try {
|
|
await configUtils.initConfig(languages, queries, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
t.fail("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getQueryUsesInvalid(undefined, "foo/bar@v1@v3")));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("API client used when reading remote config", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries() {
|
|
return {
|
|
byLanguage: {
|
|
javascript: {
|
|
"foo.ql": {},
|
|
},
|
|
},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
const inputFileContents = `
|
|
name: my config
|
|
disable-default-queries: true
|
|
queries:
|
|
- uses: ./
|
|
- uses: ./foo
|
|
- uses: foo/bar@dev
|
|
paths-ignore:
|
|
- a
|
|
- b
|
|
paths:
|
|
- c/d`;
|
|
const dummyResponse = {
|
|
content: Buffer.from(inputFileContents).toString("base64"),
|
|
};
|
|
const spyGetContents = mockGetContents(dummyResponse);
|
|
// Create checkout directory for remote queries repository
|
|
fs.mkdirSync(path.join(tmpDir, "foo/bar/dev"), { recursive: true });
|
|
const configFile = "octo-org/codeql-config/config.yaml@main";
|
|
const languages = "javascript";
|
|
await configUtils.initConfig(languages, undefined, configFile, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
t.assert(spyGetContents.called);
|
|
});
|
|
});
|
|
ava_1.default("Remote config handles the case where a directory is provided", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const dummyResponse = []; // directories are returned as arrays
|
|
mockGetContents(dummyResponse);
|
|
const repoReference = "octo-org/codeql-config/config.yaml@main";
|
|
try {
|
|
await configUtils.initConfig(undefined, undefined, repoReference, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getConfigFileDirectoryGivenMessage(repoReference)));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("Invalid format of remote config handled correctly", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const dummyResponse = {
|
|
// note no "content" property here
|
|
};
|
|
mockGetContents(dummyResponse);
|
|
const repoReference = "octo-org/codeql-config/config.yaml@main";
|
|
try {
|
|
await configUtils.initConfig(undefined, undefined, repoReference, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getConfigFileFormatInvalidMessage(repoReference)));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("No detected languages", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
mockListLanguages([]);
|
|
try {
|
|
await configUtils.initConfig(undefined, undefined, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getNoLanguagesError()));
|
|
}
|
|
});
|
|
});
|
|
ava_1.default("Unknown languages", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const languages = "ruby,english";
|
|
try {
|
|
await configUtils.initConfig(languages, undefined, undefined, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeql_1.getCachedCodeQL(), tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(configUtils.getUnknownLanguagesError(["ruby", "english"])));
|
|
}
|
|
});
|
|
});
|
|
function doInvalidInputTest(testName, inputFileContents, expectedErrorMessageGenerator) {
|
|
ava_1.default(`load invalid input - ${testName}`, async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeQL = codeql_1.setCodeQL({
|
|
async resolveQueries() {
|
|
return {
|
|
byLanguage: {},
|
|
noDeclaredLanguage: {},
|
|
multipleDeclaredLanguages: {},
|
|
};
|
|
},
|
|
});
|
|
const languages = "javascript";
|
|
const configFile = "input";
|
|
const inputFile = path.join(tmpDir, configFile);
|
|
fs.writeFileSync(inputFile, inputFileContents, "utf8");
|
|
try {
|
|
await configUtils.initConfig(languages, undefined, configFile, { owner: "github", repo: "example " }, tmpDir, tmpDir, codeQL, tmpDir, "token", "https://github.example.com", logging_1.getRunnerLogger(true));
|
|
throw new Error("initConfig did not throw error");
|
|
}
|
|
catch (err) {
|
|
t.deepEqual(err, new Error(expectedErrorMessageGenerator(inputFile)));
|
|
}
|
|
});
|
|
});
|
|
}
|
|
doInvalidInputTest("name invalid type", `
|
|
name:
|
|
- foo: bar`, configUtils.getNameInvalid);
|
|
doInvalidInputTest("disable-default-queries invalid type", `disable-default-queries: 42`, configUtils.getDisableDefaultQueriesInvalid);
|
|
doInvalidInputTest("queries invalid type", `queries: foo`, configUtils.getQueriesInvalid);
|
|
doInvalidInputTest("paths-ignore invalid type", `paths-ignore: bar`, configUtils.getPathsIgnoreInvalid);
|
|
doInvalidInputTest("paths invalid type", `paths: 17`, configUtils.getPathsInvalid);
|
|
doInvalidInputTest("queries uses invalid type", `
|
|
queries:
|
|
- uses:
|
|
- hello: world`, configUtils.getQueryUsesInvalid);
|
|
function doInvalidQueryUsesTest(input, expectedErrorMessageGenerator) {
|
|
// Invalid contents of a "queries.uses" field.
|
|
// Should fail with the expected error message
|
|
const inputFileContents = `
|
|
name: my config
|
|
queries:
|
|
- name: foo
|
|
uses: ${input}`;
|
|
doInvalidInputTest(`queries uses "${input}"`, inputFileContents, expectedErrorMessageGenerator);
|
|
}
|
|
// Various "uses" fields, and the errors they should produce
|
|
doInvalidQueryUsesTest("''", (c) => configUtils.getQueryUsesInvalid(c, undefined));
|
|
doInvalidQueryUsesTest("foo/bar", (c) => configUtils.getQueryUsesInvalid(c, "foo/bar"));
|
|
doInvalidQueryUsesTest("foo/bar@v1@v2", (c) => configUtils.getQueryUsesInvalid(c, "foo/bar@v1@v2"));
|
|
doInvalidQueryUsesTest("foo@master", (c) => configUtils.getQueryUsesInvalid(c, "foo@master"));
|
|
doInvalidQueryUsesTest("https://github.com/foo/bar@master", (c) => configUtils.getQueryUsesInvalid(c, "https://github.com/foo/bar@master"));
|
|
doInvalidQueryUsesTest("./foo", (c) => configUtils.getLocalPathDoesNotExist(c, "foo"));
|
|
doInvalidQueryUsesTest("./..", (c) => configUtils.getLocalPathOutsideOfRepository(c, ".."));
|
|
const validPaths = [
|
|
"foo",
|
|
"foo/",
|
|
"foo/**",
|
|
"foo/**/",
|
|
"foo/**/**",
|
|
"foo/**/bar/**/baz",
|
|
"**/",
|
|
"**/foo",
|
|
"/foo",
|
|
];
|
|
const invalidPaths = ["a/***/b", "a/**b", "a/b**", "**"];
|
|
ava_1.default("path validations", (t) => {
|
|
// Dummy values to pass to validateAndSanitisePath
|
|
const propertyName = "paths";
|
|
const configFile = "./.github/codeql/config.yml";
|
|
for (const path of validPaths) {
|
|
t.truthy(configUtils.validateAndSanitisePath(path, propertyName, configFile, logging_1.getRunnerLogger(true)));
|
|
}
|
|
for (const path of invalidPaths) {
|
|
t.throws(() => configUtils.validateAndSanitisePath(path, propertyName, configFile, logging_1.getRunnerLogger(true)));
|
|
}
|
|
});
|
|
ava_1.default("path sanitisation", (t) => {
|
|
// Dummy values to pass to validateAndSanitisePath
|
|
const propertyName = "paths";
|
|
const configFile = "./.github/codeql/config.yml";
|
|
// Valid paths are not modified
|
|
t.deepEqual(configUtils.validateAndSanitisePath("foo/bar", propertyName, configFile, logging_1.getRunnerLogger(true)), "foo/bar");
|
|
// Trailing stars are stripped
|
|
t.deepEqual(configUtils.validateAndSanitisePath("foo/**", propertyName, configFile, logging_1.getRunnerLogger(true)), "foo/");
|
|
});
|
|
//# sourceMappingURL=config-utils.test.js.map
|