[기술정리] 📌 통합 CI Workflow 파일 (lint_and_test.yml) - DDAL-KKAK-DOT/DDALKKAK GitHub Wiki

📌 DDALKKAK 프로젝트 CI 구축 가이드 (pylint & pytest)

DDALKKAK 프로젝트는 코드 품질 유지 및 지속 가능한 개발 환경을 위해 CI/CD 파이프라인에서 정적 분석(pylint)과 테스트 자동화(pytest) 를 수행합니다.

---

✅ CI 개요

• PR이 dev-be 브랜치로 생성될 때마다 자동 실행
• pylint 점수가 8점 이상이어야 통과
• pytest를 사용한 코드 안정성 검증
• 인증 키가 필요한 테스트는 자동으로 제외

---

🚀 1️⃣ pylint 설정 (정적 분석)

pylint는 코드 가독성과 품질을 높이기 위한 핵심 도구로 다음 기준을 사용합니다.

🛠️ 기준 설정

• 최소 점수: 8.0

• 제외 항목:

  • missing-module-docstring
  • missing-function-docstring
  • import-error
  • broad-exception-caught

📄 YAML 설정 예시

- name: Run pylint
  run: |
    pylint backend \
      --disable=missing-module-docstring,missing-function-docstring,import-error,broad-exception-caught \
      --fail-under=8

---

🚀 2️⃣ pytest 설정 (자동화 테스트)

pytest는 소프트웨어의 기능 검증 및 신뢰성 향상에 핵심입니다.

🛠️ 주요 설정

• 테스트 코드 위치: backend/test
• 인증 키가 필요한 test_api.py 및 test_gemini.py 제외
• 커버리지 검사는 제외

📄 YAML 설정 예시

- name: Install dependencies
  run: |
    pip install -r requirements.txt
    pip install pytest

- name: Run pytest (exclude API/Gemini tests)
  env:
    PYTHONPATH: ${{ github.workspace }}
  run: |
    pytest backend/test \
      --ignore=backend/test/test_api.py \
      --ignore=backend/test/test_gemini.py

---

📋 전체 CI 실행 흐름

flowchart LR
PR["PR 생성 (dev-be 브랜치)"] --> Lint[pylint 검사]
PR --> Test[pytest 실행]

Lint -->|점수 8 미만| FailLint[❌ 실패]
Lint -->|점수 8 이상| PassLint[✅ 통과]

Test -->|실패 발생| FailTest[❌ 실패]
Test -->|모든 테스트 통과| PassTest[✅ 통과]

PassLint & PassTest --> Merge["🎉 PR Merge 가능"]
FailLint & FailTest --> Reject["⚠️ PR 수정 필요"]

---

🛡️ 결론 및 장점

• 코드 품질과 가독성 향상
• 빠른 버그 발견 및 예방
• 안정적이고 효율적인 개발 환경 구축