[CI/CD] GitHub Actions를 이용한 자동 테스트

General Dong·2024년 10월 29일

CI/CD

목록 보기

5/12

PR을 하여 main 브랜치로 Merge를 할 때, 해당 코드가 이상이 없는지 매번 검사하기 번거롭다.
그래서 GitHub Actions에서 테스트 코드를 자동으로 실행하여 해당 코드가 문제 없는지 확인하도록 할 수 있다.
또한 테스트를 완료한 코드는 비교적 안심할 수 있는 코드이므로 배포 시 오류 발생을 낮출 수 있다.

Repository Actions 활성화

우선 GitHub Actions를 사용하려는 레포지토리에서
Settings -> Actions -> General로 들어가 GitHub Actions를 설정해줄 것이다.

Actions permissions는 Allow all actions and reusable workflows로 설정해준다.

Workflow permissions에서 Read and write permissions로 설정하여, PR Comment로 테스트 결과가 작성되도록 허용한다.

GitHub Access Token 환경 변수로 등록

GitHub Actions로 레포지토리에 접근하기 위해서는 GitHub Access Token이 필요하다.
토큰값을 하드 코딩하면 보안에 문제가 있을 수 있기 때문에, 토큰 값은 Secret 값으로 환경 변수처럼 등록한 후 사용할 것이다.

GitHub Actions를 사용하려는 레포지토리에서
Settings -> Secrets and variables -> Actions -> New repository secret를 클릭하여 환경 변수를 만들어주자.

Name에는 환경변수에 이름을 적어준다.
Secret에는 발급받은 GitHub Access Token을 넣어주고, Add secret을 클릭하여 환경 변수를 만들어주자.

${{ secrets.환경_변수_이름 }}으로 스크립트에 추가하면 등록된 값을 불러올 수 있다.

GitHub Actions 파일 생성

프로젝트 루트 경로에 ./.github/workflows 디렉토리에 .yaml 파일을 만든다.

CI 스크립트

name: PR 시 CI 테스트 자동화

on:
  pull_request:
    branches:
      - main

jobs:
  test:
    name: Test
    runs-on: ubuntu-latest

    permissions:
      checks: write
      pull-requests: write

    steps:
      - name: 레포지토리 체크아웃
        uses: actions/checkout@v4
        with:
          token: ${{ secrets.GIT_TOKEN }}

      - name: JDK 17 설치
        uses: actions/setup-java@v3
        with:
          distribution: 'oracle'
          java-version: '17'

      - name: Gradle 명령 실행 권한 부여
        run: chmod +x ./gradlew
        shell: bash

      - name: Gradle로 프로젝트 Build
        run: ./gradlew build

      - name: 테스트 결과를 PR 코멘트로 출력
        uses: EnricoMi/publish-unit-test-result-action@v2
        if: always()
        with:
          files: '**/build/test-results/test/TEST-*.xml'

      - name: 테스트 실패 시, 오류가 발생한 코드 라인에 코멘트 추가
        uses: mikepenz/action-junit-report@v4
        if: always()
        with:
          report_paths: '**/build/test-results/test/TEST-*.xml'