Use more-specific types for test results and diagnostics. (#15387)

(for #14866)

Some of the problems we've run into relate to how we are using the same broad types for all the different kinds of test results (passing, failing, active and unknown). This change addresses that by switching to specific types tailored to the relevant kinds of test results.

Author: Eric Snow

.eslintignore

@@ -127,11 +127,6 @@ src/test/testing/codeLenses/testFiles.unit.test.ts
 src/test/testing/nosetest/nosetest.test.ts
 src/test/testing/nosetest/nosetest.disovery.test.ts
 src/test/testing/nosetest/nosetest.run.test.ts
-src/test/testing/pytest/pytest.testMessageService.test.ts
-src/test/testing/pytest/pytest_unittest_parser_data.ts
-src/test/testing/pytest/pytest.test.ts
-src/test/testing/pytest/pytest_run_tests_data.ts
-src/test/testing/pytest/services/discoveryService.unit.test.ts
 src/test/testing/rediscover.test.ts
 src/test/testing/helper.ts
 src/test/testing/navigation/fileNavigator.unit.test.ts
@@ -140,7 +135,6 @@ src/test/testing/navigation/suiteNavigator.unit.test.ts
 src/test/testing/navigation/commandHandlers.unit.test.ts
 src/test/testing/navigation/helper.unit.test.ts
 src/test/testing/navigation/symbolNavigator.unit.test.ts
-src/test/testing/configuration.unit.test.ts
 src/test/testing/explorer/treeView.unit.test.ts
 src/test/testing/explorer/testExplorerCommandHandler.unit.test.ts
 src/test/testing/explorer/failedTestHandler.unit.test.ts
@@ -151,8 +145,6 @@ src/test/testing/banners/proposeNewLanguageServerBanner.unit.test.ts
 src/test/testing/common/argsHelper.unit.test.ts
 src/test/testing/common/trackEnablement.unit.test.ts
 src/test/testing/common/debugLauncher.unit.test.ts
-src/test/testing/common/managers/baseTestManager.unit.test.ts
-src/test/testing/common/managers/testConfigurationManager.unit.test.ts
 src/test/testing/common/testUtils.unit.test.ts
 src/test/testing/common/testVisitors/resultResetVisitor.unit.test.ts
 src/test/testing/common/services/discoveredTestParser.unit.test.ts
@@ -443,12 +435,6 @@ src/client/testing/nosetest/services/parserService.ts
 src/client/testing/nosetest/services/argsService.ts
 src/client/testing/nosetest/services/discoveryService.ts
 src/client/testing/main.ts
-src/client/testing/pytest/main.ts
-src/client/testing/pytest/testConfigurationManager.ts
-src/client/testing/pytest/runner.ts
-src/client/testing/pytest/services/argsService.ts
-src/client/testing/pytest/services/discoveryService.ts
-src/client/testing/pytest/services/testMessageService.ts
 src/client/testing/configurationFactory.ts
 src/client/testing/navigation/serviceRegistry.ts
 src/client/testing/navigation/symbolProvider.ts
@@ -462,13 +448,9 @@ src/client/testing/explorer/testTreeViewProvider.ts
 src/client/testing/explorer/commandHandlers.ts
 src/client/testing/explorer/failedTestHandler.ts
 src/client/testing/explorer/treeView.ts
-src/client/testing/types.ts
 src/client/testing/common/argumentsHelper.ts
 src/client/testing/common/enablementTracker.ts
 src/client/testing/common/debugLauncher.ts
-src/client/testing/common/managers/testConfigurationManager.ts
-src/client/testing/common/managers/baseTestManager.ts
-src/client/testing/common/types.ts
 src/client/testing/common/constants.ts
 src/client/testing/common/testUtils.ts
 src/client/testing/common/xUnitParser.ts
@@ -481,7 +463,6 @@ src/client/testing/common/services/contextService.ts
 src/client/testing/common/services/testResultsService.ts
 src/client/testing/common/services/storageService.ts
 src/client/testing/common/services/types.ts
-src/client/testing/common/services/unitTestDiagnosticService.ts
 src/client/testing/common/services/testsStatusService.ts
 src/client/testing/common/services/discovery.ts
 src/client/testing/common/services/configSettingService.ts

src/client/activation/jedi.ts

@@ -40,7 +40,7 @@ import { PythonRenameProvider } from '../providers/renameProvider';
 import { PythonSignatureProvider } from '../providers/signatureProvider';
 import { JediSymbolProvider } from '../providers/symbolProvider';
 import { PythonEnvironment } from '../pythonEnvironments/info';
-import { ITestManagementService } from '../testing/types';
+import { ITestingService } from '../testing/types';
 import { BlockFormatProviders } from '../typeFormatters/blockFormatProvider';
 import { OnTypeFormattingDispatcher } from '../typeFormatters/dispatcher';
 import { OnEnterFormatter } from '../typeFormatters/onEnterFormatter';
@@ -94,7 +94,7 @@ export class JediExtensionActivator implements ILanguageServerActivator {
             context.subscriptions.push(JediExtensionActivator.workspaceSymbols);
         }
 
-        const testManagementService = this.serviceManager.get<ITestManagementService>(ITestManagementService);
+        const testManagementService = this.serviceManager.get<ITestingService>(ITestingService);
         testManagementService
             .activate(this.symbolProvider)
             .catch((ex) => traceError('Failed to activate Unit Tests', ex));

src/client/activation/jedi/languageServerProxy.ts

@@ -21,7 +21,7 @@ import { LanguageServerSymbolProvider } from '../../providers/symbolProvider';
 import { PythonEnvironment } from '../../pythonEnvironments/info';
 import { captureTelemetry } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { ITestManagementService } from '../../testing/types';
+import { ITestingService } from '../../testing/types';
 import { FileBasedCancellationStrategy } from '../common/cancellationUtils';
 import { LanguageClientMiddleware } from '../languageClientMiddleware';
 import { ProgressReporting } from '../progress';
@@ -43,7 +43,7 @@ export class JediLanguageServerProxy implements ILanguageServerProxy {
 
     constructor(
         @inject(ILanguageClientFactory) private readonly factory: ILanguageClientFactory,
-        @inject(ITestManagementService) private readonly testManager: ITestManagementService,
+        @inject(ITestingService) private readonly testManager: ITestingService,
         @inject(IExperimentsManager) private readonly experiments: IExperimentsManager,
         @inject(IInterpreterPathService) private readonly interpreterPathService: IInterpreterPathService,
     ) {

src/client/activation/languageServer/languageServerProxy.ts

@@ -14,7 +14,7 @@ import { LanguageServerSymbolProvider } from '../../providers/symbolProvider';
 import { PythonEnvironment } from '../../pythonEnvironments/info';
 import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { ITestManagementService } from '../../testing/types';
+import { ITestingService } from '../../testing/types';
 import { ProgressReporting } from '../progress';
 import { ILanguageClientFactory, ILanguageServerProxy } from '../types';
 
@@ -28,7 +28,7 @@ export class DotNetLanguageServerProxy implements ILanguageServerProxy {
 
     constructor(
         @inject(ILanguageClientFactory) private readonly factory: ILanguageClientFactory,
-        @inject(ITestManagementService) private readonly testManager: ITestManagementService,
+        @inject(ITestingService) private readonly testManager: ITestingService,
         @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
     ) {
         this.startupCompleted = createDeferred<void>();

src/client/activation/node/languageServerProxy.ts

@@ -28,7 +28,7 @@ import { LanguageServerSymbolProvider } from '../../providers/symbolProvider';
 import { PythonEnvironment } from '../../pythonEnvironments/info';
 import { captureTelemetry, sendTelemetryEvent } from '../../telemetry';
 import { EventName } from '../../telemetry/constants';
-import { ITestManagementService } from '../../testing/types';
+import { ITestingService } from '../../testing/types';
 import { FileBasedCancellationStrategy } from '../common/cancellationUtils';
 import { ProgressReporting } from '../progress';
 import { ILanguageClientFactory, ILanguageServerFolderService, ILanguageServerProxy } from '../types';
@@ -68,7 +68,7 @@ export class NodeLanguageServerProxy implements ILanguageServerProxy {
 
     constructor(
         @inject(ILanguageClientFactory) private readonly factory: ILanguageClientFactory,
-        @inject(ITestManagementService) private readonly testManager: ITestManagementService,
+        @inject(ITestingService) private readonly testManager: ITestingService,
         @inject(IConfigurationService) private readonly configurationService: IConfigurationService,
         @inject(ILanguageServerFolderService) private readonly folderService: ILanguageServerFolderService,
         @inject(IExperimentsManager) private readonly experiments: IExperimentsManager,

src/client/common/application/commands.ts

@@ -3,14 +3,12 @@
 
 'use strict';
 
-import { CancellationToken, Position, TextDocument, Uri } from 'vscode';
+import { CancellationToken, Disposable, Position, TextDocument, Uri } from 'vscode';
 import { Commands as LSCommands } from '../../activation/commands';
 import { TensorBoardEntrypoint, TensorBoardEntrypointTrigger } from '../../tensorBoard/constants';
-import { CommandSource } from '../../testing/common/constants';
-import { TestFunction, TestsToRun } from '../../testing/common/types';
-import { TestDataItem, TestWorkspaceFolder } from '../../testing/types';
+import { TestDataItem, TestFunction, TestsToRun, TestWorkspaceFolder } from '../../testing/common/types';
 import { Commands } from '../constants';
-import { Channel } from './types';
+import { Channel, CommandSource, ICommandManager } from './types';
 
 export type CommandsWithoutArgs = keyof ICommandNameWithoutArgumentTypeMapping;
 
@@ -129,3 +127,17 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
     [Commands.navigateToTestSuite]: [Uri, TestDataItem, boolean];
     [Commands.LaunchTensorBoard]: [TensorBoardEntrypoint, TensorBoardEntrypointTrigger];
 }
+
+//export const IPythonCommandManager = Symbol('IPythonCommandManager');
+export interface IPythonCommandManager extends ICommandManager {
+    registerCommand<E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
+        command: E,
+        callback: (...args: U) => any,
+        thisArg?: any,
+    ): Disposable;
+
+    executeCommand<T, E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
+        command: E,
+        ...rest: U
+    ): Thenable<T | undefined>;
+}

src/client/common/application/types.ts

@@ -76,7 +76,14 @@ import type {
 } from 'vscode-proposed';
 
 import { IAsyncDisposable, Resource } from '../types';
-import { ICommandNameArgumentTypeMapping } from './commands';
+
+export enum CommandSource {
+    auto = 'auto',
+    ui = 'ui',
+    codelens = 'codelens',
+    commandPalette = 'commandpalette',
+    testExplorer = 'testExplorer',
+}
 
 export const IApplicationShell = Symbol('IApplicationShell');
 export interface IApplicationShell {
@@ -445,11 +452,7 @@ export interface ICommandManager {
      * @param thisArg The `this` context used when invoking the handler function.
      * @return Disposable which unregisters this command on disposal.
      */
-    registerCommand<E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
-        command: E,
-        callback: (...args: U) => any,
-        thisArg?: any,
-    ): Disposable;
+    registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;
 
     /**
      * Registers a text editor command that can be invoked via a keyboard shortcut,
@@ -485,10 +488,7 @@ export interface ICommandManager {
      * @return A thenable that resolves to the returned value of the given command. `undefined` when
      * the command handler function doesn't return anything.
      */
-    executeCommand<T, E extends keyof ICommandNameArgumentTypeMapping, U extends ICommandNameArgumentTypeMapping[E]>(
-        command: E,
-        ...rest: U
-    ): Thenable<T | undefined>;
+    executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
 
     /**
      * Retrieve the list of all available commands. Commands starting an underscore are

src/client/common/configSettings.ts

@@ -20,6 +20,7 @@ import { LogLevel } from '../logging/levels';
 import { sendTelemetryEvent } from '../telemetry';
 import { EventName } from '../telemetry/constants';
 import { sendSettingTelemetry } from '../telemetry/envFileTelemetry';
+import { ITestingSettings } from '../testing/configuration/types';
 import { IWorkspaceService } from './application/types';
 import { WorkspaceService } from './application/workspace';
 import { DEFAULT_INTERPRETER_SETTING, isTestExecution } from './constants';
@@ -40,7 +41,6 @@ import {
     IPythonSettings,
     ISortImportSettings,
     ITerminalSettings,
-    ITestingSettings,
     IWorkspaceSymbolSettings,
     LoggingLevelSettingType,
     Resource,

src/client/common/installer/productPath.ts

@@ -9,7 +9,7 @@ import { Uri } from 'vscode';
 import { IFormatterHelper } from '../../formatters/types';
 import { IServiceContainer } from '../../ioc/types';
 import { ILinterManager } from '../../linters/types';
-import { ITestsHelper } from '../../testing/common/types';
+import { ITestingService } from '../../testing/types';
 import { IConfigurationService, IInstaller, ModuleNamePurpose, Product } from '../types';
 import { IProductPathService } from './types';
 
@@ -78,7 +78,7 @@ export class TestFrameworkProductPathService extends BaseProductPathsService {
         super(serviceContainer);
     }
     public getExecutableNameFromSettings(product: Product, resource?: Uri): string {
-        const testHelper = this.serviceContainer.get<ITestsHelper>(ITestsHelper);
+        const testHelper = this.serviceContainer.get<ITestingService>(ITestingService);
         const settingsPropNames = testHelper.getSettingsPropertyNames(product);
         if (!settingsPropNames.pathName) {
             // E.g. in the case of UnitTests we don't allow customizing the paths.

src/client/common/serviceRegistry.ts

@@ -18,6 +18,7 @@ import { ApplicationEnvironment } from './application/applicationEnvironment';
 import { ApplicationShell } from './application/applicationShell';
 import { ClipboardService } from './application/clipboard';
 import { CommandManager } from './application/commandManager';
+import { IPythonCommandManager } from './application/commands';
 import { ReloadVSCodeCommandHandler } from './application/commands/reloadCommand';
 import { CustomEditorService } from './application/customEditorService';
 import { DebugService } from './application/debugService';
@@ -143,7 +144,7 @@ export function registerTypes(serviceManager: IServiceManager) {
         IJupyterExtensionDependencyManager,
         JupyterExtensionDependencyManager,
     );
-    serviceManager.addSingleton<ICommandManager>(ICommandManager, CommandManager);
+    serviceManager.addSingleton<IPythonCommandManager>(ICommandManager, CommandManager);
     serviceManager.addSingleton<IConfigurationService>(IConfigurationService, ConfigurationService);
     serviceManager.addSingleton<IWorkspaceService>(IWorkspaceService, WorkspaceService);
     serviceManager.addSingleton<IProcessLogger>(IProcessLogger, ProcessLogger);