451 строка
18 KiB
JavaScript
451 строка
18 KiB
JavaScript
"use strict";
|
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
if (k2 === undefined) k2 = k;
|
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
}
|
|
Object.defineProperty(o, k2, desc);
|
|
}) : (function(o, m, k, k2) {
|
|
if (k2 === undefined) k2 = k;
|
|
o[k2] = m[k];
|
|
}));
|
|
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
}) : function(o, v) {
|
|
o["default"] = v;
|
|
});
|
|
var __importStar = (this && this.__importStar) || function (mod) {
|
|
if (mod && mod.__esModule) return mod;
|
|
var result = {};
|
|
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
__setModuleDefault(result, mod);
|
|
return result;
|
|
};
|
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
};
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
const fs = __importStar(require("fs"));
|
|
const path = __importStar(require("path"));
|
|
const ava_1 = __importDefault(require("ava"));
|
|
const yaml = __importStar(require("js-yaml"));
|
|
const sinon = __importStar(require("sinon"));
|
|
const analyze_1 = require("./analyze");
|
|
const codeql_1 = require("./codeql");
|
|
const feature_flags_1 = require("./feature-flags");
|
|
const languages_1 = require("./languages");
|
|
const logging_1 = require("./logging");
|
|
const testing_utils_1 = require("./testing-utils");
|
|
const util = __importStar(require("./util"));
|
|
(0, testing_utils_1.setupTests)(ava_1.default);
|
|
// Checks that the duration fields are populated for the correct language
|
|
// and correct case of builtin or custom. Also checks the correct search
|
|
// paths are set in the database analyze invocation.
|
|
(0, ava_1.default)("status report fields and search path setting", async (t) => {
|
|
let searchPathsUsed = [];
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
(0, testing_utils_1.setupActionsVars)(tmpDir, tmpDir);
|
|
const memoryFlag = "";
|
|
const addSnippetsFlag = "";
|
|
const threadsFlag = "";
|
|
const packs = {
|
|
[languages_1.Language.cpp]: ["a/b@1.0.0"],
|
|
[languages_1.Language.java]: ["c/d@2.0.0"],
|
|
};
|
|
for (const language of Object.values(languages_1.Language)) {
|
|
(0, codeql_1.setCodeQL)({
|
|
packDownload: async () => ({ packs: [] }),
|
|
databaseRunQueries: async (_db, searchPath) => {
|
|
searchPathsUsed.push(searchPath);
|
|
},
|
|
databaseInterpretResults: async (_db, _queriesRun, sarifFile) => {
|
|
fs.writeFileSync(sarifFile, JSON.stringify({
|
|
runs: [
|
|
// references a rule with the lines-of-code tag, so baseline should be injected
|
|
{
|
|
tool: {
|
|
extensions: [
|
|
{
|
|
rules: [
|
|
{
|
|
properties: {
|
|
tags: ["lines-of-code"],
|
|
},
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
properties: {
|
|
metricResults: [
|
|
{
|
|
rule: {
|
|
index: 0,
|
|
toolComponent: {
|
|
index: 0,
|
|
},
|
|
},
|
|
value: 123,
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{},
|
|
],
|
|
}));
|
|
return "";
|
|
},
|
|
databasePrintBaseline: async () => "",
|
|
});
|
|
searchPathsUsed = [];
|
|
const config = {
|
|
languages: [language],
|
|
queries: {},
|
|
pathsIgnore: [],
|
|
paths: [],
|
|
originalUserInput: {},
|
|
tempDir: tmpDir,
|
|
codeQLCmd: "",
|
|
gitHubVersion: {
|
|
type: util.GitHubVariant.DOTCOM,
|
|
},
|
|
dbLocation: path.resolve(tmpDir, "codeql_databases"),
|
|
packs,
|
|
debugMode: false,
|
|
debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
|
|
debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
|
|
augmentationProperties: {
|
|
injectedMlQueries: false,
|
|
packsInputCombines: false,
|
|
queriesInputCombines: false,
|
|
},
|
|
trapCaches: {},
|
|
trapCacheDownloadTime: 0,
|
|
};
|
|
fs.mkdirSync(util.getCodeQLDatabasePath(config, language), {
|
|
recursive: true,
|
|
});
|
|
config.queries[language] = {
|
|
builtin: ["foo.ql"],
|
|
custom: [],
|
|
};
|
|
const builtinStatusReport = await (0, analyze_1.runQueries)(tmpDir, memoryFlag, addSnippetsFlag, threadsFlag, undefined, config, (0, logging_1.getRunnerLogger)(true), (0, testing_utils_1.createFeatures)([]));
|
|
const hasPacks = language in packs;
|
|
const statusReportKeys = Object.keys(builtinStatusReport).sort();
|
|
if (hasPacks) {
|
|
t.deepEqual(statusReportKeys.length, 3, statusReportKeys.toString());
|
|
t.deepEqual(statusReportKeys[0], `analyze_builtin_queries_${language}_duration_ms`);
|
|
t.deepEqual(statusReportKeys[1], `analyze_custom_queries_${language}_duration_ms`);
|
|
t.deepEqual(statusReportKeys[2], `interpret_results_${language}_duration_ms`);
|
|
}
|
|
else {
|
|
t.deepEqual(statusReportKeys[0], `analyze_builtin_queries_${language}_duration_ms`);
|
|
t.deepEqual(statusReportKeys[1], `interpret_results_${language}_duration_ms`);
|
|
}
|
|
config.queries[language] = {
|
|
builtin: [],
|
|
custom: [
|
|
{
|
|
queries: ["foo.ql"],
|
|
searchPath: "/1",
|
|
},
|
|
{
|
|
queries: ["bar.ql"],
|
|
searchPath: "/2",
|
|
},
|
|
],
|
|
};
|
|
const customStatusReport = await (0, analyze_1.runQueries)(tmpDir, memoryFlag, addSnippetsFlag, threadsFlag, undefined, config, (0, logging_1.getRunnerLogger)(true), (0, testing_utils_1.createFeatures)([]));
|
|
t.deepEqual(Object.keys(customStatusReport).length, 2);
|
|
t.true(`analyze_custom_queries_${language}_duration_ms` in customStatusReport);
|
|
const expectedSearchPathsUsed = hasPacks
|
|
? [undefined, undefined, "/1", "/2", undefined]
|
|
: [undefined, "/1", "/2"];
|
|
t.deepEqual(searchPathsUsed, expectedSearchPathsUsed);
|
|
t.true(`interpret_results_${language}_duration_ms` in customStatusReport);
|
|
}
|
|
verifyQuerySuites(tmpDir);
|
|
});
|
|
function verifyQuerySuites(tmpDir) {
|
|
const qlsContent = [
|
|
{
|
|
query: "foo.ql",
|
|
},
|
|
];
|
|
const qlsContent2 = [
|
|
{
|
|
query: "bar.ql",
|
|
},
|
|
];
|
|
for (const lang of Object.values(languages_1.Language)) {
|
|
t.deepEqual(readContents(`${lang}-queries-builtin.qls`), qlsContent);
|
|
t.deepEqual(readContents(`${lang}-queries-custom-0.qls`), qlsContent);
|
|
t.deepEqual(readContents(`${lang}-queries-custom-1.qls`), qlsContent2);
|
|
}
|
|
function readContents(name) {
|
|
const x = fs.readFileSync(path.join(tmpDir, "codeql_databases", name), "utf8");
|
|
console.log(x);
|
|
return yaml.load(fs.readFileSync(path.join(tmpDir, "codeql_databases", name), "utf8"));
|
|
}
|
|
}
|
|
});
|
|
function mockCodeQL() {
|
|
return {
|
|
getVersion: async () => "2.12.2",
|
|
databaseRunQueries: sinon.spy(),
|
|
databaseInterpretResults: async () => "",
|
|
databasePrintBaseline: async () => "",
|
|
};
|
|
}
|
|
function createBaseConfig(tmpDir) {
|
|
return {
|
|
languages: [],
|
|
queries: {},
|
|
pathsIgnore: [],
|
|
paths: [],
|
|
originalUserInput: {},
|
|
tempDir: "tempDir",
|
|
codeQLCmd: "",
|
|
gitHubVersion: {
|
|
type: util.GitHubVariant.DOTCOM,
|
|
},
|
|
dbLocation: path.resolve(tmpDir, "codeql_databases"),
|
|
packs: {},
|
|
debugMode: false,
|
|
debugArtifactName: util.DEFAULT_DEBUG_ARTIFACT_NAME,
|
|
debugDatabaseName: util.DEFAULT_DEBUG_DATABASE_NAME,
|
|
augmentationProperties: {
|
|
injectedMlQueries: false,
|
|
packsInputCombines: false,
|
|
queriesInputCombines: false,
|
|
},
|
|
trapCaches: {},
|
|
trapCacheDownloadTime: 0,
|
|
};
|
|
}
|
|
function createQueryConfig(builtin, custom) {
|
|
return {
|
|
builtin,
|
|
custom: custom.map((c) => ({ searchPath: "/search", queries: [c] })),
|
|
};
|
|
}
|
|
async function runQueriesWithConfig(config, features) {
|
|
for (const language of config.languages) {
|
|
fs.mkdirSync(util.getCodeQLDatabasePath(config, language), {
|
|
recursive: true,
|
|
});
|
|
}
|
|
return (0, analyze_1.runQueries)("sarif-folder", "--memFlag", "--addSnippetsFlag", "--threadsFlag", undefined, config, (0, logging_1.getRunnerLogger)(true), (0, testing_utils_1.createFeatures)(features));
|
|
}
|
|
function getDatabaseRunQueriesCalls(mock) {
|
|
return mock.databaseRunQueries.getCalls();
|
|
}
|
|
(0, ava_1.default)("optimizeForLastQueryRun for one language", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp];
|
|
config.queries.cpp = createQueryConfig(["foo.ql"], []);
|
|
await runQueriesWithConfig(config, []);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("optimizeForLastQueryRun for two languages", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp, languages_1.Language.java];
|
|
config.queries.cpp = createQueryConfig(["foo.ql"], []);
|
|
config.queries.java = createQueryConfig(["bar.ql"], []);
|
|
await runQueriesWithConfig(config, []);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [true, true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("optimizeForLastQueryRun for two languages, with custom queries", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp, languages_1.Language.java];
|
|
config.queries.cpp = createQueryConfig(["foo.ql"], ["c1.ql", "c2.ql"]);
|
|
config.queries.java = createQueryConfig(["bar.ql"], ["c3.ql"]);
|
|
await runQueriesWithConfig(config, []);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [false, false, true, false, true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("optimizeForLastQueryRun for two languages, with custom queries and packs", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp, languages_1.Language.java];
|
|
config.queries.cpp = createQueryConfig(["foo.ql"], ["c1.ql", "c2.ql"]);
|
|
config.queries.java = createQueryConfig(["bar.ql"], ["c3.ql"]);
|
|
config.packs.cpp = ["a/cpp-pack1@0.1.0"];
|
|
config.packs.java = ["b/java-pack1@0.2.0", "b/java-pack2@0.3.3"];
|
|
await runQueriesWithConfig(config, []);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [false, false, false, true, false, false, true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("optimizeForLastQueryRun for one language, CliConfigFileEnabled", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp];
|
|
await runQueriesWithConfig(config, [feature_flags_1.Feature.CliConfigFileEnabled]);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("optimizeForLastQueryRun for two languages, CliConfigFileEnabled", async (t) => {
|
|
return await util.withTmpDir(async (tmpDir) => {
|
|
const codeql = mockCodeQL();
|
|
(0, codeql_1.setCodeQL)(codeql);
|
|
const config = createBaseConfig(tmpDir);
|
|
config.languages = [languages_1.Language.cpp, languages_1.Language.java];
|
|
await runQueriesWithConfig(config, [feature_flags_1.Feature.CliConfigFileEnabled]);
|
|
t.deepEqual(getDatabaseRunQueriesCalls(codeql).map((c) => c.args[4]), [true, true]);
|
|
});
|
|
});
|
|
(0, ava_1.default)("validateQueryFilters", (t) => {
|
|
t.notThrows(() => (0, analyze_1.validateQueryFilters)([]));
|
|
t.notThrows(() => (0, analyze_1.validateQueryFilters)(undefined));
|
|
t.notThrows(() => {
|
|
return (0, analyze_1.validateQueryFilters)([
|
|
{
|
|
exclude: {
|
|
"problem.severity": "recommendation",
|
|
},
|
|
},
|
|
{
|
|
exclude: {
|
|
"tags contain": ["foo", "bar"],
|
|
},
|
|
},
|
|
{
|
|
include: {
|
|
"problem.severity": "something-to-think-about",
|
|
},
|
|
},
|
|
{
|
|
include: {
|
|
"tags contain": ["baz", "bop"],
|
|
},
|
|
},
|
|
]);
|
|
});
|
|
t.throws(() => {
|
|
return (0, analyze_1.validateQueryFilters)([
|
|
{
|
|
exclude: {
|
|
"tags contain": ["foo", "bar"],
|
|
},
|
|
include: {
|
|
"tags contain": ["baz", "bop"],
|
|
},
|
|
},
|
|
]);
|
|
}, { message: /Query filter must have exactly one key/ });
|
|
t.throws(() => {
|
|
return (0, analyze_1.validateQueryFilters)([{ xxx: "foo" }]);
|
|
}, { message: /Only "include" or "exclude" filters are allowed/ });
|
|
t.throws(() => {
|
|
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
return (0, analyze_1.validateQueryFilters)({ exclude: "foo" });
|
|
}, {
|
|
message: /Query filters must be an array of "include" or "exclude" entries/,
|
|
});
|
|
});
|
|
const convertPackToQuerySuiteEntryMacro = ava_1.default.macro({
|
|
exec: (t, packSpec, suiteEntry) => t.deepEqual((0, analyze_1.convertPackToQuerySuiteEntry)(packSpec), suiteEntry),
|
|
title: (_providedTitle, packSpec) => `Query Suite Entry: ${packSpec}`,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b", {
|
|
qlpack: "a/b",
|
|
from: undefined,
|
|
version: undefined,
|
|
query: undefined,
|
|
queries: undefined,
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b@~1.2.3", {
|
|
qlpack: "a/b",
|
|
from: undefined,
|
|
version: "~1.2.3",
|
|
query: undefined,
|
|
queries: undefined,
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b:my/path", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: undefined,
|
|
query: undefined,
|
|
queries: "my/path",
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b@~1.2.3:my/path", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: "~1.2.3",
|
|
query: undefined,
|
|
queries: "my/path",
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b:my/path/query.ql", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: undefined,
|
|
query: "my/path/query.ql",
|
|
queries: undefined,
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b@~1.2.3:my/path/query.ql", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: "~1.2.3",
|
|
query: "my/path/query.ql",
|
|
queries: undefined,
|
|
apply: undefined,
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b:my/path/suite.qls", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: undefined,
|
|
query: undefined,
|
|
queries: undefined,
|
|
apply: "my/path/suite.qls",
|
|
});
|
|
(0, ava_1.default)(convertPackToQuerySuiteEntryMacro, "a/b@~1.2.3:my/path/suite.qls", {
|
|
qlpack: undefined,
|
|
from: "a/b",
|
|
version: "~1.2.3",
|
|
query: undefined,
|
|
queries: undefined,
|
|
apply: "my/path/suite.qls",
|
|
});
|
|
(0, ava_1.default)("convertPackToQuerySuiteEntry Failure", (t) => {
|
|
t.throws(() => (0, analyze_1.convertPackToQuerySuiteEntry)("this-is-not-a-pack"));
|
|
});
|
|
(0, ava_1.default)("createQuerySuiteContents", (t) => {
|
|
const yamlResult = (0, analyze_1.createQuerySuiteContents)(["query1.ql", "query2.ql"], [
|
|
{
|
|
exclude: { "problem.severity": "recommendation" },
|
|
},
|
|
{
|
|
include: { "problem.severity": "recommendation" },
|
|
},
|
|
]);
|
|
const expected = `- query: query1.ql
|
|
- query: query2.ql
|
|
- exclude:
|
|
problem.severity: recommendation
|
|
- include:
|
|
problem.severity: recommendation
|
|
`;
|
|
t.deepEqual(yamlResult, expected);
|
|
});
|
|
//# sourceMappingURL=analyze.test.js.map
|