debug: abiltiy to debug with root privileges

[dzvancuks]

Add ability to debug with Delve with sudo flag. Similar as it it done for Python:
https://code.visualstudio.com/docs/python/debugging#_sudo

It is needed to debug modules that require root access, i.e. gopacket/pcap to capture traffic.

[hyangah]

I didn't look into how python is addressing the issue. Based on the description,
#124 can be a prerequisite.

/cc @polinasok @quoctruong

[dacut]

This is a duplicate/continuation of microsoft/vscode-go#2889 -- the fix there was to:

Create a script named (e.g.) $HOME/.local/bin/dlv-sudo.sh:

#!/bin/bash
if ! which dlv ; then
	PATH="${GOPATH}/bin:$PATH"
fi
if [ "$DEBUG_AS_ROOT" = "true" ]; then
	exec sudo dlv "$@"
else
	exec dlv "$@"
fi

Make it executable: chmod a+x $HOME/.local/bin/dlv-sudo.sh

Create a user/workspace/folder setting (> Preferences: Open Workspace Settings (JSON)) that points at this as an alternative to dlv:

{
    "go.alternateTools": {
        "dlv": "${env:HOME}/.local/bin/dlv-sudo.sh"
    }
}

And create a launch.json (> Debug: Open launch.json) that sets the DEBUG_AS_ROOT environment variable:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Run as root",
            "type": "go",
            "request": "launch",
            "mode": "auto",
            "program": "${workspaceFolder}",
            "env": {
                "DEBUG_AS_ROOT": "true"
            }
        }
    ]
}

[dzvancuks]

@dacut yes, I found this tutorial but this part was impossible to implement as in latest/greatest go plugin there was no "dlv" property in "go.alternateTools":

{
    "go.alternateTools": {
        "dlv": "${env:HOME}/.local/bin/dlv-sudo.sh"
    }
}

I even mentioned this in SO, but no replies on it: https://stackoverflow.com/questions/63505746/how-can-i-debug-go-file-in-vs-code-with-root-privileges.

In any case this feature request is about adding 'sudo' flag naively, without extra workaround. Goland IDE has it, why VSC can't do the same? :)

[hyangah]

@dzvancuks you can use the above configuration @dacut mentioned - v0.16.2 fixed the misleading error message.
But, an easier way to enable sudo is still a nice feature to have.

[dacut]

@dzvancuks -- That's strange; I definitely have a "dlv" property, and it was suggested by IntelliCode as well. Check your plugin version? I'm running 0.16.2.

But, yes, having this natively is definitely wanted. (I was just mentioning a workaround.)

[polinasok]

@hyangah Why is "console" a prerequisite for this? Just like in the workaround, isn't it just a matter of adding "sudo" to the dlv command we launch if the configuration has a flag for that?

[hyangah]

@polinasok See the sudoers file modification described here microsoft/vscode-go#2889 (comment). That is not ideal and running sudo dlv from the terminal would allow users to enter the password.

[sethRait]

This method seems to be broken again. Using the script above (adding the -E flag to sudo and the --only-same-user=false flag to dlv as necessary does indeed get dlv to launch as sudo, but using this method, it won't hit any breakpoints for some reason, even though the logs indicate the breakpoints have been added.
This bug has been marked as fixed through several iterations over 2 years. It would be nice to see an actual fix that addresses the problem without workarounds.

[MaurGi]

Any solution for this? the suggestion above does not seem to work on WSL2, even if I change the settings.json on the remote.

[precisionpete]

I have been fighting with this for a week now. Can someone please give the current solution? Feb 2021. Go 1.6...