Merge pull request #3086 from github/koesie10/fix-cli-tests

Fix tests with `workspaceContains:.git` activation event

Author: koesie10

extensions/ql-vscode/package.json

@@ -39,7 +39,8 @@
     "onWebviewPanel:resultsView",
     "onWebviewPanel:codeQL.variantAnalysis",
     "onWebviewPanel:codeQL.dataFlowPaths",
-    "onFileSystem:codeql-zip-archive"
+    "onFileSystem:codeql-zip-archive",
+    "workspaceContains:.git"
   ],
   "main": "./out/extension",
   "files": [

extensions/ql-vscode/src/codeql-cli/cli.ts

@@ -241,15 +241,11 @@ export class CodeQLCliServer implements Disposable {
     if (this.distributionProvider.onDidChangeDistribution) {
       this.distributionProvider.onDidChangeDistribution(() => {
         this.restartCliServer();
-        this._version = undefined;
-        this._supportedLanguages = undefined;
       });
     }
     if (this.cliConfig.onDidChangeConfiguration) {
       this.cliConfig.onDidChangeConfiguration(() => {
         this.restartCliServer();
-        this._version = undefined;
-        this._supportedLanguages = undefined;
       });
     }
   }
@@ -290,6 +286,8 @@ export class CodeQLCliServer implements Disposable {
     const callback = (): void => {
       try {
         this.killProcessIfRunning();
+        this._version = undefined;
+        this._supportedLanguages = undefined;
       } finally {
         this.runNext();
       }

extensions/ql-vscode/src/config.ts

@@ -119,6 +119,14 @@ export interface DistributionConfig {
   ownerName?: string;
   repositoryName?: string;
   onDidChangeConfiguration?: Event<void>;
+
+  /**
+   * This forces an update of the distribution, even if the settings haven't changed.
+   *
+   * This should only be used when the distribution has been updated outside of the extension
+   * and only in tests. It should not be called in production code.
+   */
+  forceUpdateConfiguration(): void;
 }
 
 // Query server configuration
@@ -275,6 +283,10 @@ export class DistributionConfigListener
     );
   }
 
+  public forceUpdateConfiguration() {
+    this._onDidChangeConfiguration.fire(undefined);
+  }
+
   protected handleDidChangeConfiguration(e: ConfigurationChangeEvent): void {
     this.handleDidChangeConfigurationForRelevantSettings(
       DISTRIBUTION_CHANGE_SETTINGS,

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

@@ -15,6 +15,7 @@ import {
   storagePath,
 } from "../../global.helper";
 import { createMockCommandManager } from "../../../__mocks__/commandsMock";
+import { remove } from "fs-extra";
 
 /**
  * Run various integration tests for databases
@@ -41,6 +42,7 @@ describe("database-fetcher", () => {
 
   afterEach(async () => {
     await cleanDatabases(databaseManager);
+    await remove(storagePath);
   });
 
   describe("importArchiveDatabase", () => {

extensions/ql-vscode/test/vscode-tests/cli-integration/jest.setup.ts

@@ -7,7 +7,7 @@ import {
 } from "../jest.activated-extension.setup";
 import { createWriteStream, existsSync, mkdirpSync } from "fs-extra";
 import { dirname } from "path";
-import { DB_URL, dbLoc } from "../global.helper";
+import { DB_URL, dbLoc, getActivatedExtension } from "../global.helper";
 import fetch from "node-fetch";
 
 beforeAll(async () => {
@@ -31,6 +31,21 @@ beforeAll(async () => {
   }
 
   await beforeAllAction();
+
+  // Activate the extension
+  const extension = await getActivatedExtension();
+
+  if (process.env.CLI_VERSION && process.env.CLI_VERSION !== "nightly") {
+    const cliVersion = await extension.cliServer.getVersion();
+
+    if (cliVersion.compare(process.env.CLI_VERSION) !== 0) {
+      // It seems like the CUSTOM_CODEQL_PATH_SETTING.updateValue() call in
+      // `beforeAllAction` doesn't fire the event that the config has changed.
+      // `forceUpdateConfiguration` will fire the event manually.
+      // This is a hacky workaround.
+      extension.distributionManager.config.forceUpdateConfiguration();
+    }
+  }
 });
 
 beforeEach(async () => {

extensions/ql-vscode/test/vscode-tests/cli-integration/model-editor/modeled-method-fs.test.ts

@@ -53,20 +53,6 @@ describe("modeled-method-fs", () => {
   let workspacePath: string;
   let cli: CodeQLCliServer;
 
-  beforeAll(async () => {
-    const extension = await getActivatedExtension();
-    cli = extension.cliServer;
-
-    // All transitive dependencies must be available for resolve extensions to succeed.
-    const packUsingExtensionsPath = join(
-      __dirname,
-      "../../..",
-      "data-extensions",
-      "pack-using-extensions",
-    );
-    await cli.packInstall(packUsingExtensionsPath);
-  });
-
   beforeEach(async () => {
     // On windows, make sure to use a temp directory that isn't an alias and therefore won't be canonicalised by CodeQL.
     // See https://github.com/github/vscode-codeql/pull/2605 for more context.
@@ -92,6 +78,15 @@ describe("modeled-method-fs", () => {
 
     const extension = await getActivatedExtension();
     cli = extension.cliServer;
+
+    // All transitive dependencies must be available for resolve extensions to succeed.
+    const packUsingExtensionsPath = join(
+      __dirname,
+      "../../..",
+      "data-extensions",
+      "pack-using-extensions",
+    );
+    await cli.packInstall(packUsingExtensionsPath);
   });
 
   afterEach(() => {