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

Allow multiple overriding queries, comma-separated

Browse Source
This commit is contained in:
Sam Partington
2020-07-27 15:41:17 +01:00
parent 95cef22589
commit 2da457060b
6 changed files with 100 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/config-utils.js generated
View File

@@ -486,7 +486,9 @@ async function updateConfigWithQueries(config, queryUses, configPath) {
}
const languages = await getLanguages();
const queries = {};
await parseQueryUses(configPath, languages, queries, queryUses);
queryUses.split(',').forEach(async (q) => {
await parseQueryUses(configPath, languages, queries, q);
});
config.queries = queries;
return config;
}

2
lib/config-utils.js.map
View File

File diff suppressed because one or more lines are too long

42
lib/config-utils.test.js generated
View File

@@ -269,6 +269,48 @@ ava_1.default("Queries can be overridden in action file", async (t) => {
t.regex(config.queries['javascript'][0], /.*\/override$/);
});
});
ava_1.default("Multiple overriding queries can be specified in action file", async (t) => {
return await util.withTmpDir(async (tmpDir) => {
process.env['RUNNER_TEMP'] = tmpDir;
process.env['GITHUB_WORKSPACE'] = tmpDir;
fs.mkdirSync(path.join(tmpDir, 'override1'));
fs.mkdirSync(path.join(tmpDir, 'override2'));
// This config item should take precedence.
setInput('queries', './override1,./override2');
const resolveQueriesArgs = [];
CodeQL.setCodeQL({
resolveQueries: async function (queries, extraSearchPath) {
resolveQueriesArgs.push({ queries, extraSearchPath });
// Return what we're given, just in the right format for a resolved query
// This way we can test overriding by seeing which returned items are in
// the final configuration.
const dummyResolvedQueries = {};
queries.forEach(q => { dummyResolvedQueries[q] = {}; });
return {
byLanguage: {
'javascript': dummyResolvedQueries,
},
noDeclaredLanguage: {},
multipleDeclaredLanguages: {},
};
},
});
setInput('languages', 'javascript');
const config = await configUtils.initConfig();
// Check resolveQueries was called correctly:
// It'll be called once for the default queries,
// and then once for each of the two overrides
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 only the override queries, not the defaults
t.deepEqual(config.queries['javascript'].length, 2);
t.regex(config.queries['javascript'][0], /.*\/override1$/);
t.regex(config.queries['javascript'][1], /.*\/override2$/);
});
});
ava_1.default("API client used when reading remote config", async (t) => {
return await util.withTmpDir(async (tmpDir) => {
process.env['RUNNER_TEMP'] = tmpDir;

2
lib/config-utils.test.js.map
View File

File diff suppressed because one or more lines are too long

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

@@ -308,6 +308,56 @@ test("Queries can be overridden in action file", async t => {
});
});
test("Multiple overriding queries can be specified in action file", async t => {
return await util.withTmpDir(async tmpDir => {
process.env['RUNNER_TEMP'] = tmpDir;
process.env['GITHUB_WORKSPACE'] = tmpDir;
fs.mkdirSync(path.join(tmpDir, 'override1'));
fs.mkdirSync(path.join(tmpDir, 'override2'));
// This config item should take precedence.
setInput('queries', './override1,./override2');
const resolveQueriesArgs: {queries: string[], extraSearchPath: string | undefined}[] = [];
CodeQL.setCodeQL({
resolveQueries: async function(queries: string[], extraSearchPath: string | undefined) {
resolveQueriesArgs.push({queries, extraSearchPath});
// Return what we're given, just in the right format for a resolved query
// This way we can test overriding by seeing which returned items are in
// the final configuration.
const dummyResolvedQueries = {};
queries.forEach(q => { dummyResolvedQueries[q] = {}; });
return {
byLanguage: {
'javascript': dummyResolvedQueries,
},
noDeclaredLanguage: {},
multipleDeclaredLanguages: {},
};
},
});
setInput('languages', 'javascript');
const config = await configUtils.initConfig();
// Check resolveQueries was called correctly:
// It'll be called once for the default queries,
// and then once for each of the two overrides
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 only the override queries, not the defaults
t.deepEqual(config.queries['javascript'].length, 2);
t.regex(config.queries['javascript'][0], /.*\/override1$/);
t.regex(config.queries['javascript'][1], /.*\/override2$/);
});
});
test("API client used when reading remote config", async t => {
return await util.withTmpDir(async tmpDir => {
process.env['RUNNER_TEMP'] = tmpDir;

4
src/config-utils.ts
View File

@@ -629,7 +629,9 @@ async function updateConfigWithQueries(config: Config, queryUses: string, config
const languages = await getLanguages();
const queries = {};
await parseQueryUses(configPath, languages, queries, queryUses);
queryUses.split(',').forEach(async q => {
await parseQueryUses(configPath, languages, queries, q);
});
config.queries = queries;
return config;