LocalStack および Terraform Tests を使用して AWS インフラストラクチャをテストする - AWS 規範的ガイダンス
概要前提条件と制限アーキテクチャツールベストプラクティスエピックトラブルシューティング関連リソース追加情報

LocalStack および Terraform Tests を使用して AWS インフラストラクチャをテストする

Amazon Web Services、Ivan Girardi、Ioannis Kalyvas

概要

このパターンは、AWS 環境にインフラストラクチャをプロビジョニングせずに、Terraform で AWS の Infrastructure as Code (IaC) をローカルでテストするのに役立ちます。Terraform Tests フレームワークを LocalStack と統合します。LocalStack Docker コンテナは、さまざまな AWS のサービスをエミュレートするローカル開発環境を提供します。これにより、AWS クラウドでコストを発生させることなく、インフラストラクチャのデプロイをテストして反復処理できます。

ソリューションは次の利点があります。

  • コストの最適化 – LocalStack に対してテストを実行すると、AWS のサービスを使用する必要がなくなります。これにより、AWS リソースの作成、運用、変更に関連するコストの発生を回避できます。

  • 速度と効率 – 通常、ローカルでのテストは AWS リソースのデプロイよりも高速です。この迅速なフィードバックループにより、開発とデバッグが高速化されます。LocalStack はローカルで実行されるため、インターネット接続なしで Terraform 設定ファイルを開発およびテストできます。Terraform 設定ファイルをローカルでデバッグし、すぐにフィードバックを受け取ることができるため、開発プロセスが効率化されます。

  • 一貫性と再現性 – LocalStack は、テストのために一貫した環境を提供します。この一貫性により、外部 AWS の変更やネットワークの問題に関係なく、テストで同じ結果が得られるようになります。

  • 分離 – LocalStack を使用したテストにより、誤ってライブ AWS リソースや本番環境に影響を与えることを防ぎます。この分離により、さまざまな設定を安全に実験およびテストできます。

  • 自動化 – 継続的インテグレーションおよび継続的デリバリー (CI/CD) パイプラインとの統合により、Terraform 設定ファイルを自動的にテストできます。パイプラインは、デプロイ前に IaC を徹底的にテストします。

  • 柔軟性 – さまざまな AWS リージョン、AWS アカウント、およびサービス設定をシミュレートして、より本番環境に近づけることができます。

前提条件と制限

前提条件

制限

  • このパターンでは、Amazon Simple Storage Service (Amazon S3)、AWS Lambda、AWS Step Functions、および Amazon DynamoDB リソースをテストするための明示的な例を示します。ただし、このソリューションを拡張して追加の AWS リソースを含めることができます。

  • このパターンでは、Terraform Tests をローカルで実行する手順を示しますが、任意の CI/CD パイプラインにテストを統合できます。

  • このパターンでは、LocalStack Community イメージを使用する手順を示します。LocalStack Pro イメージを使用している場合は、LocalStack Pro のドキュメントを参照してください。

  • LocalStack には、さまざまな AWS API のエミュレーションサービスが用意されています。完全なリストについては、AWS サービス機能のカバレッジを参照してください。一部の高度な機能では、LocalStack Pro のサブスクリプションが必要になる場合があります。

アーキテクチャ

このソリューション用のアーキテクチャを次の図に示します。主要コンポーネントは、ソースコードリポジトリ、CI/CD パイプライン、および LocalStack Docker コンテナです。LocalStack Docker コンテナは、次の AWS のサービスをローカルでホストします。

  • ファイルを保存するための Amazon S3 バケット

  • モニタリングおよびログ記録用の Amazon CloudWatch

  • サーバーレスコードを実行するための AWS Lambda 関数

  • マルチステップワークフローをオーケストレーションするための AWS Step Functions ステートマシン

  • NoSQL データを保存するための Amazon DynamoDB テーブル

CI/CD パイプラインは、LocalStack Docker コンテナと AWS リソースを構築してテストします。

この図表は、次のワークフローを示しています：

  1. Terraform 設定ファイルをソースコードリポジトリに追加してコミットします。

  2. CI/CD パイプラインが変更を検出し、Terraform の静的コード分析のビルドプロセスを開始します。パイプラインが LocalStack Docker コンテナを構築して実行します。その後、テストプロセスを開始します。

  3. パイプラインが、LocalStack Docker コンテナでホストされている Amazon S3 バケットにオブジェクトをアップロードします。

  4. オブジェクトをアップロードすると、AWS Lambda 関数が呼び出されます。

  5. Lambda 関数が、CloudWatch ログに Amazon S3 イベント通知を保存します。

  6. Lambda 関数が AWS Step Functions ステートマシンを起動します。

  7. ステートマシンが Amazon S3 オブジェクトの名前を DynamoDB テーブルに書き込みます。

  8. CI/CD パイプラインのテストプロセスで、アップロードされたオブジェクトの名前が DynamoDB テーブルのエントリと一致することを確認します。また、S3 バケットが指定された名前でデプロイされ、AWS Lambda 関数が正常にデプロイされたことも検証します。

ツール

AWS のサービス

  • Amazon CloudWatch は、AWS リソースや、AWS で実行されるアプリケーションのメトリックをリアルタイムにモニタリングします。

  • Amazon DynamoDB は、フルマネージド NoSQL データベースサービスです。高速かつ予測可能でスケーラブルなパフォーマンスを提供します。

  • AWS Lambda は、サーバーのプロビジョニングや管理を行うことなくコードを実行できるコンピューティングサービスです。必要に応じてコードを実行し、自動的にスケーリングするため、課金は実際に使用したコンピューティング時間に対してのみ発生します。

  • Amazon Simple Storage Service (Amazon S3) は、任意の量のデータを保存、保護、取得する上で役立つクラウドベースのオブジェクトストレージサービスです。

  • AWS Step Functions は、AWS Lambda 関数と他の AWS のサービスを組み合わせてビジネスクリティカルなアプリケーションを構築できるサーバーレスのオーケストレーションサービスです。

その他のツール

  • Docker は、オペレーティングシステムレベルの仮想化を使用してソフトウェアをコンテナで配信するサービスとしてのPlatform as a Service (PaaS) 製品のセットです。

  • Docker Compose は、マルチコンテナアプリケーションを定義および実行するためのツールです。

  • LocalStack は、単一のコンテナで実行されるクラウドサービスエミュレーターです。LocalStack を使用すると、AWS クラウドに接続せずに、AWS のサービスを使用するローカルマシンでワークロードを実行できます。

  • Terraform は HashiCorp の IaC ツールであり、クラウドおよびオンプレミスのリソースの作成と管理を支援します。

  • Terraform Tests は、統合またはユニットテストに類似したテストを通じて Terraform モジュール設定の更新を検証するのに役立ちます。

コードリポジトリ:

このパターンのコードは、GitHub の「Test AWS infrastructure using LocalStack and Terraform Tests」リポジトリで入手できます。

ベストプラクティス

  • このソリューションは、Terraform の設定ファイルで指定された AWS インフラストラクチャをテストし、それらのリソースを AWS クラウドにデプロイしません。リソースをデプロイする場合は、最小特権の原則 (IAM ドキュメント) に従い、Terraform バックエンドを適切に設定 (Terraform ドキュメント) します。

  • LocalStack を CI/CD パイプラインに統合する場合は、LocalStack Docker コンテナを特権モードで実行しないことをお勧めします。詳細については、「Runtime privilege and Linux capabilities」 (Docker ドキュメント) と「Security for self-managed runners」(GitLab ドキュメント) を参照してください。

エピック

タスク説明必要なスキル

リポジトリをクローン作成します。

bash シェルで、次のコマンドを入力します。これにより、GitHub から「Test AWS infrastructure using LocalStack and Terraform Tests」リポジトリのクローンが作成されます。

git clone https://github.com/aws-samples/localstack-terraform-test.git
DevOps エンジニア

LocalStack コンテナを実行します。

  1. 次のコマンドを入力して、クローン作成されたリポジトリに移動します。

    cd localstack-terraform-test

  2. 次のコマンドを入力して、デタッチモードで LocalStack Docker コンテナを起動します。

    docker-compose up -d

  3. LocalStack Docker コンテナが動作するまで待ちます。

DevOps エンジニア

Terraform を初期化します。

次のコマンドを入力して、Terraform を初期化します。

terraform init
DevOps エンジニア

Terraform Tests を実行します。

  1. 次のコマンドを入力して、Terraform Tests を実行します。

    terraform test

  2. すべてのテストが正常に完了したことを確認します。出力は次の例のようになります:

    Success! 3 passed, 0 failed.
DevOps エンジニア

リソースをクリーンアップします。

次のコマンドを入力して、LocalStack コンテナを破棄します。

docker-compose down
DevOps エンジニア

トラブルシューティング

問題ソリューション

terraform test コマンドを実行すると、Error: reading DynamoDB Table Item (Files|README.md): empty になります。

  1. terraform test コマンドを再入力します。

  2. それでもエラーが解決しない場合は、main.tf ファイルを編集してスリープタイムアウトを 15 秒より大きい値に増やします。

    resource "time_sleep" "wait" {
  create_duration = "15s"
  triggers = {
    s3_object = local.key_json
  }
}

関連リソース

追加情報

GitHub Actions との統合

GitHub Actions を使用して、LocalStack および Terraform Tests を CI/CD パイプラインに統合できます。詳細については、GitHub Actions のドキュメントを参照してください。以下は、サンプルの GitHub Actions 設定ファイルです。

name: LocalStack Terraform Test

on:
  push:
    branches:
      - '**'

  workflow_dispatch: {}

jobs:
  localstack-terraform-test:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Build and Start LocalStack Container
      run: |
        docker compose up -d

    - name: Setup Terraform
      uses: hashicorp/setup-terraform@v3
      with:
        terraform_version: latest

    - name: Run Terraform Init and Validation
      run: |
        terraform init
        terraform validate
        terraform fmt --recursive --check
        terraform plan
        terraform show

    - name: Run Terraform Test
      run: |
        terraform test

    - name: Stop and Delete LocalStack Container
      if: always()
      run: docker compose down