【Terraform】tfcmtを使用してGitHubのPRにplanの結果をコメントする

terraform planの結果をGitHubのPRにコメントしてくれる便利なツールを見つけました

その名もtfcmt!!

GitHub Actionsに導入するのも簡単なので、皆さんもぜひ本記事を参考にしてみてください

tfcmtとは？
tfcmtを使わないと…..
GitHubActionsに組み込む
動作確認
参考記事

tfcmtとは？

tfcmtを使うとterraform planやapplyの結果をGitHubのPullRequestにコメントしてくれます。

ソースコード

GitHub - suzuki-shunsuke/tfcmt: Fork of mercari/tfnotify. tfcmt enhances tfnotify in many ways, including Terraform >= v0.15 support and advanced formatting options

Fork of mercari/tfnotify. tfcmt enhances tfnotify in many ways, including Terraform >= v0.15 support and advanced formatting options - suzuki-shunsuke/tfcmt

公式ドキュメント

tfcmt | tfcmt

Build Status

Zennの記事

tfcmt で Terraform の CI/CD を改善する

tfactionなるものもあるのでご興味がある方はぜひ！

tfcmtを使わないと…..

tfcmtを使用しなくてもActionsのログからplanやapplyの結果を見れますが、面倒。。。

また、今まではgithub-scriptでJavaScriptを使ってplanの結果をPRにコメントしてました

【Terraform】GitHub Actions を使って、planやapplyを自動化しよう

Terraformでの plan, apply をGitHub Actions で自動化してみますゴール ↓の表のようなPR作成→マージの処理を作っていきます No. 処理備考 1...

ただ、この方法だとRefreshing state などのログもコメントに含まれ見にくい。

何が作成？変更？削除？されるのかもわかりづらい。

tfcmtを使うと、

いくつリソースが作成、変更、削除されるかがパッとわかる
リソース削除されるときに警告される
planの詳細も関係あるリソースのみ表示される

ので、とても見やすいコメントをしてくれます！

レビューする側からすると負荷がとても減りますよね

GitHubActionsに組み込む

ここからはtfmctをGitHubActionsに組み込んでいきます！

↓のようにワークフローを定義しました（ポイントはハイライト部）

name: TerraformPlan

on:
  pull_request:
    branches:
      - main

env:
  TF_VERSION: 1.8.5
  AWS_DEFAULT_REGION: ap-northeast-1

permissions:
  id-token: write
  contents: read
  pull-requests: write

jobs:
  plan:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v3

      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-region: ${{ env.AWS_DEFAULT_REGION }}
          role-to-assume: ${{ secrets.AWS_ROLE_ARN }}

      - name: Setup Terraform
        uses: hashicorp/setup-terraform@v2
        with:
          terraform_version: ${{ env.TF_VERSION }}

      - name: Setup tfcmt
        uses: shmokmt/actions-setup-tfcmt@v2
        with:
          version: v4.6.0

      - name: Terraform init
        id: init
        run: terraform init

      - name: Terraform fmt
        id: fmt
        run: terraform fmt -check

      - name: Terraform validate
        id: validate
        run: terraform validate

      - name: Terraform plan
        id: plan
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: tfcmt plan -patch -- terraform plan -input=false

name: TerraformPlan

on:

pull_request:

branches:

- main

env:

TF_VERSION: 1.8.5

AWS_DEFAULT_REGION: ap-northeast-1

permissions:

id-token: write

contents: read

pull-requests: write

jobs:

plan:

runs-on: ubuntu-latest

steps:

- name: Check out repository code

uses: actions/checkout@v3

- name: Configure AWS credentials

uses: aws-actions/configure-aws-credentials@v1

with:

aws-region: ${{ env.AWS_DEFAULT_REGION }}

role-to-assume: ${{ secrets.AWS_ROLE_ARN }}

- name: Setup Terraform

uses: hashicorp/setup-terraform@v2

with:

terraform_version: ${{ env.TF_VERSION }}

- name: Setup tfcmt

uses: shmokmt/actions-setup-tfcmt@v2

with:

version: v4.6.0

- name: Terraform init

id: init

run: terraform init

- name: Terraform fmt

id: fmt

run: terraform fmt -check

- name: Terraform validate

id: validate

run: terraform validate

- name: Terraform plan

id: plan

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

run: tfcmt plan -patch -- terraform plan -input=false

ハイライト部をそれぞれ見ていきます

まずは、tfcmtのセットアップをします

      - name: Setup tfcmt
        uses: shmokmt/actions-setup-tfcmt@v2
        with:
          version: v4.6.0

- name: Setup tfcmt

uses: shmokmt/actions-setup-tfcmt@v2

with:

version: v4.6.0

wgetしてtargzを解凍して…としてもいいのですが、actions-setup-tfcmtを利用します。

インストールするtfcmtのバージョンを4.6.0と指定しています

そして、terraform planを実行するパート。

      - name: Terraform plan
        id: plan
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: tfcmt plan -patch -- terraform plan -input=false

- name: Terraform plan

id: plan

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

run: tfcmt plan -patch -- terraform plan -input=false

tfcmt planコマンドを実行すると、planとその結果をコメントしてくれます。

使用するにはGitHubのトークンを渡す必要があるので環境変数に定義しておきます。
※GITHUB_TOKENは自動で生成され、シークレットに格納されるので指定するだけでOK！

patchオプション：すでにコメントがありCIが再実行された場合それが更新されます

–(ダブルダッシュ)の後に terraform planを指定します。

ここでは、-input=falseといったterraform planのオプションを指定できます

動作確認

動作確認のため、↓のようにS3を作成するコードを用意しました。

terraform {
  required_version = "~> 1.8.0"

  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.16"
    }
  }

  # tfstateの保存先
  backend "s3" {
    bucket  = "terraform-test-state-hisui"
    region  = "ap-northeast-1"
    key     = "test/terraform.tfstate"
    encrypt = true
  }
}

provider "aws" {
  region = "ap-northeast-1"
}

# S3バケットの定義
resource "aws_s3_bucket" "example" {
  bucket        = "example-bucket-hisui"
  force_destroy = true
}

# バージョニング設定
resource "aws_s3_bucket_versioning" "example" {
  bucket = aws_s3_bucket.example.id

  versioning_configuration {
    status = "Enabled"
  }
}