如何在Cloud Build中运行Datastore Emulator并解决测试连接超时问题？

问题场景 #

提交PR到指定分支时，希望通过Cloud Build运行依赖Datastore Emulator的Go单元测试。本地测试正常，但使用Cloud Build配置执行时，测试无法连接模拟器，最终超时失败。

核心问题分析 #

1. 测试代码硬编码覆盖环境变量 #

测试代码的init函数中手动设置DATASTORE_EMULATOR_HOST为localhost:8000，直接覆盖了Cloud Build步骤传递的dsemu:8000配置：

err := os.Setenv("DATASTORE_EMULATOR_HOST", "localhost:8000")

这导致Go测试进程尝试连接自身容器的8000端口，而非Cloud Build网络中dsemu容器的服务端口。

2. 连接检查目标错误 #

init函数中用net.Dial("tcp", "localhost:8000")检查模拟器状态，但在Cloud Build的golang:1.19容器中，localhost指向自身容器，而模拟器运行在独立的dsemu容器中，因此这个检查必然失败，直接触发log.Fatalf终止测试。

3. 客户端生命周期管理错误 #

init函数中创建Datastore客户端后立即defer dsClient.Close()，init函数执行完成后客户端就会被关闭，后续测试用例执行时会因客户端已关闭而报错。

修正方案 #

调整测试代码的init函数 #

去掉硬编码的环境变量设置，改用读取外部传入的环境变量，同时移除错误的本地连接检查，调整客户端生命周期：

func init() {
    // 不再手动设置环境变量，直接使用Cloud Build传递的配置
    emulatorHost := os.Getenv("DATASTORE_EMULATOR_HOST")
    if emulatorHost == "" {
        log.Fatalf("DATASTORE_EMULATOR_HOST environment variable is not set")
    }

    // 移除localhost的连接检查，由datastore.NewClient自动处理连接验证
    var err error
    dsClient, err = datastore.NewClient(ctx, mockCfg.GCP.ProjectID)
    if err != nil {
        log.Fatalf("Error creating datastore client: %v", err)
    }
    // 不要在init中defer Close，改为在测试套件结束时关闭（如使用TestMain）
}

如果需要统一管理客户端生命周期，可以使用TestMain替代init：

func TestMain(m *testing.M) {
    // 初始化客户端
    var err error
    dsClient, err = datastore.NewClient(ctx, mockCfg.GCP.ProjectID)
    if err != nil {
        log.Fatalf("Error creating datastore client: %v", err)
    }
    defer dsClient.Close()

    // 运行所有测试
    os.Exit(m.Run())
}

确认Cloud Build配置的合理性 #

当前Cloud Build配置中的以下部分无需修改：

• 启动dsemu容器时指定--network=cloudbuild，确保容器间网络互通
• 使用dockerize等待dsemu:8000端口就绪
• 在golang:1.19步骤中传递DATASTORE_EMULATOR_HOST=dsemu:8000环境变量

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