开发Julia包时如何在VS Code中调试带额外测试依赖的单元测试

问题根因 #

你直接运行/调试runtests.jl时，Julia默认只加载包主环境Project.toml的[deps]区块依赖，而Pkg.test()执行时会自动创建临时运行环境，把[extras]区块的测试专属依赖也加入环境，这就是两者行为不一致的原因。

解决方案 #

方案1：使用独立测试环境（推荐，符合Julia官方规范） #

这是Julia 1.2+之后官方推荐的测试依赖管理方式，不会和主包依赖耦合：

• 在包根目录的test文件夹下创建独立的Project.toml，将所有测试需要的依赖（比如你用到的CSV、CategoricalArrays、DataStructures等）都添加到这个文件的[deps]区块
• 在runtests.jl的最开头加入以下代码，每次运行脚本自动激活测试环境：

using Pkg
# 激活test目录对应的独立测试环境
Pkg.activate(@__DIR__)
# 确保所有依赖都已安装，首次运行会自动下载缺失包
Pkg.instantiate()

配置完成后，不管你直接点运行还是启动调试，都会自动加载所有测试需要的依赖，不会再报缺包错误。

方案2：配置VS Code调试参数，不修改代码 #

如果你不想改动runtests.jl的代码，可以通过配置调试启动项实现自动加载测试依赖：

1. 打开VS Code左侧「运行和调试」面板，点击「创建launch.json文件」，选择Julia环境
2. 将默认配置替换为以下内容：

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "julia",
            "request": "launch",
            "name": "调试当前包的单元测试",
            "program": "${file}",
            "cwd": "${workspaceFolder}",
            // 指定使用test目录下的环境
            "juliaEnv": "${workspaceFolder}/test",
            "args": []
        }
    ]
}

3. 后续调试runtests.jl时，选择这个名为「调试当前包的单元测试」的配置启动即可。

方案3：兼容旧版[extras]配置的临时方案 #

如果你暂时不想拆分独立测试环境，还是沿用主Project.toml的[extras]配置，可以在runtests.jl开头加入以下代码，模拟Pkg.test()的依赖加载逻辑：

using Pkg
# 激活主包环境
Pkg.activate(dirname(@__DIR__))
# 临时安装extras中的测试依赖
extras = Pkg.TOML.parsefile(joinpath(dirname(@__DIR__), "Project.toml"))["extras"]
Pkg.add([PackageSpec(name=pkg, uuid=uuid) for (pkg, uuid) in extras])

调试完成后你可以手动删除额外添加的依赖，或者用Pkg.resolve()恢复原环境。

内容的提问来源于stack exchange，提问作者call me Steve