Pull out node classes to shared location

robertbrignull · robertbrignull · commit a5af2f2e4bf4 · 2023-05-19T13:04:58.000+01:00
diff --git a/extensions/ql-vscode/src/common/file-tree-nodes.ts b/extensions/ql-vscode/src/common/file-tree-nodes.ts
@@ -0,0 +1,103 @@
+import { basename, dirname, join } from "path";
+import { env } from "vscode";
+
+/**
+ * A node in the tree of files. This will be either a `FileTreeDirectory` or a `FileTreeLeaf`.
+ */
+export abstract class FileTreeNode {
+  constructor(private _path: string, private _name: string) {}
+
+  public get path(): string {
+    return this._path;
+  }
+
+  public get name(): string {
+    return this._name;
+  }
+
+  public abstract get children(): readonly FileTreeNode[];
+
+  public abstract finish(): void;
+}
+
+/**
+ * A directory containing one or more files or other directories.
+ */
+export class FileTreeDirectory extends FileTreeNode {
+  constructor(
+    _path: string,
+    _name: string,
+    private _children: FileTreeNode[] = [],
+  ) {
+    super(_path, _name);
+  }
+
+  public get children(): readonly FileTreeNode[] {
+    return this._children;
+  }
+
+  public addChild(child: FileTreeNode): void {
+    this._children.push(child);
+  }
+
+  public createDirectory(relativePath: string): FileTreeDirectory {
+    const dirName = dirname(relativePath);
+    if (dirName === ".") {
+      return this.createChildDirectory(relativePath);
+    } else {
+      const parent = this.createDirectory(dirName);
+      return parent.createDirectory(basename(relativePath));
+    }
+  }
+
+  public finish(): void {
+    // remove empty directories
+    this._children.filter(
+      (child) => child instanceof FileTreeLeaf || child.children.length > 0,
+    );
+    this._children.sort((a, b) => a.name.localeCompare(b.name, env.language));
+    this._children.forEach((child, i) => {
+      child.finish();
+      if (
+        child.children?.length === 1 &&
+        child.children[0] instanceof FileTreeDirectory
+      ) {
+        // collapse children
+        const replacement = new FileTreeDirectory(
+          child.children[0].path,
+          `${child.name} / ${child.children[0].name}`,
+          Array.from(child.children[0].children),
+        );
+        this._children[i] = replacement;
+      }
+    });
+  }
+
+  private createChildDirectory(name: string): FileTreeDirectory {
+    const existingChild = this._children.find((child) => child.name === name);
+    if (existingChild !== undefined) {
+      return existingChild as FileTreeDirectory;
+    } else {
+      const newChild = new FileTreeDirectory(join(this.path, name), name);
+      this.addChild(newChild);
+      return newChild;
+    }
+  }
+}
+
+/**
+ * A single file.
+ */
+export class FileTreeLeaf extends FileTreeNode {
+  constructor(_path: string, _name: string) {
+    super(_path, _name);
+  }
+
+  public get children(): readonly FileTreeNode[] {
+    return [];
+  }
+
+  public finish(): void {
+    /**/
+  }
+}
diff --git a/extensions/ql-vscode/src/query-testing/qltest-discovery.ts b/extensions/ql-vscode/src/query-testing/qltest-discovery.ts
@@ -1,117 +1,16 @@
-import { dirname, basename, join, normalize, relative, extname } from "path";
+import { dirname, basename, normalize, relative, extname } from "path";
 import { Discovery } from "../common/discovery";
 import {
   EventEmitter,
   Event,
   Uri,
   RelativePattern,
   WorkspaceFolder,
-  env,
 } from "vscode";
 import { MultiFileSystemWatcher } from "../common/vscode/multi-file-system-watcher";
 import { CodeQLCliServer } from "../codeql-cli/cli";
 import { pathExists } from "fs-extra";
-
-/**
- * A node in the tree of tests. This will be either a `QLTestDirectory` or a `QLTestFile`.
- */
-export abstract class QLTestNode {
-  constructor(private _path: string, private _name: string) {}
-
-  public get path(): string {
-    return this._path;
-  }
-
-  public get name(): string {
-    return this._name;
-  }
-
-  public abstract get children(): readonly QLTestNode[];
-
-  public abstract finish(): void;
-}
-
-/**
- * A directory containing one or more QL tests or other test directories.
- */
-export class QLTestDirectory extends QLTestNode {
-  constructor(
-    _path: string,
-    _name: string,
-    private _children: QLTestNode[] = [],
-  ) {
-    super(_path, _name);
-  }
-
-  public get children(): readonly QLTestNode[] {
-    return this._children;
-  }
-
-  public addChild(child: QLTestNode): void {
-    this._children.push(child);
-  }
-
-  public createDirectory(relativePath: string): QLTestDirectory {
-    const dirName = dirname(relativePath);
-    if (dirName === ".") {
-      return this.createChildDirectory(relativePath);
-    } else {
-      const parent = this.createDirectory(dirName);
-      return parent.createDirectory(basename(relativePath));
-    }
-  }
-
-  public finish(): void {
-    // remove empty directories
-    this._children.filter(
-      (child) => child instanceof QLTestFile || child.children.length > 0,
-    );
-    this._children.sort((a, b) => a.name.localeCompare(b.name, env.language));
-    this._children.forEach((child, i) => {
-      child.finish();
-      if (
-        child.children?.length === 1 &&
-        child.children[0] instanceof QLTestDirectory
-      ) {
-        // collapse children
-        const replacement = new QLTestDirectory(
-          child.children[0].path,
-          `${child.name} / ${child.children[0].name}`,
-          Array.from(child.children[0].children),
-        );
-        this._children[i] = replacement;
-      }
-    });
-  }
-
-  private createChildDirectory(name: string): QLTestDirectory {
-    const existingChild = this._children.find((child) => child.name === name);
-    if (existingChild !== undefined) {
-      return existingChild as QLTestDirectory;
-    } else {
-      const newChild = new QLTestDirectory(join(this.path, name), name);
-      this.addChild(newChild);
-      return newChild;
-    }
-  }
-}
-
-/**
- * A single QL test. This will be either a `.ql` file or a `.qlref` file.
- */
-export class QLTestFile extends QLTestNode {
-  constructor(_path: string, _name: string) {
-    super(_path, _name);
-  }
-
-  public get children(): readonly QLTestNode[] {
-    return [];
-  }
-
-  public finish(): void {
-    /**/
-  }
-}
+import { FileTreeDirectory, FileTreeLeaf } from "../common/file-tree-nodes";
 
 /**
  * The results of discovering QL tests.
@@ -120,7 +19,7 @@ interface QLTestDiscoveryResults {
   /**
    * A directory that contains one or more QL Tests, or other QLTestDirectories.
    */
-  testDirectory: QLTestDirectory | undefined;
+  testDirectory: FileTreeDirectory | undefined;
 
   /**
    * The file system path to a directory to watch. If any ql or qlref file changes in
@@ -137,7 +36,7 @@ export class QLTestDiscovery extends Discovery<QLTestDiscoveryResults> {
   private readonly watcher: MultiFileSystemWatcher = this.push(
     new MultiFileSystemWatcher(),
   );
-  private _testDirectory: QLTestDirectory | undefined;
+  private _testDirectory: FileTreeDirectory | undefined;
 
   constructor(
     private readonly workspaceFolder: WorkspaceFolder,
@@ -159,7 +58,7 @@ export class QLTestDiscovery extends Discovery<QLTestDiscoveryResults> {
    * The root directory. There is at least one test in this directory, or
    * in a subdirectory of this.
    */
-  public get testDirectory(): QLTestDirectory | undefined {
+  public get testDirectory(): FileTreeDirectory | undefined {
     return this._testDirectory;
   }
 
@@ -194,10 +93,10 @@ export class QLTestDiscovery extends Discovery<QLTestDiscoveryResults> {
    * @returns A `QLTestDirectory` object describing the contents of the directory, or `undefined` if
    *   no tests were found.
    */
-  private async discoverTests(): Promise<QLTestDirectory> {
+  private async discoverTests(): Promise<FileTreeDirectory> {
     const fullPath = this.workspaceFolder.uri.fsPath;
     const name = this.workspaceFolder.name;
-    const rootDirectory = new QLTestDirectory(fullPath, name);
+    const rootDirectory = new FileTreeDirectory(fullPath, name);
 
     // Don't try discovery on workspace folders that don't exist on the filesystem
     if (await pathExists(fullPath)) {
@@ -208,7 +107,9 @@ export class QLTestDiscovery extends Discovery<QLTestDiscoveryResults> {
         const relativePath = normalize(relative(fullPath, testPath));
         const dirName = dirname(relativePath);
         const parentDirectory = rootDirectory.createDirectory(dirName);
-        parentDirectory.addChild(new QLTestFile(testPath, basename(testPath)));
+        parentDirectory.addChild(
+          new FileTreeLeaf(testPath, basename(testPath)),
+        );
       }
 
       rootDirectory.finish();
diff --git a/extensions/ql-vscode/src/query-testing/test-adapter.ts b/extensions/ql-vscode/src/query-testing/test-adapter.ts
@@ -13,17 +13,17 @@ import {
   TestHub,
 } from "vscode-test-adapter-api";
 import { TestAdapterRegistrar } from "vscode-test-adapter-util";
-import {
-  QLTestFile,
-  QLTestNode,
-  QLTestDirectory,
-  QLTestDiscovery,
-} from "./qltest-discovery";
+import { QLTestDiscovery } from "./qltest-discovery";
 import { Event, EventEmitter, CancellationTokenSource } from "vscode";
 import { DisposableObject } from "../pure/disposable-object";
 import { CodeQLCliServer, TestCompleted } from "../codeql-cli/cli";
 import { testLogger } from "../common";
 import { TestRunner } from "./test-runner";
+import {
+  FileTreeDirectory,
+  FileTreeLeaf,
+  FileTreeNode,
+} from "../common/file-tree-nodes";
 
 /**
  * Get the full path of the `.expected` file for the specified QL test.
@@ -135,26 +135,26 @@ export class QLTestAdapter extends DisposableObject implements TestAdapter {
   }
 
   private static createTestOrSuiteInfos(
-    testNodes: readonly QLTestNode[],
+    testNodes: readonly FileTreeNode[],
   ): Array<TestSuiteInfo | TestInfo> {
     return testNodes.map((childNode) => {
       return QLTestAdapter.createTestOrSuiteInfo(childNode);
     });
   }
 
   private static createTestOrSuiteInfo(
-    testNode: QLTestNode,
+    testNode: FileTreeNode,
   ): TestSuiteInfo | TestInfo {
-    if (testNode instanceof QLTestFile) {
+    if (testNode instanceof FileTreeLeaf) {
       return QLTestAdapter.createTestInfo(testNode);
-    } else if (testNode instanceof QLTestDirectory) {
+    } else if (testNode instanceof FileTreeDirectory) {
       return QLTestAdapter.createTestSuiteInfo(testNode, testNode.name);
     } else {
       throw new Error("Unexpected test type.");
     }
   }
 
-  private static createTestInfo(testFile: QLTestFile): TestInfo {
+  private static createTestInfo(testFile: FileTreeLeaf): TestInfo {
     return {
       type: "test",
       id: testFile.path,
@@ -165,7 +165,7 @@ export class QLTestAdapter extends DisposableObject implements TestAdapter {
   }
 
   private static createTestSuiteInfo(
-    testDirectory: QLTestDirectory,
+    testDirectory: FileTreeDirectory,
     label: string,
   ): TestSuiteInfo {
     return {
diff --git a/extensions/ql-vscode/src/query-testing/test-manager.ts b/extensions/ql-vscode/src/query-testing/test-manager.ts
@@ -16,19 +16,19 @@ import {
   workspace,
 } from "vscode";
 import { DisposableObject } from "../pure/disposable-object";
-import {
-  QLTestDirectory,
-  QLTestDiscovery,
-  QLTestFile,
-  QLTestNode,
-} from "./qltest-discovery";
+import { QLTestDiscovery } from "./qltest-discovery";
 import { CodeQLCliServer } from "../codeql-cli/cli";
 import { getErrorMessage } from "../pure/helpers-pure";
 import { BaseLogger, LogOptions } from "../common";
 import { TestRunner } from "./test-runner";
 import { TestManagerBase } from "./test-manager-base";
 import { App } from "../common/app";
 import { isWorkspaceFolderOnDisk } from "../helpers";
+import {
+  FileTreeDirectory,
+  FileTreeLeaf,
+  FileTreeNode,
+} from "../common/file-tree-nodes";
 
 /**
  * Returns the complete text content of the specified file. If there is an error reading the file,
@@ -209,7 +209,7 @@ export class TestManager extends TestManagerBase {
    */
   public updateTestsForWorkspaceFolder(
     workspaceFolder: WorkspaceFolder,
-    testDirectory: QLTestDirectory | undefined,
+    testDirectory: FileTreeDirectory | undefined,
   ): void {
     if (testDirectory !== undefined) {
       // Adding an item with the same ID as an existing item will replace it, which is exactly what
@@ -229,9 +229,9 @@ export class TestManager extends TestManagerBase {
   /**
    * Creates a tree of `TestItem`s from the root `QlTestNode` provided by test discovery.
    */
-  private createTestItemTree(node: QLTestNode, isRoot: boolean): TestItem {
+  private createTestItemTree(node: FileTreeNode, isRoot: boolean): TestItem {
     // Prefix the ID to identify it as a directory or a test
-    const itemType = node instanceof QLTestDirectory ? "dir" : "test";
+    const itemType = node instanceof FileTreeDirectory ? "dir" : "test";
     const testItem = this.testController.createTestItem(
       // For the root of a workspace folder, use the full path as the ID. Otherwise, use the node's
       // name as the ID, since it's shorter but still unique.
@@ -242,7 +242,7 @@ export class TestManager extends TestManagerBase {
 
     for (const childNode of node.children) {
       const childItem = this.createTestItemTree(childNode, false);
-      if (childNode instanceof QLTestFile) {
+      if (childNode instanceof FileTreeLeaf) {
         childItem.range = new Range(0, 0, 0, 0);
       }
       testItem.children.add(childItem);
