CI 환경 구축 - in Github Action

[iamabear09]

구현 사항

f-lab-edu / self-monitoring 의 main branch 로 pull request가 merge될 때마다 자동으로 test & build가 수행되도록 Github Action 을 사용하여 CI 서버를 구축한다.

공부 방향

• Github Action 공식 문서
• Docker 및 Docker compose

목표 달성 과정 계획

• [x] 기본적으로 MySQL을 Docker Compose를 사용하여 띄울 수 있어야 한다.

  • Docker & Docker Compose 를 어떻게 사용하는지는 알아야 한다.

• [x] Github action에서 docker-compose script를 통해 MySQL Container 를 띄우는 방법을 공부해야 한다.

  • Github action 공식 문서에서 Docker 관련된 부분들 읽고 정리

• [x] Github action에서 설정 값(주로 환경 변수) 를 docker container에 주입할 수 있어야 한다.

  • Docker Composer에서 Host computer(Github action server)의 환경 변수를 주입 받는 방법

• [x] Github action에서 해야 하는 일 (현재 생각)

  • 먼저 docker와 docker compose를 Github action에서 사용할 수 있도록 해야한다.
  • MySQL Image를 활용해 Container를 에 필요한 설정 값을 주입해서 띄운다.
  • 나의 Service를 실행시킬 수 있도록 JDK 17 및 Gradle Setup
  • 나의 Github repo에서 code를 가져온다.
  • Gradle을 통해 test & build 수행

[iamabear09]

CI 서버 [관련 생각 정리]

[생각 정리] 현재 계획 상 App은 Dockerfile 로 감싸지 않는다. Github Action이 제공하는 Host에서 test & build를 진행한다.

1. Github Action의 Host 안에서 docker-compose 를 통해 MySQL을 띄우고
2. App을 test 할 때, container 내부의 MySQL과 통신 하며 test를 진행한다.

만약 App도 Dockerfile로 감싸면...?

• CI환경을 Docker container 내부에 모두 만들어 놓고 최종 빌드 결과물만 이미지로 만들어서 도커 허브에 배포할 수 도 있는 것 같다.
• 따라서, Github Action의 Script가 좀더 단순해 질 것 같다. (대신, Dockerfile script가 길어질 것 이다)

[궁굼증 확인 및 테스트] Github Host에서 docker 와 docker-compose 는 기본적으로 사용 가능하다.

[생각 정리]

• local :: h2를 이용해서 in-memory DB 사용
• CI :: MySQL 띄워서 사용

즉, Local과 CI용 설정이 다르다. 따라서, 테스트 설정파일을 2개로 분리한기로 결정했다. CI용 설정 파일은 default 설정 파일을 사용하고, Local용 설정 파일은 application-dev.yml 을 사용한다.

[궁굼증 확인 및 테스트] test/resources 에 application.yml / application-dev.yml 두 개가 있다면, 어떻게 ./gradlew test 시 어떻게 profile을 설정할 수 있을까?

• 환경변수 spring.profiles.active = dev 를 설정하고 test를 실행하면 될 것 같다.
• IDE를 사용하는 경우 IDE를 통해 환경 변수를 설정하면 된다.

그런데 두 개의 application.yml application-dev.yml 가 존재하면 어떻게 실행이 되는 거지?

1. application.yml 에 sql-format: true 설정 & profile dev 설정 → sql-format: true 동작

   • 둘다 동작한다.

2. application.yml 에 sql-format: true 설정 & application-dev.yml 에 sql-format: false 설정 profile dev 설정 → sql-format: false 동작

   • dev가 default를 덮어씌운다.

결론 : 프로필을 설정해도 기본 파일은 동작한다.

[iamabear09]

yaml 파일 환경변수 - " " 존재 유무 차이

• yaml 은 기본적으로 " " 없어도 문자 인식한다.
• 하지만, 특수문자가 앞에 존재하는 경우 " "가 필요하다.
• ${ } 를 사용할 때, 어떠한 값이 들어올지 모르므로 "${ }"와 같이 설정하는 것이 더 좋은 선택이라고 생각된다.
• 또한 특수문자가 들어가있다면 " "를 사용하는 것이 좋은 선택인 것 같다.

_{참고 :: yaml spec 공식문서}