Merge branch 'main' into robertbrignull/go_build_trace

src/actions-util.test.ts

@@ -33,16 +33,28 @@ test("getRef() returns head PR ref if GITHUB_SHA not currently checked out", asy
   t.deepEqual(actualRef, "refs/pull/1/head");
 });
 
-test("prepareEnvironment() when a local run", (t) => {
-  const origLocalRun = process.env.CODEQL_LOCAL_RUN;
+test("getAnalysisKey() when a local run", async (t) => {
+  process.env.CODEQL_LOCAL_RUN = "true";
+  process.env.CODEQL_ACTION_ANALYSIS_KEY = "";
+  process.env.GITHUB_JOB = "";
 
+  actionsutil.prepareLocalRunEnvironment();
+
+  const actualAnalysisKey = await actionsutil.getAnalysisKey();
+
+  t.deepEqual(actualAnalysisKey, "LOCAL-RUN:UNKNOWN-JOB");
+});
+
+test("prepareEnvironment() when a local run", (t) => {
   process.env.CODEQL_LOCAL_RUN = "false";
   process.env.GITHUB_JOB = "YYY";
+  process.env.CODEQL_ACTION_ANALYSIS_KEY = "TEST";
 
   actionsutil.prepareLocalRunEnvironment();
 
   // unchanged
   t.deepEqual(process.env.GITHUB_JOB, "YYY");
+  t.deepEqual(process.env.CODEQL_ACTION_ANALYSIS_KEY, "TEST");
 
   process.env.CODEQL_LOCAL_RUN = "true";
 
@@ -50,13 +62,22 @@ test("prepareEnvironment() when a local run", (t) => {
 
   // unchanged
   t.deepEqual(process.env.GITHUB_JOB, "YYY");
+  t.deepEqual(process.env.CODEQL_ACTION_ANALYSIS_KEY, "TEST");
+
+  process.env.CODEQL_ACTION_ANALYSIS_KEY = "";
+
+  actionsutil.prepareLocalRunEnvironment();
+
+  // updated
+  t.deepEqual(process.env.GITHUB_JOB, "YYY");
+  t.deepEqual(process.env.CODEQL_ACTION_ANALYSIS_KEY, "LOCAL-RUN:YYY");
 
   process.env.GITHUB_JOB = "";
+  process.env.CODEQL_ACTION_ANALYSIS_KEY = "";
 
   actionsutil.prepareLocalRunEnvironment();
 
   // updated
   t.deepEqual(process.env.GITHUB_JOB, "UNKNOWN-JOB");
-
-  process.env.CODEQL_LOCAL_RUN = origLocalRun;
+  t.deepEqual(process.env.CODEQL_ACTION_ANALYSIS_KEY, "LOCAL-RUN:UNKNOWN-JOB");
 });

src/actions-util.ts

@@ -52,6 +52,12 @@ export function prepareLocalRunEnvironment() {
   if (!process.env.GITHUB_JOB) {
     core.exportVariable("GITHUB_JOB", "UNKNOWN-JOB");
   }
+  if (!process.env.CODEQL_ACTION_ANALYSIS_KEY) {
+    core.exportVariable(
+      "CODEQL_ACTION_ANALYSIS_KEY",
+      `LOCAL-RUN:${process.env.GITHUB_JOB}`
+    );
+  }
 }
 
 /**

src/codeql.ts

@@ -132,14 +132,17 @@ function getCodeQLBundleName(): string {
   return `codeql-bundle-${platform}.tar.gz`;
 }
 
-function getCodeQLActionRepository(mode: util.Mode): string {
+function getCodeQLActionRepository(mode: util.Mode, logger: Logger): string {
   if (mode !== "actions") {
     return CODEQL_DEFAULT_ACTION_REPOSITORY;
   }
 
-  // Actions do not know their own repository name,
-  // so we currently use this hack to find the name based on where our files are.
-  // This can be removed once the change to the runner in https://github.com/actions/runner/pull/585 is deployed.
+  if (process.env["GITHUB_ACTION_REPOSITORY"] !== undefined) {
+    return process.env["GITHUB_ACTION_REPOSITORY"];
+  }
+
+  // The Actions Runner used with GitHub Enterprise Server 2.22 did not set the GITHUB_ACTION_REPOSITORY variable.
+  // This fallback logic can be removed after the end-of-support for 2.22 on 2021-09-23.
   const runnerTemp = getRequiredEnvParam("RUNNER_TEMP");
   const actionsDirectory = path.join(path.dirname(runnerTemp), "_actions");
   const relativeScriptPath = path.relative(actionsDirectory, __filename);
@@ -149,8 +152,14 @@ function getCodeQLActionRepository(mode: util.Mode): string {
     relativeScriptPath.startsWith("..") ||
     path.isAbsolute(relativeScriptPath)
   ) {
+    logger.info(
+      "The CodeQL Action is checked out locally. Using the default CodeQL Action repository."
+    );
     return CODEQL_DEFAULT_ACTION_REPOSITORY;
   }
+  logger.info(
+    "GITHUB_ACTION_REPOSITORY environment variable was not set. Falling back to legacy method of finding the GitHub Action."
+  );
   const relativeScriptPathParts = relativeScriptPath.split(path.sep);
   return `${relativeScriptPathParts[0]}/${relativeScriptPathParts[1]}`;
 }
@@ -161,7 +170,7 @@ async function getCodeQLBundleDownloadURL(
   mode: util.Mode,
   logger: Logger
 ): Promise<string> {
-  const codeQLActionRepository = getCodeQLActionRepository(mode);
+  const codeQLActionRepository = getCodeQLActionRepository(mode, logger);
   const potentialDownloadSources = [
     // This GitHub instance, and this Action.
     [githubUrl, codeQLActionRepository],

src/defaults.json

@@ -1,3 +1,3 @@
 {
-	"bundleVersion": "codeql-bundle-20201028"
+	"bundleVersion": "codeql-bundle-20201106"
 }

src/init-action.ts

@@ -176,6 +176,8 @@ async function run() {
         );
       }
     }
+
+    core.setOutput("codeql-path", config.codeQLCmd);
   } catch (error) {
     core.setFailed(error.message);
     console.log(error);

src/init.ts

@@ -155,6 +155,10 @@ export async function injectWindowsTracer(
           Write-Host "Found Runner.Worker.exe process which means we are running on GitHub Actions"
           Write-Host "Aborting search early and using process: $p"
           Break
+        } elseif ($p[0].Name -eq "Agent.Worker.exe") {
+          Write-Host "Found Agent.Worker.exe process which means we are running on Azure Pipelines"
+          Write-Host "Aborting search early and using process: $p"
+          Break
         } else {
           $id = $p[0].ParentProcessId
         }

src/util.test.ts

@@ -72,8 +72,6 @@ test("getThreadsFlag() throws if the threads input is not an integer", (t) => {
 });
 
 test("isLocalRun() runs correctly", (t) => {
-  const origLocalRun = process.env.CODEQL_LOCAL_RUN;
-
   process.env.CODEQL_LOCAL_RUN = "";
   t.assert(!util.isLocalRun());
 
@@ -88,8 +86,6 @@ test("isLocalRun() runs correctly", (t) => {
 
   process.env.CODEQL_LOCAL_RUN = "hucairz";
   t.assert(util.isLocalRun());
-
-  process.env.CODEQL_LOCAL_RUN = origLocalRun;
 });
 
 test("getExtraOptionsEnvParam() succeeds on valid JSON with invalid options (for now)", (t) => {