Remove packDownload()

Author: cklin

src/analyze.test.ts

@@ -44,7 +44,6 @@ test("status report fields", async (t) => {
     for (const language of Object.values(Language)) {
       setCodeQL({
         databaseRunQueries: async () => {},
-        packDownload: async () => ({ packs: [] }),
         databaseInterpretResults: async (
           _db: string,
           _queriesRun: string[],

src/codeql.ts

@@ -128,14 +128,6 @@ export interface CodeQL {
     language: string,
   ): Promise<ResolveBuildEnvironmentOutput>;
 
-  /**
-   * Run 'codeql pack download'.
-   */
-  packDownload(
-    packs: string[],
-    qlconfigFile: string | undefined,
-  ): Promise<PackDownloadOutput>;
-
   /**
    * Run 'codeql database cleanup'.
    */
@@ -240,17 +232,6 @@ export interface ResolveBuildEnvironmentOutput {
   };
 }
 
-export interface PackDownloadOutput {
-  packs: PackDownloadItem[];
-}
-
-interface PackDownloadItem {
-  name: string;
-  version: string;
-  packDir: string;
-  installResult: string;
-}
-
 /**
  * Stores the CodeQL object, and is populated by `setupCodeQL` or `getCodeQL`.
  * Can be overridden in tests using `setCodeQL`.
@@ -450,7 +431,6 @@ export function setCodeQL(partialCodeql: Partial<CodeQL>): CodeQL {
       partialCodeql,
       "resolveBuildEnvironment",
     ),
-    packDownload: resolveFunction(partialCodeql, "packDownload"),
     databaseCleanup: resolveFunction(partialCodeql, "databaseCleanup"),
     databaseBundle: resolveFunction(partialCodeql, "databaseBundle"),
     databaseRunQueries: resolveFunction(partialCodeql, "databaseRunQueries"),
@@ -861,58 +841,6 @@ export async function getCodeQLForCmd(
       return await runCli(cmd, codeqlArgs);
     },
 
-    /**
-     * Download specified packs into the package cache. If the specified
-     * package and version already exists (e.g., from a previous analysis run),
-     * then it is not downloaded again (unless the extra option `--force` is
-     * specified).
-     *
-     * If no version is specified, then the latest version is
-     * downloaded. The check to determine what the latest version is is done
-     * each time this package is requested.
-     *
-     * Optionally, a `qlconfigFile` is included. If used, then this file
-     * is used to determine which registry each pack is downloaded from.
-     */
-    async packDownload(
-      packs: string[],
-      qlconfigFile: string | undefined,
-    ): Promise<PackDownloadOutput> {
-      const qlconfigArg = qlconfigFile
-        ? [`--qlconfig-file=${qlconfigFile}`]
-        : ([] as string[]);
-
-      const codeqlArgs = [
-        "pack",
-        "download",
-        ...qlconfigArg,
-        "--format=json",
-        "--resolve-query-specs",
-        ...getExtraOptionsFromEnv(["pack", "download"]),
-        ...packs,
-      ];
-
-      const output = await runCli(cmd, codeqlArgs);
-
-      try {
-        const parsedOutput: PackDownloadOutput = JSON.parse(output);
-        if (
-          Array.isArray(parsedOutput.packs) &&
-          // TODO PackDownloadOutput will not include the version if it is not specified
-          // in the input. The version is always the latest version available.
-          // It should be added to the output, but this requires a CLI change
-          parsedOutput.packs.every((p) => p.name /* && p.version */)
-        ) {
-          return parsedOutput;
-        } else {
-          throw new Error("Unexpected output from pack download");
-        }
-      } catch (e) {
-        throw new Error(
-          `Attempted to download specified packs but got an error:\n${output}\n${e}`,
-        );
-      }
-    },
     async databaseCleanup(
       databasePath: string,
       cleanupLevel: string,

src/config-utils.test.ts

@@ -9,12 +9,7 @@ import * as sinon from "sinon";
 import * as actionsUtil from "./actions-util";
 import * as api from "./api-client";
 import { CachingKind } from "./caching-utils";
-import {
-  CodeQL,
-  getCachedCodeQL,
-  PackDownloadOutput,
-  setCodeQL,
-} from "./codeql";
+import { CodeQL, getCachedCodeQL, setCodeQL } from "./codeql";
 import * as configUtils from "./config-utils";
 import { Feature } from "./feature-flags";
 import * as gitUtils from "./git-utils";
@@ -130,11 +125,7 @@ test("load empty config", async (t) => {
     const logger = getRunnerLogger(true);
     const languages = "javascript,python";
 
-    const codeql = setCodeQL({
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
-    });
+    const codeql = setCodeQL({});
 
     const config = await configUtils.initConfig(
       createTestInitConfigInputs({
@@ -164,11 +155,7 @@ test("loading config saves config", async (t) => {
   return await withTmpDir(async (tempDir) => {
     const logger = getRunnerLogger(true);
 
-    const codeql = setCodeQL({
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
-    });
+    const codeql = setCodeQL({});
 
     // Sanity check the saved config file does not already exist
     t.false(fs.existsSync(configUtils.getPathToParsedConfigFile(tempDir)));
@@ -285,11 +272,7 @@ test("load non-existent input", async (t) => {
 
 test("load non-empty input", async (t) => {
   return await withTmpDir(async (tempDir) => {
-    const codeql = setCodeQL({
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
-    });
+    const codeql = setCodeQL({});
 
     // Just create a generic config object with non-default values for all fields
     const inputFileContents = `
@@ -374,11 +357,7 @@ test("Using config input and file together, config input should be used.", async
 
     fs.mkdirSync(path.join(tempDir, "foo"));
 
-    const codeql = setCodeQL({
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
-    });
+    const codeql = setCodeQL({});
 
     // Only JS, python packs will be ignored
     const languagesInput = "javascript";
@@ -400,11 +379,7 @@ test("Using config input and file together, config input should be used.", async
 
 test("API client used when reading remote config", async (t) => {
   return await withTmpDir(async (tempDir) => {
-    const codeql = setCodeQL({
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
-    });
+    const codeql = setCodeQL({});
 
     const inputFileContents = `
       name: my config
@@ -505,9 +480,6 @@ test("No detected languages", async (t) => {
       async resolveLanguages() {
         return {};
       },
-      async packDownload(): Promise<PackDownloadOutput> {
-        return { packs: [] };
-      },
     });
 
     try {