Golang测试函数无法读取VSCode中launch.json的环境变量

问题描述 #

在VSCode中为Go项目的launch.json配置了环境变量，但通过测试文件中的「run test | debug test」按钮执行测试时，os.Getenv()读取到的变量值为空。即使将launch.json中的mode改为test，问题依然存在。

配置与代码信息 #

• launch.json 配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch Package",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "program": "${fileDirname}",
            "env": {
                "HI": "Hi from env!"
            }
        }
    ]
}

• 测试文件 main_test.go：

package main_test

import (
    "os"
    "testing"
)

func Test_hi(t *testing.T) {
    hi := os.Getenv("HI")
    t.Log("Hello from test. ", hi)
    t.Fail()
}

• 执行方式：点击测试函数上方的「run test | debug test」按钮。

版本信息 #

• Go: 1.20.7 linux/amd64
• VSCode: 1.81.0
• Delve: 1.20.2

原因分析 #

VSCode中点击测试按钮执行测试时，Go扩展会直接调用go test或dlv test命令，不会自动加载launch.json中的配置。launch.json仅对通过调试面板启动的配置生效，而非文件内的快捷测试按钮。

解决方法 #

方法1：添加专门的测试调试配置到launch.json #

在launch.json中新增针对测试的配置项，通过调试面板选择该配置启动测试：

{
    "version": "0.2.0",
    "configurations": [
        // 原有包启动配置
        {
            "name": "Launch Package",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "program": "${fileDirname}",
            "env": {
                "HI": "Hi from env!"
            }
        },
        // 新增测试调试配置
        {
            "name": "Debug Test: Test_hi",
            "type": "go",
            "request": "launch",
            "mode": "test",
            "program": "${fileDirname}",
            "env": {
                "HI": "Hi from env!"
            },
            // 可选：指定仅运行单个测试函数
            "testArgs": "-run Test_hi"
        }
    ]
}

使用步骤：

1. 打开VSCode左侧「运行和调试」面板
2. 下拉选择「Debug Test: Test_hi」配置
3. 点击启动按钮，环境变量即可生效

方法2：通过VSCode设置全局测试环境变量 #

打开VSCode设置（快捷键Ctrl+,），搜索go.testEnvVars，在工作区或用户设置中添加环境变量：

"go.testEnvVars": {
    "HI": "Hi from env!"
}

此配置会对所有通过VSCode启动的Go测试生效，包括点击测试按钮的场景。

方法3：终端手动传递环境变量执行 #

临时测试时，可直接在终端中传递环境变量：

• 运行测试：

HI="Hi from env!" go test -v ./...

• 调试测试：

HI="Hi from env!" dlv test -- -run Test_hi

内容的提问来源于stack exchange，提问作者Prakash P