Add tests for generateRegistries with an existing CODEQL_REGISTRIES_AUTH

lib/codeql.test.js

@@ -676,7 +676,7 @@ const injectedConfigMacro = ava_1.default.macro({
     const hasConfigArg = args.some((arg) => arg.startsWith("--codescanning-config="));
     t.false(hasConfigArg, "Should NOT have injected a codescanning config");
     // should not have passed a qlconfig file
-    const hasQlconfigArg = args.find((arg) => arg.startsWith("--qlconfig="));
+    const hasQlconfigArg = args.some((arg) => arg.startsWith("--qlconfig="));
     t.false(hasQlconfigArg, "Should NOT have passed a qlconfig file");
 });
 (0, ava_1.default)("passes a code scanning config AND qlconfig to the CLI when CLI config passing is enabled", async (t) => {

lib/config-utils.js

@@ -1119,7 +1119,7 @@ async function generateRegistries(registriesInput, codeQL, tempDir, logger) {
     return {
         registriesAuthTokens: 
         // if the user has explicitly set the CODEQL_REGISTRIES_AUTH env var then use that
-        process.env["CODEQL_REGISTRIES_AUTH"] ?? registriesAuthTokens,
+        process.env.CODEQL_REGISTRIES_AUTH ?? registriesAuthTokens,
         qlconfigFile,
     };
 }

lib/config-utils.test.js

@@ -1128,7 +1128,7 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
     // associated env vars
     return await util.withTmpDir(async (tmpDir) => {
         process.env.GITHUB_TOKEN = "not-a-token";
-        process.env.CODEQL_REGISTRIES_AUTH = "not-a-registries-auth";
+        process.env.CODEQL_REGISTRIES_AUTH = undefined;
         const logger = (0, logging_1.getRunnerLogger)(true);
         const registriesInput = yaml.dump([
             {
@@ -1187,7 +1187,7 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
         ]);
         // Verify that the env vars were unset.
         t.deepEqual(process.env.GITHUB_TOKEN, "not-a-token");
-        t.deepEqual(process.env.CODEQL_REGISTRIES_AUTH, "not-a-registries-auth");
+        t.deepEqual(process.env.CODEQL_REGISTRIES_AUTH, undefined);
     });
 });
 (0, ava_1.default)("downloadPacks-with-registries fails on 2.10.3", async (t) => {
@@ -1277,6 +1277,26 @@ const calculateAugmentationErrorMacro = ava_1.default.macro({
         t.is(qlconfigFile, undefined);
     });
 });
+(0, ava_1.default)("generateRegistries prefers original CODEQL_REGISTRIES_AUTH", async (t) => {
+    return await util.withTmpDir(async (tmpDir) => {
+        process.env.CODEQL_REGISTRIES_AUTH = "original";
+        const registriesInput = yaml.dump([
+            {
+                url: "http://ghcr.io",
+                packages: ["codeql/*", "dsp-testing/*"],
+                token: "not-a-token",
+            },
+        ]);
+        const codeQL = (0, codeql_1.setCodeQL)({
+            // Accepted CLI versions are 2.10.4 or higher
+            getVersion: () => Promise.resolve(codeql_1.CODEQL_VERSION_GHES_PACK_DOWNLOAD),
+        });
+        const logger = (0, logging_1.getRunnerLogger)(true);
+        const { registriesAuthTokens, qlconfigFile } = await configUtils.generateRegistries(registriesInput, codeQL, tmpDir, logger);
+        t.is(registriesAuthTokens, "original");
+        t.is(qlconfigFile, path.join(tmpDir, "qlconfig.yml"));
+    });
+});
 // getLanguages
 const mockRepositoryNwo = (0, repository_1.parseRepositoryNwo)("owner/repo");
 // eslint-disable-next-line github/array-foreach

src/codeql.test.ts

@@ -1025,7 +1025,7 @@ test("does not pass a code scanning config or qlconfig file to the CLI when CLI
   t.false(hasConfigArg, "Should NOT have injected a codescanning config");
 
   // should not have passed a qlconfig file
-  const hasQlconfigArg = args.find((arg: string) =>
+  const hasQlconfigArg = args.some((arg: string) =>
     arg.startsWith("--qlconfig=")
   );
   t.false(hasQlconfigArg, "Should NOT have passed a qlconfig file");

src/config-utils.test.ts

@@ -2300,7 +2300,7 @@ test("downloadPacks-with-registries", async (t) => {
   // associated env vars
   return await util.withTmpDir(async (tmpDir) => {
     process.env.GITHUB_TOKEN = "not-a-token";
-    process.env.CODEQL_REGISTRIES_AUTH = "not-a-registries-auth";
+    process.env.CODEQL_REGISTRIES_AUTH = undefined;
     const logger = getRunnerLogger(true);
 
     const registriesInput = yaml.dump([
@@ -2382,7 +2382,7 @@ test("downloadPacks-with-registries", async (t) => {
 
     // Verify that the env vars were unset.
     t.deepEqual(process.env.GITHUB_TOKEN, "not-a-token");
-    t.deepEqual(process.env.CODEQL_REGISTRIES_AUTH, "not-a-registries-auth");
+    t.deepEqual(process.env.CODEQL_REGISTRIES_AUTH, undefined);
   });
 });
 
@@ -2521,6 +2521,34 @@ test("no generateRegistries when registries is undefined", async (t) => {
   });
 });
 
+test("generateRegistries prefers original CODEQL_REGISTRIES_AUTH", async (t) => {
+  return await util.withTmpDir(async (tmpDir) => {
+    process.env.CODEQL_REGISTRIES_AUTH = "original";
+    const registriesInput = yaml.dump([
+      {
+        url: "http://ghcr.io",
+        packages: ["codeql/*", "dsp-testing/*"],
+        token: "not-a-token",
+      },
+    ]);
+    const codeQL = setCodeQL({
+      // Accepted CLI versions are 2.10.4 or higher
+      getVersion: () => Promise.resolve(CODEQL_VERSION_GHES_PACK_DOWNLOAD),
+    });
+    const logger = getRunnerLogger(true);
+    const { registriesAuthTokens, qlconfigFile } =
+      await configUtils.generateRegistries(
+        registriesInput,
+        codeQL,
+        tmpDir,
+        logger
+      );
+
+    t.is(registriesAuthTokens, "original");
+    t.is(qlconfigFile, path.join(tmpDir, "qlconfig.yml"));
+  });
+});
+
 // getLanguages
 
 const mockRepositoryNwo = parseRepositoryNwo("owner/repo");

src/config-utils.ts

@@ -1993,7 +1993,7 @@ export async function generateRegistries(
   return {
     registriesAuthTokens:
       // if the user has explicitly set the CODEQL_REGISTRIES_AUTH env var then use that
-      process.env["CODEQL_REGISTRIES_AUTH"] ?? registriesAuthTokens,
+      process.env.CODEQL_REGISTRIES_AUTH ?? registriesAuthTokens,
     qlconfigFile,
   };
 }