Allow testing workflow parsing functionality from PR checks

lib/init-action-post-helper.test.js

@@ -38,6 +38,7 @@ const workflow = __importStar(require("./workflow"));
 (0, testing_utils_1.setupTests)(ava_1.default);
 (0, ava_1.default)("post: init action with debug mode off", async (t) => {
     return await util.withTmpDir(async (tmpDir) => {
+        process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
         process.env["RUNNER_TEMP"] = tmpDir;
         const gitHubVersion = {
             type: util.GitHubVariant.DOTCOM,
@@ -59,6 +60,7 @@ const workflow = __importStar(require("./workflow"));
 });
 (0, ava_1.default)("post: init action with debug mode on", async (t) => {
     return await util.withTmpDir(async (tmpDir) => {
+        process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
         process.env["RUNNER_TEMP"] = tmpDir;
         const gitHubVersion = {
             type: util.GitHubVariant.DOTCOM,
@@ -139,6 +141,7 @@ async function testFailedSarifUpload(t, actionsWorkflow, { category } = {}) {
     };
     const messages = [];
     process.env["GITHUB_JOB"] = "analyze";
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     process.env["GITHUB_WORKSPACE"] =
         "/home/runner/work/codeql-action/codeql-action";
     sinon.stub(actionsUtil, "getRequiredInput").withArgs("matrix").returns("{}");

lib/workflow.js

@@ -293,6 +293,19 @@ function getInputOrThrow(workflow, jobName, actionName, inputName, matrixVars) {
     }
     return input;
 }
+/**
+ * Get the expected name of the analyze Action.
+ *
+ * This allows us to test workflow parsing functionality as a CodeQL Action PR check.
+ */
+function getAnalyzeActionName() {
+    if ((0, util_1.getRequiredEnvParam)("GITHUB_REPOSITORY") === "github/codeql-action") {
+        return "./analyze";
+    }
+    else {
+        return "github/codeql-action/analyze";
+    }
+}
 /**
  * Makes a best effort attempt to retrieve the category input for the particular job,
  * given a set of matrix variables.
@@ -303,7 +316,7 @@ function getInputOrThrow(workflow, jobName, actionName, inputName, matrixVars) {
  * @throws an error if the category input could not be determined
  */
 function getCategoryInputOrThrow(workflow, jobName, matrixVars) {
-    return getInputOrThrow(workflow, jobName, "github/codeql-action/analyze", "category", matrixVars);
+    return getInputOrThrow(workflow, jobName, getAnalyzeActionName(), "category", matrixVars);
 }
 exports.getCategoryInputOrThrow = getCategoryInputOrThrow;
 /**
@@ -316,7 +329,7 @@ exports.getCategoryInputOrThrow = getCategoryInputOrThrow;
  * @throws an error if the upload input could not be determined
  */
 function getUploadInputOrThrow(workflow, jobName, matrixVars) {
-    return (getInputOrThrow(workflow, jobName, "github/codeql-action/analyze", "upload", matrixVars) || "true" // if unspecified, upload defaults to true
+    return (getInputOrThrow(workflow, jobName, getAnalyzeActionName(), "upload", matrixVars) || "true" // if unspecified, upload defaults to true
     );
 }
 exports.getUploadInputOrThrow = getUploadInputOrThrow;
@@ -330,7 +343,7 @@ exports.getUploadInputOrThrow = getUploadInputOrThrow;
  * @throws an error if the checkout_path input could not be determined
  */
 function getCheckoutPathInputOrThrow(workflow, jobName, matrixVars) {
-    return (getInputOrThrow(workflow, jobName, "github/codeql-action/analyze", "checkout_path", matrixVars) || (0, util_1.getRequiredEnvParam)("GITHUB_WORKSPACE") // if unspecified, checkout_path defaults to ${{ github.workspace }}
+    return (getInputOrThrow(workflow, jobName, getAnalyzeActionName(), "checkout_path", matrixVars) || (0, util_1.getRequiredEnvParam)("GITHUB_WORKSPACE") // if unspecified, checkout_path defaults to ${{ github.workspace }}
     );
 }
 exports.getCheckoutPathInputOrThrow = getCheckoutPathInputOrThrow;

lib/workflow.test.js

@@ -356,6 +356,7 @@ function errorCodes(actual, expected) {
   `)), []));
 });
 (0, ava_1.default)("getCategoryInputOrThrow returns category for simple workflow with category", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.is((0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
         jobs:
           analysis:
@@ -369,6 +370,7 @@ function errorCodes(actual, expected) {
       `), "analysis", {}), "some-category");
 });
 (0, ava_1.default)("getCategoryInputOrThrow returns undefined for simple workflow without category", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.is((0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
         jobs:
           analysis:
@@ -380,6 +382,7 @@ function errorCodes(actual, expected) {
       `), "analysis", {}), undefined);
 });
 (0, ava_1.default)("getCategoryInputOrThrow returns category for workflow with multiple jobs", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.is((0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
         jobs:
           foo:
@@ -403,6 +406,7 @@ function errorCodes(actual, expected) {
       `), "bar", {}), "bar-category");
 });
 (0, ava_1.default)("getCategoryInputOrThrow finds category for workflow with language matrix", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.is((0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
         jobs:
           analysis:
@@ -421,6 +425,7 @@ function errorCodes(actual, expected) {
       `), "analysis", { language: "javascript" }), "/language:javascript");
 });
 (0, ava_1.default)("getCategoryInputOrThrow throws error for workflow with dynamic category", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.throws(() => (0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
           jobs:
             analysis:
@@ -436,6 +441,7 @@ function errorCodes(actual, expected) {
     });
 });
 (0, ava_1.default)("getCategoryInputOrThrow throws error for workflow with multiple calls to analyze", (t) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     t.throws(() => (0, workflow_1.getCategoryInputOrThrow)(yaml.load(`
           jobs:
             analysis:

src/init-action-post-helper.test.ts

@@ -21,6 +21,7 @@ setupTests(test);
 
 test("post: init action with debug mode off", async (t) => {
   return await util.withTmpDir(async (tmpDir) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     process.env["RUNNER_TEMP"] = tmpDir;
 
     const gitHubVersion: util.GitHubVersion = {
@@ -54,6 +55,7 @@ test("post: init action with debug mode off", async (t) => {
 
 test("post: init action with debug mode on", async (t) => {
   return await util.withTmpDir(async (tmpDir) => {
+    process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
     process.env["RUNNER_TEMP"] = tmpDir;
 
     const gitHubVersion: util.GitHubVersion = {
@@ -157,6 +159,7 @@ async function testFailedSarifUpload(
   } as unknown as configUtils.Config;
   const messages = [];
   process.env["GITHUB_JOB"] = "analyze";
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   process.env["GITHUB_WORKSPACE"] =
     "/home/runner/work/codeql-action/codeql-action";
   sinon.stub(actionsUtil, "getRequiredInput").withArgs("matrix").returns("{}");

src/workflow.test.ts

@@ -525,6 +525,7 @@ test("getWorkflowErrors() should not report an error if PRs are totally unconfig
 });
 
 test("getCategoryInputOrThrow returns category for simple workflow with category", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.is(
     getCategoryInputOrThrow(
       yaml.load(`
@@ -546,6 +547,7 @@ test("getCategoryInputOrThrow returns category for simple workflow with category
 });
 
 test("getCategoryInputOrThrow returns undefined for simple workflow without category", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.is(
     getCategoryInputOrThrow(
       yaml.load(`
@@ -565,6 +567,7 @@ test("getCategoryInputOrThrow returns undefined for simple workflow without cate
 });
 
 test("getCategoryInputOrThrow returns category for workflow with multiple jobs", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.is(
     getCategoryInputOrThrow(
       yaml.load(`
@@ -596,6 +599,7 @@ test("getCategoryInputOrThrow returns category for workflow with multiple jobs",
 });
 
 test("getCategoryInputOrThrow finds category for workflow with language matrix", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.is(
     getCategoryInputOrThrow(
       yaml.load(`
@@ -622,6 +626,7 @@ test("getCategoryInputOrThrow finds category for workflow with language matrix",
 });
 
 test("getCategoryInputOrThrow throws error for workflow with dynamic category", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.throws(
     () =>
       getCategoryInputOrThrow(
@@ -647,6 +652,7 @@ test("getCategoryInputOrThrow throws error for workflow with dynamic category",
 });
 
 test("getCategoryInputOrThrow throws error for workflow with multiple calls to analyze", (t) => {
+  process.env["GITHUB_REPOSITORY"] = "github/codeql-action-fake-repository";
   t.throws(
     () =>
       getCategoryInputOrThrow(

src/workflow.ts

@@ -368,6 +368,19 @@ function getInputOrThrow(
   return input;
 }
 
+/**
+ * Get the expected name of the analyze Action.
+ *
+ * This allows us to test workflow parsing functionality as a CodeQL Action PR check.
+ */
+function getAnalyzeActionName() {
+  if (getRequiredEnvParam("GITHUB_REPOSITORY") === "github/codeql-action") {
+    return "./analyze";
+  } else {
+    return "github/codeql-action/analyze";
+  }
+}
+
 /**
  * Makes a best effort attempt to retrieve the category input for the particular job,
  * given a set of matrix variables.
@@ -385,7 +398,7 @@ export function getCategoryInputOrThrow(
   return getInputOrThrow(
     workflow,
     jobName,
-    "github/codeql-action/analyze",
+    getAnalyzeActionName(),
     "category",
     matrixVars
   );
@@ -409,7 +422,7 @@ export function getUploadInputOrThrow(
     getInputOrThrow(
       workflow,
       jobName,
-      "github/codeql-action/analyze",
+      getAnalyzeActionName(),
       "upload",
       matrixVars
     ) || "true" // if unspecified, upload defaults to true
@@ -434,7 +447,7 @@ export function getCheckoutPathInputOrThrow(
     getInputOrThrow(
       workflow,
       jobName,
-      "github/codeql-action/analyze",
+      getAnalyzeActionName(),
       "checkout_path",
       matrixVars
     ) || getRequiredEnvParam("GITHUB_WORKSPACE") // if unspecified, checkout_path defaults to ${{ github.workspace }}