Go アプリケーションをビルドしてテストする

このページでは、Cloud Build を使用して Go アプリケーションをビルド、テスト、デプロイする方法について説明します。

準備

このページの説明は、Go と以下の知識があることを前提としています。

• Enable the Cloud Build, Cloud Run, and Artifact Registry APIs.

  Enable the APIs

• このページで gcloud コマンドを実行するには、Google Cloud CLI をインストールします。
• cloud-build-samples Git リポジトリのクローンを作成します。これにより、テストと Dockerfile を備えた小さなウェブ アプリケーションが提供されます。
• Artifact Registry で Docker リポジトリを作成します（まだ作成していない場合）。
• テストログを保存する Cloud Storage にバケットを作成します。

サービス アカウントを構成する

このドキュメントの例では、ユーザー指定のサービス アカウントを使用します。Cloud Build で使用するサービス アカウントを作成するには、Google Cloud CLI で次のコマンドを実行します。

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

デフォルトのコンピューティング サービス アカウント（Cloud Run で使用）には、新しいサービス アカウントとして機能するための権限が必要です。まず、プロジェクトのコンピューティング サービス アカウントの名前を確認します。

gcloud iam service-accounts list --filter="email:[e-mail]"

次に、サービス アカウント ユーザー（roles/iam.serviceAccountUser）ロールを付与します。

gcloud iam service-accounts add-iam-policy-binding \
COMPUTE_SERVICE_ACCOUNT_EMAIL  \
--member="serviceAccount:cloud-build-go@PROJECT_ID.iam.gserviceaccount.com" \
--role="roles/iam.serviceAccountUser"

COMPUTE_SERVICE_ACCOUNT_EMAIL は、前のコマンドで出力されたデフォルトのコンピューティング サービス アカウントのメールアドレスに置き換えます。

IAM 権限を構成する

必要な権限があることを確認します。

Cloud Build でビルドを実行するために必要な権限を取得するには、ビルドサービス アカウントに対する Cloud Build サービス アカウント （roles/cloudbuild.builds.builder）IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ビルドされたイメージを Artifact Registry に保存するために必要な権限を取得するには、ビルドサービス アカウントに対する Artifact Registry 書き込み（roles/artifactregistry.writer）IAM ロール を付与するよう管理者に依頼してください。

テストログを Logging に保存するために必要な権限を取得するには、ビルドサービス アカウントに対するストレージ オブジェクト作成者 （roles/storage.objectCreator）IAM ロールを付与するよう管理者に依頼してください。

アプリケーションを Cloud Run にデプロイするために必要な権限を取得するには、ビルド サービス アカウントに対する Cloud Run デベロッパー （roles/run.developer）IAM ロールを付与するよう管理者に依頼してください。

Go ビルドを構成する

Docker Hub にある一般公開の golang イメージは、Go モジュールを使用したビルドの作成に対応しています。このイメージを Cloud Build 構成ファイルのビルドステップとして使用すると、イメージ内で go コマンドを呼び出すことができます。このビルドステップに渡された引数が golang ツールに直接渡されるため、このイメージで任意の go コマンドを実行できます。

このセクションでは、cloud-build-samples Git リポジトリの Go アプリのビルド構成ファイルの例を示します。アプリのビルド、単体テストの追加、テスト合格後、アプリをコンテナ化、デプロイするためのビルドステップが含まれます。

Go サンプル アプリケーションをビルドするには:

1. ビルドとテスト: アプリケーションで単体テストを定義している場合、ビルドステップに次のフィールドを追加してテストを実行するように Cloud Build を構成できます。

   • name: タスクの Docker Hub から取得した Golang イメージを使用するには、このフィールドの値を golang に設定します。
   • entrypoint: このフィールドの値を /bin/bash に設定します。これにより、ビルドステップから複数行の bash コマンドを直接実行できます。
   • args: ビルドステップの args フィールドは引数のリストを受け取り、name フィールドによって参照されるイメージに渡します。次の例では、args フィールドが次の引数を受け取ります。
     • テストログ フォーマッタを実行してテストログ出力をダウンロードする。
     • ログ出力を出力する。
     • テスト結果を sponge.log に保存する。
     • sponge.log の結果を JUNIT XML ファイルに出力します。JUNIT XML ファイルの名前は、ビルドに関連付けられた commit ID の短縮バージョンを使用して作成されます。以降のビルドステップでは、このファイルのログを 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. アプリをコンテナ化する: ビルドステップを追加してテストに合格したことを確認したら、アプリケーションをビルドします。Cloud Build には、Go アプリケーションのコンテナ化に使用できるビルド済み Docker イメージがあります。アプリをコンテナ化するには、ビルドステップに次のフィールドを追加します。

   • name: タスクに事前ビルドされた Docker イメージを使用するには、このフィールドの値を gcr.io/cloud-builders/docker に設定します。
   • args: docker build コマンドの引数を、このフィールドの値として追加します。

   次のビルドステップでは、イメージ myimage をビルドし、commit ID の短縮バージョンでタグ付けします。ビルドステップでは、プロジェクト ID、リポジトリ名、短縮 SHA 値の置換を使用するため、これらの値はビルド時に自動的に置き換えられます。イメージを保存するためには、Artifact Registry に Docker リポジトリを作成するか、既存のリポジトリが必要です。

   # Docker Build
   - name: 'gcr.io/cloud-builders/docker'
     args: ['build', '-t', 
            'us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA', '.']

3. コンテナを Artifact Registry に push: ビルドされたコンテナは Artifact Registry 内に保存できます。Artifact Registry は、ビルド アーティファクトを保存、管理、保護するために使用できる Google Cloud サービスです。これを行うには、Artifact Registry 内に既存の Docker リポジトリが必要です。Artifact Registry Docker リポジトリにイメージを格納するように Cloud Build を構成するには、次のフィールドを含むビルドステップを追加します。

   • name: タスクに公式の docker ビルダー イメージを使用するには、このフィールドの値を gcr.io/cloud-builders/docker に設定します。
   • args: docker push コマンドの引数を、このフィールドの値として追加します。リンク先 URL には、イメージを保存する Artifact Registry Docker リポジトリを入力します。

   次のビルドステップでは、前の手順でビルドしたイメージを Artifact Registry に push します。

   # Docker push to Google Artifact Registry
   - name: 'gcr.io/cloud-builders/docker'
     args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA']

4. コンテナを Cloud Run にデプロイする: Cloud Run にイメージをデプロイするには、次のフィールドを含むビルドステップを追加します。

   • name: このフィールドの値を google/cloud-sdk に設定して、gcloud CLI イメージを使用し、gcloud コマンドを呼び出して Cloud Run にイメージをデプロイします。
   • args: gcloud run deploy コマンドの引数をこのフィールドの値として追加します。

   次のビルドステップでは、以前にビルドしたイメージを Cloud Run にデプロイします。

   # Deploy to Cloud Run
   - name: 'gcr.io/cloud-builders/gcloud'
     args: ['run', 'deploy', 'helloworld-${SHORT_SHA}', 
            '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA', 
            '--region', 'us-central1', '--platform', 'managed']

5. テストログを Cloud Storage に保存する: 既存のバケットのロケーションとテストログのパスを指定して、テストログを Cloud Storage に保存するように Cloud Build を構成できます。

   次のビルドステップでは、JUNIT XML ファイルに保存したテストログを Cloud Storage バケットに保存します。

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

   次のスニペットは、上記のすべてのステップの完全なビルド構成ファイルを示しています。

   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
   
     # Docker Build
     - name: 'gcr.io/cloud-builders/docker'
       args: ['build', '-t', 
              'us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA', '.']
   
     # Docker push to Google Artifact Registry
     - name: 'gcr.io/cloud-builders/docker'
       args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA']
   
     # Deploy to Cloud Run
     - name: 'gcr.io/cloud-builders/gcloud'
       args: ['run', 'deploy', 'helloworld-${SHORT_SHA}', 
              '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA', 
              '--region', 'us-central1', '--platform', 'managed']
   
   # Save test logs to Google Cloud Storage
   artifacts:
     objects:
       location: gs://$_BUCKET_NAME/
       paths:
         - ${SHORT_SHA}_test_log.xml
   # Store images in Google Artifact Registry
   images:
     - us-central1-docker.pkg.dev/$PROJECT_ID/$_AR_REPO_NAME/myimage:$SHORT_SHA

6. gcloud CLI を使用してビルドを開始するか、ビルドトリガーを作成します。

Google Cloud CLI

--substitutions を使用して、cloudbuild.yaml で使用される置換変数を指定します。次のコマンドを実行します。

gcloud builds submit --region=us-central1 --config=cloudbuild.yaml \
--default-buckets-behavior=REGIONAL_USER_OWNED_BUCKET \
--service-account= projects/PROJECT_ID/serviceAccounts/cloud-build-go@PROJECT_ID.iam.gserviceaccount.com \
--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 は、gcloud CLI を使用して実行するときに SHORT_SHA の値が指定されないため、「temp_fake_sha」などの短い汎用テキスト文字列に置き換えます。

ビルドトリガー

ビルドトリガーを作成するの手順に沿って操作します。[置換変数] フィールドには、Artifact Registry リポジトリの名前と、テストログ用の Cloud Storage バケットの名前も指定する必要があります。

次のステップ

• この例を使用して、独自の Go アプリケーションをビルド、テスト、デプロイします。
• コンテナ イメージを作成する方法を学習する。
• ビルドエラーをトラブルシューティングする方法について学習する。