"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; }; Object.defineProperty(exports, "__esModule", { value: true }); const fs = __importStar(require("fs")); const path = __importStar(require("path")); const toolrunner = __importStar(require("@actions/exec/lib/toolrunner")); const analysisPaths = __importStar(require("./analysis-paths")); const codeql_1 = require("./codeql"); const count_loc_1 = require("./count-loc"); const languages_1 = require("./languages"); const sharedEnv = __importStar(require("./shared-environment")); const upload_lib_1 = require("./upload-lib"); const util = __importStar(require("./util")); class CodeQLAnalysisError extends Error { constructor(queriesStatusReport, message) { super(message); this.name = "CodeQLAnalysisError"; this.queriesStatusReport = queriesStatusReport; } } exports.CodeQLAnalysisError = CodeQLAnalysisError; async function setupPythonExtractor(logger) { const codeqlPython = process.env["CODEQL_PYTHON"]; if (codeqlPython === undefined || codeqlPython.length === 0) { // If CODEQL_PYTHON is not set, no dependencies were installed, so we don't need to do anything return; } let output = ""; const options = { listeners: { stdout: (data) => { output += data.toString(); }, }, }; await new toolrunner.ToolRunner(codeqlPython, [ "-c", "import os; import pip; print(os.path.dirname(os.path.dirname(pip.__file__)))", ], options).exec(); logger.info(`Setting LGTM_INDEX_IMPORT_PATH=${output}`); process.env["LGTM_INDEX_IMPORT_PATH"] = output; output = ""; await new toolrunner.ToolRunner(codeqlPython, ["-c", "import sys; print(sys.version_info[0])"], options).exec(); logger.info(`Setting LGTM_PYTHON_SETUP_VERSION=${output}`); process.env["LGTM_PYTHON_SETUP_VERSION"] = output; } async function createdDBForScannedLanguages(config, logger) { // Insert the LGTM_INDEX_X env vars at this point so they are set when // we extract any scanned languages. analysisPaths.includeAndExcludeAnalysisPaths(config); const codeql = codeql_1.getCodeQL(config.codeQLCmd); for (const language of config.languages) { if (languages_1.isScannedLanguage(language)) { logger.startGroup(`Extracting ${language}`); if (language === languages_1.Language.python) { await setupPythonExtractor(logger); } await codeql.extractScannedLanguage(util.getCodeQLDatabasePath(config, language), language); logger.endGroup(); } } } async function finalizeDatabaseCreation(config, threadsFlag, logger) { await createdDBForScannedLanguages(config, logger); const codeql = codeql_1.getCodeQL(config.codeQLCmd); for (const language of config.languages) { logger.startGroup(`Finalizing ${language}`); await codeql.finalizeDatabase(util.getCodeQLDatabasePath(config, language), threadsFlag); logger.endGroup(); } } // Runs queries and creates sarif files in the given folder async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag, automationDetailsId, config, logger) { const statusReport = {}; // count the number of lines in the background const locPromise = count_loc_1.countLoc(path.resolve(), // config.paths specifies external directories. the current // directory is included in the analysis by default. Replicate // that here. config.paths, config.pathsIgnore, config.languages, logger); for (const language of config.languages) { logger.startGroup(`Analyzing ${language}`); const queries = config.queries[language]; if (queries === undefined || (queries.builtin.length === 0 && queries.custom.length === 0)) { throw new Error(`Unable to analyse ${language} as no queries were selected for this language`); } try { let analysisSummary = ""; if (queries["builtin"].length > 0) { const startTimeBuliltIn = new Date().getTime(); const { sarifFile, stdout } = await runQueryGroup(language, "builtin", queries["builtin"], sarifFolder, undefined); analysisSummary = stdout; await injectLinesOfCode(sarifFile, language, locPromise); statusReport[`analyze_builtin_queries_${language}_duration_ms`] = new Date().getTime() - startTimeBuliltIn; } const startTimeCustom = new Date().getTime(); const temporarySarifDir = config.tempDir; const temporarySarifFiles = []; for (let i = 0; i < queries["custom"].length; ++i) { if (queries["custom"][i].queries.length > 0) { const { sarifFile } = await runQueryGroup(language, `custom-${i}`, queries["custom"][i].queries, temporarySarifDir, queries["custom"][i].searchPath); temporarySarifFiles.push(sarifFile); } } if (temporarySarifFiles.length > 0) { const sarifFile = path.join(sarifFolder, `${language}-custom.sarif`); fs.writeFileSync(sarifFile, upload_lib_1.combineSarifFiles(temporarySarifFiles)); await injectLinesOfCode(sarifFile, language, locPromise); statusReport[`analyze_custom_queries_${language}_duration_ms`] = new Date().getTime() - startTimeCustom; } logger.endGroup(); // Print the LoC baseline and the summary results from database analyze. logger.startGroup(`Analysis summary for ${language}`); printLinesOfCodeSummary(logger, language, await locPromise); logger.info(analysisSummary); logger.endGroup(); } catch (e) { logger.info(e); statusReport.analyze_failure_language = language; throw new CodeQLAnalysisError(statusReport, `Error running analysis for ${language}: ${e}`); } } return statusReport; async function runQueryGroup(language, type, queries, destinationFolder, searchPath) { const databasePath = util.getCodeQLDatabasePath(config, language); // Pass the queries to codeql using a file instead of using the command // line to avoid command line length restrictions, particularly on windows. const querySuitePath = `${databasePath}-queries-${type}.qls`; const querySuiteContents = queries .map((q) => `- query: ${q}`) .join("\n"); fs.writeFileSync(querySuitePath, querySuiteContents); logger.debug(`Query suite file for ${language}...\n${querySuiteContents}`); const sarifFile = path.join(destinationFolder, `${language}-${type}.sarif`); const codeql = codeql_1.getCodeQL(config.codeQLCmd); const databaseAnalyzeStdout = await codeql.databaseAnalyze(databasePath, sarifFile, searchPath, querySuitePath, memoryFlag, addSnippetsFlag, threadsFlag, automationDetailsId); logger.debug(`SARIF results for database ${language} created at "${sarifFile}"`); return { sarifFile, stdout: databaseAnalyzeStdout }; } } exports.runQueries = runQueries; async function runAnalyze(outputDir, memoryFlag, addSnippetsFlag, threadsFlag, automationDetailsId, config, logger) { // Delete the tracer config env var to avoid tracing ourselves delete process.env[sharedEnv.ODASA_TRACER_CONFIGURATION]; fs.mkdirSync(outputDir, { recursive: true }); logger.info("Finalizing database creation"); await finalizeDatabaseCreation(config, threadsFlag, logger); logger.info("Analyzing database"); const queriesStats = await runQueries(outputDir, memoryFlag, addSnippetsFlag, threadsFlag, automationDetailsId, config, logger); return { ...queriesStats }; } exports.runAnalyze = runAnalyze; async function injectLinesOfCode(sarifFile, language, locPromise) { const lineCounts = await locPromise; const idPrefix = count_loc_1.getIdPrefix(language); if (language in lineCounts) { const sarif = JSON.parse(fs.readFileSync(sarifFile, "utf8")); if (Array.isArray(sarif.runs)) { for (const run of sarif.runs) { const ruleId = `${idPrefix}/summary/lines-of-code`; run.properties = run.properties || {}; run.properties.metricResults = run.properties.metricResults || []; const rule = run.properties.metricResults.find( // the rule id can be in either of two places (r) => { var _a; return r.ruleId === ruleId || ((_a = r.rule) === null || _a === void 0 ? void 0 : _a.id) === ruleId; }); // only add the baseline value if the rule already exists if (rule) { rule.baseline = lineCounts[language]; } } } fs.writeFileSync(sarifFile, JSON.stringify(sarif)); } } function printLinesOfCodeSummary(logger, language, lineCounts) { if (language in lineCounts) { logger.info(`Counted ${lineCounts[language]} lines of code for ${language} as a baseline.`); } } //# sourceMappingURL=analyze.js.map