코드 품질 관리

 

코드 품질을 유지하기 위해 사용할 여러 가지 도구에 대해서 정리했다.

사용할 코드 품질 도구

1. Sonar : 코드 품질 분석, 보안 취약점 탐지
2. Black : 코드 스타일 자동 포맷팅
3. Flake8 : 정적 코드 분석 (PEP 8, 문법 오류 검사)
4. isort : import 문 자동 정렬
5. pytest : Python 테스트 프레임 워크

 

1️⃣ Sonar (SonarQube / SonarCloud)

• Sonar는 코드 품질을 분석하는 정적 코드 분석 도구
• SonarQube, SonarCloud 두 가지 형태로 제공

✔ 사용 방법

• 로컬에서 SonarQube를 설치하고 실행 (sonarqube + sonar-scanner 사용)
• CI/CD 환경에서는 SonarCloud를 이용하여 분석

sonar-scanner \
  -Dsonar.projectKey=my_project \
  -Dsonar.organization=my_org \
  -Dsonar.host.url=https://sonarcloud.io \
  -Dsonar.login=my_sonar_token

 

2️⃣ Black

• Python 코드 formatter
• 코드 스타일 자동 정리

✔ 사용 방법

 

1. 패키지 설치

pip install black

 

2. 코드 포맷팅 실행

black my_script.py

 

3. 특정 폴더에 있는 모든 파일 포맷팅

black .

 

3️⃣ Flack8

Python의 정적 코드 분석 도구 → 코드 스타일, 문법 오류를 체크하는 역할

 

✔ 사용 방법

 

1. 패키지 설치

pip install flake8

 

2. 코드 검사 실행

flake8 my_script.py

 

3. 특정 폴더 검사

flake8 my_project/

 

✔ .flake8 파일을 만들어 특정 규칙 무시 가능

[flake8]
max-line-length = 100
ignore = E203, E266, E501

 

4️⃣ isort

Python import 순서 자동 정리

 

✔ 사용 방법

 

1. 패키지 설치

pip install isort

 

2. 특정 파일 정리

isort my_script.py

 

3. 특정 폴더 검사

isort .

 

5️⃣ pytest

Python 테스트 프레임 워크 → 단위 테스트, 기능 테스트 실행하는데 사용

• assert 키워드 사용
• @pytest.mark.parametrize로 테스트 데이터화 가능
• pytest.fixture로 테스트 환경 구성 가능
• 테스트 실행 결과 리포트 지원
• 병렬 테스트 실행 가능 (pytest-xdist 활용)

✔ 사용 방법

 

1. 패키지 설치

pip install pytest

 

2. 간단한 테스트 작성

def add(a, b):
    return a + b

def test_add():
    assert add(2, 3) == 5

 

3. 테스트 실행

pytest

 

→ 현재 디렉토리와 하위 디렉토리에서 모든 test_*.py 및 *_test.py 파일을 찾아 실행

→ 프로젝트 전체의 테스트를 실행할 때 사용 !!

 

4. 특정 파일의 테스트 실행

pytest test_example.py

 

5. 특정 테스트 함수만 실행

pytest test_example.py::test_add

 

→ test_example.py 파일 안에 있는 test_add 함수만 실행

 

6. 실패한 테스트만 다시 실행

pytest --lf

 

7. 테스트 상세 리포트 출력

pytest -v

 

 

✅ Git pre-commit hook 설정

Git의 pre-commit hook을 설정하면, black, flake8, isort, pytest 같은 도구를 코드를 커밋하기 전에 자동으로 실행할 수 있다. 이를 통해 코드 스타일을 유지하고, 버그를 미리 방지 가능

✔ 동작 방식

1. git commit -m "메시지" 입력
2. pre-commit이 실행되면서 black, flake8, isort, pytest 체크
3. 오류 발생 시 커밋이 취소됨
4. 모든 검사 통과 시 커밋 성공 !

✔ 설정 방법

 

1. pre-commit 패키지 설치

pip install pre-commit

 

 

2. pre-commit-config.yaml 파일 생성

- 프로젝트의 루트 디렉토리에 .pre-commit-config.yaml 파일을 만들고 내용 추가

- 파일 예시:

repos:
  - repo: https://github.com/psf/black
    rev: 23.7.0  # 최신 버전 확인 후 업데이트 가능
    hooks:
      - id: black

  - repo: https://github.com/PyCQA/flake8
    rev: 6.1.0  # 최신 버전 확인 후 업데이트 가능
    hooks:
      - id: flake8

  - repo: https://github.com/PyCQA/isort
    rev: 5.12.0  # 최신 버전 확인 후 업데이트 가능
    hooks:
      - id: isort
        args: ["--profile", "black"]  # black 스타일과 호환되도록 설정

  - repo: https://github.com/pytest-dev/pytest
    rev: 7.4.2  # 최신 버전 확인 후 업데이트 가능
    hooks:
      - id: pytest

 

3. Git Hook 활성화 (pre-commit install)

- 이제 pre-commit을 Git의 pre-commit hook으로 등록

pre-commit install

 

 

✔ 테스트 실행

설정 확인을 위해 수동으로 실행 가능

pre-commit run --all-files