소프트웨어를 개발하다보면 코드의 품질을 유지하고 발전시키기 위해 코드 커버리지 테스트를 수행해야 합니다. 코드 커버리지 테스트는 코드에서 어느 부분이 테스트되었고 어느 부분이 테스트되지 않았는지를 확인하여 품질을 향상시키는 데 도움을 줍니다.
pytest-cov-report는 pytest 및 pytest-cov와 함께 사용되어 코드 커버리지 리포트를 출력하는 도구입니다. 이를 통해 개발자는 코드의 테스트 커버리지를 쉽게 확인하고, 보다 안정적인 소프트웨어를 개발할 수 있습니다.
이번 글에서는 pytest-cov-report를 사용하여 코드 커버리지 리포트를 출력하는 방법에 대해 알아보겠습니다.
pytest-cov-report 설치
먼저, pytest와 pytest-cov를 설치해야 합니다. 다음 명령을 사용하여 설치할 수 있습니다.
pip install pytest pytest-cov
이어서 pytest-cov-report를 설치합니다.
pip install pytest-cov-report
코드 커버리지 리포트 출력
pytest 및 pytest-cov가 설치되었다면, 다음과 같이 pytest 명령어에 --cov
옵션을 사용하여 코드 커버리지 리포트를 출력할 수 있습니다.
pytest --cov=<모듈명> --cov-report=html
이때 <모듈명>
은 코드 커버리지를 측정할 대상 모듈의 이름입니다. 위 명령을 실행하면 <모듈명>
의 코드 커버리지에 대한 리포트가 생성됩니다.
리포트 확인
리포트는 HTML 형식으로 생성되며, 해당 프로젝트 디렉토리에 htmlcov
폴더 내에 저장됩니다. 웹 브라우저에서 해당 폴더를 열어 코드 커버리지 리포트를 확인할 수 있습니다.
이렇게 pytest-cov-report를 사용하여 코드 커버리지 리포트를 출력할 수 있습니다. 이를 통해 소프트웨어의 품질을 지속적으로 향상시키고 안정성을 높일 수 있습니다.
참고 문헌:
- https://pytest-cov.readthedocs.io/en/latest/reporting.html
- https://pypi.org/project/pytest-cov-report/