GitHub Actions로 NestJS 빌드 및 테스트 자동화하기

# workflow의 이름입니다.
name: Build

# workflow 동작 trigger 입니다.
# master 브랜치에 Push가 발생하거나 PR이 열리면 실행됩니다.
# push 이외에도 PR이 만들어지거나 병합되는 등 여러 이벤트 트리거가 가능합니다.
# 'release/**' 처럼 필터도 사용할 수 있습니다.
on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, reopened, synchronize]

# 동시성을 제어하는 concurrency 설정입니다.
# 동일한 ref(브랜치)에서 여러 개의 workflow가 동시에 실행되지 않도록 합니다.
# 예를 들어, 같은 브랜치에서 여러 번 push가 발생하면 이전 workflow를 취소(`cancel-in-progress: true`)하고 최신 작업만 실행합니다.
# 'group'의 값은 workflow 이름과 ref를 조합하여 지정됩니다.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

# job에서 사용할 환경 변수 설정입니다.
env:
  NODE_VERSION: 22.11.0

# job은 실행할 작업 단위입니다.
# 각 job은 독립적으로 실행되며, 여러 개의 job을 정의할 수도 있습니다.
# 필요하면 job 간의 데이터 공유도 가능합니다.
jobs:
  build:
    # job의 이름입니다.
    name: build

    # 해당 job을 실행할 운영체제 환경입니다.
    # 'ubuntu-latest'는 최신 안정화된 Ubuntu 버전에서 실행됩니다.
    runs-on: ubuntu-latest

    # step은 job 안에서 실행되는 개별 작업들입니다.
    steps:
      # 1. 코드 체크아웃 (저장소 코드를 가져옵니다.)
      - name: Checkout
        uses: actions/checkout@v4

      # 2. Node.js 설정 (job 환경 변수에 설정된 Node.js 버전 사용)
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      # 3. node_modules 캐싱
      - name: Cache node modules
        uses: actions/cache@v4
        id: npm-cache
        with:
          path: '**/node_modules'  # 캐싱할 디렉토리
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} # 키값 지정
          restore-keys: |
            ${{ runner.os }}-node-

      # 4. 의존성 설치 (캐시가 없을 경우에만 실행)
      - name: Install Dependencies
        if: steps.npm-cache.outputs.cache-hit != 'true'
        run: npm install

      # 5. 빌드 실행
      - name: Build
        run: npm run build

- name: Cache node modules
  uses: actions/cache@v4
  id: yarn-cache
  with:
    path: '**/node_modules'
    key: ${{ runner.os }}-node-${{ hashFiles('**/yarn.lock') }}
    restore-keys: |
      ${{ runner.os }}-node-

# workflow의 이름입니다.
name: Test

# workflow 동작 trigger 입니다.
# master 브랜치에 Push가 발생하거나 PR이 열리면 실행됩니다.
on:
  push:
    branches:
      - master
  pull_request:
    types: [opened, reopened, synchronize]

# 동시성을 제어하는 concurrency 설정입니다.
# 동일한 ref(브랜치)에서 여러 개의 workflow가 동시에 실행되지 않도록 합니다.
# 이전 workflow를 취소하고 최신 작업만 실행합니다.
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

# job에서 사용할 환경 변수 설정입니다.
env:
  NODE_VERSION: 22.11.0

# job은 실행할 작업 단위입니다.
# 각 job은 독립적으로 실행되며, 필요하면 여러 개의 job을 정의할 수도 있습니다.
jobs:
  test:
    # job의 이름입니다.
    name: test

    # 해당 job을 실행할 운영체제 환경입니다.
    runs-on: ubuntu-latest

    # step은 job 안에서 실행되는 개별 작업들입니다.
    steps:
      # 1. 코드 체크아웃 (저장소 코드를 가져옵니다.)
      - name: Checkout
        uses: actions/checkout@v4

      # 2. Node.js 설정 (job 환경 변수에 설정된 Node.js 버전 사용)
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      # 3. 환경 변수 파일(.env) 생성
      # .env.example 파일을 복사하여 .env 파일을 생성합니다.
      - name: Create .env file
        run: cp .env.example .env

      # 4. Docker Hub 로그인
      # 도커 이미지를 사용할 수 있도록 Docker Hub에 로그인합니다.
      # GitHub Secrets에서 저장된 사용자명과 토큰을 사용합니다.
      - name: Login to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      # 5. MySQL 컨테이너 실행 (Docker Compose 사용)
      # 데이터베이스가 필요한 테스트를 위해 MySQL을 컨테이너에서 실행합니다.
      - name: Start MySQL using Docker Compose
        run: docker compose up -d

      # 6. node_modules 캐싱
      - name: Cache node modules
        uses: actions/cache@v4
        id: npm-cache
        with:
          path: '**/node_modules'  # 캐싱할 디렉토리
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} # 키값 지정
          restore-keys: |
            ${{ runner.os }}-node-

      # 7. 의존성 설치 (캐시가 없을 경우에만 실행)
      - name: Install Dependencies
        if: steps.npm-cache.outputs.cache-hit != 'true'
        run: npm install

      # 8. MySQL이 준비될 때까지 대기
      # MySQL 컨테이너의 상태를 확인하며, 최대 30초간 대기합니다.
      - name: Wait for MySQL to be Ready
        run: |
          echo "Waiting for MySQL to be healthy..."
          for i in {1..30}; do
            STATUS=$(docker inspect --format='{{.State.Health.Status}}' nestjs-test-db)
            if [ "$STATUS" == "healthy" ]; then
             echo "MySQL is up!"
             exit 0
            fi
            echo "Waiting for MySQL..."
            sleep 2
          done
          echo "MySQL did not start in time" >&2
          exit 1

      # 9. 유닛 테스트 실행
      # Jest, Mocha 또는 기타 테스트 프레임워크를 사용하여 유닛 테스트를 수행합니다.
      - name: Unit Test
        run: npm run test

      # 실제 프로젝트에 사용하신다면 테스트 리포트나 커버리지 결과를 업로드하는 작업을 추가할 수 있습니다.
      # 또는 슬랙 알림으로 발송하거나, 배포 워크플로우에서도 배포가 완료되고 슬랙 알림을 발송하거나 할 수 있습니다.

version: "3.8"
services:
  db:
    image: mysql:8.0.36
    container_name: nestjs-test-db
    ports:
      - "3306:3306"
    environment:
      - # 생략
    tmpfs:
      - # 생략
    command:
      - # 생략
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 3