Lowercase drive letter for non-empty path mappings (#6228)

kimadeline · web-flow · commit 43fde7c3af6a · 2019-06-19T12:24:33.000-07:00
* Lowercase drive letter for non-empty path mappings
* Simplify path expansion loop
* Update unit test
* Fix path
* Hardcode lowercase strings
diff --git a/src/client/debugger/extension/configuration/resolvers/attach.ts b/src/client/debugger/extension/configuration/resolvers/attach.ts
@@ -8,6 +8,7 @@ import { CancellationToken, Uri, WorkspaceFolder } from 'vscode';
 import { IDocumentManager, IWorkspaceService } from '../../../../common/application/types';
 import { IPlatformService } from '../../../../common/platform/types';
 import { IConfigurationService } from '../../../../common/types';
+import { SystemVariables } from '../../../../common/variables/systemVariables';
 import { AttachRequestArguments, DebugOptions } from '../../../types';
 import { BaseConfigurationResolver } from './base';
 
@@ -94,18 +95,33 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
         }
         // If attaching to local host, then always map local root and remote roots.
         if (workspaceFolder && debugConfiguration.host &&
-            debugConfiguration.pathMappings!.length === 0 &&
             ['LOCALHOST', '127.0.0.1', '::1'].indexOf(debugConfiguration.host.toUpperCase()) >= 0) {
-            // If on Windows, lowercase the drive letter for path mappings.
-            let localRoot = workspaceFolder.fsPath;
-            if (this.platformService.isWindows && localRoot.match(/^[A-Z]:/)) {
-                localRoot = `${localRoot[0].toLowerCase()}${localRoot.substr(1)}`;
-            }
-
-            debugConfiguration.pathMappings!.push({
-                localRoot,
-                remoteRoot: workspaceFolder.fsPath
-            });
+                let configPathMappings;
+                if (debugConfiguration.pathMappings!.length === 0) {
+                    configPathMappings = [{
+                        localRoot: workspaceFolder.fsPath,
+                        remoteRoot: workspaceFolder.fsPath
+                    }];
+                } else {
+                    // Expand ${workspaceFolder} variable first if necessary.
+                    const systemVariables = new SystemVariables(workspaceFolder.fsPath);
+                    configPathMappings = debugConfiguration.pathMappings.map(({ localRoot: mappedLocalRoot, remoteRoot }) => ({
+                        localRoot: systemVariables.resolveAny(mappedLocalRoot),
+                        remoteRoot
+                    }));
+                }
+                // If on Windows, lowercase the drive letter for path mappings.
+                let pathMappings = configPathMappings;
+                if (this.platformService.isWindows) {
+                    pathMappings = configPathMappings.map(({ localRoot: windowsLocalRoot, remoteRoot }) => {
+                        let localRoot = windowsLocalRoot;
+                        if (windowsLocalRoot.match(/^[A-Z]:/)) {
+                            localRoot = `${windowsLocalRoot[0].toLowerCase()}${windowsLocalRoot.substr(1)}`;
+                        }
+                        return { localRoot, remoteRoot };
+                    });
+                }
+                debugConfiguration.pathMappings = pathMappings;
         }
         this.sendTelemetry('attach', debugConfiguration);
     }
diff --git a/src/test/debugger/extension/configuration/resolvers/attach.unit.test.ts b/src/test/debugger/extension/configuration/resolvers/attach.unit.test.ts
@@ -168,7 +168,6 @@ getNamesAndValues(OSType).forEach(os => {
                 expect(pathMappings![0].localRoot).to.be.equal(workspaceFolder.uri.fsPath);
                 expect(pathMappings![0].remoteRoot).to.be.equal(workspaceFolder.uri.fsPath);
             });
-
             test(`Ensure drive letter is lower cased for local path mappings on Windows when host is '${host}'`, async function () {
                 if (os.name !== 'Windows') {
                     return this.skip();
@@ -183,7 +182,26 @@ getNamesAndValues(OSType).forEach(os => {
                 const localRoot = `Debug_PythonPath_${new Date().toString()}`;
                 const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { localRoot, host, request: 'attach' } as any as DebugConfiguration);
                 const pathMappings = (debugConfig as AttachRequestArguments).pathMappings;
-                const lowercasedLocalRoot = workspaceFolder.uri.fsPath.charAt(0).toLowerCase() + workspaceFolder.uri.fsPath.substr(1);
+                const lowercasedLocalRoot = path.join('c:', 'Debug', 'Python_Path');
+
+                expect(pathMappings![0].localRoot).to.be.equal(lowercasedLocalRoot);
+            });
+            test(`Ensure drive letter is lower cased for local path mappings on Windows when host is '${host}' and with existing path mappings`, async function () {
+                if (os.name !== 'Windows') {
+                    return this.skip();
+                }
+
+                const activeFile = 'xyz.py';
+                const workspaceFolder = createMoqWorkspaceFolder(path.join('C:', 'Debug', 'Python_Path'));
+                setupActiveEditor(activeFile, PYTHON_LANGUAGE);
+                const defaultWorkspace = path.join('usr', 'desktop');
+                setupWorkspaces([defaultWorkspace]);
+
+                const localRoot = `Debug_PythonPath_${new Date().toString()}`;
+                const debugPathMappings = [ { localRoot: path.join('${workspaceFolder}', localRoot), remoteRoot: '/app/' }];
+                const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { localRoot, pathMappings: debugPathMappings, host, request: 'attach' } as any as DebugConfiguration);
+                const pathMappings = (debugConfig as AttachRequestArguments).pathMappings;
+                const lowercasedLocalRoot = path.join('c:', 'Debug', 'Python_Path', localRoot);
 
                 expect(pathMappings![0].localRoot).to.be.equal(lowercasedLocalRoot);
             });
