Add tests for extension pack and model file selection

Author: koesie10

extensions/ql-vscode/src/data-extensions-editor/extension-packs.ts

@@ -7,7 +7,7 @@ import { ProgressCallback } from "../progress";
 const maxStep = 3;
 
 export async function pickExtensionPackModelFile(
-  cliServer: CodeQLCliServer,
+  cliServer: Pick<CodeQLCliServer, "resolveQlpacks" | "resolveExtensions">,
   progress: ProgressCallback,
 ): Promise<string | undefined> {
   const extensionPackPath = await pickExtensionPack(cliServer, progress);
@@ -24,7 +24,7 @@ export async function pickExtensionPackModelFile(
 }
 
 async function pickExtensionPack(
-  cliServer: CodeQLCliServer,
+  cliServer: Pick<CodeQLCliServer, "resolveQlpacks">,
   progress: ProgressCallback,
 ): Promise<string | undefined> {
   progress({
@@ -73,7 +73,7 @@ async function pickExtensionPack(
 }
 
 async function pickModelFile(
-  cliServer: CodeQLCliServer,
+  cliServer: Pick<CodeQLCliServer, "resolveExtensions">,
   progress: ProgressCallback,
   extensionPackPath: string,
 ): Promise<string | undefined> {

extensions/ql-vscode/test/vscode-tests/no-workspace/data-extensions-editor/extension-packs.test.ts

@@ -0,0 +1,207 @@
+import { QuickPickItem, window } from "vscode";
+
+import { pickExtensionPackModelFile } from "../../../../src/data-extensions-editor/extension-packs";
+import { QlpacksInfo, ResolveExtensionsResult } from "../../../../src/cli";
+import * as helpers from "../../../../src/helpers";
+
+describe("pickExtensionPackModelFile", () => {
+  const qlPacks = {
+    "my-extension-pack": ["/a/b/c/my-extension-pack"],
+    "another-extension-pack": ["/a/b/c/another-extension-pack"],
+  };
+  const extensions = {
+    models: [],
+    data: {
+      "/a/b/c/my-extension-pack": [
+        {
+          file: "/a/b/c/my-extension-pack/models/model.yml",
+          index: 0,
+          predicate: "sinkModel",
+        },
+      ],
+    },
+  };
+
+  const progress = jest.fn();
+  let showQuickPickSpy: jest.SpiedFunction<typeof window.showQuickPick>;
+
+  beforeEach(() => {
+    showQuickPickSpy = jest
+      .spyOn(window, "showQuickPick")
+      .mockRejectedValue(new Error("Unexpected call to showQuickPick"));
+  });
+
+  it("allows choosing an existing extension pack and model file", async () => {
+    const cliServer = mockCliServer(qlPacks, extensions);
+
+    showQuickPickSpy.mockResolvedValueOnce({
+      label: "my-extension-pack",
+      extensionPack: "my-extension-pack",
+    } as QuickPickItem);
+    showQuickPickSpy.mockResolvedValueOnce({
+      label: "models/model.yml",
+      file: "/a/b/c/my-extension-pack/models/model.yml",
+    } as QuickPickItem);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      "/a/b/c/my-extension-pack/models/model.yml",
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledTimes(2);
+    expect(showQuickPickSpy).toHaveBeenCalledWith(
+      [
+        {
+          label: "my-extension-pack",
+          extensionPack: "my-extension-pack",
+        },
+        {
+          label: "another-extension-pack",
+          extensionPack: "another-extension-pack",
+        },
+      ],
+      {
+        title: expect.any(String),
+      },
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledWith(
+      [
+        {
+          label: "models/model.yml",
+          file: "/a/b/c/my-extension-pack/models/model.yml",
+        },
+      ],
+      {
+        title: expect.any(String),
+      },
+    );
+    expect(cliServer.resolveQlpacks).toHaveBeenCalledTimes(1);
+    expect(cliServer.resolveQlpacks).toHaveBeenCalledWith([], true);
+    expect(cliServer.resolveExtensions).toHaveBeenCalledTimes(1);
+    expect(cliServer.resolveExtensions).toHaveBeenCalledWith(
+      "/a/b/c/my-extension-pack",
+      [],
+    );
+  });
+
+  it("allows cancelling the extension pack prompt", async () => {
+    const cliServer = mockCliServer(qlPacks, extensions);
+
+    showQuickPickSpy.mockResolvedValueOnce(undefined);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      undefined,
+    );
+    expect(cliServer.resolveQlpacks).toHaveBeenCalled();
+    expect(cliServer.resolveExtensions).not.toHaveBeenCalled();
+  });
+
+  it("does not show any options when there are no extension packs", async () => {
+    const cliServer = mockCliServer({}, { models: [], data: {} });
+
+    showQuickPickSpy.mockResolvedValueOnce(undefined);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      undefined,
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledTimes(1);
+    expect(showQuickPickSpy).toHaveBeenCalledWith([], {
+      title: expect.any(String),
+    });
+    expect(cliServer.resolveQlpacks).toHaveBeenCalled();
+    expect(cliServer.resolveExtensions).not.toHaveBeenCalled();
+  });
+
+  it("shows an error when an extension pack resolves to more than 1 location", async () => {
+    const showAndLogErrorMessageSpy = jest.spyOn(
+      helpers,
+      "showAndLogErrorMessage",
+    );
+
+    const cliServer = mockCliServer(
+      {
+        "my-extension-pack": [
+          "/a/b/c/my-extension-pack",
+          "/a/b/c/my-extension-pack2",
+        ],
+      },
+      { models: [], data: {} },
+    );
+
+    showQuickPickSpy.mockResolvedValueOnce({
+      label: "my-extension-pack",
+      extensionPack: "my-extension-pack",
+    } as QuickPickItem);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      undefined,
+    );
+    expect(showAndLogErrorMessageSpy).toHaveBeenCalledTimes(1);
+    expect(showAndLogErrorMessageSpy).toHaveBeenCalledWith(
+      expect.stringMatching(/could not be resolved to a single location/),
+      expect.anything(),
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledTimes(1);
+    expect(cliServer.resolveQlpacks).toHaveBeenCalled();
+    expect(cliServer.resolveExtensions).not.toHaveBeenCalled();
+  });
+
+  it("allows cancelling the model file prompt", async () => {
+    const cliServer = mockCliServer(qlPacks, extensions);
+
+    showQuickPickSpy.mockResolvedValueOnce({
+      label: "my-extension-pack",
+      extensionPack: "my-extension-pack",
+    } as QuickPickItem);
+    showQuickPickSpy.mockResolvedValueOnce(undefined);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      undefined,
+    );
+    expect(cliServer.resolveQlpacks).toHaveBeenCalled();
+    expect(cliServer.resolveExtensions).toHaveBeenCalled();
+  });
+
+  it("does not show any options when there are no model files", async () => {
+    const cliServer = mockCliServer(qlPacks, { models: [], data: {} });
+
+    showQuickPickSpy.mockResolvedValueOnce({
+      label: "my-extension-pack",
+      extensionPack: "my-extension-pack",
+    } as QuickPickItem);
+    showQuickPickSpy.mockResolvedValueOnce(undefined);
+
+    expect(await pickExtensionPackModelFile(cliServer, progress)).toEqual(
+      undefined,
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledTimes(2);
+    expect(showQuickPickSpy).toHaveBeenCalledWith(
+      [
+        {
+          label: "my-extension-pack",
+          extensionPack: "my-extension-pack",
+        },
+        {
+          label: "another-extension-pack",
+          extensionPack: "another-extension-pack",
+        },
+      ],
+      {
+        title: expect.any(String),
+      },
+    );
+    expect(showQuickPickSpy).toHaveBeenCalledWith([], {
+      title: expect.any(String),
+    });
+    expect(cliServer.resolveQlpacks).toHaveBeenCalled();
+    expect(cliServer.resolveExtensions).toHaveBeenCalled();
+  });
+});
+
+function mockCliServer(
+  qlpacks: QlpacksInfo,
+  extensions: ResolveExtensionsResult,
+) {
+  return {
+    resolveQlpacks: jest.fn().mockResolvedValue(qlpacks),
+    resolveExtensions: jest.fn().mockResolvedValue(extensions),
+  };
+}