LocalStackに対してAWS CDKでデプロイしてみた

はじめに

【エンジニア募集中】フルリモート可◎、売上/従業員数9年連続UP、平均残業8時間、有給取得率90％、年休124日以上 etc.　　詳細はこちらから＞

Local Stack便利ですよね。私の現場では、Unit Test時にAWSリソースのMockとして使用しています。今回は、このLocal Stackに対してAWS CDK経由でのデプロイを試してみようかと思います。

開発環境

Local Stack用意

インストール方法は色々ありますが、docker compose経由が楽です。こちらを参考にしていきます。

1. 以下の内容でdocker-compose.yml作成
   
   version: "3.8" services: localstack: container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}" image: localstack/localstack:latest ports: - "127.0.0.1:4566:4566" # LocalStack Gateway - "127.0.0.1:4510-4559:4510-4559" # external services port range environment: # LocalStack configuration: https://docs.localstack.cloud/references/configuration/ - DEBUG=${DEBUG:-0} volumes: - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack" - "/var/run/docker.sock:/var/run/docker.sock"

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

   version: "3.8"   services:   localstack:     container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"     image: localstack/localstack:latest     ports:       - "127.0.0.1:4566:4566"            # LocalStack Gateway       - "127.0.0.1:4510-4559:4510-4559"  # external services port range     environment:       # LocalStack configuration: https://docs.localstack.cloud/references/configuration/       - DEBUG=${DEBUG:-0}     volumes:       - "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack"       - "/var/run/docker.sock:/var/run/docker.sock"

2. コンテナ起動
   
   docker compose up -d

   1	docker compose up -d

3. 接続テスト

   # AWSサービスエンドポイントをLocalStackに設定 export AWS_ENDPOINT_URL=http://localhost:4566 # S3 Bucketを一覧表示 エラーが起きずに空のリストが表示されればオーケー aws s3 ls

   1 2 3 4 5

   # AWSサービスエンドポイントをLocalStackに設定 export AWS_ENDPOINT_URL=http://localhost:4566   # S3 Bucketを一覧表示 エラーが起きずに空のリストが表示されればオーケー aws s3 ls

CDKプロジェクト作成

ここから見出しに関する本文を記載

1. AWS CDKとAWS CDK Localのインストール
   
   npm install -g aws-cdk aws-cdk-local

   1	npm install -g aws-cdk aws-cdk-local

2. プロジェクト作成
   
   mkdir hello-cdk && cd hello-cdk cdk init app --language typescript

   1 2	mkdir hello-cdk && cd hello-cdk cdk init app --language typescript

   以下のようなプロジェクトが作成されます

   ├── README.md ├── bin │ └── hello-cdk.ts ├── cdk.json ├── jest.config.js ├── lib │ └── hello-cdk-stack.ts ├── package-lock.json ├── package.json ├── test │ └── hello-cdk.test.ts └── tsconfig.json

   1 2 3 4 5 6 7 8 9 10 11 12

   ├── README.md ├── bin │   └── hello-cdk.ts ├── cdk.json ├── jest.config.js ├── lib │   └── hello-cdk-stack.ts ├── package-lock.json ├── package.json ├── test │   └── hello-cdk.test.ts └── tsconfig.json

3. 今回は、lib/hello-cdk-stack.tsにSQSを作成するコードを記述していきます。
   import * as cdk from 'aws-cdk-lib'; import { Construct } from 'constructs'; import * as sqs from 'aws-cdk-lib/aws-sqs'; export class HelloCdkStack extends cdk.Stack { constructor(scope: Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // The code that defines your stack goes here // example resource const queue = new sqs.Queue(this, 'HelloCdkQueue', { visibilityTimeout: cdk.Duration.seconds(300) }); } }

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

   import * as cdk from 'aws-cdk-lib'; import { Construct } from 'constructs'; import * as sqs from 'aws-cdk-lib/aws-sqs';   export class HelloCdkStack extends cdk.Stack {   constructor(scope: Construct, id: string, props?: cdk.StackProps) {     super(scope, id, props);       // The code that defines your stack goes here       // example resource     const queue = new sqs.Queue(this, 'HelloCdkQueue', {       visibilityTimeout: cdk.Duration.seconds(300)     });   } }

LocalStackへデプロイ

1. cdklocalを用いて、Bootstrapを行います。
   
   cdklocal bootstrap

   1	cdklocal bootstrap

   
   
   ⏳ Bootstrapping environment aws://000000000000/ap-northeast-1... Trusted accounts for deployment: (none) Trusted accounts for lookup: (none) Using default execution policy of 'arn:aws:iam::aws:policy/AdministratorAccess'. Pass '--cloudformation-execution-policies' to customize. CDKToolkit: creating CloudFormation changeset... ✅ Environment aws://000000000000/ap-northeast-1 bootstrapped.

   1 2 3 4 5 6

   ⏳  Bootstrapping environment aws://000000000000/ap-northeast-1... Trusted accounts for deployment: (none) Trusted accounts for lookup: (none) Using default execution policy of 'arn:aws:iam::aws:policy/AdministratorAccess'. Pass '--cloudformation-execution-policies' to customize. CDKToolkit: creating CloudFormation changeset... ✅  Environment aws://000000000000/ap-northeast-1 bootstrapped.

   
   
2. デプロイを実行
   cdklocal bootstrap

   1	cdklocal bootstrap

   ✨ Synthesis time: 4.54s HelloCdkStack: start: Building de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack: success: Built de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack: start: Publishing de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack: success: Published de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset... ✅ HelloCdkStack ✨ Deployment time: 5.2s Stack ARN: arn:aws:cloudformation:ap-northeast-1:000000000000:stack/HelloCdkStack/de5c42bf ✨ Total time: 9.74s

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

   ✨  Synthesis time: 4.54s   HelloCdkStack:  start: Building de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack:  success: Built de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack:  start: Publishing de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack:  success: Published de6c03de9ff4df3f1d14ea56db5630226f950ca578b2aff5e8dec47f281887e4:current_account-current_region HelloCdkStack: deploying... [1/1] HelloCdkStack: creating CloudFormation changeset...   ✅  HelloCdkStack   ✨  Deployment time: 5.2s   Stack ARN: arn:aws:cloudformation:ap-northeast-1:000000000000:stack/HelloCdkStack/de5c42bf   ✨  Total time: 9.74s

まとめ

意外と簡単にできましたね。

Unit Test時のMockとして利用できるものは他にもありますが、moto3などと合わせて選択肢の1つとして覚えておくのも良いかもしれません。
ちなみに対応済みのサービスはこちらから確認できます。

【エンジニア募集中】フルリモートも◎(リモート率85.7％)、平均残業8時間、年休124日以上、有給取得率90％ etc.　詳細はこちらから＞