1. 導入：なぜTerraform fmtが重要なのか
インフラ構成をコード化するIaC（Infrastructure as Code）において、チーム開発の大きな課題となるのが「コードの書き方のばらつき」です。エンジニアごとにインデントや改行が異なると、Gitの差分（Diff）が本質的な変更点以外にも広がり、コードレビューの効率が著しく低下します。Terraform fmtは、HCL（HashiCorp Configuration Language）を標準スタイルに自動整形するコマンドです。これを導入することで、コードの可読性が向上し、本質的な変更点だけをレビューに集中させることが可能になります。
2. 基礎知識：Terraform fmtとは何か
Terraform fmtは、Terraformが提供する公式のフォーマットツールです。人間が読みやすいように空白やインデントを自動調整し、コードの「見た目」を統一します。
主なメリット：
・コード規約の自動遵守：誰が書いても同じフォーマットになるため、個人の癖を排除できる。
・Diffの最適化：不要な空白差分が消え、リソースの増減やパラメータ変更といった「意味のある差分」だけをGitで追跡できる。
・CI/CDとの親和性：CIパイプラインで自動チェックを行うことで、フォーマット崩れを未然に防ぐ「CIゲート」を構築できる。
3. 実装と解決策：プロジェクトへの導入手順
プロジェクトのルートディレクトリで以下のコマンドを実行するだけで、配下のすべてのファイルが整形されます。
基本コマンド：
terraform fmt -recursive
また、CI環境（GitHub Actionsなど）でフォーマット違反を検知するには、以下のチェックオプションを使用します。
terraform fmt -check -recursive
このコマンドが終了コード「0以外」を返せば、整形されていないファイルが存在することを示します。
4. サンプルプログラム：CIで活用するGitHub Actionsの例
以下のコードは、GitHub Actionsのワークフローファイル（.github/workflows/terraform.yml）のサンプルです。プルリクエスト時に実行し、フォーマット違反があれば失敗させる設定です。
CIでフォーマットチェックを行う設定例
name: ‘Terraform Format Check’
on: [pull_request]
jobs:
fmt:
runs-on: ubuntu-latest
steps:
- name: リポジトリをチェックアウト
uses: actions/checkout@v3
- name: Terraformのセットアップ
uses: hashicorp/setup-terraform@v2
- name: フォーマットの確認
# -checkは整形が必要な場合にエラーを返す
# -recursiveはサブディレクトリも対象にする
run: terraform fmt -check -recursive
5. 応用・注意点：現場で陥りやすい罠
・IDE連携を活用する
コマンドラインだけでなく、VSCodeの拡張機能（HashiCorp Terraform）を利用し、「Format on Save（保存時にフォーマット）」を有効にすることをお勧めします。これにより、コードを保存するたびに自動整形されるため、そもそも「フォーマット崩れ」という概念自体を意識しなくて済みます。
・Gitフックの検討
チームメンバーがうっかりfmtを忘れてプッシュしてしまうのを防ぐために、「pre-commit」フックなどを導入し、コミット前に自動で整形を走らせる仕組みを構築するのも有効です。
・まとめ
Terraform fmtは「プロの最低限の嗜み」です。自動化できる部分は機械に任せ、人間は「設計の妥当性」や「セキュリティリスク」といった、より重要な議論にリソースを割く環境を作りましょう。
コメント