Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Allow multiple overriding queries, comma-separated
  • Loading branch information
Sam Partington committed Jul 27, 2020
1 parent 95cef22 commit 2da4570
Showing 6 changed files with 100 additions and 4 deletions.
4 changes: 3 additions & 1 deletion lib/config-utils.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/config-utils.js.map

Large diffs are not rendered by default.

42 changes: 42 additions & 0 deletions lib/config-utils.test.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/config-utils.test.js.map

Large diffs are not rendered by default.

50 changes: 50 additions & 0 deletions src/config-utils.test.ts
@@ -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 changes: 3 additions & 1 deletion src/config-utils.ts
@@ -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;

0 comments on commit 2da4570

Please sign in to comment.