CI/CD란?

CI란?

💡 CI는 빌드/테스트 자동화 과정을 말하며, 개발자를 위한 자동화 프로세스인 ‘지속적인 통합’을 의미한다.

CI가 성공적으로 구현되면 애플리케이션에 대한 새로운 코드 변경 사항이 정기적으로 빌드 및 테스트 되어 공유 레포지토리에 통합된다.

→ 따라서, 이를 통해 여러 개발자가 동시에 애플리케이션 개발과 관련된 코드 작업을 할 경우 서로 충돌할 수 있는 문제를 해결할 수 있다.

CI는 커밋할 때마다 빌드와 일련의 자동 테스트가 이루어져 동작을 확인하고, 변경 사항으로 인한 오류가 생기는 부분이 없도록 보장한다. 즉, 클래스와 기능에서부터 전체 애플리케이션을 구성하는 서로 다른 모듈에 이르기까지 모든 것에 대한 테스트를 수행하며, 자동화된 테스트 과정에서 기존 코드와 신규 코드 간의 충돌이 발견되면 CI를 통해 버그가 더 빠르게 수정될 수 있다.

따라서, CI를 이용하면 빌드 자동화, 테스트 자동화를 통해 버그나 코드 충돌이 발생할 경우 더욱 빠르게 대응할 수 있다.

CD란?

💡 CD는 Continuous Delivery의 약자로, “지속적 제공”을 의미하는데, Continuous Deployment인 “지속적 배포”까지 CI → Continuous Delivery → Continous Deployment 총 3단계 구축 사례를 모두 포함하는 경우일 수도 있다.

지속적 제공

“지속적 제공”은 CI의 빌드, 자동화, 유닛 및 통합 테스트 수행 이후에 이어지는 프로세스로, CD에서는 유효한 코드를 레포지토리에 자동으로 배포하게 된다. 지속적 제공은 프로덕션 환경으로 배포할 준비가 된 코드 베이스를 확보하는 것을 목표로 한다.

지속적 배포

“지속적 배포”는 프로덕션 준비가 완료된 빌드를 코드 레포지토리에 자동으로 배포하는 “지속적 제공”의 확장된 형태로, 애플리케이션을 프로덕션으로 배포하는 작업을 자동화 한다.

실제 사례에서는 지속적 배포가 이루어지려면 개발자가 애플리케이션에 변경 사항을 작성한 후 몇 분 이내에 애플리케이션을 자동으로 실행할 수 있어야 한다. 그럴려면 이전에 당연히 CI 단계는 통과한 것이라 봐야 한다.

CI/CD를 적용하면 어떤 work process를 거치게 되는가?

1. 개발자들이 개발하여 feature브랜치에 코드를 push 한다.
2. git push를 통해 Trigger되어 CI서버에서 알아서 Build, Test, Lint를 실행하고 결과를 전송한다.
3. 개발자들은 결과를 전송받고 에러가 난 부분이 있다면 에러 부분을 수정하고 코드를 master 브랜치에 merge 한다.
4. master 브랜치에 코드를 merge하고 Build, Test가 정상적으로 수행이 되었다면 CI서버에서 알아서 Deploy 과정을 수행한다.

결론적으로, CI/CD를 이용하면 애플리케이션 배포의 위험성을 줄여주기 때문에 애플리케이션 변경 사항을 한 번에 모두 릴리스 하지 않고 작은 조각으로 세분화 하여 더욱 효율적으로 배포하는 것이 가능해진다.

사용 가능한 툴: CircleCI

CircleCI

CircleCI는 CI/CD를 위한 툴이다.

이를 사용하기 위해서는 circleci.com의 프로젝트에 현재 사용하고 있는 프로젝트의 vcs 레포지토리가 인증되어 있어야 한다. 그러면 code 변화가 있을 때 circleCI가 도커 컨테이너 혹은 VM내에서 자동화된 테스트를 진행하게 된다.

프로젝트 루트 디렉토리에 ‘.circleci/config.yml’ 파일을 생성해서 아래와 같은 내용을 추가한다.

# Python CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-python/ for more details
#
version: 2
jobs:
  build:
    docker:
      # specify the version you desire here
      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
      - image: circleci/python:3.6.1
      
      # Specify service dependencies here if necessary
      # CircleCI maintains a library of pre-built images
      # documented at https://circleci.com/docs/2.0/circleci-images/
      # - image: circleci/postgres:9.4

    working_directory: ~/repo

    steps:
      - checkout

      # Download and cache dependencies
      - restore_cache:
          keys:
          - v1-dependencies-{{ checksum "requirements.txt" }}
          # fallback to using the latest cache if no exact match is found
          - v1-dependencies-

      - run:
          name: install dependencies
          command: |
            python3 -m venv venv
            . venv/bin/activate
            pip install -r requirements.txt

      - save_cache:
          paths:
            - ./venv
          key: v1-dependencies-{{ checksum "requirements.txt" }}
        
      # run tests!
      - run:
          name: run tests
          command: |
            . venv/bin/activate
            python manage.py test accounts lists

      - store_artifacts:
          path: test-reports
          destination: test-reports

본인의 개발 환경에 따라 steps에 추가하고 싶은 내용들을 변경한다.

만약 postgres를 데이터베이스로 사용하고 있다면, docker image에 아래와 같은 내용을 추가한다.

- image: circleci/postgres:9.6-alpine
        auth:
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference
        environment:
          POSTGRES_USER: postgres
					POSTGRES_PASSWORD: {your password}
					POSTGRES_DB: {your db}

그 다음 CLI에 아래의 명령어들을 작성한다.

git add .circleci
git commit -m "{message}"
git push

그 다음 CircleCI에서 “start building” 버튼을 클릭하면 circleCI와의 연동이 된다.

Codecov

Codecov는 test coverage를 측정하기 위한 툴로, 테스트 코드가 해당 제품 코드를 얼마나 커버하고 있는지 그리고 어떤 부분이 취약한 지를 알려준다. codecov는 circleCi와 연동해서 사용할 수 있으며 프로젝트 빌드 후 테스트 실행시 coverage를 측정할 수 있다.

codecov를 추가해 사용하려면 먼저 codecov에 프로젝트 레포지토리를 등록한 뒤, 아래의 내용을 config.yml에 추가하면 된다.

일단 “coverage” “codecov”를 pip로 설치하고 위에서 run에 사용되는 명령어들 즉,

      # run tests!
      - run:
          name: run tests
          command: |
            . venv/bin/activate
            python manage.py test accounts lists

이 내용 중 “python manage.py ~” 부분을 아래와 같이 수정한다.

# run tests!
      - run:
          name: run tests
          command: |
            . venv/bin/activate
            coverage run ./manage.py test accounts lists
            codecov

→ 이는 ‘coverage’ 후 ‘codecov’ 추가를 하겠다는 뜻이다.

이렇게 변경한 후 push하면 coverage 분석이 잘 실행된다.

참고

1) CI/CD: https://www.redhat.com/ko/topics/devops/what-is-ci-cd

2) sentry: https://blog.sentry.io/2020/01/21/automating-sentry-releases-with-circleci

3) CircleCIhttps://showerbugs.github.io/2017-12-26/circleci-codecov-django-연동하기