Merge pull request #2306 from github/dbartol/new-test-ui

Use native VS Code test UI on canary

Author: Dave Bartolomeo

extensions/ql-vscode/package.json

@@ -682,6 +682,10 @@
         "command": "codeQLTests.acceptOutput",
         "title": "Accept Test Output"
       },
+      {
+        "command": "codeQLTests.acceptOutputContextTestItem",
+        "title": "Accept Test Output"
+      },
       {
         "command": "codeQLAstViewer.gotoCode",
         "title": "Go To Code"
@@ -977,6 +981,13 @@
           "when": "viewItem == testWithSource"
         }
       ],
+      "testing/item/context": [
+        {
+          "command": "codeQLTests.acceptOutputContextTestItem",
+          "group": "qltest@1",
+          "when": "controllerId == codeql && testId =~ /^test /"
+        }
+      ],
       "explorer/context": [
         {
           "command": "codeQL.setCurrentDatabase",
@@ -1325,6 +1336,10 @@
         {
           "command": "codeQL.createQuery",
           "when": "config.codeQL.canary"
+        },
+        {
+          "command": "codeQLTests.acceptOutputContextTestItem",
+          "when": "false"
         }
       ],
       "editor/context": [

extensions/ql-vscode/src/cli.ts

@@ -23,7 +23,7 @@ import {
   getErrorStack,
 } from "./pure/helpers-pure";
 import { QueryMetadata, SortDirection } from "./pure/interface-types";
-import { Logger, ProgressReporter } from "./common";
+import { BaseLogger, Logger, ProgressReporter } from "./common";
 import { CompilationMessage } from "./pure/legacy-messages";
 import { sarifParser } from "./sarif-parser";
 import { walkDirectory } from "./helpers";
@@ -149,6 +149,7 @@ export interface TestCompleted {
   compilationMs: number;
   evaluationMs: number;
   expected: string;
+  actual?: string;
   diff: string[] | undefined;
   failureDescription?: string;
   failureStage?: string;
@@ -439,14 +440,19 @@ export class CodeQLCliServer implements Disposable {
     command: string[],
     commandArgs: string[],
     cancellationToken?: CancellationToken,
-    logger?: Logger,
+    logger?: BaseLogger,
   ): AsyncGenerator<string, void, unknown> {
     // Add format argument first, in case commandArgs contains positional parameters.
     const args = [...command, "--format", "jsonz", ...commandArgs];
 
     // Spawn the CodeQL process
     const codeqlPath = await this.getCodeQlPath();
     const childPromise = spawn(codeqlPath, args);
+    // Avoid a runtime message about unhandled rejection.
+    childPromise.catch(() => {
+      /**/
+    });
+
     const child = childPromise.childProcess;
 
     let cancellationRegistration: Disposable | undefined = undefined;
@@ -497,7 +503,7 @@ export class CodeQLCliServer implements Disposable {
       logger,
     }: {
       cancellationToken?: CancellationToken;
-      logger?: Logger;
+      logger?: BaseLogger;
     } = {},
   ): AsyncGenerator<EventType, void, unknown> {
     for await (const event of this.runAsyncCodeQlCliCommandInternal(
@@ -776,7 +782,7 @@ export class CodeQLCliServer implements Disposable {
       logger,
     }: {
       cancellationToken?: CancellationToken;
-      logger?: Logger;
+      logger?: BaseLogger;
     },
   ): AsyncGenerator<TestCompleted, void, unknown> {
     const subcommandArgs = this.cliConfig.additionalTestArguments.concat([
@@ -1661,7 +1667,7 @@ const lineEndings = ["\r\n", "\r", "\n"];
  * @param stream The stream to log.
  * @param logger The logger that will consume the stream output.
  */
-async function logStream(stream: Readable, logger: Logger): Promise<void> {
+async function logStream(stream: Readable, logger: BaseLogger): Promise<void> {
   for await (const line of splitStreamAtSeparators(stream, lineEndings)) {
     // Await the result of log here in order to ensure the logs are written in the correct order.
     await logger.log(line);

extensions/ql-vscode/src/common/commands.ts

@@ -298,6 +298,9 @@ export type SummaryLanguageSupportCommands = {
 export type TestUICommands = {
   "codeQLTests.showOutputDifferences": (node: TestTreeNode) => Promise<void>;
   "codeQLTests.acceptOutput": (node: TestTreeNode) => Promise<void>;
+  "codeQLTests.acceptOutputContextTestItem": (
+    node: TestTreeNode,
+  ) => Promise<void>;
 };
 
 export type MockGitHubApiServerCommands = {

extensions/ql-vscode/src/extension.ts

@@ -31,6 +31,7 @@ import { CodeQLCliServer } from "./cli";
 import {
   CliConfigListener,
   DistributionConfigListener,
+  isCanary,
   joinOrderWarningThreshold,
   QueryHistoryConfigListener,
   QueryServerConfigListener,
@@ -114,14 +115,16 @@ import {
   BaseCommands,
   PreActivationCommands,
   QueryServerCommands,
-  TestUICommands,
 } from "./common/commands";
 import { LocalQueries } from "./local-queries";
 import { getAstCfgCommands } from "./ast-cfg-commands";
 import { getQueryEditorCommands } from "./query-editor";
 import { App } from "./common/app";
 import { registerCommandWithErrorHandling } from "./common/vscode/commands";
 import { DataExtensionsEditorModule } from "./data-extensions-editor/data-extensions-editor-module";
+import { TestManager } from "./test-manager";
+import { TestRunner } from "./test-runner";
+import { TestManagerBase } from "./test-manager-base";
 
 /**
  * extension.ts
@@ -885,25 +888,34 @@ async function activateWithInstalledDistribution(
     );
 
   void extLogger.log("Initializing QLTest interface.");
-  const testExplorerExtension = extensions.getExtension<TestHub>(
-    testExplorerExtensionId,
-  );
-  let testUiCommands: Partial<TestUICommands> = {};
-  if (testExplorerExtension) {
-    const testHub = testExplorerExtension.exports;
-    const testAdapterFactory = new QLTestAdapterFactory(
-      testHub,
-      cliServer,
-      dbm,
-    );
-    ctx.subscriptions.push(testAdapterFactory);
 
-    const testUIService = new TestUIService(app, testHub);
-    ctx.subscriptions.push(testUIService);
+  const testRunner = new TestRunner(dbm, cliServer);
+  ctx.subscriptions.push(testRunner);
+
+  let testManager: TestManagerBase | undefined = undefined;
+  if (isCanary()) {
+    testManager = new TestManager(app, testRunner, cliServer);
+    ctx.subscriptions.push(testManager);
+  } else {
+    const testExplorerExtension = extensions.getExtension<TestHub>(
+      testExplorerExtensionId,
+    );
+    if (testExplorerExtension) {
+      const testHub = testExplorerExtension.exports;
+      const testAdapterFactory = new QLTestAdapterFactory(
+        testHub,
+        testRunner,
+        cliServer,
+      );
+      ctx.subscriptions.push(testAdapterFactory);
 
-    testUiCommands = testUIService.getCommands();
+      testManager = new TestUIService(app, testHub);
+      ctx.subscriptions.push(testManager);
+    }
   }
 
+  const testUiCommands = testManager?.getCommands() ?? {};
+
   const astViewer = new AstViewer();
   const astTemplateProvider = new TemplatePrintAstProvider(
     cliServer,