Resolve variables in the envFile of launch.json (microsoft#7386)

DonJayamanne · web-flow · commit ba524969bf85 · 2019-09-13T11:24:56.000+04:00
diff --git a/news/2 Fixes/7210.md b/news/2 Fixes/7210.md
@@ -0,0 +1 @@
+Resolve variables such as `${workspaceFolder}` in the `envFile` setting of `launch.json`.
diff --git a/src/client/debugger/extension/configuration/resolvers/base.ts b/src/client/debugger/extension/configuration/resolvers/base.ts
@@ -56,6 +56,19 @@ export abstract class BaseConfigurationResolver<T extends DebugConfiguration> im
             return editor.document.fileName;
         }
     }
+    protected resolveAndUpdatePaths(workspaceFolder: Uri | undefined, debugConfiguration: LaunchRequestArguments): void {
+        this.resolveAndUpdateEnvFilePath(workspaceFolder, debugConfiguration);
+        this.resolveAndUpdatePythonPath(workspaceFolder, debugConfiguration);
+    }
+    protected resolveAndUpdateEnvFilePath(workspaceFolder: Uri | undefined, debugConfiguration: LaunchRequestArguments): void {
+        if (!debugConfiguration) {
+            return;
+        }
+        if (debugConfiguration.envFile && (workspaceFolder || debugConfiguration.cwd)) {
+            const systemVariables = new SystemVariables((workspaceFolder ? workspaceFolder.fsPath : undefined) || debugConfiguration.cwd);
+            debugConfiguration.envFile = systemVariables.resolveAny(debugConfiguration.envFile);
+        }
+    }
     protected resolveAndUpdatePythonPath(workspaceFolder: Uri | undefined, debugConfiguration: LaunchRequestArguments): void {
         if (!debugConfiguration) {
             return;
@@ -64,7 +77,7 @@ export abstract class BaseConfigurationResolver<T extends DebugConfiguration> im
             const pythonPath = this.configurationService.getSettings(workspaceFolder).pythonPath;
             debugConfiguration.pythonPath = pythonPath;
             this.pythonPathSource = PythonPathSource.settingsJson;
-        } else{
+        } else {
             this.pythonPathSource = PythonPathSource.launchJson;
         }
     }
diff --git a/src/client/debugger/extension/configuration/resolvers/launch.ts b/src/client/debugger/extension/configuration/resolvers/launch.ts
@@ -57,7 +57,7 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
     }
     // tslint:disable-next-line:cyclomatic-complexity
     protected async provideLaunchDefaults(workspaceFolder: Uri | undefined, debugConfiguration: LaunchRequestArguments): Promise<void> {
-        this.resolveAndUpdatePythonPath(workspaceFolder, debugConfiguration);
+        this.resolveAndUpdatePaths(workspaceFolder, debugConfiguration);
         if (typeof debugConfiguration.cwd !== 'string' && workspaceFolder) {
             debugConfiguration.cwd = workspaceFolder.fsPath;
         }
diff --git a/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts b/src/test/debugger/extension/configuration/resolvers/launch.unit.test.ts
@@ -661,6 +661,23 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
             diagnosticsService.verifyAll();
             expect(debugConfig).to.not.be.equal(undefined, 'is undefined');
         });
+        test('Resolve path to envFile', async () => {
+            const pythonPath = `PythonPath_${new Date().toString()}`;
+            const workspaceFolder = createMoqWorkspaceFolder(__dirname);
+            const pythonFile = 'xyz.py';
+            const expectedEnvFilePath = `${workspaceFolder.uri.fsPath}${osType === OSType.Windows ? '\\' : '/'}${'wow.envFile'}`;
+            setupIoc(pythonPath);
+            setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
+
+            diagnosticsService.reset();
+            diagnosticsService
+                .setup(h => h.validatePythonPath(TypeMoq.It.isValue(pythonPath), TypeMoq.It.isAny(), TypeMoq.It.isAny()))
+                .returns(() => Promise.resolve(true));
+
+            const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { redirectOutput: false, pythonPath, envFile: path.join('${workspaceFolder}', 'wow.envFile') } as LaunchRequestArguments);
+
+            expect(debugConfig!.envFile).to.be.equal(expectedEnvFilePath);
+        });
         async function testSetting(requestType: 'launch' | 'attach', settings: Record<string, boolean>, debugOptionName: DebugOptions, mustHaveDebugOption: boolean) {
             setupIoc('pythonPath');
             const debugConfiguration: DebugConfiguration = { request: requestType, type: 'python', name: '', ...settings };

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Resolve variables such as `${workspaceFolder}` in the `envFile` setting of `launch.json`.
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc`
`57`	`57`	`}`
`58`	`58`	`// tslint:disable-next-line:cyclomatic-complexity`
`59`	`59`	`protected async provideLaunchDefaults(workspaceFolder: Uri \| undefined, debugConfiguration: LaunchRequestArguments): Promise<void> {`
`60`		`- this.resolveAndUpdatePythonPath(workspaceFolder, debugConfiguration);`
	`60`	`+ this.resolveAndUpdatePaths(workspaceFolder, debugConfiguration);`
`61`	`61`	`if (typeof debugConfiguration.cwd !== 'string' && workspaceFolder) {`
`62`	`62`	`debugConfiguration.cwd = workspaceFolder.fsPath;`
`63`	`63`	`}`