Feature/5603 update pytest on ui settings (#5787)

james-flynn-ie · DonJayamanne · commit 6dff6875b051 · 2019-06-04T15:10:37.000-07:00
* Renaming pyTestArgs to pytestArgs

* Renaming pyTestEnabled to pytestEnabled

* Renaming pyTestPath to pytestPath

* Adding news file for #5603

* Reverting case change for pytestargs defs/vars in pythonfiles

* Adding check for old pyTestEnabled test settings

* Adding pyTestEnabled check to fixSettingInFile()

* Updating fixSettingInFile function to regex-replace 'pyTest' strings
diff --git a/news/.vscode/settings.json b/news/.vscode/settings.json
@@ -2,10 +2,10 @@
     "python.jediEnabled": false,
     "python.formatting.provider": "black",
     "editor.formatOnSave": true,
-    "python.testing.pyTestArgs": [
+    "python.testing.pytestArgs": [
         "."
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.nosetestsEnabled": false,
-    "python.testing.pyTestEnabled": true
+    "python.testing.pytestEnabled": true
 }
diff --git a/news/1 Enhancements/5603.md b/news/1 Enhancements/5603.md
@@ -0,0 +1,2 @@
+Updated labels in File > Preferences > Settings. It now states 'Pytest' where it stated 'Py Test'.
+(thanks [James Flynn](https://github.com/james-flynn-ie/))
diff --git a/package.json b/package.json
@@ -1947,7 +1947,7 @@
                     "description": "Prompt to configure a test framework if potential tests directories are discovered.",
                     "scope": "resource"
                 },
-                "python.testing.pyTestArgs": {
+                "python.testing.pytestArgs": {
                     "type": "array",
                     "description": "Arguments passed in. Each argument is a separate item in the array.",
                     "default": [],
@@ -1956,13 +1956,13 @@
                     },
                     "scope": "resource"
                 },
-                "python.testing.pyTestEnabled": {
+                "python.testing.pytestEnabled": {
                     "type": "boolean",
                     "default": false,
                     "description": "Enable testing using pytest.",
                     "scope": "resource"
                 },
-                "python.testing.pyTestPath": {
+                "python.testing.pytestPath": {
                     "type": "string",
                     "default": "pytest",
                     "description": "Path to pytest (pytest), you can use a custom version of pytest by modifying this setting to include the full path.",
diff --git a/src/client/application/diagnostics/checks/updateTestSettings.ts b/src/client/application/diagnostics/checks/updateTestSettings.ts
@@ -107,8 +107,14 @@ export class InvalidTestSettingDiagnosticsService extends BaseDiagnosticsService
     public async fixSettingInFile(filePath: string) {
         const fileContents = await this.fs.readFile(filePath);
         const setting = new RegExp('"python.unitTest', 'g');
+        const setting_pytest_enabled = new RegExp('.pyTestEnabled"', 'g');
+        const setting_pytest_args = new RegExp('.pyTestArgs"', 'g');
+        const setting_pytest_path = new RegExp('.pyTestPath"', 'g');
 
         await this.fs.writeFile(filePath, fileContents.replace(setting, '"python.testing'));
+        await this.fs.writeFile(filePath, fileContents.replace(setting_pytest_enabled, '.pytestEnabled"'));
+        await this.fs.writeFile(filePath, fileContents.replace(setting_pytest_args, '.pytestArgs"'));
+        await this.fs.writeFile(filePath, fileContents.replace(setting_pytest_path, '.pytestPath"'));
 
         // Keep track of updated file.
         this.stateStore.value.push(filePath);
@@ -124,7 +130,7 @@ export class InvalidTestSettingDiagnosticsService extends BaseDiagnosticsService
             return false;
         }
         const contents = await this.fs.readFile(filePath);
-        return contents.indexOf('python.unitTest.') > 0;
+        return contents.indexOf('python.unitTest.') > 0 || contents.indexOf('python.pyTest') > 0;
     }
     /**
      * Checks whether to handle a particular workspace resource.
diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -304,10 +304,10 @@ export class PythonSettings implements IPythonSettings {
                 // tslint:disable-next-line:prefer-type-cast
                 // tslint:disable-next-line:no-object-literal-type-assertion
                 this.testing = {
-                    nosetestArgs: [], pyTestArgs: [], unittestArgs: [],
+                    nosetestArgs: [], pytestArgs: [], unittestArgs: [],
                     promptToConfigure: true, debugPort: 3000,
-                    nosetestsEnabled: false, pyTestEnabled: false, unittestEnabled: false,
-                    nosetestPath: 'nosetests', pyTestPath: 'pytest', autoTestDiscoverOnSaveEnabled: true
+                    nosetestsEnabled: false, pytestEnabled: false, unittestEnabled: false,
+                    nosetestPath: 'nosetests', pytestPath: 'pytest', autoTestDiscoverOnSaveEnabled: true
                 } as ITestingSettings;
             }
         }
@@ -317,18 +317,18 @@ export class PythonSettings implements IPythonSettings {
             promptToConfigure: true,
             debugPort: 3000,
             nosetestArgs: [], nosetestPath: 'nosetest', nosetestsEnabled: false,
-            pyTestArgs: [], pyTestEnabled: false, pyTestPath: 'pytest',
+            pytestArgs: [], pytestEnabled: false, pytestPath: 'pytest',
             unittestArgs: [], unittestEnabled: false, autoTestDiscoverOnSaveEnabled: true
         };
-        this.testing.pyTestPath = getAbsolutePath(systemVariables.resolveAny(this.testing.pyTestPath), workspaceRoot);
+        this.testing.pytestPath = getAbsolutePath(systemVariables.resolveAny(this.testing.pytestPath), workspaceRoot);
         this.testing.nosetestPath = getAbsolutePath(systemVariables.resolveAny(this.testing.nosetestPath), workspaceRoot);
         if (this.testing.cwd) {
             this.testing.cwd = getAbsolutePath(systemVariables.resolveAny(this.testing.cwd), workspaceRoot);
         }
 
         // Resolve any variables found in the test arguments.
         this.testing.nosetestArgs = this.testing.nosetestArgs.map(arg => systemVariables.resolveAny(arg));
-        this.testing.pyTestArgs = this.testing.pyTestArgs.map(arg => systemVariables.resolveAny(arg));
+        this.testing.pytestArgs = this.testing.pytestArgs.map(arg => systemVariables.resolveAny(arg));
         this.testing.unittestArgs = this.testing.unittestArgs.map(arg => systemVariables.resolveAny(arg));
 
         // tslint:disable-next-line:no-backbone-get-set-outside-model no-non-null-assertion
diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -179,9 +179,9 @@ export interface ITestingSettings {
     readonly nosetestsEnabled: boolean;
     nosetestPath: string;
     nosetestArgs: string[];
-    readonly pyTestEnabled: boolean;
-    pyTestPath: string;
-    pyTestArgs: string[];
+    readonly pytestEnabled: boolean;
+    pytestPath: string;
+    pytestArgs: string[];
     readonly unittestEnabled: boolean;
     unittestArgs: string[];
     cwd?: string;
diff --git a/src/client/testing/common/runner.ts b/src/client/testing/common/runner.ts
@@ -90,7 +90,7 @@ function getExecutablePath(testProvider: TestProvider, settings: IPythonSettings
             break;
         }
         case PYTEST_PROVIDER: {
-            testRunnerExecutablePath = settings.testing.pyTestPath;
+            testRunnerExecutablePath = settings.testing.pytestPath;
             break;
         }
         default: {
diff --git a/src/client/testing/common/services/configSettingService.ts b/src/client/testing/common/services/configSettingService.ts
@@ -31,7 +31,7 @@ export class TestConfigSettingsService implements ITestConfigSettingsService {
             case Product.unittest:
                 return 'testing.unittestArgs';
             case Product.pytest:
-                return 'testing.pyTestArgs';
+                return 'testing.pytestArgs';
             case Product.nosetest:
                 return 'testing.nosetestArgs';
             default:
@@ -43,7 +43,7 @@ export class TestConfigSettingsService implements ITestConfigSettingsService {
             case Product.unittest:
                 return 'testing.unittestEnabled';
             case Product.pytest:
-                return 'testing.pyTestEnabled';
+                return 'testing.pytestEnabled';
             case Product.nosetest:
                 return 'testing.nosetestsEnabled';
             default:
diff --git a/src/client/testing/common/services/testManagerService.ts b/src/client/testing/common/services/testManagerService.ts
@@ -40,7 +40,7 @@ export class TestManagerService implements ITestManagerService {
         const settings = this.configurationService.getSettings(this.wkspace);
         if (settings.testing.nosetestsEnabled) {
             return Product.nosetest;
-        } else if (settings.testing.pyTestEnabled) {
+        } else if (settings.testing.pytestEnabled) {
             return Product.pytest;
         } else if (settings.testing.unittestEnabled) {
             return Product.unittest;
diff --git a/src/client/testing/common/testUtils.ts b/src/client/testing/common/testUtils.ts
@@ -91,9 +91,9 @@ export class TestsHelper implements ITestsHelper {
         switch (id) {
             case 'pytest': {
                 return {
-                    argsName: 'pyTestArgs' as keyof ITestingSettings,
-                    pathName: 'pyTestPath' as keyof ITestingSettings,
-                    enabledName: 'pyTestEnabled' as keyof ITestingSettings
+                    argsName: 'pytestArgs' as keyof ITestingSettings,
+                    pathName: 'pytestPath' as keyof ITestingSettings,
+                    enabledName: 'pytestEnabled' as keyof ITestingSettings
                 };
             }
             case 'nosetest': {
diff --git a/src/client/testing/configuration.ts b/src/client/testing/configuration.ts
@@ -28,7 +28,7 @@ export class UnitTestConfigurationService implements ITestConfigurationService {
     }
     public async displayTestFrameworkError(wkspace: Uri): Promise<void> {
         const settings = this.configurationService.getSettings(wkspace);
-        let enabledCount = settings.testing.pyTestEnabled ? 1 : 0;
+        let enabledCount = settings.testing.pytestEnabled ? 1 : 0;
         enabledCount += settings.testing.nosetestsEnabled ? 1 : 0;
         enabledCount += settings.testing.unittestEnabled ? 1 : 0;
         if (enabledCount > 1) {
diff --git a/src/client/testing/display/main.ts b/src/client/testing/display/main.ts
@@ -150,7 +150,7 @@ export class TestResultDisplay implements ITestResultDisplay {
     // tslint:disable-next-line:no-any
     private async disableTests(): Promise<any> {
         const configurationService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
-        const settingsToDisable = ['testing.promptToConfigure', 'testing.pyTestEnabled',
+        const settingsToDisable = ['testing.promptToConfigure', 'testing.pytestEnabled',
             'testing.unittestEnabled', 'testing.nosetestsEnabled'];
 
         for (const setting of settingsToDisable) {
diff --git a/src/client/testing/main.ts b/src/client/testing/main.ts
@@ -134,7 +134,7 @@ export class UnitTestManagementService implements ITestManagementService, Dispos
         }
         const workspaceUri = workspaceFolderUri.uri;
         const settings = this.serviceContainer.get<IConfigurationService>(IConfigurationService).getSettings(workspaceUri);
-        if (!settings.testing.nosetestsEnabled && !settings.testing.pyTestEnabled && !settings.testing.unittestEnabled) {
+        if (!settings.testing.nosetestsEnabled && !settings.testing.pytestEnabled && !settings.testing.unittestEnabled) {
             if (this.testResultDisplay) {
                 this.testResultDisplay.enabled = false;
             }
@@ -180,7 +180,7 @@ export class UnitTestManagementService implements ITestManagementService, Dispos
         }
         const configurationService = this.serviceContainer.get<IConfigurationService>(IConfigurationService);
         const settings = configurationService.getSettings(resource);
-        if (!settings.testing.nosetestsEnabled && !settings.testing.pyTestEnabled && !settings.testing.unittestEnabled) {
+        if (!settings.testing.nosetestsEnabled && !settings.testing.pytestEnabled && !settings.testing.unittestEnabled) {
             return;
         }
 
diff --git a/src/client/testing/pytest/main.ts b/src/client/testing/pytest/main.ts
@@ -14,7 +14,7 @@ export class TestManager extends BaseTestManager {
     private readonly runner: ITestManagerRunner;
     private readonly testMessageService: ITestMessageService;
     public get enabled() {
-        return this.settings.testing.pyTestEnabled;
+        return this.settings.testing.pytestEnabled;
     }
     constructor(workspaceFolder: Uri, rootDirectory: string,
         serviceContainer: IServiceContainer) {
@@ -25,7 +25,7 @@ export class TestManager extends BaseTestManager {
         this.testMessageService = this.serviceContainer.get<ITestMessageService>(ITestMessageService, this.testProvider);
     }
     public getDiscoveryOptions(ignoreCache: boolean): TestDiscoveryOptions {
-        const args = this.settings.testing.pyTestArgs.slice(0);
+        const args = this.settings.testing.pytestArgs.slice(0);
         return {
             workspaceFolder: this.workspaceFolder,
             cwd: this.rootDirectory, args,
@@ -38,9 +38,9 @@ export class TestManager extends BaseTestManager {
 
         const runAllTests = this.helper.shouldRunAllTests(testsToRun);
         if (debug) {
-            args = this.argsService.filterArguments(this.settings.testing.pyTestArgs, runAllTests ? TestFilter.debugAll : TestFilter.debugSpecific);
+            args = this.argsService.filterArguments(this.settings.testing.pytestArgs, runAllTests ? TestFilter.debugAll : TestFilter.debugSpecific);
         } else {
-            args = this.argsService.filterArguments(this.settings.testing.pyTestArgs, runAllTests ? TestFilter.runAll : TestFilter.runSpecific);
+            args = this.argsService.filterArguments(this.settings.testing.pytestArgs, runAllTests ? TestFilter.runAll : TestFilter.runSpecific);
         }
 
         if (runFailedTests === true && args.indexOf('--lf') === -1 && args.indexOf('--last-failed') === -1) {
diff --git a/src/test/.vscode/settings.json b/src/test/.vscode/settings.json
@@ -3,7 +3,7 @@
     "python.linting.flake8Enabled": false,
     "python.workspaceSymbols.enabled": false,
     "python.testing.nosetestArgs": [],
-    "python.testing.pyTestArgs": [],
+    "python.testing.pytestArgs": [],
     "python.testing.unittestArgs": [
         "-s=./tests",
         "-p=test_*.py"
diff --git a/src/test/application/diagnostics/checks/updateTestSettings.unit.test.ts b/src/test/application/diagnostics/checks/updateTestSettings.unit.test.ts
@@ -107,7 +107,7 @@ suite('Application Diagnostics - Check Test Settings', () => {
         when(appEnv.userSettingsFile).thenReturn('user.json');
         when(fs.readFile('user.json')).thenResolve('{"python.unitTest.cwd":"blah"}');
         when(fs.readFile(path.join(folder1.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.testing.cwd":"blah"}');
-        when(fs.readFile(path.join(folder2.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.unitTest.pyTestArgs":[]}');
+        when(fs.readFile(path.join(folder2.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.unitTest.pytestArgs":[]}');
         when(storage.value).thenReturn([]);
 
         const files = await diagnosticService.getFilesToBeFixed();
@@ -128,7 +128,7 @@ suite('Application Diagnostics - Check Test Settings', () => {
         when(appEnv.userSettingsFile).thenReturn('user.json');
         when(fs.readFile('user.json')).thenResolve('{"python.testing.cwd":"blah"}');
         when(fs.readFile(path.join(folder1.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.testing.cwd":"blah"}');
-        when(fs.readFile(path.join(folder2.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.testing.pyTestArgs":[]}');
+        when(fs.readFile(path.join(folder2.fsPath, '.vscode', 'settings.json'))).thenResolve('{"python.testing.pytestArgs":[]}');
         when(storage.value).thenReturn([]);
 
         const files = await diagnosticService.getFilesToBeFixed();
diff --git a/src/test/common.ts b/src/test/common.ts
@@ -46,9 +46,9 @@ export type PythonSettingKeys = 'workspaceSymbols.enabled' | 'pythonPath' |
     'linting.enabled' | 'linting.pylintEnabled' |
     'linting.flake8Enabled' | 'linting.pep8Enabled' | 'linting.pylamaEnabled' |
     'linting.prospectorEnabled' | 'linting.pydocstyleEnabled' | 'linting.mypyEnabled' | 'linting.banditEnabled' |
-    'testing.nosetestArgs' | 'testing.pyTestArgs' | 'testing.unittestArgs' |
+    'testing.nosetestArgs' | 'testing.pytestArgs' | 'testing.unittestArgs' |
     'formatting.provider' | 'sortImports.args' |
-    'testing.nosetestsEnabled' | 'testing.pyTestEnabled' | 'testing.unittestEnabled' |
+    'testing.nosetestsEnabled' | 'testing.pytestEnabled' | 'testing.unittestEnabled' |
     'envFile' | 'jediEnabled' | 'linting.ignorePatterns' | 'terminal.activateEnvironment';
 
 async function disposePythonSettings() {
diff --git a/src/test/testing/common/services/configSettingService.unit.test.ts b/src/test/testing/common/services/configSettingService.unit.test.ts
@@ -45,7 +45,7 @@ suite('Unit Tests - ConfigSettingsService', () => {
                         case Product.unittest:
                             return 'testing.unittestArgs';
                         case Product.pytest:
-                            return 'testing.pyTestArgs';
+                            return 'testing.pytestArgs';
                         case Product.nosetest:
                             return 'testing.nosetestArgs';
                         default:
@@ -57,7 +57,7 @@ suite('Unit Tests - ConfigSettingsService', () => {
                         case Product.unittest:
                             return 'testing.unittestEnabled';
                         case Product.pytest:
-                            return 'testing.pyTestEnabled';
+                            return 'testing.pytestEnabled';
                         case Product.nosetest:
                             return 'testing.nosetestsEnabled';
                         default:
diff --git a/src/test/testing/configuration.unit.test.ts b/src/test/testing/configuration.unit.test.ts
@@ -182,7 +182,7 @@ suite('Unit Tests - ConfigurationService', () => {
                 appShell.verifyAll();
             });
             test('Prompt to enable a test if a test framework is not enabled', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => false);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => false);
 
@@ -204,7 +204,7 @@ suite('Unit Tests - ConfigurationService', () => {
                 appShell.verifyAll();
             });
             test('Prompt to select a test if a test framework is not enabled', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => false);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => false);
 
@@ -234,7 +234,7 @@ suite('Unit Tests - ConfigurationService', () => {
                 appShell.verifyAll();
             });
             test('Configure selected test framework and disable others', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => false);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => false);
 
@@ -279,7 +279,7 @@ suite('Unit Tests - ConfigurationService', () => {
                 workspaceConfig.verifyAll();
             });
             test('If more than one test framework is enabled, then prompt to select a test framework', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => true);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => true);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => true);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => true);
 
@@ -304,7 +304,7 @@ suite('Unit Tests - ConfigurationService', () => {
                 appShell.verifyAll();
             });
             test('If more than one test framework is enabled, then prompt to select a test framework and enable test, but do not configure', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => true);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => true);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => true);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => true);
 
@@ -349,7 +349,7 @@ suite('Unit Tests - ConfigurationService', () => {
             });
 
             test('Prompt to enable and configure selected test framework', async () => {
-                unitTestSettings.setup(u => u.pyTestEnabled).returns(() => false);
+                unitTestSettings.setup(u => u.pytestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.unittestEnabled).returns(() => false);
                 unitTestSettings.setup(u => u.nosetestsEnabled).returns(() => false);
 
diff --git a/src/test/testing/debugger.test.ts b/src/test/testing/debugger.test.ts
diff --git a/src/test/testing/display/main.unit.test.ts b/src/test/testing/display/main.unit.test.ts
diff --git a/src/test/testing/pytest/pytest.discovery.test.ts b/src/test/testing/pytest/pytest.discovery.test.ts
diff --git a/src/test/testing/pytest/pytest.run.test.ts b/src/test/testing/pytest/pytest.run.test.ts
diff --git a/src/test/testing/pytest/pytest.test.ts b/src/test/testing/pytest/pytest.test.ts
diff --git a/src/test/testing/pytest/pytest.testMessageService.test.ts b/src/test/testing/pytest/pytest.testMessageService.test.ts
diff --git a/src/test/testing/rediscover.test.ts b/src/test/testing/rediscover.test.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Updated labels in File > Preferences > Settings. It now states 'Pytest' where it stated 'Py Test'.`
	`2`	`+(thanks [James Flynn](https://github.com/james-flynn-ie/))`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ function getExecutablePath(testProvider: TestProvider, settings: IPythonSettings`
`90`	`90`	`break;`
`91`	`91`	`}`
`92`	`92`	`case PYTEST_PROVIDER: {`
`93`		`- testRunnerExecutablePath = settings.testing.pyTestPath;`
	`93`	`+ testRunnerExecutablePath = settings.testing.pytestPath;`
`94`	`94`	`break;`
`95`	`95`	`}`
`96`	`96`	`default: {`