Pytest 란?

• pytest는 Python으로 작성된 소프트웨어 테스트 프레임워크입니다. 일반적으로 유닛 테스트, 통합 테스트 및 기능 테스트를 작성할 때 사용됩니다. pytest는 간결하고 사용하기 쉬운 문법을 제공하여 테스트 코드를 작성하고 유지 관리하는 것을 간편하게 만들어줍니다.
• pytest의 중요한 특징 중 하나는 강력한 플러그인 시스템입니다. 이를 통해 사용자는 필요에 따라 pytest의 기능을 확장하고 사용자 정의할 수 있습니다. 예를 들어, 코드 커버리지를 계산하는 플러그인이나 테스트 리포트를 작성하는 플러그인을 사용할 수 있습니다.
• pytest는 assert 문을 사용하여 테스트를 작성합니다. 이를 통해 테스트 조건을 간결하게 표현할 수 있고, 오류가 발생할 경우 의도한 조건과 다른 경우를 명확하게 파악할 수 있습니다.
• 또한, pytest는 여러 가지 기능을 지원합니다. 예를 들어, 테스트 파라미터화, 테스트 자동 검색, 픽스처 (fixture) 기능 등을 제공하여 테스트 작성을 더욱 효율적으로 만들어줍니다.

테스트 코드 작성이 중요한 이유

1. 코드 안정성: 테스트 코드를 작성하면 코드의 각 부분이 예상대로 작동하는지 확인할 수 있습니다. 이를 통해 버그를 조기에 발견하고 수정할 수 있습니다. 또한, 새로운 기능을 추가하거나 코드를 변경할 때 기존의 기능에 영향을 주지 않는지 확인할 수 있습니다.
2. 문서화: 테스트 코드는 코드의 동작을 설명하는 문서 역할을 합니다. 다른 개발자나 팀원들이 코드를 이해하고 사용할 때 테스트 코드를 참고하여 코드의 의도를 파악할 수 있습니다.
3. 생산성 향상: 테스트 코드는 개발 생산성을 향상시킵니다. 테스트 코드를 작성하면 개발 중에 발생하는 버그를 빠르게 발견하고 수정할 수 있습니다. 또한, 테스트 코드를 작성하면 기능을 더욱 명확하게 이해하고 설계할 수 있습니다.

실습 준비

• 4.2. Dependency Injector 에서 이어집니다.

1. 라이브러리 의존성 추가

   poetry add pytest pytest-asyncio httpx
   

Pytest 테스트 코드 작성 방법

• pytest는 프로젝트 내에 ‘test’ 문자열이 포함되어있는 파일명을 인식하여 테스트를 실행합니다.

  • 파일 내에서 ‘test_’ 문자열로 시작하는 함수를 인식하여 실행합니다.

    • ex) test_sum

  • @pytest.mark.parameterize 데코레이터를 통해 테스트에 주입할 인자와 실제 값들을 정의할 수 있습니다.

    • 예시에서는 test_list,expected 두 인자를 입력으로 받으며, [3, 5], 8, [1,2], 3으로 테스트 데이터가 입력됩니다.
    • 로직을 수행한 뒤 assert 문으로 결과를 검사해볼 수 있습니다.

    import pytest
    
    # 일반 테스트 코드를 작성하는 경우
    @pytest.mark.parametrize("test_list,expected", [([3, 5], 8),
                                                    ([1, 2], 3)] )
    def test_sum(test_list, expected):
        assert sum(test_list) == expected
        
    
    # 비동기 테스트 코드를 작성하는 경우
    @pytest.mark.asyncio
    @pytest.mark.parametrize("test_list,expected", [([3, 5], 8),
                                                    ([1, 2], 3)] )
    async def test_sum(test_list, expected):
        assert sum(test_list) == expected
    

Pytest Fixture