[AWS] What is Localstack?

yoon-bomi·2022년 8월 23일

Infra S3 TIL aws docker localstack

로컬에서 S3 에 파일 업로드를 테스트 하던 중, localStack 을 사용하면 된다고 해서 알아보고 직접 적용해본 내용을 정리했다.

공식문서

https://github.com/localstack/localstack

What is Localstack ?

AWS API 를 시뮬레이션 해주는 프레임워크
도커 컨테이너 형태로 제공되며, AWS REST API 스펙에 맞는 모킹 http 서버를 실행한다.

Localstack 지원하는 서비스

Localstack은 유료 버전과 무료 버전으로 나눠져 있으며 무료로 제공하는 서비스는 아래와 같다.

Note: localstack 0.11.0 부터는 모든 APIs 단위 포인트(http://localhost:4566)로 연결을 됨API Gateway at http://localhost:4567
Kinesis at http://localhost:4568
DynamoDB at http://localhost:4569
DynamoDB Streams at http://localhost:4570
S3 at http://localhost:4572
Firehose at http://localhost:4573
Lambda at http://localhost:4574
SNS at http://localhost:4575
SQS at http://localhost:4576
Redshift at http://localhost:4577
Elasticsearch Service at http://localhost:4578
SES at http://localhost:4579
Route53 at http://localhost:4580
CloudFormation at http://localhost:4581
CloudWatch at http://localhost:4582
SSM at http://localhost:4583
SecretsManager at http://localhost:4584
StepFunctions at http://localhost:4585
CloudWatch Logs at http://localhost:4586
EventBridge (CloudWatch Events) at http://localhost:4587
STS at http://localhost:4592
IAM at http://localhost:4593
EC2 at http://localhost:4597
KMS at http://localhost:4599
ACM at http://localhost:4619

왜 쓰나요?

실제 aws s3 와 연동하지 않고도 로컬에서 aws 서비스를 테스트 할 수 있다.
AWS 서비스를 사용하는 인프라 로직의 통합테스트를 작성하기 위해 사용한다.

localstack 을 실행하는 방법

Testcontainers
docker compose

→ docker compose 를 사용하는 방법으로 테스트해보겠다.

docker compose 로 localstack 실행하기

docker-compose.yml

aws:
    image: localstack/localstack
    environment:
      - SERVICES=s3 // 사용할 서비스 , 를 이용해 나열
      - DEBUG=1
    volumes:
      - "./test/docker-entrypoint-initaws.d:/docker-entrypoint-initaws.d"

사용할 서비스는 SERVICES=ses,s3... 처럼 나열이 가능하다.
./test/docker-entrypoint-initaws.d 경로에 있는 파일에 s3 버킷을 만들 수 있다.

./test/docker-entrypoint-initaws.d

#!/bin/sh

awslocal s3 mb s3://test

awslocal 명령어를 이용해 test 버킷을 만들었다.

docker compose up 명령어를 이용해 빌드 후 실행 시켜준다.

make bucket test 가 제대로 뜬다면 성공 🚀

str:
    build:
      context: ./storage-api
      dockerfile: ../Dockerfile.str
    environment:
      - NODE_ENV=development
      - DB_HOST=db
      - DB_PORT=3306
      - DB_USER=root
      - DB_PASSWORD=1234
      - PORT=3030
      - AWS_ENDPOINT=http://aws:4566 # see https://github.com/localstack/localstack
      - AWS_ACCESS_KEY_ID=aws # 아무 값이나 환경변수로 지정하기만 하면 ok
      - AWS_SECRET_ACCESS_KEY=aws # 아무 값이나 환경변수로 지정하기만 하면 ok
    depends_on:
      - db
    ports:
      - "3030:3030"