Auto expand failed tests in test explorer (microsoft#5052)

For microsoft#4386

Author: DonJayamanne

gulpfile.js

@@ -811,7 +811,6 @@ function getFilesToProcess(fileList) {
 * @param {hygieneOptions} options
 */
 function getFileListToProcess(options) {
- return [];
  const mode = options ? options.mode : 'all';
  const gulpSrcOptions = { base: '.' };
 

news/1 Enhancements/4386.md

@@ -0,0 +1 @@
+Auto expand tree view in `Test Explorer` to display failed tests.

src/client/common/application/applicationShell.ts

@@ -5,7 +5,7 @@
 // tslint:disable:no-var-requires no-any unified-signatures
 
 import { injectable } from 'inversify';
-import { CancellationToken, Disposable, env, InputBox, InputBoxOptions, MessageItem, MessageOptions, OpenDialogOptions, Progress, ProgressOptions, QuickPick, QuickPickItem, QuickPickOptions, SaveDialogOptions, StatusBarAlignment, StatusBarItem, Uri, window, WorkspaceFolder, WorkspaceFolderPickOptions } from 'vscode';
+import { CancellationToken, Disposable, env, InputBox, InputBoxOptions, MessageItem, MessageOptions, OpenDialogOptions, Progress, ProgressOptions, QuickPick, QuickPickItem, QuickPickOptions, SaveDialogOptions, StatusBarAlignment, StatusBarItem, TreeView, TreeViewOptions, Uri, window, WorkspaceFolder, WorkspaceFolderPickOptions } from 'vscode';
 import { IApplicationShell } from './types';
 
 @injectable()
@@ -75,4 +75,8 @@ export class ApplicationShell implements IApplicationShell {
  public createInputBox(): InputBox {
  return window.createInputBox();
  }
+ public createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T> {
+ return window.createTreeView<T>(viewId, options);
+ }
+
 }

src/client/common/application/commands.ts

@@ -70,6 +70,7 @@ export interface ICommandNameArgumentTypeMapping extends ICommandNameWithoutArgu
  [Commands.Tests_Select_And_Run_File]: [undefined, CommandSource];
  [Commands.Tests_Run_Current_File]: [undefined, CommandSource];
  [Commands.Tests_Stop]: [undefined, Uri];
+ [Commands.Test_Reveal_Test_Item]: [TestDataItem];
  // When command is invoked from a tree node, first argument is the node data.
  [Commands.Tests_Run]: [undefined | TestWorkspaceFolder, undefined | CommandSource, undefined | Uri, undefined | TestsToRun];
  // When command is invoked from a tree node, first argument is the node data.

src/client/common/application/types.ts

@@ -37,6 +37,8 @@ import {
  TextEditorOptionsChangeEvent,
  TextEditorSelectionChangeEvent,
  TextEditorViewColumnChangeEvent,
+ TreeView,
+ TreeViewOptions,
  Uri,
  ViewColumn,
  WorkspaceConfiguration,
@@ -331,6 +333,14 @@ export interface IApplicationShell {
  * @return The thenable the task-callback returned.
  */
  withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; increment?: number }>, token: CancellationToken) => Thenable<R>): Thenable<R>;
+
+ /**
+ * Create a [TreeView](#TreeView) for the view contributed using the extension point `views`.
+ * @param viewId Id of the view contributed using the extension point `views`.
+ * @param options Options for creating the [TreeView](#TreeView)
+ * @returns a [TreeView](#TreeView).
+ */
+ createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T>;
 }
 
 export const ICommandManager = Symbol('ICommandManager');

src/client/common/constants.ts

@@ -30,6 +30,7 @@ export namespace Commands {
  export const Tests_Ask_To_Stop_Test = 'python.askToStopUnitTests';
  export const Tests_Ask_To_Stop_Discovery = 'python.askToStopUnitTestDiscovery';
  export const Tests_Stop = 'python.stopUnitTests';
+ export const Test_Reveal_Test_Item = 'python.revealTestItem';
  export const ViewOutput = 'python.viewOutput';
  export const Tests_ViewOutput = 'python.viewTestOutput';
  export const Tests_Select_And_Run_Method = 'python.selectAndRunTestMethod';

src/client/unittests/explorer/failedTestHandler.ts

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, injectable } from 'inversify';
+import { Uri } from 'vscode';
+import { IExtensionActivationService } from '../../activation/types';
+import { ICommandManager } from '../../common/application/types';
+import { Commands } from '../../common/constants';
+import '../../common/extensions';
+import { IDisposable, IDisposableRegistry, Resource } from '../../common/types';
+import { debounceAsync } from '../../common/utils/decorators';
+import { getTestType } from '../common/testUtils';
+import { ITestCollectionStorageService, TestStatus, TestType } from '../common/types';
+import { TestDataItem } from '../types';
+
+@injectable()
+export class FailedTestHandler implements IExtensionActivationService, IDisposable {
+ private readonly disposables: IDisposable[] = [];
+ private readonly failedItems: TestDataItem[] = [];
+ constructor(@inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
+ @inject(ICommandManager) private readonly commandManager: ICommandManager,
+ @inject(ITestCollectionStorageService) private readonly storage: ITestCollectionStorageService) {
+ disposableRegistry.push(this);
+ }
+ public dispose() {
+ this.disposables.forEach(d => d.dispose());
+ }
+ public async activate(_resource: Resource): Promise<void> {
+ this.storage.onDidChange(this.onDidChangeTestData, this, this.disposables);
+ }
+ public onDidChangeTestData(args: { uri: Uri; data?: TestDataItem }): void {
+ if (args.data && (args.data.status === TestStatus.Error || args.data.status === TestStatus.Fail) &&
+ getTestType(args.data) === TestType.testFunction) {
+ this.failedItems.push(args.data);
+ this.revealFailedNodes().ignoreErrors();
+ }
+ }
+
+ @debounceAsync(500)
+ private async revealFailedNodes(): Promise<void> {
+ while (this.failedItems.length > 0) {
+ const item = this.failedItems.pop()!;
+ await this.commandManager.executeCommand(Commands.Test_Reveal_Test_Item, item);
+ }
+ }
+}

src/client/unittests/explorer/treeView.ts

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { inject, injectable } from 'inversify';
+import { TreeView } from 'vscode';
+import { IExtensionActivationService } from '../../activation/types';
+import { IApplicationShell, ICommandManager } from '../../common/application/types';
+import { Commands } from '../../common/constants';
+import { IDisposable, IDisposableRegistry, Resource } from '../../common/types';
+import { ITestTreeViewProvider, TestDataItem } from '../types';
+
+@injectable()
+export class TreeViewService implements IExtensionActivationService, IDisposable {
+ private _treeView!: TreeView<TestDataItem>;
+ private readonly disposables: IDisposable[] = [];
+ public get treeView(): TreeView<TestDataItem> {
+ return this._treeView;
+ }
+ constructor(@inject(ITestTreeViewProvider) private readonly treeViewProvider: ITestTreeViewProvider,
+ @inject(IDisposableRegistry) disposableRegistry: IDisposableRegistry,
+ @inject(IApplicationShell) private readonly appShell: IApplicationShell,
+ @inject(ICommandManager) private readonly commandManager: ICommandManager) {
+ disposableRegistry.push(this);
+ }
+ public dispose() {
+ this.disposables.forEach(d => d.dispose());
+ }
+ public async activate(_resource: Resource): Promise<void> {
+ this._treeView = this.appShell.createTreeView('python_tests', { showCollapseAll: true, treeDataProvider: this.treeViewProvider });
+ this.disposables.push(this._treeView);
+ this.disposables.push(this.commandManager.registerCommand(Commands.Test_Reveal_Test_Item, this.onRevealTestItem, this));
+ }
+ public async onRevealTestItem(testItem: TestDataItem): Promise<void> {
+ await this.treeView.reveal(testItem);
+ }
+}

src/client/unittests/main.ts

@@ -6,7 +6,7 @@ import { inject, injectable } from 'inversify';
 import {
  ConfigurationChangeEvent, Disposable,
  DocumentSymbolProvider, Event,
- EventEmitter, OutputChannel, TextDocument, Uri, window
+ EventEmitter, OutputChannel, TextDocument, Uri
 } from 'vscode';
 import {
  IApplicationShell, ICommandManager, IDocumentManager, IWorkspaceService
@@ -32,7 +32,7 @@ import {
  TestFunction, TestStatus, TestsToRun
 } from './common/types';
 import {
- ITestDisplay, ITestResultDisplay, ITestTreeViewProvider,
+ ITestDisplay, ITestResultDisplay,
  IUnitTestConfigurationService, IUnitTestManagementService,
  TestWorkspaceFolder,
  WorkspaceTestStatus
@@ -84,15 +84,10 @@ export class UnitTestManagementService implements IUnitTestManagementService, Di
  }
  this.activatedOnce = true;
  this.workspaceTestManagerService = this.serviceContainer.get<IWorkspaceTestManagerService>(IWorkspaceTestManagerService);
- const disposablesRegistry = this.serviceContainer.get<Disposable[]>(IDisposableRegistry);
 
  this.registerHandlers();
  this.registerCommands();
 
- const testViewProvider = this.serviceContainer.get<ITestTreeViewProvider>(ITestTreeViewProvider);
- const disposable = window.registerTreeDataProvider('python_tests', testViewProvider);
- disposablesRegistry.push(disposable);
-
  this.autoDiscoverTests(undefined)
  .catch(ex => this.serviceContainer.get<ILogger>(ILogger).logError('Failed to auto discover tests upon activation', ex));
  await this.registerSymbolProvider(symbolProvider);

src/client/unittests/serviceRegistry.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import { Uri } from 'vscode';
+import { IExtensionActivationService } from '../activation/types';
 import { IServiceContainer, IServiceManager } from '../ioc/types';
 import { ArgumentsHelper } from './common/argumentsHelper';
 import { NOSETEST_PROVIDER, PYTEST_PROVIDER, UNITTEST_PROVIDER } from './common/constants';
@@ -31,7 +32,9 @@ import { TestConfigurationManagerFactory } from './configurationFactory';
 import { TestResultDisplay } from './display/main';
 import { TestDisplay } from './display/picker';
 import { TestExplorerCommandHandler } from './explorer/commandHandlers';
+import { FailedTestHandler } from './explorer/failedTestHandler';
 import { TestTreeViewProvider } from './explorer/testTreeViewProvider';
+import { TreeViewService } from './explorer/treeView';
 import { UnitTestManagementService } from './main';
 import { registerTypes as registerNavigationTypes } from './navigation/serviceRegistry';
 import { ITestExplorerCommandHandler } from './navigation/types';
@@ -50,8 +53,8 @@ import {
  IArgumentsHelper, IArgumentsService, ITestConfigSettingsService,
  ITestConfigurationManagerFactory, ITestDataItemResource, ITestDisplay,
  ITestManagerRunner, ITestResultDisplay, ITestTreeViewProvider,
- IUnitTestConfigurationService, IUnitTestDiagnosticService,
- IUnitTestHelper, IUnitTestManagementService
+ IUnitTestConfigurationService,
+ IUnitTestDiagnosticService, IUnitTestHelper, IUnitTestManagementService
 } from './types';
 import { UnitTestHelper } from './unittest/helper';
 import { TestManager as UnitTestTestManager } from './unittest/main';
@@ -109,6 +112,8 @@ export function registerTypes(serviceManager: IServiceManager) {
  serviceManager.addSingleton<ITestTreeViewProvider>(ITestTreeViewProvider, TestTreeViewProvider);
  serviceManager.addSingleton<ITestDataItemResource>(ITestDataItemResource, TestTreeViewProvider);
  serviceManager.addSingleton<ITestExplorerCommandHandler>(ITestExplorerCommandHandler, TestExplorerCommandHandler);
+ serviceManager.addSingleton<IExtensionActivationService>(IExtensionActivationService, TreeViewService);
+ serviceManager.addSingleton<IExtensionActivationService>(IExtensionActivationService, FailedTestHandler);
 
  serviceManager.addFactory<ITestManager>(ITestManagerFactory, (context) => {
  return (testProvider: TestProvider, workspaceFolder: Uri, rootDirectory: string) => {