[파이썬][Django] 코드 커버리지 리포트 생성 방법과 예제

Django 프로젝트에서 코드 커버리지 리포트를 생성하려면 코드를 테스트하고 커버리지 데이터를 수집하는 도구와 리포트를 생성하는 도구가 필요합니다. 대표적인 코드 커버리지 도구로는 coverage.py가 있으며, 리포트 생성을 위해 coverage 패키지의 다양한 도구를 사용할 수 있습니다. 아래는 코드 커버리지 리포트 생성 방법과 예제입니다.

1. coverage.py 설치

먼저 coverage.py를 설치해야 합니다. 다음 명령어를 사용하여 설치합니다.

pip install coverage

2. 테스트 실행 및 커버리지 데이터 수집

coverage.py를 사용하여 테스트를 실행하고 코드 커버리지 데이터를 수집합니다. Django의 manage.py를 사용하여 테스트를 실행하면 됩니다.

coverage run manage.py test myapp

위 명령어에서 myapp는 테스트할 Django 앱의 이름입니다.

3. 코드 커버리지 리포트 생성

코드 커버리지 리포트를 생성하려면 다음 명령어를 사용합니다.

coverage html

이 명령어는 HTML 형식의 코드 커버리지 리포트를 생성하며, htmlcov 디렉토리에 결과가 저장됩니다.

4. 코드 커버리지 리포트 확인

이제 웹 브라우저로 htmlcov/index.html 파일을 열어 코드 커버리지 리포트를 확인할 수 있습니다.

코드 커버리지 리포트 예제

다음은 Django 프로젝트에서 코드 커버리지 리포트를 생성하는 예제입니다.

  1. coverage.py 설치:
pip install coverage
  1. 테스트 실행 및 커버리지 데이터 수집:
coverage run manage.py test myapp
  1. 코드 커버리지 리포트 생성:
coverage html
  1. 리포트 확인:

    코드 커버리지 리포트는 htmlcov 디렉토리에 생성됩니다. 해당 디렉토리에서 index.html 파일을 열어서 리포트를 확인합니다.

코드 커버리지 리포트를 통해 어떤 부분이 테스트되지 않았거나 커버리지가 낮은 부분을 확인하고, 테스트 커버리지를 향상시키는 데 도움을 줄 수 있습니다.