이전의 문제점
통합 테스트에 실 DB를 사용하여 테스트를 진행함
테스트와 빌드 스테이지를 구분하지 않고 사용하여 test fail 이 나도 배포에 실패함
1번 해결방법
Github actions에서 지원하는 postgres service를 활용하여 메모리 상에서 RDBMS 를 container 형태로 구성함
DDL를 하나의 sql 파일로 관리하여 구성한 휘발성 postgresql 에 실제 테이블 구조와 동일하게 sql를 실행함
위에서 구성한 RDBMS 에 localhost:5432/postgres 로 접근하여 테스트를 진행함
2번 해결방법
테스트 action 를 별도로 구성
main, develop 브랜치에 pull request 시, test가 실행되도록 구성
추가)
실제 빌드 & 배포 스테이지에서는 테스트가 필요 없어서 gradle build -x test 명령어로 테스트 없이 실행함
mikepenz/action-junit-report@v3 를 사용하여 테스트 실패 로그 출력
전체 test github actions 코드
name: Gradle Build and Test
on:
pull_request:
branches: [ "main", "develope" ]
jobs:
test:
runs-on: ubuntu-latest
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: postgres
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
# Maps tcp port 5432 on service container to the host
- 5432:5432
steps:
- uses: actions/checkout@v3
- name: Import DB seed data
run: psql -d postgresql://postgres@localhost/postgres -f ddl.sql
# working-directory: ./test/data
env:
PGPASSWORD: postgres
- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'corretto'
- name: Remove previous snapshot.jar
run: rm -rf ./build/libs
- name: Add properties
run: echo "${{ secrets.APPLICATION_TEST }}" > ./src/main/resources/application.yml
- name: init with Gradle
uses: gradle/gradle-build-action@v2
- run: gradle init
- name: Build with Gradle
uses: gradle/gradle-build-action@v2
with:
gradle-version: 7.5.1
arguments: build
- name: 테스트 실패 시, 실패한 코드 라인에 Check 코멘트를 등록합니다
uses: mikepenz/action-junit-report@v3
if: always()
with:
report_paths: '**/build/test-results/test/TEST-*.xml'
token: ${{ secrets.TOKEN }}
- name: build 실패 시 Slack으로 알립니다
uses: 8398a7/action-slack@v3
with:
status: ${{ job.status }}
author_name: 백엔드 빌드 실패 알림
fields: repo, message, commit, author, action, eventName, ref, workflow, job, took
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
if: failure()
- name: Notify Slack
uses: rtCamp/action-slack-notify@v2
env:
SLACK_COLOR: '#00FF00'
SLACK_TITLE: 'Build and Test'
SLACK_TEXT: 'Spring boot Build and Test Success'
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK_URL }}
if: success()
참고) 깃허브 공식문서 psql service container 구성하기