Introduce autoTestDiscoverOnSavePattern test configuration option

microsoft · Jan 17, 2025 · c61bbd7 · c61bbd7
1 parent 8c54b8a
commit c61bbd7
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -657,6 +657,12 @@
                     "scope": "resource",
                     "type": "boolean"
                 },
+                "python.testing.autoTestDiscoverOnSavePattern": {
+                    "default": "**.py",
+                    "description": "%python.testing.autoTestDiscoverOnSavePattern.description%",
+                    "scope": "resource",
+                    "type": "string"
+                },
                 "python.testing.cwd": {
                     "default": null,
                     "description": "%python.testing.cwd.description%",

diff --git a/package.nls.json b/package.nls.json
@@ -74,6 +74,7 @@
     "python.terminal.focusAfterLaunch.description": "When launching a python terminal, whether to focus the cursor on the terminal.",
     "python.terminal.launchArgs.description": "Python launch arguments to use when executing a file in the terminal.",
     "python.testing.autoTestDiscoverOnSaveEnabled.description": "Enable auto run test discovery when saving a test file.",
+    "python.testing.autoTestDiscoverOnSavePattern.description": "Glob pattern used to determine which files are used by autoTestDiscoverOnSaveEnabled.",
     "python.testing.cwd.description": "Optional working directory for tests.",
     "python.testing.debugPort.description": "Port number used for debugging of tests.",
     "python.testing.promptToConfigure.description": "Prompt to configure a test framework if potential tests directories are discovered.",

diff --git a/resources/report_issue_user_settings.json b/resources/report_issue_user_settings.json
@@ -79,7 +79,8 @@
         "pytestPath": "placeholder",
         "unittestArgs": "placeholder",
         "unittestEnabled": true,
-        "autoTestDiscoverOnSaveEnabled": true
+        "autoTestDiscoverOnSaveEnabled": true,
+        "autoTestDiscoverOnSavePattern": "placeholder"
     },
     "terminal": {
         "activateEnvironment": true,

diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -320,6 +320,7 @@ export class PythonSettings implements IPythonSettings {
                     unittestEnabled: false,
                     pytestPath: 'pytest',
                     autoTestDiscoverOnSaveEnabled: true,
+                    autoTestDiscoverOnSavePattern: "**"
                 } as ITestingSettings;
             }
         }
@@ -336,6 +337,7 @@ export class PythonSettings implements IPythonSettings {
                   unittestArgs: [],
                   unittestEnabled: false,
                   autoTestDiscoverOnSaveEnabled: true,
+                  autoTestDiscoverOnSavePattern: "**",
               };
         this.testing.pytestPath = getAbsolutePath(systemVariables.resolveAny(this.testing.pytestPath), workspaceRoot);
         if (this.testing.cwd) {

diff --git a/src/client/testing/configuration/types.ts b/src/client/testing/configuration/types.ts
@@ -11,6 +11,7 @@ export interface ITestingSettings {
     unittestArgs: string[];
     cwd?: string;
     readonly autoTestDiscoverOnSaveEnabled: boolean;
+    readonly autoTestDiscoverOnSavePattern: string;
 }
 
 export type TestSettingsPropertyNames = {

diff --git a/src/client/testing/testController/controller.ts b/src/client/testing/testController/controller.ts
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+import * as minimatch from 'minimatch';
 import { inject, injectable, named } from 'inversify';
 import { uniq } from 'lodash';
 import {
@@ -215,7 +216,7 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
             if (settings.testing.autoTestDiscoverOnSaveEnabled) {
                 traceVerbose(`Testing: Setting up watcher for ${workspace.uri.fsPath}`);
                 this.watchForSettingsChanges(workspace);
-                this.watchForTestContentChangeOnSave();
+                this.watchForTestContentChangeOnSave(settings.testing.autoTestDiscoverOnSavePattern);
             }
         });
     }
@@ -549,10 +550,10 @@ export class PythonTestController implements ITestController, IExtensionSingleAc
         );
     }
 
-    private watchForTestContentChangeOnSave(): void {
+    private watchForTestContentChangeOnSave(testFileGlob: String): void {
         this.disposables.push(
             onDidSaveTextDocument(async (doc: TextDocument) => {
-                if (doc.fileName.endsWith('.py')) {
+                if (minimatch.default(doc.uri.fs, testFileGlob)) {
                     traceVerbose(`Testing: Trigger refresh after saving ${doc.uri.fsPath}`);
                     this.sendTriggerTelemetry('watching');
                     this.refreshData.trigger(doc.uri, false);