【Tips】無料の Google アカウントで Cloud Build の成功通知を Google Chat へ投稿する方法

作成日: 2023/11/24, 更新日: 2023/11/24

無料の Google アカウントで Google Chat へシステム通知を行おうとしたのですが、無料の Google アカウントでは Google Chat の API を利用することができませんでした。
Google Chat の「アプリとの統合」機能であればいくつかの SaaS サービスとの連携だったため色々と検証したところ
Cloud Build の成功通知を行うことができましたので、その方法を記載いたします。

はじめに結論
Cloud Build と Google Chat の連携方法
まとめ

はじめに結論

無料の Google アカウントの Google Chat で Cloud Build の成功通知を直接受け取ることはできません。
- 「アプリの統合」機能で Cloud Build は選択できるのですが、設定を進めても連携を行うことができませんでした。
- Google Chat API 自体が有料のため、無料の Google アカウントでは利用できないようです。
- Webhook も有料のため、Slack や Chatwork など他のチャットツールと比較すると使い辛いなぁと感じました。。。

「アプリの統合」機能のうち、Git Hub との連携は無料の Google アカウントでも利用できたので、Git Hub の Commit へコメントを行う際のイベントをトリガーにして、Cloud Build の成功通知を Google Chat に送信することで実現できました。

Cloud Build と Google Chat の連携方法

前提条件

GCP のプロジェクトが作成済みであること。[参考 1]
GCP のプロジェクトで以下の API が有効になっていること。[参考 2]
- Cloud Build API
- Secret Manager API
Git Hub のアカウントが作成済みであること。[参考 3]
作業環境に GitHub CLI がインストール済みであること。[参考 4]

参考

GitHub で Personal Access Token を作成し GCP の Secret Manager へ登録

CodeBuild から GitHub へアクセスするための Personal Access Token を作成します。
個人用アクセストークンを管理する - GitHub Docs を参考に作成しましょう。
- サイトは英語の説明しかないので、Google 翻訳で日本語化しましょう。

「Token name」「Expiration」「Description」は適当な値を入力します。
「Resource owner」は組織に属しているかどうかで選択肢が変わりますが、特に組織に属していない場合は自分のアカウントを選択します。
「Repository access」は All repositories を選択します。権限を絞り込みたい場合は Only select repositories を選択し、権限を絞り込みます。
「Permissions」は Administration を Read-only 、 Contents を Read and write に設定します。
すべてを設定したら、画面下部の「Generate token」をクリックします。表示されたトークンはこのあと GCP の Secret Manager へ登録するためコピーしておきます。

つづいて、先ほどコピーしたトークンを GCP の Secret Manager へ登録します。
シークレットを作成する | Secret Manager のドキュメント | Google Cloud を参考に作成します。

「名前」は適当な値を入力します。今回は GIT_HUB_PERSONAL_ACCESS_TOKEN としました。
それ以外の設定値はデフォルトで OK です。

GitHub レポジトリの作成

通知を行いたいレポジトリを作成します。
Web コンソール上で作成することもできますが、今回は GitHub CLI を利用してレポジトリを作成しました。


          gh repo create test-repository --private --clone

          # 出力結果
          ✓ Created repository ${オーナー名}/test-repository on GitHub

CloudBuild で GitHub レポジトリと連携

CloudBuild のトリガーを作成し、GitHub レポジトリと連携します。
ビルドトリガーの作成と管理 | Cloud Build のドキュメント | Google Cloud を参考に作成を進めましょう。

「名前」は適当な値を入力します。今回は test-repository-master としました。
「ソース」は先ほど作成した GitHub レポジトリを選択します。
ソール管理プロバイダの画面で GitHub が２つありますが、Enterprise を利用していない場合は GitHub（CloudBuild GitHubアプリ） を選択します。

それ以外の設定値はデフォルトで OK です。

CloudBuild では共通のサービスアカウントの権限で処理を実行します。CloudBuild の「設定」の画面でいくつかの権限は追加可能です。
今回は Secret Manager へのアクセス権限を追加するため、以下の画像の赤枠のプルダウンメニューから「有効にする」を選択します。

Google Chat のスペースを作成し GitHub アプリを追加

Google Chat のスペースを作成し、GitHub アプリを追加します。
スペースを作成 - Google Workspace ラーニングセンターと Google Chat で GitHub アプリを使用する - パソコン - Google Chat ヘルプを参考に作成を進めましょう。
- アプリを追加する際には前方一致での検索しかできないようなので、ご注意ください。

作成したスペースに GitHub アプリを追加した後は以下のようなメッセージが表示されるので、メッセージに従って設定を進めます。

GitHub アプリの設定では、レポジトリの選択やスレッドの単位、通知するイベントを選択します。
通知するイベントは Comments のみ選択します。
設定が完了したら Save をクリックします。

CloudBuild のビルド構成ファイルへ通知処理を追加

最後に CloudBuild のビルド構成ファイルへ通知処理を追加します。
このタイミングで通知を行うまでの設定は完了しているため、ビルド構成ファイルを Push した時点で CloudBuild が動作し Google Chat へ通知が行われます。

先ほど作成した GitHub レポジトリへ以下のファイルを追加します。
- python/post_deploy/__main__.py
- python/requirements.post_deploy.txt
- cloudbuild.yaml

各ファイルの内容は以下の通りです。

追加ファイル① `python/post_deploy/main.py`

CloudBuild の成功通知を GitHub の Commit へコメントする処理を定義します。
11行目の GIT_HUB_REPO_OWNER は GitHub レポジトリのオーナー名を指定します。
73-75行目はGitHub の Commit へコメントを行う処理を定義しています。


          #!/usr/bin/env python3
          from datetime import datetime
          import json
          import logging
          import os
          import sys

          from google.cloud import secretmanager
          import requests

          GIT_HUB_REPO_OWNER = "${オーナー名}"
          LOG_LEVEL = os.environ.get("LOG_LEVEL", "INFO")


          class TimeFormatter(logging.Formatter):
              converter = datetime.fromtimestamp

              def formatTime(self, record, datefmt=None):
                  created_time = self.converter(record.created).astimezone()
                  timezone = created_time.strftime('%z')
                  return created_time.strftime('%Y/%m/%d %H:%M:%S.%f') + timezone[:3] + ':' + timezone[3:]


          def init_logger():
              logger = logging.getLogger(__name__)

              log_format_string = json.dumps({
                  'logLevel': '%(levelname)s',
                  'time': '%(asctime)s',
                  'line': "%(filename)s: %(lineno)d",
                  'message': '%(message)s',
              }, indent=None)
              handler = logging.StreamHandler(sys.stdout)
              handler.setFormatter((TimeFormatter(log_format_string)))
              logger.addHandler(handler)
              logger.setLevel(LOG_LEVEL)

              return logger


          def get_git_hub_token(project_id):
              client = secretmanager.SecretManagerServiceClient()
              name = client.secret_version_path(project_id, 'GIT_HUB_PERSONAL_ACCESS_TOKEN', 1)
              response = client.access_secret_version(name=name)

              return response.payload.data.decode('UTF-8')


          def create_comment_on_commit(token, repo_name, commit_sha, comment, logger):
              url = f"https://api.github.com/repos/{repo_name}/commits/{commit_sha}/comments"
              headers = {'Authorization': f'token {token}'}
              data = {'body': comment}
              response = requests.post(url, headers=headers, json=data)

              if response.status_code != 201:
                  raise Exception(f'Failed to create comment on commit: {response.content}')

              logger.info("Create comment on commit")
              return response.json()


          def main():
              logger = init_logger()
              project_id = os.environ["PROJECT_ID"]
              repo_name = os.environ["REPO_NAME"]
              commit_sha = os.environ["COMMIT_SHA"]
              build_id = os.environ["BUILD_ID"]

              create_comment_on_commit(
                  repo_name=f"{GIT_HUB_REPO_OWNER}/{repo_name}",
                  commit_sha=commit_sha,
                  comment='\n'.join([
                      "## Deployed",
                      f"Commit ID: {commit_sha}",
                      f"Cloud Build URL: https://console.cloud.google.com/cloud-build/builds;region=global/{build_id};step=0?hl=ja&project={project_id}",
                  ]),
                  token=get_git_hub_token(project_id=project_id),
                  logger=logger
              )


          if __name__ == "__main__":
              main()

追加ファイル② `python/requirements.post_deploy.txt`

python/post_deploy/__main__.py で利用するライブラリを記載します。


          requests==2.28.2
          google-cloud-secret-manager==2.16.4

追加ファイル③ `cloudbuild.yaml`

最後に CloudBuild のビルド構成ファイルへ通知処理を追加します。
以下はデプロイ後の通知処理のみ記載しておりますので、デプロイ処理も追加する場合は steps の中に追記してください。


          steps:
            # デプロイ処理を記載

            - id: "PostDeploy"
              name: python:3.9
              entrypoint: sh
              args:
                - -c
                - |
                  export PROJECT_ID="${PROJECT_ID}" && \
                  export BUILD_ID="${BUILD_ID}" && \
                  export PROJECT_NUMBER="${PROJECT_NUMBER}" && \
                  export LOCATION="${LOCATION}" && \
                  export TRIGGER_NAME="${TRIGGER_NAME}" && \
                  export COMMIT_SHA="${COMMIT_SHA}" && \
                  export REVISION_ID="${REVISION_ID}" && \
                  export SHORT_SHA="${SHORT_SHA}" && \
                  export REPO_NAME="${REPO_NAME}" && \
                  export BRANCH_NAME="${BRANCH_NAME}" && \
                  export TAG_NAME="${TAG_NAME}" && \
                  export REF_NAME="${REF_NAME}" && \
                  export TRIGGER_BUILD_CONFIG_PATH="${TRIGGER_BUILD_CONFIG_PATH}" && \
                  pip install --quiet --upgrade pip && \
                  pip install --quiet --user -r ./python/requirements.post_deploy.txt && \
                  python3 ./python/post_deploy

通知結果

GitHub レポジトリの更新を契機に CloudBuild の処理が行われたあと、通知結果は以下のようになります。

GitHub アプリに表示されている「View」をクリックすると GitHub の Commit の画面へ遷移します。
以下の画像の通り、Commit の内容とデプロイした際の情報がコメントとして表示されています。
- 今回は CodeBuild の URL のみ情報として通知しましたが、処理次第でデプロイしたリソースの情報を追加することも可能です。

まとめ

今回は CloudBuild の成功通知を Google Chat へ通知する方法を紹介しました。
無料の Google アカウントでできることには限りがありますが、Git Hub との連携を利用することで、無料の Google アカウントでも CloudBuild の成功通知を Google Chat へ通知することができました。
お金に余裕のある方はこんな面倒なことはせず、有料の Google アカウントを利用することをおすすめします。笑
今回の記事が少しでもお役に立てれば幸いです。