Add basic integration test for 'add db list' functionality (#1881)

Author: charisk

extensions/ql-vscode/src/databases/config/db-config-store.ts

@@ -1,4 +1,4 @@
-import { pathExists, writeJSON, readJSON, readJSONSync } from "fs-extra";
+import { pathExists, outputJSON, readJSON, readJSONSync } from "fs-extra";
 import { join } from "path";
 import {
   cloneDbConfig,
@@ -123,7 +123,7 @@ export class DbConfigStore extends DisposableObject {
   }
 
   private async writeConfig(config: DbConfig): Promise<void> {
-    await writeJSON(this.configPath, config, {
+    await outputJSON(this.configPath, config, {
       spaces: 2,
     });
   }

extensions/ql-vscode/src/databases/db-module.ts

@@ -20,22 +20,25 @@ export class DbModule extends DisposableObject {
   }
 
   public static async initialize(app: App): Promise<DbModule | undefined> {
-    if (
-      isCanary() &&
-      isNewQueryRunExperienceEnabled() &&
-      app.mode === AppMode.Development
-    ) {
+    if (DbModule.shouldEnableModule(app.mode)) {
       const dbModule = new DbModule(app);
       app.subscriptions.push(dbModule);
 
       await dbModule.initialize();
-
       return dbModule;
     }
 
     return undefined;
   }
 
+  private static shouldEnableModule(app: AppMode): boolean {
+    if (app === AppMode.Development || app === AppMode.Test) {
+      return true;
+    }
+
+    return isCanary() && isNewQueryRunExperienceEnabled();
+  }
+
   private async initialize(): Promise<void> {
     void extLogger.log("Initializing database module");
 

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

@@ -0,0 +1,36 @@
+import { commands, extensions, window } from "vscode";
+
+import { CodeQLExtensionInterface } from "../../../extension";
+import { readJson } from "fs-extra";
+import * as path from "path";
+import { DbConfig } from "../../../databases/config/db-config";
+
+jest.setTimeout(60_000);
+
+describe("Db panel UI commands", () => {
+  let extension: CodeQLExtensionInterface | Record<string, never>;
+  let storagePath: string;
+
+  beforeEach(async () => {
+    extension = await extensions
+      .getExtension<CodeQLExtensionInterface | Record<string, never>>(
+        "GitHub.vscode-codeql",
+      )!
+      .activate();
+
+    storagePath =
+      extension.ctx.storageUri?.fsPath || extension.ctx.globalStorageUri.fsPath;
+  });
+
+  it("should add new remote db list", async () => {
+    // Add db list
+    jest.spyOn(window, "showInputBox").mockResolvedValue("my-list-1");
+    await commands.executeCommand("codeQLDatabasesExperimental.addNewList");
+
+    // Check db config
+    const dbConfigFilePath = path.join(storagePath, "workspace-databases.json");
+    const dbConfig: DbConfig = await readJson(dbConfigFilePath);
+    expect(dbConfig.databases.remote.repositoryLists).toHaveLength(1);
+    expect(dbConfig.databases.remote.repositoryLists[0].name).toBe("my-list-1");
+  });
+});