robojerk/codeql-action

make tests clearer

Browse source
This commit is contained in:
Robert Brignull 2020-08-25 11:09:07 +01:00
parent 407ef0ac11
commit 82fb31ed5e
9 changed files with 84 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/setup-tracer.ts
View file

@ -6,7 +6,7 @@ import * as path from 'path';
import * as analysisPaths from './analysis-paths';
import { CodeQL, setupCodeQL } from './codeql';
import * as configUtils from './config-utils';
import { getTracerConfig } from './tracer-config';
import { getCombinedTracerConfig } from './tracer-config';
import * as util from './util';
interface InitSuccessStatusReport extends util.StatusReportBase {
@ -103,7 +103,7 @@ async function run() {
await codeql.databaseInit(util.getCodeQLDatabasePath(config.tempDir, language), language, sourceRoot);
}
const tracerConfig = await getTracerConfig(config, codeql);
const tracerConfig = await getCombinedTracerConfig(config, codeql);
if (tracerConfig !== undefined) {
if (process.platform === 'win32') {
await exec.exec(
@ -115,7 +115,7 @@ async function run() {
{ env: { 'ODASA_TRACER_CONFIGURATION': tracerConfig.spec } });
}
// NB: in CLI mode these will be outputted to a file instead of exported with core.exportVariable
// NB: in CLI mode these will be output to a file rather than exported with core.exportVariable
Object.entries(tracerConfig.env).forEach(([key, value]) => core.exportVariable(key, value));
}

62
src/tracer-config.test.ts
View file

@ -6,7 +6,7 @@ import { setCodeQL } from './codeql';
import * as configUtils from './config-utils';
import { Language } from './languages';
import { setupTests } from './testing-utils';
import { concatTracerConfigs, getTracerConfig, tracerConfig } from './tracer-config';
import { concatTracerConfigs, getCombinedTracerConfig, getTracerConfigForLanguage } from './tracer-config';
import * as util from './util';
setupTests(test);
@ -25,7 +25,7 @@ function getTestConfig(tmpDir: string): configUtils.Config {
}
// A very minimal setup
test('tracerConfig - minimal', async t => {
test('getTracerConfigForLanguage - minimal setup', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -38,16 +38,27 @@ test('tracerConfig - minimal', async t => {
},
});
const result = await tracerConfig(codeQL, config, Language.javascript);
const result = await getTracerConfigForLanguage(codeQL, config, Language.javascript);
t.deepEqual(result, { spec: 'abc', env: {'foo': 'bar'} });
});
});
// Existing vars should not be overwritten, unless they are critical or prefixed with CODEQL_
test('tracerConfig - existing / critical vars', async t => {
test('getTracerConfigForLanguage - existing / critical vars', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
// Set up some variables in the environment
process.env['foo'] = 'abc';
process.env['SEMMLE_PRELOAD_libtrace'] = 'abc';
process.env['SEMMLE_RUNNER'] = 'abc';
process.env['SEMMLE_COPY_EXECUTABLES_ROOT'] = 'abc';
process.env['SEMMLE_DEPTRACE_SOCKET'] = 'abc';
process.env['SEMMLE_JAVA_TOOL_OPTIONS'] = 'abc';
process.env['SEMMLE_DEPTRACE_SOCKET'] = 'abc';
process.env['CODEQL_VAR'] = 'abc';
// Now CodeQL returns all these variables, and one more, with different values
const codeQL = setCodeQL({
getTracerEnv: async function() {
return {
@ -64,19 +75,12 @@ test('tracerConfig - existing / critical vars', async t => {
},
});
process.env['foo'] = 'abc';
process.env['SEMMLE_PRELOAD_libtrace'] = 'abc';
process.env['SEMMLE_RUNNER'] = 'abc';
process.env['SEMMLE_COPY_EXECUTABLES_ROOT'] = 'abc';
process.env['SEMMLE_DEPTRACE_SOCKET'] = 'abc';
process.env['SEMMLE_JAVA_TOOL_OPTIONS'] = 'abc';
process.env['SEMMLE_DEPTRACE_SOCKET'] = 'abc';
process.env['CODEQL_VAR'] = 'abc';
const result = await tracerConfig(codeQL, config, Language.javascript);
const result = await getTracerConfigForLanguage(codeQL, config, Language.javascript);
t.deepEqual(result, {
spec: 'abc',
env: {
// Should contain all variables except 'foo', because that already existed in the
// environment with a different value, and is not deemed a "critical" variable.
'baz': 'qux',
'SEMMLE_PRELOAD_libtrace': 'SEMMLE_PRELOAD_libtrace',
'SEMMLE_RUNNER': 'SEMMLE_RUNNER',
@ -89,7 +93,7 @@ test('tracerConfig - existing / critical vars', async t => {
});
});
test('concatTracerConfigs - minimal', async t => {
test('concatTracerConfigs - minimal configs correctly combined', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -161,8 +165,7 @@ test('concatTracerConfigs - conflicting env vars', async t => {
});
});
// If cpp is present then it's spec lines always come at the end
test('concatTracerConfigs - cpp comes last', async t => {
test('concatTracerConfigs - cpp spec lines come last if present', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -201,7 +204,7 @@ test('concatTracerConfigs - cpp comes last', async t => {
});
});
test('concatTracerConfigs - SEMMLE_COPY_EXECUTABLES_ROOT', async t => {
test('concatTracerConfigs - SEMMLE_COPY_EXECUTABLES_ROOT is updated to point to compound spec', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -223,7 +226,7 @@ test('concatTracerConfigs - SEMMLE_COPY_EXECUTABLES_ROOT', async t => {
});
});
test('concatTracerConfigs - compound environment file', async t => {
test('concatTracerConfigs - compound environment file is created correctly', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -250,16 +253,17 @@ test('concatTracerConfigs - compound environment file', async t => {
t.true(fs.existsSync(envPath));
const buffer: Buffer = fs.readFileSync(envPath);
t.deepEqual(28, buffer.length);
t.deepEqual(2, buffer.readInt32LE(0));
t.deepEqual(4, buffer.readInt32LE(4));
t.deepEqual('a=a\0', buffer.toString('utf8', 8, 12));
t.deepEqual(12, buffer.readInt32LE(12));
t.deepEqual('foo=bar_baz\0', buffer.toString('utf8', 16, 28));
// Contents is binary data
t.deepEqual(buffer.length, 28);
t.deepEqual(buffer.readInt32LE(0), 2); // number of env vars
t.deepEqual(buffer.readInt32LE(4), 4); // length of env var definition
t.deepEqual(buffer.toString('utf8', 8, 12), 'a=a\0'); // [key]=[value]\0
t.deepEqual(buffer.readInt32LE(12), 12); // length of env var definition
t.deepEqual(buffer.toString('utf8', 16, 28), 'foo=bar_baz\0'); // [key]=[value]\0
});
});
test('getTracerConfig - no traced languages', async t => {
test('getCombinedTracerConfig - return undefined when no languages are traced languages', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
// No traced languages
@ -274,11 +278,11 @@ test('getTracerConfig - no traced languages', async t => {
},
});
t.deepEqual(undefined, await getTracerConfig(config, codeQL));
t.deepEqual(await getCombinedTracerConfig(config, codeQL), undefined);
});
});
test('getTracerConfig - full', async t => {
test('getCombinedTracerConfig - valid spec file', async t => {
await util.withTmpDir(async tmpDir => {
const config = getTestConfig(tmpDir);
@ -294,7 +298,7 @@ test('getTracerConfig - full', async t => {
},
});
const result = await getTracerConfig(config, codeQL);
const result = await getCombinedTracerConfig(config, codeQL);
t.deepEqual(result, {
spec: path.join(tmpDir, 'compound-spec'),
env: {

10
src/tracer-config.ts
View file

@ -19,7 +19,7 @@ const CRITICAL_TRACER_VARS = new Set(
, 'SEMMLE_JAVA_TOOL_OPTIONS'
]);
export async function tracerConfig(
export async function getTracerConfigForLanguage(
codeql: CodeQL,
config: configUtils.Config,
language: Language): Promise<TracerConfig> {
@ -129,7 +129,7 @@ export function concatTracerConfigs(
return { env, spec };
}
export async function getTracerConfig(
export async function getCombinedTracerConfig(
config: configUtils.Config,
codeql: CodeQL): Promise<TracerConfig | undefined> {
@ -140,9 +140,9 @@ export async function getTracerConfig(
}
// Get all the tracer configs and combine them together
let tracedLanguageConfigs: { [lang: string]: TracerConfig } = {};
for (let language of tracedLanguages) {
tracedLanguageConfigs[language] = await tracerConfig(codeql, config, language);
const tracedLanguageConfigs: { [lang: string]: TracerConfig } = {};
for (const language of tracedLanguages) {
tracedLanguageConfigs[language] = await getTracerConfigForLanguage(codeql, config, language);
}
const mainTracerConfig = concatTracerConfigs(tracedLanguageConfigs, config);