如何管理需API Key的Go测试并与封闭测试隔离？

在Go生态里，你可以用这几种方案把依赖API Key的测试和封闭测试（hermetic tests）隔离开，确保CI只跑封闭测试，本地按需运行集成测试：

1. 用构建标签拆分测试文件 #

把需要API Key的测试单独放到一个文件，比如foo_integration_test.go，在文件最顶部加构建标签：

//go:build integration
// +build integration

默认执行go test时，这个文件里的测试会被忽略。要跑这些集成测试，得加上标签参数：

go test -tags=integration ./...

CI脚本里只执行不带标签的go test就行，本地需要验证API逻辑时再加上标签。

2. 检查环境变量自动跳过测试 #

在依赖API Key的测试函数开头，先检查对应的环境变量有没有设置，没设置就直接跳过：

func TestAPICall(t *testing.T) {
    apiKey := os.Getenv("API_KEY")
    if apiKey == "" {
        t.Skip("未设置API_KEY环境变量，跳过该测试")
    }
    // 这里写实际的API调用测试逻辑
}

CI环境里不配置这个环境变量，这些测试就会自动跳过；本地跑之前先执行export API_KEY=你的密钥，再正常跑go test就行。

3. 自定义测试标记控制测试执行 #

在测试文件里定义一个自定义标记，比如apitest，然后在测试函数里判断是否传入了这个标记：

var runAPITests = flag.Bool("apitest", false, "运行需要API Key的测试")

func init() {
    flag.Parse()
}

func TestAPICall(t *testing.T) {
    if !*runAPITests {
        t.Skip("未指定-apitest标记，跳过该测试")
    }
    apiKey := os.Getenv("API_KEY")
    if apiKey == "" {
        t.Fatal("运行API测试必须设置API_KEY环境变量")
    }
    // 测试逻辑
}

要跑这些测试时，得带上标记：

go test -apitest ./...

CI里默认不使用这个标记，自然不会触发这些测试。

4. 用子测试分组管理 #

如果不想拆分文件，可以把所有依赖API Key的测试放到一个子测试组里，统一控制跳过逻辑：

func TestAPIGroup(t *testing.T) {
    apiKey := os.Getenv("API_KEY")
    if apiKey == "" {
        t.Skip("未设置API_KEY，跳过所有API相关测试")
    }

    t.Run("创建资源", func(t *testing.T) {
        // 具体测试逻辑
    })
    t.Run("删除资源", func(t *testing.T) {
        // 具体测试逻辑
    })
}

这样只要API Key不存在，整个子测试组都会被跳过，不会影响其他封闭测试的执行。

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