vscode (Win 10) "unverified" 中的断点,在 Linux Docker 容器 (Hyper-V) 中远程调试 Go 应用程序时未命中

Breakpoints in vscode (Win 10) "unverified" and not hit when remote debugging Go app in Linux Docker container (Hyper-V)

我正在为 Windows 10 使用 vscode(1.34.0 内部和稳定版本)开发 Go (1.12.0) api-server。源代码位于在定义的 %GOPATH% 中的 Windows 机器上。 Delve(dlv.exe - 版本 1.2.0)也安装在 %GOPATH%\bin 中,%GOPATH%\bin 也在 Windows %PATH%.

go 应用程序随后构建在 Docker(Docker 桌面版 2.0.0.3(31259))容器中,其中包含 docker-compose(作为其他一些服务,例如数据库和网络服务器 运行ning 在其他容器中)。然后将最终的 go app 二进制文件与 delve 可执行文件一起复制到 Alpine-Linux 容器中,并且 delve 服务器以无头模式启动。没有源代码被复制到 Alpine-Linux 容器,只有二进制文件。

我没有设法在 vscode 中使用此设置正确设置远程调试。调试器确实启动了我的应用程序,但任何断点都会立即变灰并变为 "unverified"。当应用程序(api 服务器)运行s.

时,它们也不会被命中

使用 Jetbrains 的 Goland IDE 进行远程调试时,使用此设置进行调试非常有效(调试器启动,可以设置断点并命中)。

过去几天我一直在寻找解决方案,在 post 论坛上找到了具有类似问题的 Chrome 调试、Node.js 调试等,这个 post 在 Go 上,特别是:

我还找到了这个示例配置:

https://github.com/lukehoban/webapp-go/blob/debugging/.vscode/launch.json

我认为我遇到的主要问题是,我在任何地方都找不到任何示例,说明如何在 launch.json 中为 Windows 机器上的远程调试配置正确设置程序路径(我也找不到任何与此相关的文档)。源代码仅在 GOPATH 中的 Windows 机器上,而不是在应用程序的最终容器中,并在 运行 中钻研(这同样适用于 Goland 调试器)

我的项目path/directory结构(简化):

%GOPATH%\github.com\myuser\project_dir\
   .vscode\
      launch.json
   cmd\
      my_api\
          main.go
      another_app\
          main.go
   package1\
      package1.go (this is where I am setting the breakpoint, this package is imported in cmd\my_api\main.go)
   Dockerfile
   ... (.gitignore, GoPkg etc.)

我当前的 launch.json 配置(请参阅下面我尝试过的一些变体)

launch.json - 远程配置

{
         "name": "RemoteDockerAPI",
         "type": "go",
         "request": "launch",
         "mode": "remote",
         "program": "${workspaceFolder}/cmd/my_api",
         "env": {},
         "args": [],
         "remotePath": "/my_api",
         "port": 40400, // Port 
         "host": "127.0.0.1", // Docker IP
         "showLog": true
}

注意:project_folder/cmd/my_api 是 api 服务器的 main.go 所在的位置。然而,这个应用程序的一些包直接位于项目文件夹下,即 project_folder/package1/package1.go

我试过

"program": "${workspaceFolder}",

"program": "${workspaceFolder}\cmd\my_api",

"program": "${workspaceFolder}/cmd/my_api",

"program": "${workspaceFolder}\cmd\my_api\main.go",

"program": "${workspaceFolder}/cmd/my_api/main.go",

我也试着改变这个(没有明显的改变):

"remotePath": "/",

没有成功。

我的多阶段 Docker 用于构建应用程序并以无头模式启动 Delve 的文件:

FROM golang:1.11.6-alpine3.9 AS builder

RUN wget -O /usr/bin/dep 'https://github.com/golang/dep/releases/download/v0.5.1/dep-linux-amd64' \
    && chmod +x /usr/bin/dep

# For debugging: conmpile Delve
RUN apk add --no-cache git
RUN go get github.com/derekparker/delve/cmd/dlv

# Copy Code and build it:
WORKDIR $GOPATH/src/github.com/myuser/my_api/
COPY Gopkg.toml Gopkg.lock ./
RUN dep ensure --vendor-only
COPY . ./

# Compile with necessary flags for delve
RUN CGO_ENABLED=0 GOOS=linux go build -gcflags "all=-N -l" -a -installsuffix nocgo -o /my_api ./cmd/my_api

FROM alpine:3.9 AS runtime-base

# DEBUGGING: Allow delve to run on Alpine based containers.
RUN apk add --no-cache libc6-compat

# App container
FROM runtime-base

WORKDIR /
# Copy certificates
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
# Copy app
COPY --from=builder /my_api ./
# Copy delve
COPY --from=builder /go/bin/dlv /

# 40400 for delve
EXPOSE 40400

CMD ["/dlv","--listen=:40400","--headless=true","--api-version=2", "exec", "./my_api"]

我在其中一个包中设置了一个断点(不是在 project_dir/cmd/my_api/main.go 中,而是在 project_dir/package1/package1.go 中)。一旦我在 vscode 中启动调试器并且没有命中断点,它就会变成灰色和 "unverified"。

我可能在非常简单的层面上做错了,但我似乎无法弄清楚是什么。

更新 我终于找到了调试器日志并看到了这个:

From client: setBreakpoints({"source":{"name":"package1.go","path":"c:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go"},"lines":[165,170],"breakpoints":[{"line":165},{"line":170}],"sourceModified":false})
SetBreakPointsRequest
All cleared
Creating on: C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go (C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go) :165
Creating on: C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go (C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go) :170
Error on CreateBreakpoint: could not find C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:165
Error on CreateBreakpoint: could not find C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170

不过,我不确定它能否真正帮助我找出 vscode 的问题。这可能是一个错误吗?我发现了对旧 MacOS 错误的引用:

https://github.com/Microsoft/vscode-go/issues/1859

https://github.com/go-delve/delve/issues/1282

但这些都是旧的和固定的(?)。

除windows路径分隔符(“\”)被vscode(?)转换为Unix风格的路径分隔符“/”外,路径是正确的,文件存在并且设置断点的行位于文件的中间(并且正确)...

在 vscode 中,如果我按住 CTRL 并单击 "could not find.." 中显示的路径(由 vscode 制作成 link),它会将我带到文件(所以 vscode 可以 find/see 没问题)。

这在 Windows 主机上连接没有问题(但仅当从该目录中调用时):

%GOPATH%\...\project_dir\cmd\my_api\dlv debug -l 127.0.0.1:40400

(dlv) funcs any_function_in_package1 

找到这个函数,所以(源)代码似乎是可见的。

直接在Delve中设置我想要的断点也可以:

(dlv) break C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170
Breakpoint 1 set at 0xad8dd8 for github.com/githubaccount/project_dir/package1.(*Struct).Function() C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170

Windows-style 路径在命令行上也以同样的方式工作:

(dlv) break C:\Users\myuser\go\src\github.com\githubaccount\project_dir\package1\package1.go:170
Breakpoint 1 set at 0xad8dd8 for github.com/githubaccount/project_dir/package1.(*Struct).Function() C:/Users/myuser/go/src/github.com/githubaccount/project_dir/package1/package1.go:170

这是 vscode 中的 Windows/Unix 路径样式问题吗?有什么建议吗?

更新 2 刚刚发现这个 2018 年底的错误报告,它似乎描述了 Delve 和 vscode:

之间的类似问题

https://github.com/bazelbuild/rules_go/issues/1844

但是,正如我在上面 post 编辑的那样,在我的情况下,Delve 似乎可以毫无问题地传递断点的绝对 (Windows) 路径,所以我不确定上述错误是否适用于此情况?另外,为什么它会直接在 Delve 中运行,而不是通过 vscode?还是毕竟是 Windows 路径/Unix 路径问题?

感谢您的帮助!

我终于在这方面找到了一个 bug report,所以它现在似乎是一个未解决的错误。留在这里供任何人搜索,因为这个错误不容易找到(至少对我而言)。

我刚刚遇到了同样的问题,最新的(2019 年 7 月)1.37.0 VSCode、dlv 1.2.0 和 Go 1.12.7,在本地 Windows 10 机器上(没有Docker,只需附加到本地主机 运行 Go 程序)。

在我的例子中,project\.vscode\launch.json 是:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Remote Debug",
            "type": "go",
            "request": "attach",
            "mode": "remote",
            "remotePath": "C:\Users\VonC\git\go-gitea\gitea.exe",
            "cwd": "C:\Users\VonC\git\go-gitea",
            "port": 2345,
            "host": "127.0.0.1",
            "showLog": true,
            "trace": "verbose",
        }
    ]
}

通过激活日志和详细的跟踪,我清楚地看到了根本原因:

Error on CreateBreakpoint: could not find C:\Users\VonC\git\go-gitea\gitea.exe\models\repo.go:230

我混淆了可执行文件的 remotePath。

"remotePath": "C:\Users\VonC\git\go-gitea",

有了路径,同样的配置可以完美运行,并且我的断点被识别(并在执行过程中遇到时停止)。

当尝试远程连接到 Docker 容器中的程序时,也许 microsoft/vscode-go issue 2010 仍然有效。


2020 年 3 月更新:microsoft/vscode-go issue 2010 is now closed with PR 3108, from Quoc Truong, commit 7da5077

When we are remote debugging cross-compiled binary on Windows, we are not respecting the separator that users use in remotePath field.

那应该在 VSCode 1.44,2020 年 3 月版中。