Add setting for auto run test discover on save (microsoft#1687)

Author: lingyv-li

news/1 Enhancements/1037.md

@@ -0,0 +1,2 @@
+Add setting for auto run test discover on save
+(thanks [Lingyu Li](http://github.com/lingyv-li/))

package.json

@@ -1722,6 +1722,12 @@
  "description": "Use the experimental debugger when debugging unit tests.",
  "scope": "resource"
  },
+ "python.unitTest.autoTestDiscoverOnSaveEnabled": {
+ "type": "boolean",
+ "default": true,
+ "description": "Whether to enable or disable auto run test discovery when saving a unit test file.",
+ "scope": "resource"
+ },
  "python.venvFolders": {
  "type": "array",
  "default": [

src/client/common/configSettings.ts

@@ -267,7 +267,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
  nosetestArgs: [], pyTestArgs: [], unittestArgs: [],
  promptToConfigure: true, debugPort: 3000,
  nosetestsEnabled: false, pyTestEnabled: false, unittestEnabled: false,
- nosetestPath: 'nosetests', pyTestPath: 'pytest'
+ nosetestPath: 'nosetests', pyTestPath: 'pytest', autoTestDiscoverOnSaveEnabled: true
  } as IUnitTestSettings;
  }
  }
@@ -278,7 +278,7 @@ export class PythonSettings extends EventEmitter implements IPythonSettings {
  debugPort: 3000,
  nosetestArgs: [], nosetestPath: 'nosetest', nosetestsEnabled: false,
  pyTestArgs: [], pyTestEnabled: false, pyTestPath: 'pytest',
- unittestArgs: [], unittestEnabled: false
+ unittestArgs: [], unittestEnabled: false, autoTestDiscoverOnSaveEnabled: true
  };
  this.unitTest.pyTestPath = getAbsolutePath(systemVariables.resolveAny(this.unitTest.pyTestPath), workspaceRoot);
  this.unitTest.nosetestPath = getAbsolutePath(systemVariables.resolveAny(this.unitTest.nosetestPath), workspaceRoot);

src/client/common/types.ts

@@ -137,6 +137,7 @@ export interface IUnitTestSettings {
  unittestArgs: string[];
  cwd?: string;
  readonly useExperimentalDebugger?: boolean;
+ readonly autoTestDiscoverOnSaveEnabled: boolean;
 }
 export interface IPylintCategorySeverity {
  readonly convention: DiagnosticSeverity;

src/client/unittests/main.ts

@@ -308,10 +308,17 @@ export class UnitTestManagementService implements IUnitTestManagementService, Di
 
  disposablesRegistry.push(...disposables);
  }
+ private onDocumentSaved(doc: TextDocument) {
+ const settings = this.serviceContainer.get<IConfigurationService>(IConfigurationService).getSettings(doc.uri);
+ if (!settings.unitTest.autoTestDiscoverOnSaveEnabled) {
+ return;
+ }
+ this.discoverTestsForDocument(doc);
+ }
  private registerHandlers() {
  const documentManager = this.serviceContainer.get<IDocumentManager>(IDocumentManager);
 
- this.disposableRegistry.push(documentManager.onDidSaveTextDocument(this.discoverTestsForDocument.bind(this)));
+ this.disposableRegistry.push(documentManager.onDidSaveTextDocument(this.onDocumentSaved.bind(this)));
  this.disposableRegistry.push(this.workspaceService.onDidChangeConfiguration(e => {
  if (this.configChangedTimer) {
  clearTimeout(this.configChangedTimer);