ReadmeGenie용 CI/CD 구현

왜 CI/CD인가?

설정을 시작하기 전에 CI/CD가 왜 중요한지 간단히 알아보겠습니다.

1. 자동 테스트: 자동으로 테스트를 실행하면 모든 변경 사항에 대해 코드가 안정적인지 확인할 수 있습니다.
2. 일관성: CI/CD는 코드베이스 전체에 표준(린팅, 서식 지정)을 적용합니다.
3. 신뢰성: 자동화된 검사 및 테스트를 통해 인적 오류를 최소화하고 코드 신뢰성을 향상시킵니다.
4. 신속한 피드백: 개발자는 코드 품질에 대한 즉각적인 피드백을 받아 문제를 조기에 발견할 수 있습니다.

ReadmeGenie에서는 GitHub Actions를 CI/CD 도구로 활용했습니다. GitHub 리포지토리와 원활하게 통합되며 YAML 구성 파일을 통해 유연성과 자동화를 제공합니다.

ReadmeGenie용 CI/CD 파이프라인

CI/CD 파이프라인에는 다음과 같은 자동화된 단계가 포함됩니다.

1. 린팅 및 서식 검사: 코드 스타일과 일관성을 보장하기 위해 Ruff 및 Black을 실행합니다.
2. 단위 테스트: 단위 테스트를 사용하여 코드 변경으로 인해 기존 기능이 중단되지 않는지 확인합니다.
3. 커버리지 분석: 커밋이 허용되기 전에 코드가 커버리지 임계값을 충족하는지 확인하기 위해 Coverage.py를 사용합니다.
4. 사전 커밋 후크: 변경 사항을 푸시하기 전에 로컬 품질 검사를 시행하기 위해 후크를 추가했습니다.

GitHub Actions 워크플로 개요

CI 워크플로는 .github/workflows/python-app.yml에 정의되어 있습니다. 워크플로의 각 부분이 수행하는 작업은 다음과 같습니다.

1. 워크플로 트리거

워크플로는 기본 분기에 대한 모든 푸시 및 풀 요청에서 실행됩니다. 이렇게 하면 모든 코드 변경 사항이 프로덕션에 병합되기 전에 검증을 거칩니다.

name: Python application

on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["main"]

2. Python 환경 설정

Python 3.12.x를 사용하도록 GitHub Actions를 구성하여 로컬 개발 환경과의 일관성을 보장합니다. 이 단계에서는 특정 Python 버전을 설치하고 종속성 설치를 위한 환경을 준비합니다.

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.12.x
        uses: actions/setup-python@v3
        with:
          python-version: "3.12.x"

3. 종속성 설치

다음 단계는 프로젝트 종속성을 설치하는 것입니다. 여기에서는 pip를 업그레이드하고 요구사항.txt 파일을 설치합니다. 그러면 여기에 지정된 추가 종속성이 설치됩니다.

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install flake8 pytest
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

4. Linting 및 코드 품질 검사 실행

린팅은 코드가 지정된 품질 표준을 준수하도록 보장하는 작업 흐름의 중요한 부분입니다. 구문 오류, 정의되지 않은 이름 및 복잡성 문제를 플래그하는 옵션과 함께 flake8을 실행합니다.

name: Python application

on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["main"]

5. 커버리지 분석을 통한 테스트 실행

단위 테스트의 경우 pytest를 사용하여 모든 테스트 사례를 실행합니다. 또한 우리는 테스트 대상 코드 라인을 추적하기 위해 커버리지를 사용하여 테스트 스위트가 정의된 커버리지 임계값인 75%를 충족하는지 확인합니다.

다음 명령은 테스트를 실행하고 테스트 적용 범위의 차이를 강조하는 적용 범위 보고서를 생성합니다. 테스트되지 않은 코드는 향후 버그의 잠재적 원인이 될 수 있으므로 이는 품질 보증에 필수적입니다.

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Set up Python 3.12.x
        uses: actions/setup-python@v3
        with:
          python-version: "3.12.x"

이 적용 범위 검사는 코드베이스의 최소 75%가 테스트에 포함되도록 강제하여 높은 수준의 코드 품질을 보장합니다. 적용 범위가 이 임계값 아래로 떨어지면 커밋이 허용되지 않습니다.

사전 커밋 후크 통합

CI/CD 외에도 사전 커밋 후크를 설정하여 변경 사항이 저장소에 푸시되기 전에 로컬에서 코드 품질을 강화합니다. 이 후크:

• 린팅에는 Ruff를, 서식 지정에는 Black을 실행하세요.
• 로컬 적용 범위로 테스트를 실행하여 최소 적용 범위 임계값을 적용하세요.

다음은 .pre-commit-config.yaml에 사전 커밋 후크로 적용 범위 검사를 추가한 방법입니다.

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install flake8 pytest
          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

과제와 교훈

CI/CD를 설정하려면 GitHub Actions 내에서 다양한 도구(flake8, pytest, Coverage)가 어떻게 상호 작용하는지에 대한 깊은 이해가 필요했습니다. 다음은 우리가 직면한 몇 가지 과제와 구현한 솔루션입니다.

서로 다른 로컬 및 원격 구성 처리

특히 API 통합 및 구성 처리 테스트에서 환경 변수 충돌 문제가 발생했습니다. Unittest에서 @patch.dict 및 기타 모킹 기법을 사용하여 환경을 효과적으로 시뮬레이션할 수 있었습니다.

테스트 범위 및 임계값

가장 큰 과제는 적절한 테스트 범위를 보장하는 것이었습니다. GitHub Actions와 사전 커밋 후크 모두에서 --fail-under=75와 함께 Coverage.py를 사용하면 이 표준을 적용하는 데 도움이 되었습니다.

향후 개선 사항

CI/CD 파이프라인을 더욱 강력하게 만들기 위해 다음을 계획하고 있습니다.

1. 배포 단계 추가: 테스트 통과 후 스테이징 또는 프로덕션 환경에 대한 배포를 자동화합니다.
2. 코드 품질 배지 자동화: 동적 배지를 추가하여 README에 적용 범위, Linting 상태 및 테스트 결과를 표시합니다.
3. 적용 범위 요구 사항 확장: 테스트를 개선하고 더 많은 예외 사례를 다루면서 적용 범위 임계값을 늘립니다.

테이크아웃

이번 프로젝트를 통해 저는 강력한 테스트와 CI/CD 관행을 조기에 확립하는 것이 중요하다는 것을 깨달았습니다. 다시 시작한다면 처음부터 포괄적인 테스트를 작성하고 프로젝트가 진행됨에 따라 점진적으로 확장하고 개선하는 데 집중할 것입니다. 이 접근 방식을 사용하면 분기 누락이나 테스트되지 않은 영역을 방지하고 모든 새 코드가 잘 처리된 코드베이스에 원활하게 통합되도록 할 수 있습니다.

위 내용은 ReadmeGenie용 CI/CD 구현의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!