Use getCodeQLAssetDownloadURL for start-proxy

Author: mbg

lib/entry-points.js

@@ -5,7 +5,7 @@ import * as core from "@actions/core";
 
 import { Action, ActionState, runInActions } from "./action-common";
 import * as actionsUtil from "./actions-util";
-import { getGitHubVersion } from "./api-client";
+import { getApiDetails, getGitHubVersion } from "./api-client";
 import { FeatureEnablement, initFeatures } from "./feature-flags";
 import { BuiltInLanguage, parseBuiltInLanguage } from "./languages";
 import { Logger } from "./logging";
@@ -98,7 +98,10 @@ async function run(action: ActionState<["Base", "Logger", "Env", "Actions"]>) {
     };
 
     // Start the Proxy
-    const proxyBin = await getProxyBinaryPath({ ...action, features });
+    const proxyBin = await getProxyBinaryPath(
+      { ...action, features },
+      getApiDetails(action.env),
+    );
     const proxyInfo = await startProxy(
       proxyBin,
       proxyConfig,

src/start-proxy-action.ts

@@ -6,24 +6,29 @@ import test, { ExecutionContext } from "ava";
 import sinon from "sinon";
 
 import { ActionState } from "./action-common";
+import * as actionsUtil from "./actions-util";
 import * as apiClient from "./api-client";
 import * as defaults from "./defaults.json";
+import { ActionsEnvVars } from "./environment";
 import { setUpFeatureFlagTests } from "./feature-flags/testing-util";
 import { UnvalidatedObject, validateSchema } from "./json";
 import { makeFromSchema } from "./json/testing-util";
 import { BuiltInLanguage } from "./languages";
 import { getRunnerLogger, Logger } from "./logging";
 import { BundlePlatform, getBundlePlatform } from "./platform";
+import * as repository from "./setup/repository";
 import * as startProxyExports from "./start-proxy";
 import * as statusReport from "./status-report";
 import {
+  addSinonAssertions,
   assertNotLogged,
   checkExpectedLogMessages,
   createFeatures,
   initAllState,
   makeMacro,
   makeTestToken,
   RecordingLogger,
+  SAMPLE_DOTCOM_API_DETAILS,
   setupTests,
   withRecordingLoggerAsync,
 } from "./testing-utils";
@@ -705,15 +710,23 @@ function mockGetApiClient(endpoints: any) {
 
 type ReleaseAssets = Array<{ name: string; url?: string }>;
 
-function mockGetReleaseByTag(assets?: ReleaseAssets) {
+function mockGetReleaseByTag(expectedTag?: string, assets?: ReleaseAssets) {
   const getReleaseByTag =
     assets === undefined
       ? sinon.stub().rejects()
-      : sinon.stub().resolves({
-          status: 200,
-          data: { assets },
-          headers: {},
-          url: "GET /repos/:owner/:repo/releases/tags/:tag",
+      : sinon.stub().callsFake(({ tag }) => {
+          if (tag === expectedTag) {
+            return {
+              status: 200,
+              data: { assets },
+              headers: {},
+              url: "GET /repos/:owner/:repo/releases/tags/:tag",
+            };
+          } else {
+            return {
+              status: 404,
+            };
+          }
         });
 
   return mockGetApiClient({ repos: { getReleaseByTag } });
@@ -743,6 +756,8 @@ test.serial(
     const logger = new RecordingLogger();
     mockGetReleaseByTag();
 
+    sinon.stub(repository, "getCodeQLAssetDownloadURL").rejects();
+
     await withTmpDir(async (tempDir) => {
       const features = mockOfflineFeatures(tempDir, logger);
       const state = initAllState({
@@ -751,7 +766,14 @@ test.serial(
         logger,
         features,
       });
-      const info = await startProxyExports.getDownloadUrl(state);
+      const info = await startProxyExports.getDownloadUrl(
+        state,
+        SAMPLE_DOTCOM_API_DETAILS,
+      );
+
+      t.true(
+        logger.hasMessage(`Unsupported platform android on architecture ppc`),
+      );
 
       t.is(info.version, startProxyExports.UPDATEJOB_PROXY_VERSION);
       t.is(
@@ -760,10 +782,6 @@ test.serial(
           startProxyExports.getProxyPackage(BundlePlatform.Linux64),
         ),
       );
-
-      t.true(
-        logger.hasMessage(`Unsupported platform android on architecture ppc`),
-      );
     });
   },
 );
@@ -777,7 +795,10 @@ test.serial(
     await withTmpDir(async (tempDir) => {
       const features = mockOfflineFeatures(tempDir, logger);
       const state = initAllState({ logger, features });
-      const info = await startProxyExports.getDownloadUrl(state);
+      const info = await startProxyExports.getDownloadUrl(
+        state,
+        SAMPLE_DOTCOM_API_DETAILS,
+      );
 
       t.is(info.version, startProxyExports.UPDATEJOB_PROXY_VERSION);
       t.is(
@@ -801,8 +822,11 @@ test.serial(
       const state = initAllState({ logger, features });
 
       for (const assets of testAssets) {
-        const stub = mockGetReleaseByTag(assets);
-        const info = await startProxyExports.getDownloadUrl(state);
+        const stub = mockGetReleaseByTag(defaults.bundleVersion, assets);
+        const info = await startProxyExports.getDownloadUrl(
+          state,
+          SAMPLE_DOTCOM_API_DETAILS,
+        );
 
         t.is(info.version, startProxyExports.UPDATEJOB_PROXY_VERSION);
         t.is(
@@ -835,11 +859,17 @@ test.serial("getDownloadUrl returns matching release asset", async (t) => {
       url: "url-we-want",
     },
   ];
-  mockGetReleaseByTag(assets);
+  const getReleaseByTag = mockGetReleaseByTag(defaults.bundleVersion, assets);
 
   await withTmpDir(async (tempDir) => {
+    state.env.set(ActionsEnvVars.RUNNER_TEMP, tempDir);
     const features = mockOfflineFeatures(tempDir, logger);
-    const info = await startProxyExports.getDownloadUrl({ ...state, features });
+    const info = await startProxyExports.getDownloadUrl(
+      { ...state, features },
+      SAMPLE_DOTCOM_API_DETAILS,
+    );
+
+    t.is(getReleaseByTag.callCount, 1);
 
     t.is(info.version, defaults.cliVersion);
     t.is(info.url, "url-we-want");
@@ -975,6 +1005,7 @@ test.serial(
       const features = mockOfflineFeatures(tempDir, logger);
       const path = await startProxyExports.getProxyBinaryPath(
         initAllState({ logger, features }),
+        SAMPLE_DOTCOM_API_DETAILS,
       );
 
       t.assert(path);
@@ -992,7 +1023,7 @@ test.serial(
     const logger = new RecordingLogger();
     const state = initAllState({ logger });
     const downloadUrl = "url-we-want";
-    mockGetReleaseByTag([
+    const getApiClient = mockGetReleaseByTag(defaults.bundleVersion, [
       {
         name: startProxyExports.getProxyPackage(getTestPlatform(state)),
         url: downloadUrl,
@@ -1001,11 +1032,6 @@ test.serial(
 
     const toolcachePath = "/path/to/proxy/dir";
     const find = sinon.stub(toolcache, "find").returns("");
-    const getApiDetails = sinon.stub(apiClient, "getApiDetails").returns({
-      auth: "",
-      url: "",
-      apiURL: "",
-    });
     const getAuthorizationHeaderFor = sinon
       .stub(apiClient, "getAuthorizationHeaderFor")
       .returns(undefined);
@@ -1019,15 +1045,26 @@ test.serial(
       .resolves(extractedPath);
     const cacheDir = sinon.stub(toolcache, "cacheDir").resolves(toolcachePath);
 
-    const path = await startProxyExports.getProxyBinaryPath({
-      ...state,
-      features: createFeatures([]),
-    });
+    // Stub this to always return `true` so we get the default repo for the tests.
+    sinon.stub(actionsUtil, "isRunningLocalAction").returns(true);
 
+    const path = await startProxyExports.getProxyBinaryPath(
+      {
+        ...state,
+        features: createFeatures([]),
+      },
+      SAMPLE_DOTCOM_API_DETAILS,
+    );
+
+    t.is(getApiClient.callCount, 1);
     t.assert(find.calledOnce);
-    t.assert(getApiDetails.calledOnce);
     t.assert(getAuthorizationHeaderFor.calledOnce);
-    t.assert(downloadTool.calledOnceWith(downloadUrl));
+
+    const st = addSinonAssertions(t);
+    st.onceWith(downloadTool, downloadUrl);
+    st.onceWith(extractTar, archivePath);
+    st.onceWith(cacheDir, extractedPath);
+
     t.assert(extractTar.calledOnceWith(archivePath));
     t.assert(cacheDir.calledOnceWith(extractedPath));
     t.assert(path);
@@ -1037,7 +1074,7 @@ test.serial(
     );
 
     checkExpectedLogMessages(t, logger.messages, [
-      `Found '${startProxyExports.getProxyPackage(getTestPlatform(state))}' in release '${defaults.bundleVersion}' at '${downloadUrl}'`,
+      `Found private registry proxy ${startProxyExports.getProxyPackage(getTestPlatform(state))} in github/codeql-action on https://github.com with URL ${downloadUrl}`,
     ]);
   },
 );
@@ -1073,11 +1110,6 @@ test.serial(
     await withTmpDir(async (tempDir) => {
       const toolcachePath = "/path/to/proxy/dir";
       const find = sinon.stub(toolcache, "find").returns("");
-      const getApiDetails = sinon.stub(apiClient, "getApiDetails").returns({
-        auth: "",
-        url: "",
-        apiURL: "",
-      });
       const getAuthorizationHeaderFor = sinon
         .stub(apiClient, "getAuthorizationHeaderFor")
         .returns(undefined);
@@ -1107,18 +1139,23 @@ test.serial(
         .resolves({
           enabledVersions: [{ cliVersion: "2.20.1", tagName: expectedTag }],
         });
-      const path = await startProxyExports.getProxyBinaryPath({
-        ...state,
-        features,
-      });
 
-      t.assert(getDefaultCliVersion.calledOnce);
-      sinon.assert.calledOnceWithMatch(
-        getReleaseByTag,
-        sinon.match(expectedParams),
+      // Stub this to always return `true` so we get the default repo for the tests.
+      sinon.stub(actionsUtil, "isRunningLocalAction").returns(true);
+
+      const path = await startProxyExports.getProxyBinaryPath(
+        {
+          ...state,
+          features,
+        },
+        SAMPLE_DOTCOM_API_DETAILS,
       );
+
+      t.assert(getDefaultCliVersion.calledOnce);
+
+      const st = addSinonAssertions(t);
+      st.onceWith(getReleaseByTag, expectedParams);
       t.assert(find.calledOnce);
-      t.assert(getApiDetails.calledOnce);
       t.assert(getAuthorizationHeaderFor.calledOnce);
       t.assert(downloadTool.calledOnceWith(downloadUrl));
       t.assert(extractTar.calledOnceWith(archivePath));
@@ -1132,7 +1169,7 @@ test.serial(
     });
 
     checkExpectedLogMessages(t, logger.messages, [
-      `Found '${startProxyExports.getProxyPackage(getTestPlatform(state))}' in release '${expectedTag}' at '${downloadUrl}'`,
+      `Found private registry proxy ${startProxyExports.getProxyPackage(getTestPlatform(state))} in github/codeql-action on https://github.com with URL url-we-want.`,
     ]);
   },
 );