[TIL] 내일배움캠프 91일차_[Python] 테스트 프레임워크(pytest)

February 25, 2025

TIL

👀Today I Learn

pytest란?

pytest는 Python에서 가장 널리 사용되는 테스트 프레임워크 중 하나
간결한 문법과 강력한 기능을 제공하며, 단위 테스트부터 기능 테스트까지 다양한 테스트를 쉽게 작성할 수 있음

pytest의 장점

설치 및 사용이 간편: pip install pytest로 쉽게 설치 가능
간결한 문법: assert 문을 활용한 직관적인 테스트 작성
강력한 확장성: fixture, parameterization 등 다양한 기능 제공
테스트 자동 검색: test_로 시작하는 함수 또는 Test 클래스를 자동으로 인식
강력한 플러그인 지원: pytest-cov(코드 커버리지), pytest-django(Django 테스트) 등 다양한 플러그인 활용 가능

pytest 설치 및 기본 사용법

설치 방법

pip install pytest

기본 테스트 코드 작성

pytest에서는 assert 문을 활용하여 테스트를 작성

  # test_sample.py
  def test_addition():
      assert 1 + 2 == 3

  def test_string():
      assert "hello".upper() == "HELLO"

테스트 실행

pytest test_sample.py

# 현재 디렉토리의 모든 테스트 실행 :
pytest

결과 예시

`` ============================= test session starts ============================= collected 2 items

test_sample.py .. [100%]

============================== 2 passed in 0.12s ============================== ```

pytest Fixture 활용하기

pytest의 fixture는 반복되는 설정 작업을 줄이고, 테스트 간 의존성을 효과적으로 관리하는 기능

기본 사용 예제

import pytest

@pytest.fixture
def sample_data():
    return {"name": "pytest", "type": "testing"}

def test_sample_data(sample_data):
    assert sample_data["name"] == "pytest"
    assert sample_data["type"] == "testing"

@pytest.fixture를 사용하여 테스트에 필요한 데이터를 설정
test_sample_data 함수에서 sample_data를 파라미터로 받아 사용

Fixture의 Scope 설정

기본적으로 fixture는 각 테스트 함수마다 실행되지만, scope를 지정하여 실행 범위를 조정할 수 있음
```
  @pytest.fixture(scope="module")  # 한 모듈에서 한 번만 실행
```
- function (기본값): 각 테스트 함수마다 실행
- module: 모듈 내에서 한 번만 실행
- session: 전체 테스트에서 한 번만 실행

pytest에서 Mocking 사용하기

외부 API 호출, 데이터베이스 연결 등 실제 환경과 분리하여 테스트하려면 Mocking이 필요
pytest에서는 unittest.mock 라이브러리를 활용하여 Mocking을 수행할 수 있음

Mock 객체 활용 예제

from unittest.mock import MagicMock

def test_mocked_function():
    mock_function = MagicMock(return_value=10)
    assert mock_function() == 10
    mock_function.assert_called_once()

MagicMock(return_value=10): 가짜 함수(mock function)를 생성하고, 호출 시 10을 반환
mock_function.assert_called_once(): 해당 함수가 한 번 호출되었는지 검증

파라미터화 테스트 (Parameterized Test)

-동일한 테스트를 여러 개의 입력값에 대해 반복적으로 실행할 때 @pytest.mark.parametrize를 사용할 수 있음

여러 개의 입력값 테스트 예제

import pytest

@pytest.mark.parametrize("a, b, result", [(1, 2, 3), (2, 3, 5), (3, 5, 8)])
def test_addition(a, b, result):
    assert a + b == result

@pytest.mark.parametrize("변수명", [(값1, 값2, 결과), (값3, 값4, 결과)])를 사용하여 다양한 케이스를 테스트
동일한 테스트 함수를 여러 번 실행하여 각 입력값을 검증

코드 커버리지 측정(pytest-cov)

테스트가 코드의 몇 퍼센트를 실행했는지 확인하려면 pytest-cov 플러그인을 사용할 수 있음

설치 및 실행 방법

pip install pytest-cov
pytest --cov=your_module_name

테스트 결과 예시

  ----------- coverage: platform linux, python 3.10 -----------
  Name              Stmts   Miss  Cover
  -------------------------------------
  your_module.py      10      2    80%

Stmts: 총 실행된 코드 줄 수
Miss: 테스트되지 않은 코드 줄 수
Cover: 코드 커버리지 비율

pytest를 활용한 실전 테스트 예제

Django에서 pytest 활용

Django 프로젝트에서 pytest를 활용하려면 pytest-django를 설치해야 함
```
  pip install pytest-django
```
설치 후 pytest.ini 파일을 생성하여 Django 설정을 지정
```
  [pytest]
  DJANGO_SETTINGS_MODULE = myproject.settings
```

Django의 ORM을 활용한 테스트를 작성

  import pytest
  from myapp.models import User

  @pytest.mark.django_db
  def test_create_user():
      user = User.objects.create(username="testuser", email="test@example.com")
      assert user.username == "testuser"

API 테스트 (FastAPI + HTTPX 활용)

  from fastapi.testclient import TestClient
  from myapi import app

  client = TestClient(app)

  def test_read_main():
      response = client.get("/")
      assert response.status_code == 200
      assert response.json() == {"message": "Hello, World!"}

💡Today I Thought

오늘의 체크리스트

회고

우리팀 다 잘했는데 GitHub Actions CI 자동화가 잘 안되서 해보려고 공부했는데, 그래도 해결은 못했다. 도대체 뭐가 문제지..🫠 env랑 toml때문에 헷갈려서 더 잘 안되는거 같기두.. 이건 시간내서 해결봐야할 것 같다.

Lee Hyun Ji