Merge pull request #1510 from github/henrymercer/fix-fallback-version…

…-number Fix computation of fallback version number
github · Jan 26, 2023 · 43f1a6c · 43f1a6c
2 parents 24ca6b0 + 75ae065
commit 43f1a6c
Show file tree

Hide file tree

Showing 6 changed files with 112 additions and 117 deletions.
diff --git a/lib/codeql.test.js b/lib/codeql.test.js
diff --git a/lib/codeql.test.js.map b/lib/codeql.test.js.map
diff --git a/lib/setup-codeql.js b/lib/setup-codeql.js
diff --git a/lib/setup-codeql.js.map b/lib/setup-codeql.js.map
diff --git a/src/codeql.test.ts b/src/codeql.test.ts
@@ -298,80 +298,71 @@ for (const {
   });
 }
 
-for (const { isCached, tagName, toolcacheCliVersion } of [
+for (const { githubReleases, toolcacheVersion } of [
+  // Test that we use the tools from the toolcache when `SAMPLE_DEFAULT_CLI_VERSION` is requested
+  // and `SAMPLE_DEFAULT_CLI_VERSION-` is in the toolcache.
   {
-    isCached: true,
-    tagName: "codeql-bundle-20230101",
-    toolcacheCliVersion: SAMPLE_DEFAULT_CLI_VERSION.cliVersion,
+    toolcacheVersion: SAMPLE_DEFAULT_CLI_VERSION.cliVersion,
   },
   {
-    isCached: true,
-    // By leaving toolcacheCliVersion undefined, the bundle will be installed
-    // into the toolcache as `${SAMPLE_DEFAULT_CLI_VERSION.cliVersion}-20230101`.
-    // This lets us test that `x.y.z-yyyymmdd` toolcache versions are used if an
-    // `x.y.z` version isn't in the toolcache.
-    tagName: `codeql-bundle-${SAMPLE_DEFAULT_CLI_VERSION.cliVersion}-20230101`,
+    githubReleases: {
+      "codeql-bundle-20230101": `cli-version-${SAMPLE_DEFAULT_CLI_VERSION.cliVersion}.txt`,
+    },
+    toolcacheVersion: "0.0.0-20230101",
   },
   {
-    isCached: false,
-    tagName: "codeql-bundle-20230101",
+    toolcacheVersion: `${SAMPLE_DEFAULT_CLI_VERSION.cliVersion}-20230101`,
   },
 ]) {
-  test(`uses default version on Dotcom when default version bundle ${tagName} is ${
-    isCached ? "" : "not "
-  }cached`, async (t) => {
-    await util.withTmpDir(async (tmpDir) => {
-      setupActionsVars(tmpDir, tmpDir);
-
-      if (isCached) {
-        await installIntoToolcache({
-          cliVersion: toolcacheCliVersion,
-          tagName,
-          isPinned: true,
-          tmpDir,
-        });
-      } else {
-        mockDownloadApi({
-          tagName,
-        });
-        sinon.stub(api, "getApiClient").value(() => ({
-          repos: {
-            listReleases: sinon.stub().resolves(undefined),
-          },
-          paginate: sinon.stub().resolves([
-            {
-              assets: [
-                {
-                  name: "cli-version-2.0.0.txt",
-                },
-              ],
-              tag_name: tagName,
+  test(
+    `uses tools from toolcache when ${SAMPLE_DEFAULT_CLI_VERSION.cliVersion} is requested and ` +
+      `${toolcacheVersion} is installed`,
+    async (t) => {
+      await util.withTmpDir(async (tmpDir) => {
+        setupActionsVars(tmpDir, tmpDir);
+
+        sinon
+          .stub(toolcache, "find")
+          .withArgs("CodeQL", toolcacheVersion)
+          .returns("path/to/cached/codeql");
+        sinon.stub(toolcache, "findAllVersions").returns([toolcacheVersion]);
+
+        if (githubReleases) {
+          sinon.stub(api, "getApiClient").value(() => ({
+            repos: {
+              listReleases: sinon.stub().resolves(undefined),
             },
-          ]),
-        }));
-      }
-
-      const result = await codeql.setupCodeQL(
-        undefined,
-        sampleApiDetails,
-        tmpDir,
-        util.GitHubVariant.DOTCOM,
-        false,
-        SAMPLE_DEFAULT_CLI_VERSION,
-        getRunnerLogger(true),
-        false
-      );
-      t.is(result.toolsVersion, SAMPLE_DEFAULT_CLI_VERSION.cliVersion);
-
-      if (isCached) {
+            paginate: sinon.stub().resolves(
+              Object.entries(githubReleases).map(
+                ([releaseTagName, cliVersionMarkerFile]) => ({
+                  assets: [
+                    {
+                      name: cliVersionMarkerFile,
+                    },
+                  ],
+                  tag_name: releaseTagName,
+                })
+              )
+            ),
+          }));
+        }
+
+        const result = await codeql.setupCodeQL(
+          undefined,
+          sampleApiDetails,
+          tmpDir,
+          util.GitHubVariant.DOTCOM,
+          false,
+          SAMPLE_DEFAULT_CLI_VERSION,
+          getRunnerLogger(true),
+          false
+        );
+        t.is(result.toolsVersion, SAMPLE_DEFAULT_CLI_VERSION.cliVersion);
         t.is(result.toolsSource, ToolsSource.Toolcache);
         t.is(result.toolsDownloadDurationMs, undefined);
-      } else {
-        t.is(result.toolsSource, ToolsSource.Download);
-        t.is(typeof result.toolsDownloadDurationMs, "number");
-      }
-    });
-  });
+      });
+    }
+  );
 }
 
 for (const variant of [util.GitHubVariant.GHAE, util.GitHubVariant.GHES]) {

diff --git a/src/setup-codeql.ts b/src/setup-codeql.ts
@@ -241,14 +241,24 @@ async function getCodeQLBundleDownloadURL(
   return `https://github.com/${CODEQL_DEFAULT_ACTION_REPOSITORY}/releases/download/${tagName}/${codeQLBundleName}`;
 }
 
+function getBundleVersionFromTagName(tagName: string): string {
+  const match = tagName.match(/^codeql-bundle-(.*)$/);
+  if (match === null || match.length < 2) {
+    throw new Error(
+      `Malformed bundle tag name: ${tagName}. Bundle version could not be inferred`
+    );
+  }
+  return match[1];
+}
+
 export function getBundleVersionFromUrl(url: string): string {
-  const match = url.match(/\/codeql-bundle-(.*)\//);
+  const match = url.match(/\/(codeql-bundle-.*)\//);
   if (match === null || match.length < 2) {
     throw new Error(
       `Malformed tools url: ${url}. Bundle version could not be inferred`
     );
   }
-  return match[1];
+  return getBundleVersionFromTagName(match[1]);
 }
 
 export function convertToSemVer(version: string, logger: Logger): string {
@@ -448,14 +458,17 @@ export async function getCodeQLSource(
   }
 
   if (!codeqlFolder && requestedVersion.cliVersion) {
-    // Fall back to accepting a `0.0.0-<tagName>` version if we didn't find the
+    // Fall back to accepting a `0.0.0-<bundleVersion>` version if we didn't find the
     // `x.y.z` version. This is to support old versions of the toolcache.
     //
     // If we are on Dotcom, we will make an HTTP request to the Releases API here
     // to find the tag name for the requested version.
     tagName =
       tagName || (await getOrFindBundleTagName(requestedVersion, logger));
-    const fallbackVersion = convertToSemVer(tagName, logger);
+    const fallbackVersion = convertToSemVer(
+      getBundleVersionFromTagName(tagName),
+      logger
+    );
     logger.debug(
       `Computed a fallback toolcache version number of ${fallbackVersion} for CodeQL tools version ` +
         `${requestedVersion.cliVersion}.`