Expose a setting to allow a user modify the working directory of linters (microsoft#15171)

Matthew Shirley · web-flow · commit bbdba531a16f · 2021-04-06T14:42:11.000-07:00
* expose a setting to change the working directory of linters
* set linting cwd after linters
* address ci failure
* default cwd setting should be undefined
* add method that determines whether to return cwd or workspace root
* add functional test that asserts no errors are thrown if cwd is set
* add thanks to self
* update test runner to force cwd path
* update test cwd settings
* update mock to return undefined cwd
diff --git a/news/1 Enhancements/15170.md b/news/1 Enhancements/15170.md
@@ -0,0 +1 @@
+Added `python.linting.cwd` to change the working directory of the linters (thanks [Matthew Shirley](https://github.com/matthewshirley))
diff --git a/package.json b/package.json
@@ -1269,6 +1269,12 @@
                     "description": "Whether to lint Python files.",
                     "scope": "resource"
                 },
+                "python.linting.cwd": {
+                    "type": "string",
+                    "default": null,
+                    "description": "Optional working directory for linters.",
+                    "scope": "resource"
+                },
                 "python.linting.flake8Args": {
                     "type": "array",
                     "description": "Arguments passed in. Each argument is a separate item in the array.",
diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -349,6 +349,7 @@ export class PythonSettings implements IPythonSettings {
             ? this.linting
             : {
                   enabled: false,
+                  cwd: undefined,
                   ignorePatterns: [],
                   flake8Args: [],
                   flake8Enabled: false,
@@ -419,6 +420,10 @@ export class PythonSettings implements IPythonSettings {
         this.linting.mypyPath = getAbsolutePath(systemVariables.resolveAny(this.linting.mypyPath), workspaceRoot);
         this.linting.banditPath = getAbsolutePath(systemVariables.resolveAny(this.linting.banditPath), workspaceRoot);
 
+        if (this.linting.cwd) {
+            this.linting.cwd = getAbsolutePath(systemVariables.resolveAny(this.linting.cwd), workspaceRoot);
+        }
+
         const formattingSettings = systemVariables.resolveAny(pythonSettings.get<IFormattingSettings>('formatting'))!;
         if (this.formatting) {
             Object.assign<IFormattingSettings, IFormattingSettings>(this.formatting, formattingSettings);
diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -262,6 +262,7 @@ export interface ILintingSettings {
     readonly pycodestyleCategorySeverity: IPycodestyleCategorySeverity;
     readonly flake8CategorySeverity: Flake8CategorySeverity;
     readonly mypyCategorySeverity: IMypyCategorySeverity;
+    cwd?: string;
     prospectorPath: string;
     pylintPath: string;
     pycodestylePath: string;
diff --git a/src/client/linters/baseLinter.ts b/src/client/linters/baseLinter.ts
@@ -101,6 +101,10 @@ export abstract class BaseLinter implements ILinter {
             workspaceFolder && typeof workspaceFolder.uri.fsPath === 'string' ? workspaceFolder.uri.fsPath : undefined;
         return typeof workspaceRootPath === 'string' ? workspaceRootPath : path.dirname(document.uri.fsPath);
     }
+
+    protected getWorkingDirectoryPath(document: vscode.TextDocument): string {
+        return this._pythonSettings.linting.cwd || this.getWorkspaceRootPath(document);
+    }
     protected abstract runLinter(
         document: vscode.TextDocument,
         cancellation: vscode.CancellationToken,
@@ -138,7 +142,7 @@ export abstract class BaseLinter implements ILinter {
             return [];
         }
         const executionInfo = this.info.getExecutionInfo(args, document.uri);
-        const cwd = this.getWorkspaceRootPath(document);
+        const cwd = this.getWorkingDirectoryPath(document);
         const pythonToolsExecutionService = this.serviceContainer.get<IPythonToolExecutionService>(
             IPythonToolExecutionService,
         );
diff --git a/src/client/linters/prospector.ts b/src/client/linters/prospector.ts
@@ -30,7 +30,7 @@ export class Prospector extends BaseLinter {
     }
 
     protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {
-        const cwd = this.getWorkspaceRootPath(document);
+        const cwd = this.getWorkingDirectoryPath(document);
         const relativePath = path.relative(cwd, document.uri.fsPath);
         return this.run(['--absolute-paths', '--output-format=json', relativePath], document, cancellation);
     }
diff --git a/src/client/linters/pylint.ts b/src/client/linters/pylint.ts
@@ -39,10 +39,10 @@ export class Pylint extends BaseLinter {
             this.info.linterArgs(uri).length === 0 &&
             // Check pylintrc next to the file or above up to and including the workspace root
             !(await Pylint.hasConfigurationFileInWorkspace(this.fileSystem, path.dirname(uri.fsPath), workspaceRoot)) &&
-            // Check for pylintrc at the root and above
+            // Check for pylintrc at the cwd and above
             !(await Pylint.hasConfigurationFile(
                 this.fileSystem,
-                this.getWorkspaceRootPath(document),
+                this.getWorkingDirectoryPath(document),
                 this.platformService,
             ))
         ) {
diff --git a/src/test/linters/common.ts b/src/test/linters/common.ts
@@ -70,6 +70,7 @@ export function throwUnknownProduct(product: Product) {
 
 export class LintingSettings {
     public enabled: boolean;
+    public cwd?: string;
     public ignorePatterns: string[];
     public prospectorEnabled: boolean;
     public prospectorArgs: string[];
@@ -107,6 +108,7 @@ export class LintingSettings {
         // mostly from configSettings.ts
 
         this.enabled = true;
+        this.cwd = undefined;
         this.ignorePatterns = [];
         this.lintOnSave = false;
         this.maxNumberOfProblems = 100;
diff --git a/src/test/linters/lint.args.test.ts b/src/test/linters/lint.args.test.ts
@@ -102,6 +102,7 @@ suite('Linting - Arguments', () => {
                         const lintSettings = TypeMoq.Mock.ofType<ILintingSettings>();
                         lintSettings.setup((x) => x.enabled).returns(() => true);
                         lintSettings.setup((x) => x.lintOnSave).returns(() => true);
+                        lintSettings.setup((x) => x.cwd).returns(() => undefined);
 
                         settings = TypeMoq.Mock.ofType<IPythonSettings>();
                         settings.setup((x) => x.linting).returns(() => lintSettings.object);
diff --git a/src/test/linters/lint.functional.test.ts b/src/test/linters/lint.functional.test.ts
@@ -877,4 +877,17 @@ suite('Linting Functional Tests', () => {
             maxErrors,
         );
     });
+
+    test('Linters use config in cwd directory', async () => {
+        const maxErrors = 0;
+        const fixture = new TestFixture();
+        fixture.lintingSettings.cwd = path.join(pythonFilesDir, 'pylintcwd');
+
+        await testLinterMessageCount(
+            fixture,
+            Product.pylint,
+            path.join(pythonFilesDir, 'threeLineLints.py'),
+            maxErrors,
+        );
+    });
 });
diff --git a/src/test/linters/pylint.unit.test.ts b/src/test/linters/pylint.unit.test.ts
@@ -354,7 +354,7 @@ suite('Pylint - Function runLinter()', () => {
         ): Promise<ILintMessage[]> {
             return super.runLinter(document, cancellation);
         }
-        public getWorkspaceRootPath(_document: vscode.TextDocument): string {
+        public getWorkingDirectoryPath(_document: vscode.TextDocument): string {
             return 'path/to/workspaceRoot';
         }
     }
diff --git a/src/test/mockClasses.ts b/src/test/mockClasses.ts
@@ -56,6 +56,7 @@ export class MockStatusBarItem implements vscode.StatusBarItem {
 
 export class MockLintingSettings implements ILintingSettings {
     public enabled!: boolean;
+    public cwd?: string;
     public ignorePatterns!: string[];
     public prospectorEnabled!: boolean;
     public prospectorArgs!: string[];
diff --git a/src/test/pythonFiles/linting/cwd/.pylintrc b/src/test/pythonFiles/linting/cwd/.pylintrc
@@ -0,0 +1,2 @@
+[MESSAGES CONTROL]
+disable=C0326,I0011,I0012,C0304,C0103,W0613,E0001,E1101

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Added `python.linting.cwd` to change the working directory of the linters (thanks [Matthew Shirley](https://github.com/matthewshirley))
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ export class Prospector extends BaseLinter {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`protected async runLinter(document: TextDocument, cancellation: CancellationToken): Promise<ILintMessage[]> {`
`33`		`- const cwd = this.getWorkspaceRootPath(document);`
	`33`	`+ const cwd = this.getWorkingDirectoryPath(document);`
`34`	`34`	`const relativePath = path.relative(cwd, document.uri.fsPath);`
`35`	`35`	`return this.run(['--absolute-paths', '--output-format=json', relativePath], document, cancellation);`
`36`	`36`	`}`