简单介绍vscode调试container中的程序的方法步骤

25次阅读

共计 2927 个字符，预计需要花费 8 分钟才能阅读完成。

导读	本文主要介绍了 vscode 调试 container 中的程序的方法步骤，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下

在写 cmu14-445 的 project 时，我希望在本地 vscode 编辑代码，然后在 docker 中编译和测试代码。但是如果测试出了问题，直接在本地调试就变得麻烦了。所以希望利用 vscode 进行远程调试。

参考官方文档，利用 ssh + pipeTransport 来完成，下面是我的 launch.json 和 tasks.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": "g++-9 - Build and debug active file",
      "type": "cppdbg",
      "request": "launch",
      "program": "./build/test/${fileBasenameNoExtension}",
      "args": [],
      "stopAtEntry": false,
      "sourceFileMap":{"/bustub": "${workspaceFolder}"
        /*remote src directory : local src directory*/
        /* 文档里说这个是为了便于 debugger 找源码 */
      },
      "cwd": "/bustub",
      "environment": [],
      "pipeTransport": {
        "pipeCwd": "/usr/bin",
        "pipeProgram": "ssh",
        "pipeArgs": ["root@172.17.0.2"],
        "debuggerPath": "/usr/bin/gdb"
      },
      "externalConsole": false,
      "MIMode": "gdb",
      "setupCommands": [
        {
          "description": "Enable pretty-printing for gdb",
          "text": "-enable-pretty-printing",
          "ignoreFailures": true
        }
      ],
      "preLaunchTask": "C/C++: g++-9 build active file",
      "miDebuggerPath": "/usr/bin/gdb"
    }
  ]
}

{
  "tasks": [
    {
      "type": "shell",
      "label": "C/C++: g++-9 build active file",
      "command": "ssh",
      "args": [
        "root@172.17.0.2",
        "cd /bustub/build && make ${fileBasenameNoExtension}"
      ],
      "group": {
        "kind": "build",
        "isDefault": true
      },
      "detail": "Task generated by Debugger."
    }
  ],
  "version": "2.0.0"
}

编译时利用 ssh，在 docker 的终端中进行编译。而在 launch.json 中利用 ssh 作为 pipeProgram，传递调试信息（虽然原理我也不太懂就是了）。172.17.0.2 是 container 的 IP 地址。

为了保证主机能够直接通过 ssh 登录 container，需要修改一下 dockerfile 文件。最终我的 dockerfile 文件长这样：

FROM ubuntu:18.04
 
# Install Ubuntu packages.
# Please add packages in alphabetical order.
ARG DEBIAN_FRONTEND=noninteractive
RUN apt-get -y update && \
    apt-get -y install \
      build-essential \
      clang-8 \
      clang-format-8 \
      clang-tidy-8 \
      cmake \
      doxygen \
      git \
      g++-7 \
      pkg-config \
      valgrind \
      zlib1g-dev \
      ssh
RUN echo 'PermitRootLogin yes' >> /etc/ssh/sshd_config && \
    echo 'PermitEmptyPasswords yes' >> /etc/ssh/sshd_config && \
    echo 'PasswordAuthentication yes' >> /etc/ssh/sshd_config && \
    echo 'PubkeyAuthentication yes' >> /etc/ssh/sshd_config && \
    mkdir /root/.ssh
 
COPY ./id_rsa.pub /root/.ssh/authorized_keys
 
CMD service ssh start && git config --global http.proxy "http://192.168.31.1:7890" && bash

修改的地方主要是安装 ssh，然后把本地公钥 copy 过去，注意 copy 命令只能 copy 当前 context 下的文件，所以需要先复制一份公钥到源码目录中。然后 CMD 中显式启动 ssh service。并且配置 git 代理（不然有时候 clone github 会失败）。

docker 启动该镜像的时候就不要显式指定命令了，不然这样会覆盖默认的 CMD 指令。

最后还需要改一下.dockerignore 文件，原来的.dockerignore 文件会忽略源码目录下所有文件，导致 COPY 命令出错。OK，这样就可以愉快地在本地 vscode 下面调试 container 里面的程序了。

update:

发现上面的远程调试的方法挺麻烦的，vscode 的 docker 插件提供了直接把 vscode attach 到 container 里的方法，然后直接在 vscode 里面调试就行了。这个方法唯一的弊端是每次开启容器后，都需要在容器中重新安装一次 vscode 的插件。

在 bustub 容器里装了一波 C ++ 的插件，因为 bustub 的根目录中已经有一个 CmakeLists.txt，自动就配置好啦！