"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 }); exports.runCleanup = exports.warnIfGoInstalledAfterInit = exports.runFinalize = exports.runQueries = exports.dbIsFinalized = exports.runExtraction = exports.CodeQLAnalysisError = void 0; const fs = __importStar(require("fs")); const path = __importStar(require("path")); const perf_hooks_1 = require("perf_hooks"); const safe_which_1 = require("@chrisgavin/safe-which"); const del_1 = __importDefault(require("del")); const yaml = __importStar(require("js-yaml")); const autobuild_1 = require("./autobuild"); const codeql_1 = require("./codeql"); const diagnostics_1 = require("./diagnostics"); const environment_1 = require("./environment"); const feature_flags_1 = require("./feature-flags"); const languages_1 = require("./languages"); const tools_features_1 = require("./tools-features"); const tracer_config_1 = require("./tracer-config"); const upload_lib_1 = require("./upload-lib"); const util = __importStar(require("./util")); const util_1 = 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; } logger.warning("The CODEQL_PYTHON environment variable is no longer supported. Please remove it from your workflow. This environment variable was originally used to specify a Python executable that included the dependencies of your Python code, however Python analysis no longer uses these dependencies." + "\nIf you used CODEQL_PYTHON to force the version of Python to analyze as, please use CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION instead, such as 'CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION=2.7' or 'CODEQL_EXTRACTOR_PYTHON_ANALYSIS_VERSION=3.11'."); return; } async function runExtraction(codeql, config, logger) { for (const language of config.languages) { if (dbIsFinalized(config, language, logger)) { logger.debug(`Database for ${language} has already been finalized, skipping extraction.`); continue; } if (shouldExtractLanguage(config, language)) { logger.startGroup(`Extracting ${language}`); if (language === languages_1.Language.python) { await setupPythonExtractor(logger); } if (config.buildMode && (await codeql.supportsFeature(tools_features_1.ToolsFeature.TraceCommandUseBuildMode))) { if (language === languages_1.Language.cpp && config.buildMode === util_1.BuildMode.Autobuild) { await (0, autobuild_1.setupCppAutobuild)(codeql, logger); } await codeql.extractUsingBuildMode(config, language); } else { await codeql.extractScannedLanguage(config, language); } logger.endGroup(); } } } exports.runExtraction = runExtraction; function shouldExtractLanguage(config, language) { return (config.buildMode === util_1.BuildMode.None || (config.buildMode === util_1.BuildMode.Autobuild && process.env[environment_1.EnvVar.AUTOBUILD_DID_COMPLETE_SUCCESSFULLY] !== "true") || (!config.buildMode && (0, languages_1.isScannedLanguage)(language))); } function dbIsFinalized(config, language, logger) { const dbPath = util.getCodeQLDatabasePath(config, language); try { const dbInfo = yaml.load(fs.readFileSync(path.resolve(dbPath, "codeql-database.yml"), "utf8")); return !("inProgress" in dbInfo); } catch (e) { logger.warning(`Could not check whether database for ${language} was finalized. Assuming it is not.`); return false; } } exports.dbIsFinalized = dbIsFinalized; async function finalizeDatabaseCreation(codeql, config, threadsFlag, memoryFlag, logger) { const extractionStart = perf_hooks_1.performance.now(); await runExtraction(codeql, config, logger); const extractionTime = perf_hooks_1.performance.now() - extractionStart; const trapImportStart = perf_hooks_1.performance.now(); for (const language of config.languages) { if (dbIsFinalized(config, language, logger)) { logger.info(`There is already a finalized database for ${language} at the location where the CodeQL Action places databases, so we did not create one.`); } else { logger.startGroup(`Finalizing ${language}`); await codeql.finalizeDatabase(util.getCodeQLDatabasePath(config, language), threadsFlag, memoryFlag, config.debugMode); logger.endGroup(); } } const trapImportTime = perf_hooks_1.performance.now() - trapImportStart; return { scanned_language_extraction_duration_ms: Math.round(extractionTime), trap_import_duration_ms: Math.round(trapImportTime), }; } // Runs queries and creates sarif files in the given folder async function runQueries(sarifFolder, memoryFlag, addSnippetsFlag, threadsFlag, automationDetailsId, config, logger, features) { const statusReport = {}; const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd); const queryFlags = [memoryFlag, threadsFlag]; for (const language of config.languages) { try { const sarifFile = path.join(sarifFolder, `${language}.sarif`); // The work needed to generate the query suites // is done in the CLI. We just need to make a single // call to run all the queries for each language and // another to interpret the results. logger.startGroup(`Running queries for ${language}`); const startTimeRunQueries = new Date().getTime(); const databasePath = util.getCodeQLDatabasePath(config, language); await codeql.databaseRunQueries(databasePath, queryFlags); logger.debug(`Finished running queries for ${language}.`); // TODO should not be using `builtin` here. We should be using `all` instead. // The status report does not support `all` yet. statusReport[`analyze_builtin_queries_${language}_duration_ms`] = new Date().getTime() - startTimeRunQueries; logger.startGroup(`Interpreting results for ${language}`); const startTimeInterpretResults = new Date(); const analysisSummary = await runInterpretResults(language, undefined, sarifFile, config.debugMode); const endTimeInterpretResults = new Date(); statusReport[`interpret_results_${language}_duration_ms`] = endTimeInterpretResults.getTime() - startTimeInterpretResults.getTime(); logger.endGroup(); logger.info(analysisSummary); if (await features.getValue(feature_flags_1.Feature.QaTelemetryEnabled)) { const perQueryAlertCounts = getPerQueryAlertCounts(sarifFile, logger); const perQueryAlertCountEventReport = { event: "codeql database interpret-results", started_at: startTimeInterpretResults.toISOString(), completed_at: endTimeInterpretResults.toISOString(), exit_status: "success", language, properties: { alertCounts: perQueryAlertCounts, }, }; if (statusReport["event_reports"] === undefined) { statusReport["event_reports"] = []; } statusReport["event_reports"].push(perQueryAlertCountEventReport); } if (!(await util.codeQlVersionAtLeast(codeql, codeql_1.CODEQL_VERSION_ANALYSIS_SUMMARY_V2))) { await runPrintLinesOfCode(language); } } catch (e) { statusReport.analyze_failure_language = language; throw new CodeQLAnalysisError(statusReport, `Error running analysis for ${language}: ${util.wrapError(e).message}`); } } return statusReport; async function runInterpretResults(language, queries, sarifFile, enableDebugLogging) { const databasePath = util.getCodeQLDatabasePath(config, language); return await codeql.databaseInterpretResults(databasePath, queries, sarifFile, addSnippetsFlag, threadsFlag, enableDebugLogging ? "-vv" : "-v", automationDetailsId, config, features, logger); } /** Get an object with all queries and their counts parsed from a SARIF file path. */ function getPerQueryAlertCounts(sarifPath, log) { (0, upload_lib_1.validateSarifFileSchema)(sarifPath, log); const sarifObject = JSON.parse(fs.readFileSync(sarifPath, "utf8")); // We do not need to compute fingerprints because we are not sending data based off of locations. // Generate the query: alert count object const perQueryAlertCounts = {}; // All rules (queries), from all results, from all runs for (const sarifRun of sarifObject.runs) { if (sarifRun.results) { for (const result of sarifRun.results) { const query = result.rule?.id || result.ruleId; if (query) { perQueryAlertCounts[query] = (perQueryAlertCounts[query] || 0) + 1; } } } } return perQueryAlertCounts; } async function runPrintLinesOfCode(language) { const databasePath = util.getCodeQLDatabasePath(config, language); return await codeql.databasePrintBaseline(databasePath); } } exports.runQueries = runQueries; async function runFinalize(outputDir, threadsFlag, memoryFlag, codeql, config, features, logger) { try { await (0, del_1.default)(outputDir, { force: true }); } catch (error) { if (error?.code !== "ENOENT") { throw error; } } await fs.promises.mkdir(outputDir, { recursive: true }); const timings = await finalizeDatabaseCreation(codeql, config, threadsFlag, memoryFlag, logger); // If we didn't already end tracing in the autobuild Action, end it now. if (process.env[environment_1.EnvVar.AUTOBUILD_DID_COMPLETE_SUCCESSFULLY] !== "true") { await (0, tracer_config_1.endTracingForCluster)(codeql, config, logger, features); } return timings; } exports.runFinalize = runFinalize; async function warnIfGoInstalledAfterInit(config, logger) { // Check that `which go` still points at the same path it did when the `init` Action ran to ensure that no steps // in-between performed any setup. We encourage users to perform all setup tasks before initializing CodeQL so that // the setup tasks do not interfere with our analysis. // Furthermore, if we installed a wrapper script in the `init` Action, we need to ensure that there isn't a step // in the workflow after the `init` step which installs a different version of Go and takes precedence in the PATH, // thus potentially circumventing our workaround that allows tracing to work. const goInitPath = process.env[environment_1.EnvVar.GO_BINARY_LOCATION]; if (process.env[environment_1.EnvVar.DID_AUTOBUILD_GOLANG] !== "true" && goInitPath !== undefined) { const goBinaryPath = await (0, safe_which_1.safeWhich)("go"); if (goInitPath !== goBinaryPath) { logger.warning(`Expected \`which go\` to return ${goInitPath}, but got ${goBinaryPath}: please ensure that the correct version of Go is installed before the \`codeql-action/init\` Action is used.`); (0, diagnostics_1.addDiagnostic)(config, languages_1.Language.go, (0, diagnostics_1.makeDiagnostic)("go/workflow/go-installed-after-codeql-init", "Go was installed after the `codeql-action/init` Action was run", { markdownMessage: "To avoid interfering with the CodeQL analysis, perform all installation steps before calling the `github/codeql-action/init` Action.", visibility: { statusPage: true, telemetry: true, cliSummaryTable: true, }, severity: "warning", })); } } } exports.warnIfGoInstalledAfterInit = warnIfGoInstalledAfterInit; async function runCleanup(config, cleanupLevel, logger) { logger.startGroup("Cleaning up databases"); for (const language of config.languages) { const codeql = await (0, codeql_1.getCodeQL)(config.codeQLCmd); const databasePath = util.getCodeQLDatabasePath(config, language); await codeql.databaseCleanup(databasePath, cleanupLevel); } logger.endGroup(); } exports.runCleanup = runCleanup; //# sourceMappingURL=analyze.js.map