Add path mappings for remote debugging when attaching to the localhost (microsoft#1830)

Author: DonJayamanne

news/2 Fixes/1829.md

@@ -0,0 +1 @@
+Automatically add path mappings for remote debugging when attaching to the localhost.

src/client/debugger/configProviders/pythonV2Provider.ts

@@ -16,7 +16,7 @@ export class PythonV2DebugConfigurationProvider extends BaseConfigurationProvide
  constructor(@inject(IServiceContainer) serviceContainer: IServiceContainer) {
  super('pythonExperimental', serviceContainer);
  }
- protected async provideLaunchDefaults(workspaceFolder: Uri, debugConfiguration: PythonLaunchDebugConfiguration<LaunchRequestArguments>): Promise<void> {
+ protected async provideLaunchDefaults(workspaceFolder: Uri | undefined, debugConfiguration: PythonLaunchDebugConfiguration<LaunchRequestArguments>): Promise<void> {
  await super.provideLaunchDefaults(workspaceFolder, debugConfiguration);
  const debugOptions = debugConfiguration.debugOptions!;
  if (debugConfiguration.debugStdLib) {
@@ -48,7 +48,8 @@ export class PythonV2DebugConfigurationProvider extends BaseConfigurationProvide
  debugConfiguration.program = (await utils.getPyramidStartupScriptFilePath(workspaceFolder))!;
  }
  }
- protected async provideAttachDefaults(workspaceFolder: Uri, debugConfiguration: PythonAttachDebugConfiguration<AttachRequestArguments>): Promise<void> {
+ // tslint:disable-next-line:cyclomatic-complexity
+ protected async provideAttachDefaults(workspaceFolder: Uri | undefined, debugConfiguration: PythonAttachDebugConfiguration<AttachRequestArguments>): Promise<void> {
  await super.provideAttachDefaults(workspaceFolder, debugConfiguration);
  const debugOptions = debugConfiguration.debugOptions!;
  if (debugConfiguration.debugStdLib) {
@@ -82,12 +83,22 @@ export class PythonV2DebugConfigurationProvider extends BaseConfigurationProvide
  if (!debugConfiguration.pathMappings) {
  debugConfiguration.pathMappings = [];
  }
+ // This is for backwards compatibility.
  if (debugConfiguration.localRoot && debugConfiguration.remoteRoot) {
  debugConfiguration.pathMappings!.push({
  localRoot: debugConfiguration.localRoot,
  remoteRoot: debugConfiguration.remoteRoot
  });
  }
+ // 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) {
+ debugConfiguration.pathMappings!.push({
+ localRoot: workspaceFolder.fsPath,
+ remoteRoot: workspaceFolder.fsPath
+ });
+ }
  }
  private debugOption(debugOptions: DebugOptions[], debugOption: DebugOptions) {
  if (debugOptions.indexOf(debugOption) >= 0) {

src/test/debugger/configProvider/provider.attach.test.ts

@@ -14,7 +14,7 @@ import { PYTHON_LANGUAGE } from '../../../client/common/constants';
 import { EnumEx } from '../../../client/common/enumUtils';
 import { IFileSystem, IPlatformService } from '../../../client/common/platform/types';
 import { PythonDebugConfigurationProvider, PythonV2DebugConfigurationProvider } from '../../../client/debugger';
-import { DebugOptions } from '../../../client/debugger/Common/Contracts';
+import { AttachRequestArguments, DebugOptions } from '../../../client/debugger/Common/Contracts';
 import { IServiceContainer } from '../../../client/ioc/types';
 
 enum OS {
@@ -164,9 +164,44 @@ enum OS {
  const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { localRoot, request: 'attach' } as any as DebugConfiguration);
 
  expect(debugConfig).to.have.property('localRoot', localRoot);
- if (provider.debugType === 'pythonExperimental') {
- expect(debugConfig!.pathMappings).to.be.lengthOf(0);
- }
+ });
+ ['localhost', '127.0.0.1', '::1'].forEach(host => {
+ test(`Ensure path mappings are automatically added when host is '${host}'`, async () => {
+ const activeFile = 'xyz.py';
+ const workspaceFolder = createMoqWorkspaceFolder(__dirname);
+ setupActiveEditor(activeFile, PYTHON_LANGUAGE);
+ const defaultWorkspace = path.join('usr', 'desktop');
+ setupWorkspaces([defaultWorkspace]);
+
+ const localRoot = `Debug_PythonPath_${new Date().toString()}`;
+ const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { localRoot, host, request: 'attach' } as any as DebugConfiguration);
+
+ expect(debugConfig).to.have.property('localRoot', localRoot);
+ if (provider.debugType === 'pythonExperimental') {
+ const pathMappings = (debugConfig as AttachRequestArguments).pathMappings;
+ expect(pathMappings).to.be.lengthOf(1);
+ expect(pathMappings![0].localRoot).to.be.equal(workspaceFolder.uri.fsPath);
+ expect(pathMappings![0].remoteRoot).to.be.equal(workspaceFolder.uri.fsPath);
+ }
+ });
+ });
+ ['192.168.1.123', 'don.debugger.com'].forEach(host => {
+ test(`Ensure path mappings are not automatically added when host is '${host}'`, async () => {
+ const activeFile = 'xyz.py';
+ const workspaceFolder = createMoqWorkspaceFolder(__dirname);
+ setupActiveEditor(activeFile, PYTHON_LANGUAGE);
+ const defaultWorkspace = path.join('usr', 'desktop');
+ setupWorkspaces([defaultWorkspace]);
+
+ const localRoot = `Debug_PythonPath_${new Date().toString()}`;
+ const debugConfig = await debugProvider.resolveDebugConfiguration!(workspaceFolder, { localRoot, host, request: 'attach' } as any as DebugConfiguration);
+
+ expect(debugConfig).to.have.property('localRoot', localRoot);
+ if (provider.debugType === 'pythonExperimental') {
+ const pathMappings = (debugConfig as AttachRequestArguments).pathMappings;
+ expect(pathMappings).to.be.lengthOf(0);
+ }
+ });
  });
  test('Ensure \'localRoot\' and \'remoteRoot\' is used', async function () {
  if (provider.debugType !== 'pythonExperimental') {