Add tests for prompting for database download

Author: koesie10

extensions/ql-vscode/src/local-queries/skeleton-query-wizard.ts

@@ -45,6 +45,7 @@ export const QUERY_LANGUAGE_TO_DATABASE_REPO: QueryLanguagesToDatabaseMap = {
 export class SkeletonQueryWizard {
   private fileName = "example.ql";
   private qlPackStoragePath: string | undefined;
+  private downloadPromise: Promise<void> | undefined;
 
   constructor(
     private readonly cliServer: CodeQLCliServer,
@@ -60,6 +61,16 @@ export class SkeletonQueryWizard {
     return `codeql-custom-queries-${this.language}`;
   }
 
+  /**
+   * Wait for the download process to complete by waiting for the user to select
+   * either "Download database" or closing the dialog. This is used for testing.
+   */
+  public async waitForDownload() {
+    if (this.downloadPromise) {
+      await this.downloadPromise;
+    }
+  }
+
   public async execute() {
     if (!this.language) {
       // show quick pick to choose language
@@ -313,7 +324,9 @@ export class SkeletonQueryWizard {
       }
     } else {
       // download new database and select it
-      void this.promptDownloadDatabase();
+      this.downloadPromise = this.promptDownloadDatabase().finally(() => {
+        this.downloadPromise = undefined;
+      });
     }
   }
 

extensions/ql-vscode/test/vscode-tests/cli-integration/local-queries/skeleton-query-wizard.test.ts

@@ -5,7 +5,13 @@ import {
 } from "../../../../src/local-queries/skeleton-query-wizard";
 import { mockedObject, mockedQuickPickItem } from "../../utils/mocking.helpers";
 import * as tmp from "tmp";
-import { TextDocument, window, workspace, WorkspaceFolder } from "vscode";
+import {
+  MessageItem,
+  TextDocument,
+  window,
+  workspace,
+  WorkspaceFolder,
+} from "vscode";
 import { extLogger } from "../../../../src/common/logging/vscode";
 import { QlPackGenerator } from "../../../../src/local-queries/qlpack-generator";
 import * as workspaceFolders from "../../../../src/common/vscode/workspace-folders";
@@ -31,6 +37,9 @@ describe("SkeletonQueryWizard", () => {
   let storagePath: string;
   let quickPickSpy: jest.SpiedFunction<typeof window.showQuickPick>;
   let showInputBoxSpy: jest.SpiedFunction<typeof window.showInputBox>;
+  let showInformationMessageSpy: jest.SpiedFunction<
+    typeof window.showInformationMessage
+  >;
   let generateSpy: jest.SpiedFunction<
     typeof QlPackGenerator.prototype.generate
   >;
@@ -97,6 +106,9 @@ describe("SkeletonQueryWizard", () => {
     showInputBoxSpy = jest
       .spyOn(window, "showInputBox")
       .mockResolvedValue(storagePath);
+    showInformationMessageSpy = jest
+      .spyOn(window, "showInformationMessage")
+      .mockResolvedValue(undefined);
     generateSpy = jest
       .spyOn(QlPackGenerator.prototype, "generate")
       .mockResolvedValue(undefined);
@@ -168,9 +180,32 @@ describe("SkeletonQueryWizard", () => {
       expect(generateSpy).toHaveBeenCalled();
     });
 
-    it("should download database for selected language", async () => {
+    it("should prompt for download database", async () => {
       await wizard.execute();
 
+      expect(showInformationMessageSpy).toHaveBeenCalledWith(
+        expect.stringMatching(/a CodeQL database/i),
+        expect.objectContaining({
+          title: "Download database",
+        }),
+      );
+      expect(downloadGitHubDatabaseSpy).not.toHaveBeenCalled();
+    });
+
+    it("should download database for selected language when selecting download in prompt", async () => {
+      showInformationMessageSpy.mockImplementation(
+        async (_message, options, item) => {
+          if (item === undefined) {
+            return options as MessageItem;
+          }
+
+          return item;
+        },
+      );
+
+      await wizard.execute();
+      await wizard.waitForDownload();
+
       expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();
     });
 
@@ -259,51 +294,126 @@ describe("SkeletonQueryWizard", () => {
           name: databaseNwo,
           language: chosenLanguage,
         } as DatabaseItem;
+      });
 
-        mockDatabaseManagerWithItems = mockedObject<DatabaseManager>({
-          setCurrentDatabaseItem: jest.fn(),
-          databaseItems: [databaseItem] as DatabaseItem[],
+      describe("with database selected", () => {
+        beforeEach(async () => {
+          mockDatabaseManagerWithItems = mockedObject<DatabaseManager>({
+            currentDatabaseItem: databaseItem,
+            setCurrentDatabaseItem: jest.fn(),
+            databaseItems: [databaseItem] as DatabaseItem[],
+          });
+
+          wizard = new SkeletonQueryWizard(
+            mockCli,
+            jest.fn(),
+            credentials,
+            extLogger,
+            mockDatabaseManagerWithItems,
+            storagePath,
+          );
         });
 
-        wizard = new SkeletonQueryWizard(
-          mockCli,
-          jest.fn(),
-          credentials,
-          extLogger,
-          mockDatabaseManagerWithItems,
-          storagePath,
-        );
-      });
+        it("should not download a new database for language", async () => {
+          await wizard.execute();
 
-      it("should not download a new database for language", async () => {
-        await wizard.execute();
+          expect(downloadGitHubDatabaseSpy).not.toHaveBeenCalled();
+        });
 
-        expect(downloadGitHubDatabaseSpy).not.toHaveBeenCalled();
-      });
+        it("should not select the database", async () => {
+          await wizard.execute();
 
-      it("should select an existing database", async () => {
-        await wizard.execute();
+          expect(
+            mockDatabaseManagerWithItems.setCurrentDatabaseItem,
+          ).not.toHaveBeenCalled();
+        });
+
+        it("should open the new query file", async () => {
+          await wizard.execute();
+
+          expect(openTextDocumentSpy).toHaveBeenCalledWith(
+            expect.objectContaining({
+              path: expect.stringMatching("example2.ql"),
+            }),
+          );
+        });
+
+        it("should not show an information message", async () => {
+          await wizard.execute();
 
-        expect(
-          mockDatabaseManagerWithItems.setCurrentDatabaseItem,
-        ).toHaveBeenCalledWith(databaseItem);
+          expect(showInformationMessageSpy).not.toHaveBeenCalled();
+        });
       });
 
-      it("should open the new query file", async () => {
-        await wizard.execute();
+      describe("with database not selected", () => {
+        beforeEach(async () => {
+          mockDatabaseManagerWithItems = mockedObject<DatabaseManager>({
+            currentDatabaseItem: undefined,
+            setCurrentDatabaseItem: jest.fn(),
+            databaseItems: [databaseItem] as DatabaseItem[],
+          });
+
+          wizard = new SkeletonQueryWizard(
+            mockCli,
+            jest.fn(),
+            credentials,
+            extLogger,
+            mockDatabaseManagerWithItems,
+            storagePath,
+          );
+        });
 
-        expect(openTextDocumentSpy).toHaveBeenCalledWith(
-          expect.objectContaining({
-            path: expect.stringMatching("example2.ql"),
-          }),
-        );
+        it("should not download a new database for language", async () => {
+          await wizard.execute();
+
+          expect(downloadGitHubDatabaseSpy).not.toHaveBeenCalled();
+        });
+
+        it("should select an existing database", async () => {
+          await wizard.execute();
+
+          expect(
+            mockDatabaseManagerWithItems.setCurrentDatabaseItem,
+          ).toHaveBeenCalledWith(databaseItem);
+        });
+
+        it("should open the new query file", async () => {
+          await wizard.execute();
+
+          expect(openTextDocumentSpy).toHaveBeenCalledWith(
+            expect.objectContaining({
+              path: expect.stringMatching("example2.ql"),
+            }),
+          );
+        });
+
+        it("should show an information message", async () => {
+          await wizard.execute();
+
+          expect(showInformationMessageSpy).toHaveBeenCalledWith(
+            expect.stringMatching(new RegExp(databaseNwo)),
+          );
+        });
       });
     });
 
     describe("if database is missing", () => {
-      describe("if the user choses to downloaded the suggested database from GitHub", () => {
+      describe("if the user chooses to downloaded the suggested database from GitHub", () => {
+        beforeEach(() => {
+          showInformationMessageSpy.mockImplementation(
+            async (_message, options, item) => {
+              if (item === undefined) {
+                return options as MessageItem;
+              }
+
+              return item;
+            },
+          );
+        });
+
         it("should download a new database for language", async () => {
           await wizard.execute();
+          await wizard.waitForDownload();
 
           expect(askForGitHubRepoSpy).toHaveBeenCalled();
           expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();
@@ -312,6 +422,16 @@ describe("SkeletonQueryWizard", () => {
 
       describe("if the user choses to download a different database from GitHub than the one suggested", () => {
         beforeEach(() => {
+          showInformationMessageSpy.mockImplementation(
+            async (_message, options, item) => {
+              if (item === undefined) {
+                return options as MessageItem;
+              }
+
+              return item;
+            },
+          );
+
           const chosenGitHubRepo = "pickles-owner/pickles-repo";
 
           askForGitHubRepoSpy = jest
@@ -321,6 +441,7 @@ describe("SkeletonQueryWizard", () => {
 
         it("should download the newly chosen database", async () => {
           await wizard.execute();
+          await wizard.waitForDownload();
 
           expect(askForGitHubRepoSpy).toHaveBeenCalled();
           expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();