[vscode-go] docs: update "debug a program as root" to work with snap and package tests
866 views
Skip to first unread message
Suzy Mueller (Gerrit)
May 25, 2022, 12:30:09 PM5/25/22
to Gerrit Bot, goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, Hyang-Ah Hana Kim, TheDiveO, Jamal Carvalho, Gopher Robot, golang-co...@googlegroups.com
Suzy Mueller submitted this change.
Approvals:
Hyang-Ah Hana Kim: Looks good to me, approved; Automatically submit change
Suzy Mueller: Looks good to me, approved
docs: update "debug a program as root" to work with snap and package tests
fixes issue golang/vscode-go#2250
Change-Id: I95dcf9d9c724059602877892c9f82de45c6d1f13
GitHub-Last-Rev: 92e7970190694268af53c56017312f1861ae3d5f
GitHub-Pull-Request: golang/vscode-go#2258
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/408454
Reviewed-by: Hyang-Ah Hana Kim <hya...@gmail.com>
Auto-Submit: Hyang-Ah Hana Kim <hya...@gmail.com>
Reviewed-by: Suzy Mueller <suz...@golang.org>
---
M docs/debugging.md
1 file changed, 75 insertions(+), 3 deletions(-)
diff --git a/docs/debugging.md b/docs/debugging.md
index 86d01fc..2304d3f 100644
--- a/docs/debugging.md
+++ b/docs/debugging.md
@@ -354,12 +354,14 @@
The Go extension delegates interaction with terminals to VS Code [using Debug Adapter Protocol's `RunInTerminal` functionality](https://github.com/golang/vscode-go/discussions/1626). For configuring VS Code's terminal related behavior, see VS Code's [documentation](https://code.visualstudio.com/docs/editor/integrated-terminal).
-### Debugging a program as root
+### Debugging programs and tests as root
-In order to run and debug a program running as root, the debugger (`dlv`) must run with root privilege, too. You can start the debug session with root privilege utilizing the `"asRoot"` AND `"console"` launch options. This is currently supported only on Linux and Mac.
+In order to run and debug a program or a package test running as root, the debugger (`dlv`) must run with root privilege, too. You can start the debug session with root privilege utilizing the `"asRoot"` AND `"console"` launch options. This is currently supported only on Linux and Mac.
When `asRoot` is true, the Go extension will use the `sudo` command to run `dlv`. Since `sudo` may ask you to enter password, the debug session needs [terminal access](#handling-stdin) so set `"console": "integratedTerminal"` or `"console": "externalTerminal"` in the launch configuration.
+#### Debug a program as root
+
For example, the following launch configuration will start `myprogram` and debug it by running `sudo dlv dap` command in the integrated terminal.
```json
@@ -391,6 +393,7 @@
"tasks": [
{
"label": "go: build (debug)",
+ "type": "shell",
"command": "go",
"args": [
"build",
@@ -400,7 +403,7 @@
],
"options": {
"cwd": "${fileDirname}"
- }
+ },
...
}
]
@@ -409,6 +412,8 @@
The `-gcflags=all=-N -l` flag tells the `go build` command to preserve the debug information. The `-o` flag causes the compiled binary to be placed in `"${fileDirname}/__debug_bin"`. Extra build flags and environment variables *used for build* should be configured here as `args` or `options`'s `env` settings.
+It might be useful to add `__debug_bin` to your `.gitignore` to avoid debugging binaries getting checked-in into your repository.
+
Then, configure the launch config to run the task before starting debugging.
In `.vscode/launch.json`:
@@ -430,6 +435,56 @@
Settings (`args`, `cwd`, `env`, ...) configured in the above `launch.json` will only apply when *running* the compiled binary, not when building the binary.
+#### Debug a package test as root
+
+To debug package tests as root add the following launch and task configurations.
+
+In `.vscode/tasks.json`:
+```json
+ ...
+ "tasks": [
+ {
+ ...
+ },
+ {
+ "label": "go test (debug)",
+ "type": "shell",
+ "command": "go",
+ "args": [
+ "test",
+ "-c",
+ "-o",
+ "${fileDirname}/__debug_bin"
+ ],
+ "options": {
+ "cwd": "${fileDirname}",
+ },
+ ...
+ }
+ ]
+```
+
+In `.vscode/launch.json`:
+```json
+ ...
+ "configurations": [
+ {
+ ...
+ },
+ {
+ "name": "Debug Package Test as root",
+ "type": "go",
+ "request": "launch",
+ "mode": "exec",
+ "asRoot": true,
+ "program": "${fileDirname}/__debug_bin",
+ "cwd": "${fileDirname}",
+ "console": "integratedTerminal",
+ "preLaunchTask": "go test (debug)"
+ }
+ ]
+```
+
### Manually installing `dlv`
On rare occasions, you may want to install `dlv` by yourself instead of letting the extension handle its installation.
To view, visit change 408454. To unsubscribe, or for help writing mail filters, visit settings.
Reply all
Reply to author
Forward
0 new messages