[배포 및 인프라] 해보자 배포 [7] - Github Actions로 PR 테스트 자동화

 

 

 

이번 글에서는 PR을 날렸을 때 해당 PR이 문제가 없는지 자동으로 테스트를 수행하고,

만약 테스트에 실패한다면 merge할 수 없도록 메인 브랜치를 보호하는 방법에 대해 살펴보겠습니다.

 

 

 

 

🧐 Github Actions 설정

Repository에 들어가서 Actions - Java with Gradle을 클릭합니다.

 

 

 

 

 

위 yml 파일을 아래와 같이 수정합니다.

 

 

 

name: Java CI with Gradle

on:
  pull_request:
    branches: [ "main" ]

permissions:
  contents: read

jobs:
  test:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: 🐳 JDK 11 세팅
      uses: actions/setup-java@v3
      with:
        java-version: '11'
        distribution: 'temurin'

    - name: 🐳 gradlew 실행 권한 설정
      run: chmod +x gradlew
 
    - name: 🐳 테스트 진행
      run: ./gradlew --info test

 

 

 

이후 yml 파일 이름을 원하는 이름으로 바꾸어주고 commit changes 를 클릭합니다.

 

 

 

Commit changes를 클릭합니다.

 

이렇게 하면 기본적인 설정이 완료됩니다.

한번 PR을 보내 테스트해보도록 하겠습니다.

성공적으로 테스트가 진행되는 것을 확인할 수 있습니다.

 

 

 

 

 

📕 성공하는 테스트의 경우

테스트에 성공하면 위와 같이 All checks have passed가 보여집니다.

 

 

Actions 창에서도 확인할 수 있습니다.

 

 

 

 

 

 

 

📙 실패하는 테스트의 경우

    @Test
    void contextLoads() {
        if (1 == 1) {
            throw new IllegalArgumentException();
        }
    }

위와 같이 실패하는 테스트를 작성한 후, 이를 반영한 PR을 보내도록 하겠습니다.

 

 

 



다음과 같이 All checks have failed가 표시됩니다.

그런데 한가지 문제가 존재하는데요, 위 상황에서도 Merge pull request를 클릭하면 merge할 수 있게 됩니다.

상황에 따라 달라지겠지만, 대체로 테스트에 실패한다면 메인 브랜치에 merge되는 상황을 막는 것이 좋을 것입니다.

 

이는 조금 뒤에 설정하도록 하고, 우선 테스트에 대한 Report를 보여주는 기능을 추가하겠습니다.

 

 

 

 

 

 

 

 

 

 

🧐 테스트 Report 추가

워크플로우 yml을 다음과 같이 수정합니다.

name: Java CI with Gradle

on:
  pull_request:
    branches: [ "main" ]

# Report 결과 쓰기 위해 필요
permissions:
  checks: write
  pull-requests: write

jobs:
  test:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: 🐳 JDK 11 세팅
      uses: actions/setup-java@v3
      with:
        java-version: '11'
        distribution: 'temurin'

    - name: 🐳 gradlew 실행 권한 설정
      run: chmod +x gradlew
 
    - name: 🐳 테스트 진행
      run: ./gradlew --info test
      
    - name: 🐳 테스트 결과 Report
      uses: EnricoMi/publish-unit-test-result-action@v2
      if: always()  # 테스트가 실패하여도 Report를 보기 위해 `always`로 설정
      with:
         files: 'build/test-results/**/*.xml'

 

 

 

이제 테스트 실행 시 다음과 같은 결과를 얻을 수 있습니다.

 

 

 

 

 

 

 

 

 

🧐 테스트 실패 시 실패하는 코드에 Comment 추가

name: Java CI with Gradle

on:
  pull_request:
    branches: [ "main" ]

# Report 결과 쓰기 위해 필요
permissions:
  checks: write
  pull-requests: write

jobs:
  test:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: 🐳 JDK 11 세팅
      uses: actions/setup-java@v3
      with:
        java-version: '11'
        distribution: 'temurin'

    - name: 🐳 gradlew 실행 권한 설정
      run: chmod +x gradlew
 
    - name: 🐳 테스트 진행
      run: ./gradlew --info test
      
    - name: 🐳 테스트 결과 Report
      uses: EnricoMi/publish-unit-test-result-action@v2
      if: always()  # 테스트가 실패하여도 Report를 보기 위해 `always`로 설정
      with:
         files: 'build/test-results/**/*.xml'
    
    - name: 🐳 테스트 실패 Comment
      uses: mikepenz/action-junit-report@v3
      if: always()
      with:
        report_paths: 'build/test-results/test/TEST-*.xml'

 

결과는 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

🧐 테스트 성공 시에만 Merge 가능하게 만들기

레포지토리의 Settings - Branches - Add branch protection rule을 클릭합니다.

 

 

 

 

 

 

위와 같이 Branch name pattern에는 main을 입력하고

Require status checks to pass before merging - Require branches to be up to date before merging을 선택합니다.

 

이때 검색창에 입력한 test는 다음 부분입니다.

 

(이는 workflow yml 파일의 jobs에 작성한 이름입니다.)

 

 

 

 

위 부분은 선택사항인데 테스트가 실패했을 때, 절대로 merge할 수 없게 설정하기 위해서는 체크해줍니다.

 

이후 Create를 눌러 규칙을 생성합니다.

 

 

 

이제 다시 실패하는 PR로 돌아와보면 다음과 같이 PR시 merge할 수 없도록 설정됩니다.

 

 

 

 

 

 

 

 

 

 

이렇게 해서 PR 생성 시 자동으로 Test를 실행하고, 실패 시 Report와 Merge할 수 없도록 방어하는 기능을 Github Actions를 통해 추가해 보았습니다.

 

다음 글에서는 Jenkins를 통해 메인 브랜치에 merge 시 자동으로 EC2 서버에 배포가 이루어지도록 CD를 설정해 보도록 하겠습니다.

 

 

 

 

 

 

🧐 + 실패 시 슬랙 알림

8398a7/action-slack@v3

위를 구글에 검색하면 많은 예시를 볼 수 있을 것입니다.

 

 

 

 

 

 

 

📚 Reference

https://devs0n.tistory.com/25

Github Actions로 PR 시 테스트를 돌려보자