Enable restoreMocks Jest configuration option

This will ensure all mocks are restored after every test. This required
a significant amount of changes in the tests since `jest.spyOn` now
needs to be called in `beforeEach`, rather than in the `describe` block.

Author: koesie10

extensions/ql-vscode/src/vscode-tests/cli-integration/databases.test.ts

@@ -21,15 +21,17 @@ describe("Databases", () => {
     "https://lgtm.com/projects/g/aeisenberg/angular-bind-notifier/";
 
   let databaseManager: DatabaseManager;
-  const inputBoxStub = jest.spyOn(window, "showInputBox");
+  let inputBoxStub: jest.SpiedFunction<typeof window.showInputBox>;
   let cli: CodeQLCliServer;
   const progressCallback = jest.fn();
 
-  jest.spyOn(window, "showErrorMessage").mockResolvedValue(undefined);
-  jest.spyOn(window, "showInformationMessage").mockResolvedValue(undefined);
-
   beforeEach(async () => {
-    inputBoxStub.mockResolvedValue(undefined);
+    inputBoxStub = jest
+      .spyOn(window, "showInputBox")
+      .mockResolvedValue(undefined);
+
+    jest.spyOn(window, "showErrorMessage").mockResolvedValue(undefined);
+    jest.spyOn(window, "showInformationMessage").mockResolvedValue(undefined);
 
     const extension = await extensions
       .getExtension<CodeQLExtensionInterface | Record<string, never>>(

extensions/ql-vscode/src/vscode-tests/cli-integration/packaging.test.ts

@@ -17,22 +17,28 @@ jest.setTimeout(3 * 60 * 1000);
 describe("Packaging commands", () => {
   let cli: CodeQLCliServer;
   const progress = jest.fn();
-  const quickPickSpy = jest.spyOn(window, "showQuickPick");
-  const inputBoxSpy = jest.spyOn(window, "showInputBox");
-  const showAndLogErrorMessageSpy = jest.spyOn(
-    helpers,
-    "showAndLogErrorMessage",
-  );
-  const showAndLogInformationMessageSpy = jest.spyOn(
-    helpers,
-    "showAndLogInformationMessage",
-  );
+  let quickPickSpy: jest.SpiedFunction<typeof window.showQuickPick>;
+  let inputBoxSpy: jest.SpiedFunction<typeof window.showInputBox>;
+  let showAndLogErrorMessageSpy: jest.SpiedFunction<
+    typeof helpers.showAndLogErrorMessage
+  >;
+  let showAndLogInformationMessageSpy: jest.SpiedFunction<
+    typeof helpers.showAndLogInformationMessage
+  >;
 
   beforeEach(async () => {
-    quickPickSpy.mockResolvedValue(undefined);
-    inputBoxSpy.mockResolvedValue(undefined);
-    showAndLogErrorMessageSpy.mockResolvedValue(undefined);
-    showAndLogInformationMessageSpy.mockResolvedValue(undefined);
+    quickPickSpy = jest
+      .spyOn(window, "showQuickPick")
+      .mockResolvedValue(undefined);
+    inputBoxSpy = jest
+      .spyOn(window, "showInputBox")
+      .mockResolvedValue(undefined);
+    showAndLogErrorMessageSpy = jest
+      .spyOn(helpers, "showAndLogErrorMessage")
+      .mockResolvedValue(undefined);
+    showAndLogInformationMessageSpy = jest
+      .spyOn(helpers, "showAndLogInformationMessage")
+      .mockResolvedValue(undefined);
 
     const extension = await extensions
       .getExtension<CodeQLExtensionInterface | Record<string, never>>(

extensions/ql-vscode/src/vscode-tests/cli-integration/remote-queries/remote-queries-manager.test.ts

@@ -47,18 +47,20 @@ describe("Remote queries", () => {
   let cli: CodeQLCliServer;
   let cancellationTokenSource: CancellationTokenSource;
   const progress = jest.fn();
-  const showQuickPickSpy = jest.spyOn(window, "showQuickPick");
-  const getRepositoryFromNwoStub = jest.spyOn(
-    ghApiClient,
-    "getRepositoryFromNwo",
-  );
+  let showQuickPickSpy: jest.SpiedFunction<typeof window.showQuickPick>;
+  let getRepositoryFromNwoStub: jest.SpiedFunction<
+    typeof ghApiClient.getRepositoryFromNwo
+  >;
   let ctx: ExtensionContext;
   let logger: any;
   let remoteQueriesManager: RemoteQueriesManager;
 
   let originalDeps: Record<string, string> | undefined;
 
   beforeEach(async () => {
+    showQuickPickSpy = jest.spyOn(window, "showQuickPick");
+    getRepositoryFromNwoStub = jest.spyOn(ghApiClient, "getRepositoryFromNwo");
+
     const extension = await extensions
       .getExtension<CodeQLExtensionInterface | Record<string, never>>(
         "GitHub.vscode-codeql",
@@ -125,17 +127,20 @@ describe("Remote queries", () => {
   });
 
   describe("runRemoteQuery", () => {
-    const mockSubmitRemoteQueries = jest.spyOn(
-      ghApiClient,
-      "submitRemoteQueries",
-    );
-    const executeCommandSpy = jest.spyOn(commands, "executeCommand");
+    let mockSubmitRemoteQueries: jest.SpiedFunction<
+      typeof ghApiClient.submitRemoteQueries
+    >;
+    let executeCommandSpy: jest.SpiedFunction<typeof commands.executeCommand>;
 
     beforeEach(() => {
-      mockSubmitRemoteQueries.mockResolvedValue({
-        workflow_run_id: 20,
-        repositories_queried: ["octodemo/hello-world-1"],
-      });
+      mockSubmitRemoteQueries = jest
+        .spyOn(ghApiClient, "submitRemoteQueries")
+        .mockResolvedValue({
+          workflow_run_id: 20,
+          repositories_queried: ["octodemo/hello-world-1"],
+        });
+
+      executeCommandSpy = jest.spyOn(commands, "executeCommand");
     });
 
     it("should run a remote query that is part of a qlpack", async () => {