Add localRoot & remoteRoot to the launch.json snippets (microsoft#3950)

d3r3kk · web-flow · commit bd1ee9fb03ac · 2019-01-22T10:55:19.000-08:00
- Will set localRoot to "${workspaceFolder}" by default
- Will set remoteRoot to "." by default
- PTVSD will pick this up and infer "." to be CWD.
diff --git a/news/1 Enhancements/1385.md b/news/1 Enhancements/1385.md
@@ -0,0 +1 @@
+Add localRoot and remoteRoot defaults for Remote Debugging configuration in `launch.json`.
diff --git a/package.json b/package.json
@@ -675,14 +675,20 @@
                         }
                     },
                     {
-                        "label": "Python: Attach",
+                        "label": "Python: Remote Attach",
                         "description": "%python.snippet.launch.attach.description%",
                         "body": {
                             "name": "Attach (Remote Debug)",
                             "type": "python",
                             "request": "attach",
                             "port": 5678,
-                            "host": "localhost"
+                            "host": "localhost",
+                            "pathMappings": [
+                                {
+                                    "localRoot": "${workspaceFolder}",
+                                    "remoteRoot": "."
+                                }
+                            ]
                         }
                     }
                 ],
@@ -2028,4 +2034,4 @@
         "publisherDisplayName": "Microsoft",
         "publisherId": "998b010b-e2af-44a5-a6cd-0b5fd3b9b6f8"
     }
-}
+}
diff --git a/resources/default.launch.json b/resources/default.launch.json
@@ -7,11 +7,17 @@
         "console": "integratedTerminal"
     },
     {
-        "name": "Python: Attach",
+        "name": "Python: Remote Attach",
         "type": "python",
         "request": "attach",
         "port": 5678,
-        "host": "localhost"
+        "host": "localhost",
+        "pathMappings": [
+            {
+                "localRoot": "${workspaceFolder}",
+                "remoteRoot": "."
+            }
+        ]
     },
     {
         "name": "Python: Module",
@@ -55,4 +61,4 @@
         "program": "${file}",
         "console": "externalTerminal"
     }
-]
+]
diff --git a/src/client/debugger/extension/configuration/providers/remoteAttach.ts b/src/client/debugger/extension/configuration/providers/remoteAttach.ts
@@ -19,11 +19,18 @@ const defaultPort = 5678;
 export class RemoteAttachDebugConfigurationProvider implements IDebugConfigurationProvider {
     public async buildConfiguration(input: MultiStepInput<DebugConfigurationState>, state: DebugConfigurationState): Promise<InputStep<DebugConfigurationState> | void> {
         const config: Partial<AttachRequestArguments> = {
-            name: localize('python.snippet.launch.attach.label', 'Python: Attach')(),
+            name: localize('python.snippet.launch.attach.label', 'Python: Remote Attach')(),
             type: DebuggerTypeName,
             request: 'attach',
             port: defaultPort,
-            host: defaultHost
+            host: defaultHost,
+            pathMappings: [
+                {
+                    // tslint:disable-next-line:no-invalid-template-strings
+                    localRoot: '${workspaceFolder}',
+                    remoteRoot: '.'
+                }
+            ]
         };
 
         config.host = await input.showInputBox({
diff --git a/src/test/debugger/extension/configuration/providers/remoteAttach.unit.test.ts b/src/test/debugger/extension/configuration/providers/remoteAttach.unit.test.ts
@@ -83,7 +83,13 @@ suite('Debugging - Configuration Provider Remote Attach', () => {
             type: DebuggerTypeName,
             request: 'attach',
             port: 5678,
-            host: 'localhost'
+            host: 'localhost',
+            pathMappings: [
+                {
+                    localRoot: '${workspaceFolder}',
+                    remoteRoot: '.'
+                }
+            ]
         };
 
         expect(state.config).to.be.deep.equal(config);
@@ -110,7 +116,13 @@ suite('Debugging - Configuration Provider Remote Attach', () => {
             type: DebuggerTypeName,
             request: 'attach',
             port: 9999,
-            host: 'Hello'
+            host: 'Hello',
+            pathMappings: [
+                {
+                    localRoot: '${workspaceFolder}',
+                    remoteRoot: '.'
+                }
+            ]
         };
 
         expect(state.config).to.be.deep.equal(config);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Add localRoot and remoteRoot defaults for Remote Debugging configuration in `launch.json`.
Original file line number	Diff line number	Diff line change
`@@ -675,14 +675,20 @@`
`675`	`675`	`}`
`676`	`676`	`},`
`677`	`677`	`{`
`678`		`- "label": "Python: Attach",`
	`678`	`+ "label": "Python: Remote Attach",`
`679`	`679`	`"description": "%python.snippet.launch.attach.description%",`
`680`	`680`	`"body": {`
`681`	`681`	`"name": "Attach (Remote Debug)",`
`682`	`682`	`"type": "python",`
`683`	`683`	`"request": "attach",`
`684`	`684`	`"port": 5678,`
`685`		`- "host": "localhost"`
	`685`	`+ "host": "localhost",`
	`686`	`+ "pathMappings": [`
	`687`	`+ {`
	`688`	`+ "localRoot": "${workspaceFolder}",`
	`689`	`+ "remoteRoot": "."`
	`690`	`+ }`
	`691`	`+ ]`
`686`	`692`	`}`
`687`	`693`	`}`
`688`	`694`	`],`
`@@ -2028,4 +2034,4 @@`
`2028`	`2034`	`"publisherDisplayName": "Microsoft",`
`2029`	`2035`	`"publisherId": "998b010b-e2af-44a5-a6cd-0b5fd3b9b6f8"`
`2030`	`2036`	`}`
`2031`		`-}`
	`2037`	`+}`