"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 () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); Object.defineProperty(exports, "__esModule", { value: true }); exports.getFileOidsUnderPath = exports.getGitRoot = exports.decodeGitFilePath = exports.gitRepack = exports.gitFetch = exports.deepenGitHistory = exports.determineBaseBranchHeadCommitOid = exports.getCommitOid = exports.runGitCommand = void 0; exports.getRef = getRef; exports.isAnalyzingDefaultBranch = isAnalyzingDefaultBranch; const core = __importStar(require("@actions/core")); const toolrunner = __importStar(require("@actions/exec/lib/toolrunner")); const io = __importStar(require("@actions/io")); const actions_util_1 = require("./actions-util"); const util_1 = require("./util"); const runGitCommand = async function (workingDirectory, args, customErrorMessage) { let stdout = ""; let stderr = ""; core.debug(`Running git command: git ${args.join(" ")}`); try { await new toolrunner.ToolRunner(await io.which("git", true), args, { silent: true, listeners: { stdout: (data) => { stdout += data.toString(); }, stderr: (data) => { stderr += data.toString(); }, }, cwd: workingDirectory, }).exec(); return stdout; } catch (error) { let reason = stderr; if (stderr.includes("not a git repository")) { reason = "The checkout path provided to the action does not appear to be a git repository."; } core.info(`git call failed. ${customErrorMessage} Error: ${reason}`); throw error; } }; exports.runGitCommand = runGitCommand; /** * Gets the SHA of the commit that is currently checked out. */ const getCommitOid = async function (checkoutPath, ref = "HEAD") { // Try to use git to get the current commit SHA. If that fails then // log but otherwise silently fall back to using the SHA from the environment. // The only time these two values will differ is during analysis of a PR when // the workflow has changed the current commit to the head commit instead of // the merge commit, which must mean that git is available. // Even if this does go wrong, it's not a huge problem for the alerts to // reported on the merge commit. try { const stdout = await (0, exports.runGitCommand)(checkoutPath, ["rev-parse", ref], "Continuing with commit SHA from user input or environment."); return stdout.trim(); } catch { return (0, actions_util_1.getOptionalInput)("sha") || (0, util_1.getRequiredEnvParam)("GITHUB_SHA"); } }; exports.getCommitOid = getCommitOid; /** * If the action was triggered by a pull request, determine the commit sha at * the head of the base branch, using the merge commit that this workflow analyzes. * Returns undefined if run by other triggers or the base branch commit cannot be * determined. */ const determineBaseBranchHeadCommitOid = async function (checkoutPathOverride) { if ((0, actions_util_1.getWorkflowEventName)() !== "pull_request") { return undefined; } const mergeSha = (0, util_1.getRequiredEnvParam)("GITHUB_SHA"); const checkoutPath = checkoutPathOverride ?? (0, actions_util_1.getOptionalInput)("checkout_path"); try { let commitOid = ""; let baseOid = ""; let headOid = ""; const stdout = await (0, exports.runGitCommand)(checkoutPath, ["show", "-s", "--format=raw", mergeSha], "Will calculate the base branch SHA on the server."); for (const data of stdout.split("\n")) { if (data.startsWith("commit ") && commitOid === "") { commitOid = data.substring(7); } else if (data.startsWith("parent ")) { if (baseOid === "") { baseOid = data.substring(7); } else if (headOid === "") { headOid = data.substring(7); } } } // Let's confirm our assumptions: We had a merge commit and the parsed parent data looks correct if (commitOid === mergeSha && headOid.length === 40 && baseOid.length === 40) { return baseOid; } return undefined; } catch { return undefined; } }; exports.determineBaseBranchHeadCommitOid = determineBaseBranchHeadCommitOid; /** * Deepen the git history of HEAD by one level. Errors are logged. * * This function uses the `checkout_path` to determine the repository path and * works only when called from `analyze` or `upload-sarif`. */ const deepenGitHistory = async function () { try { await (0, exports.runGitCommand)((0, actions_util_1.getOptionalInput)("checkout_path"), [ "fetch", "origin", "HEAD", "--no-tags", "--no-recurse-submodules", "--deepen=1", ], "Cannot deepen the shallow repository."); } catch { // Errors are already logged by runGitCommand() } }; exports.deepenGitHistory = deepenGitHistory; /** * Fetch the given remote branch. Errors are logged. * * This function uses the `checkout_path` to determine the repository path and * works only when called from `analyze` or `upload-sarif`. */ const gitFetch = async function (branch, extraFlags) { try { await (0, exports.runGitCommand)((0, actions_util_1.getOptionalInput)("checkout_path"), ["fetch", "--no-tags", ...extraFlags, "origin", `${branch}:${branch}`], `Cannot fetch ${branch}.`); } catch { // Errors are already logged by runGitCommand() } }; exports.gitFetch = gitFetch; /** * Repack the git repository, using with the given flags. Errors are logged. * * This function uses the `checkout_path` to determine the repository path and * works only when called from `analyze` or `upload-sarif`. */ const gitRepack = async function (flags) { try { await (0, exports.runGitCommand)((0, actions_util_1.getOptionalInput)("checkout_path"), ["repack", ...flags], "Cannot repack the repository."); } catch { // Errors are already logged by runGitCommand() } }; exports.gitRepack = gitRepack; /** * Decode, if necessary, a file path produced by Git. See * https://git-scm.com/docs/git-config#Documentation/git-config.txt-corequotePath * for details on how Git encodes file paths with special characters. * * This function works only for Git output with `core.quotePath=false`. */ const decodeGitFilePath = function (filePath) { if (filePath.startsWith('"') && filePath.endsWith('"')) { filePath = filePath.substring(1, filePath.length - 1); return filePath.replace(/\\([abfnrtv\\"]|[0-7]{1,3})/g, (_match, seq) => { switch (seq[0]) { case "a": return "\x07"; case "b": return "\b"; case "f": return "\f"; case "n": return "\n"; case "r": return "\r"; case "t": return "\t"; case "v": return "\v"; case "\\": return "\\"; case '"': return '"'; default: // Both String.fromCharCode() and String.fromCodePoint() works only // for constructing an entire character at once. If a Unicode // character is encoded as a sequence of escaped bytes, calling these // methods sequentially on the individual byte values would *not* // produce the original multi-byte Unicode character. As a result, // this implementation works only with the Git option core.quotePath // set to false. return String.fromCharCode(parseInt(seq, 8)); } }); } return filePath; }; exports.decodeGitFilePath = decodeGitFilePath; /** * Get the root of the Git repository. * * @param sourceRoot The source root of the code being analyzed. * @returns The root of the Git repository. */ const getGitRoot = async function (sourceRoot) { try { const stdout = await (0, exports.runGitCommand)(sourceRoot, ["rev-parse", "--show-toplevel"], `Cannot find Git repository root from the source root ${sourceRoot}.`); return stdout.trim(); } catch { // Errors are already logged by runGitCommand() return undefined; } }; exports.getGitRoot = getGitRoot; /** * Returns the Git OIDs of all tracked files (in the index and in the working * tree) that are under the given base path, including files in active * submodules. Untracked files and files not under the given base path are * ignored. * * @param basePath A path into the Git repository. * @returns a map from file paths (relative to `basePath`) to Git OIDs. * @throws {Error} if "git ls-tree" produces unexpected output. */ const getFileOidsUnderPath = async function (basePath) { // Without the --full-name flag, the path is relative to the current working // directory of the git command, which is basePath. const stdout = await (0, exports.runGitCommand)(basePath, ["ls-files", "--recurse-submodules", "--format=%(objectname)_%(path)"], "Cannot list Git OIDs of tracked files."); const fileOidMap = {}; // With --format=%(objectname)_%(path), the output is a list of lines like: // 30d998ded095371488be3a729eb61d86ed721a18_lib/git-utils.js // d89514599a9a99f22b4085766d40af7b99974827_lib/git-utils.js.map const regex = /^([0-9a-f]{40})_(.+)$/; for (const line of stdout.split("\n")) { if (line) { const match = line.match(regex); if (match) { const oid = match[1]; const path = (0, exports.decodeGitFilePath)(match[2]); fileOidMap[path] = oid; } else { throw new Error(`Unexpected "git ls-files" output: ${line}`); } } } return fileOidMap; }; exports.getFileOidsUnderPath = getFileOidsUnderPath; function getRefFromEnv() { // To workaround a limitation of Actions dynamic workflows not setting // the GITHUB_REF in some cases, we accept also the ref within the // CODE_SCANNING_REF variable. When possible, however, we prefer to use // the GITHUB_REF as that is a protected variable and cannot be overwritten. let refEnv; try { refEnv = (0, util_1.getRequiredEnvParam)("GITHUB_REF"); } catch (e) { // If the GITHUB_REF is not set, we try to rescue by getting the // CODE_SCANNING_REF. const maybeRef = process.env["CODE_SCANNING_REF"]; if (maybeRef === undefined || maybeRef.length === 0) { throw e; } refEnv = maybeRef; } return refEnv; } /** * Get the ref currently being analyzed. */ async function getRef() { // Will be in the form "refs/heads/master" on a push event // or in the form "refs/pull/N/merge" on a pull_request event const refInput = (0, actions_util_1.getOptionalInput)("ref"); const shaInput = (0, actions_util_1.getOptionalInput)("sha"); const checkoutPath = (0, actions_util_1.getOptionalInput)("checkout_path") || (0, actions_util_1.getOptionalInput)("source-root") || (0, util_1.getRequiredEnvParam)("GITHUB_WORKSPACE"); const hasRefInput = !!refInput; const hasShaInput = !!shaInput; // If one of 'ref' or 'sha' are provided, both are required if ((hasRefInput || hasShaInput) && !(hasRefInput && hasShaInput)) { throw new util_1.ConfigurationError("Both 'ref' and 'sha' are required if one of them is provided."); } const ref = refInput || getRefFromEnv(); const sha = shaInput || (0, util_1.getRequiredEnvParam)("GITHUB_SHA"); // If the ref is a user-provided input, we have to skip logic // and assume that it is really where they want to upload the results. if (refInput) { return refInput; } // For pull request refs we want to detect whether the workflow // has run `git checkout HEAD^2` to analyze the 'head' ref rather // than the 'merge' ref. If so, we want to convert the ref that // we report back. const pull_ref_regex = /refs\/pull\/(\d+)\/merge/; if (!pull_ref_regex.test(ref)) { return ref; } const head = await (0, exports.getCommitOid)(checkoutPath, "HEAD"); // in actions/checkout@v2+ we can check if git rev-parse HEAD == GITHUB_SHA // in actions/checkout@v1 this may not be true as it checks out the repository // using GITHUB_REF. There is a subtle race condition where // git rev-parse GITHUB_REF != GITHUB_SHA, so we must check // git rev-parse GITHUB_REF == git rev-parse HEAD instead. const hasChangedRef = sha !== head && (await (0, exports.getCommitOid)(checkoutPath, ref.replace(/^refs\/pull\//, "refs/remotes/pull/"))) !== head; if (hasChangedRef) { const newRef = ref.replace(pull_ref_regex, "refs/pull/$1/head"); core.debug(`No longer on merge commit, rewriting ref from ${ref} to ${newRef}.`); return newRef; } else { return ref; } } function removeRefsHeadsPrefix(ref) { return ref.startsWith("refs/heads/") ? ref.slice("refs/heads/".length) : ref; } /** * Returns whether we are analyzing the default branch for the repository. * * This first checks the environment variable `CODE_SCANNING_IS_ANALYZING_DEFAULT_BRANCH`. This * environment variable can be set in cases where repository information might not be available, for * example dynamic workflows. */ async function isAnalyzingDefaultBranch() { if (process.env.CODE_SCANNING_IS_ANALYZING_DEFAULT_BRANCH === "true") { return true; } // Get the current ref and trim and refs/heads/ prefix let currentRef = await getRef(); currentRef = removeRefsHeadsPrefix(currentRef); const event = (0, actions_util_1.getWorkflowEvent)(); let defaultBranch = event?.repository?.default_branch; if ((0, actions_util_1.getWorkflowEventName)() === "schedule") { defaultBranch = removeRefsHeadsPrefix(getRefFromEnv()); } return currentRef === defaultBranch; } //# sourceMappingURL=git-utils.js.map