构建和测试 Go 应用

本页面介绍如何使用 Cloud Build 构建和测试 Go 应用、将工件上传到 Artifact Registry、生成来源信息，以及将测试日志保存在 Cloud Storage 中。

准备工作

本页面的说明假定您熟悉 Go。此外：

  • 启用 Cloud Build API、Cloud Run API 和 Artifact Registry API（如果尚未启用）。

    启用 API 所需的角色

    如需启用 API，您需要拥有 serviceusage.services.enable 权限。如果您创建了项目，则可能已经通过 Owner 角色 (roles/owner) 拥有此权限。否则，您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获取此权限。 了解如何授予角色。

    启用 API

  • 如需运行此页面中的 gcloud 命令，请安装 Google Cloud CLI。
  • 准备好 Go 项目。
  • 在 Artifact Registry 中拥有 Go 代码库。如果您没有代码库，请创建一个新代码库。
  • 如果您想在 Cloud Storage 中存储测试日志，或者想使用 gcloud CLI 启动 build，请在 Cloud Storage 中创建存储桶。
  • 确保您知道 Cloud Run 的运行时服务账号的 ID。

创建自定义 Cloud Build 服务账号

在 Google Cloud CLI 中运行以下命令，创建自定义 Cloud Build 服务账号：

  gcloud iam service-accounts create cloud-build-go \
      --description="Build and test Go applications" \
      --display-name="Cloud Build Go" \
      --project="PROJECT_ID"

将 PROJECT_ID 替换为您的 Google Cloud 项目 ID。如果省略此标志，则假定为当前项目。

您将使用此服务账号来构建和测试 Go 应用。

配置 IAM 权限

如需为新服务账号配置构建和部署 Go 应用所需的权限，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往 Cloud Build 权限页面：

    前往权限

  2. 前往服务账号菜单，然后选择您的 cloud-build-go 服务账号。

  3. 将以下角色的状态设置为已启用：

    • Cloud Run Admin (roles/run.admin)：允许 Cloud Build 将新服务部署到 Cloud Run。
    • Storage Admin (roles/storage.admin)：可用于从 Cloud Storage 读取数据和向 Cloud Storage 写入数据。
    • Artifact Registry Writer (roles/artifactregistry.writer)：允许从 Artifact Registry 拉取映像以及向其中写入映像。
    • 日志写入者 (roles/logging.logWriter)：允许将日志条目写入 Cloud Logging。
    • Cloud Build Editor (roles/cloudbuild.builds.editor)：允许您的服务账号运行 build。

配置 Go 构建

Docker Hub 中的公共 golang 映像支持使用 Go 模块进行构建。在 Cloud Build 配置文件中使用此映像作为构建步骤，可让您调用映像中的 go 命令。传递到此构建步骤的参数会直接传递到 golang 工具，让您可以在此映像中运行任何 go 命令。

本部分展示了如何从 cloud-build-samples Git 代码库为 Go 应用创建示例 build 配置文件。build 配置文件包含用于构建应用、添加单元测试的步骤，以及在测试通过后用于部署应用的步骤。

如需构建示例 Go 应用，请执行以下操作：

  1. 配置单元测试：如果您已在应用中定义单元测试，则可以在构建步骤中添加以下字段，以配置 Cloud Build 来运行测试：

    • name：将此字段的值设置为 golang 以将 Docker Hub 中的 golang 映像用于您的任务。
    • entrypoint：将此字段的值设置为 /bin/bash。这样，您就可以直接从构建步骤运行多行 bash 命令。

    • args：构建步骤的 args 字段采用一系列参数，并将其传递给 name 字段引用的映像。在以下示例中，args 字段采用参数进行：

      • 运行测试日志格式化程序以下载测试日志输出。
      • 打印日志输出。
      • 将测试结果保存在 sponge.log 中。

      • 将 sponge.log 中的结果输出到 JUNIT XML 文件。JUNIT XML 文件的名称是使用与 build 关联的提交 ID 的简短版本构建的。后续的 build 步骤会将此文件中的日志保存到 Cloud Storage。

        steps:
  # Run tests and save to file
  - name: golang:1.23
    entrypoint: /bin/bash
    args:
      - -c
      - |
        go install github.com/jstemmer/go-junit-report/v2@latest
        2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml

  2. 上传到 Artifact Registry：在配置文件中，使用 goModules 字段指定应用路径和 Artifact Registry 中的 Go 代码库：

    # Upload Go module to artifact registry
artifacts:
  goModules:
    - repositoryName: 'repositoryName'
      repositoryLocation: 'location'
      repositoryProjectId: 'projectId'
      sourcePath: 'sourcePath'
      modulePath: 'appPath'
      moduleVersion: 'version'

    替换以下值：

    • repositoryName：您的 Go 代码库在 Artifact Registry 中的名称。
    • location：您的代码库在 Artifact Registry 中的位置。
    • projectId：包含 Artifact Registry 制品库的 Google Cloud 项目的 ID。
    • sourcePath：build 工作区中 go.mod 文件的路径。
    • appPath：打包应用的路径。
    • version：应用的版本号，以数字和英文句点表示，例如 v1.0.1。

  3. 可选：启用来源信息生成功能

    Cloud Build 可以生成可验证的软件制品的供应链等级 (SLSA) 构建来源元数据，以帮助保护您的持续集成流水线。

    如需启用来源生成，请将 requestedVerifyOption: VERIFIED 添加到配置文件中的 options 部分。

    构建完成后，您可以在 Artifact Registry 中查看代码库详细信息。

    您还可以查看 build 出处元数据和验证出处。

  4. 将测试日志保存到 Cloud Storage：您可以指定现有存储桶位置和测试日志路径，将 Cloud Build 配置为将所有测试日志存储在 Cloud Storage 中。

    以下构建步骤会将您保存在 JUNIT XML 文件中的测试日志存储到 Cloud Storage 存储桶：

    # Save test logs to Google Cloud Storage
artifacts:
  objects:
    location: gs://$_BUCKET_NAME/
    paths:
      - ${SHORT_SHA}_test_log.xml

    以下代码段显示了上述步骤的完整 build 配置文件：

      steps:
    # Run tests and save to file
    - name: golang:1.23
      entrypoint: /bin/bash
      args:
        - -c
        - |
          go install github.com/jstemmer/go-junit-report/v2@latest
          2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml

  # Store golang modules in Google Artifact Registry
  artifacts:
    goModules:
      - repositoryName: 'repositoryName'
        repositoryLocation: 'location'
        repositoryProjectId: 'projectId'
        sourcePath: 'sourcePath'
        modulePath: 'appPath'
        moduleVersion: 'version'

  5. 使用 gcloud CLI 启动构建，或创建构建触发器：

    gcloud

    运行以下命令，使用 --substitutions 指定 cloudbuild.yaml 中使用的替换变量：

    gcloud builds submit --region=us-west2 --config=cloudbuild.yaml \
    --default-buckets-behavior=REGIONAL_USER_OWNED_BUCKET \
    --service-account=projects/PROJECT_ID/serviceAccounts/cloud-build-go@PROJECT_ID. \
    --substitutions=_AR_REPO_NAME="_AR_REPO_NAME",_BUCKET_NAME="_BUCKET_NAME",SHORT_SHA="SHORT_SHA"

    替换以下内容：

    • _AR_REPO_NAME：您的 Artifact Registry 代码库的名称。

    • _BUCKET_NAME：用于测试日志的 Cloud Storage 存储桶的名称。

    • SHORT_SHA：简短的通用文本字符串，例如“手动”。对于由触发器调用的 build，系统会自动填充 SHORT_SHA 值，但使用 gcloud CLI 提交 build 时不会提供这些值。

    构建触发器

    按照创建构建触发器中的步骤操作。在替换变量字段中，您还必须提供 Artifact Registry 代码库的名称和 Cloud Storage 存储桶的名称（用于存放测试日志）。

后续步骤