Pytest Fixture 개념과 필요성

Pytest Fixture 개념과 필요성

Python
Pytest Fixture 개념과 필요성
Author

gabriel yang

Published

October 7, 2024


Pytest Fixture: 개념과 필요성

테스트를 작성할 때, 특정한 환경이나 상태를 세팅하는 것이 종종 필요합니다. 이럴 때 유용하게 사용할 수 있는 것이 바로 Fixture입니다. pytest에서 제공하는 Fixture는 테스트 함수에 필요한 자원을 세팅하고, 이를 관리하는 방법을 제공합니다. 이 글에서는 Fixture의 개념, 필요성, 그리고 실제 예제 코드를 통해 Fixture를 사용하는 방법을 알아보겠습니다.

1. Fixture란?

Fixture는 테스트가 실행되기 전에 필요한 준비 작업을 수행하는 코드 블록입니다. 데이터베이스 연결, 테스트 데이터 생성, 파일 생성 등 다양한 초기화를 쉽게 처리할 수 있도록 도와줍니다. 이를 통해 테스트 코드의 중복을 줄이고, 코드의 가독성을 높일 수 있습니다.

2. Fixture의 필요성

  • 재사용성: 여러 테스트에서 동일한 초기 설정을 사용할 경우, Fixture를 통해 코드를 재사용할 수 있습니다.
  • 유지보수성: Fixture를 수정하면 이를 사용하는 모든 테스트에 자동으로 반영되므로, 유지보수가 쉬워집니다.
  • 가독성: 테스트 코드와 초기 설정 코드를 분리하여 가독성을 높입니다.

3. Fixture 사용 방법

Fixture는 @pytest.fixture 데코레이터를 사용하여 정의합니다. 아래 예제를 통해 Fixture의 사용 방법을 알아보겠습니다.

예제 코드: Fixture 사용하기

import pytest

# Fixture 정의
@pytest.fixture
def sample_data():
    # 테스트에 필요한 초기 데이터를 설정
    data = {
        "name": "John",
        "age": 30,
        "city": "New York"
    }
    return data

# 테스트 함수에서 Fixture 사용
def test_sample_data_name(sample_data):
    assert sample_data["name"] == "John"  # 이름 테스트

def test_sample_data_age(sample_data):
    assert sample_data["age"] == 30  # 나이 테스트

def test_sample_data_city(sample_data):
    assert sample_data["city"] == "New York"  # 도시 테스트

4. Fixture의 동작 방식

  1. Fixture 정의: @pytest.fixture 데코레이터를 사용하여 Fixture를 정의합니다. 이 함수는 초기 데이터를 반환합니다.
  2. Fixture 사용: 테스트 함수의 매개변수로 Fixture의 이름을 지정하면, pytest는 해당 Fixture를 자동으로 호출하고 반환값을 테스트 함수에 전달합니다.

5. Fixture의 활용

Fixture는 더 복잡한 초기화 작업에도 사용할 수 있습니다. 예를 들어, 데이터베이스 연결을 관리하는 Fixture를 정의할 수 있습니다.

예제 코드: 데이터베이스 Fixture

import pytest
import sqlite3

@pytest.fixture
def db_connection():
    # 데이터베이스 연결 생성
    conn = sqlite3.connect(":memory:")  # 메모리 내 데이터베이스 사용
    yield conn  # 테스트 실행

    # 테스트 후 연결 종료
    conn.close()

def test_db_insert(db_connection):
    cursor = db_connection.cursor()
    cursor.execute("CREATE TABLE users (name TEXT, age INTEGER)")
    cursor.execute("INSERT INTO users (name, age) VALUES (?, ?)", ("Alice", 25))

    cursor.execute("SELECT * FROM users")
    user = cursor.fetchone()

    assert user == ("Alice", 25)  # 데이터베이스에서 데이터 확인

6. Fixture의 범위 설정

Fixture는 기본적으로 테스트 함수마다 새로 생성됩니다. 그러나, 필요한 경우 Fixture의 범위를 설정할 수 있습니다. 예를 들어, session, module, class, function 등의 범위를 설정할 수 있습니다.

@pytest.fixture(scope="module")
def sample_data():
    data = {
        "name": "John",
        "age": 30,
        "city": "New York"
    }
    return data

위의 예제에서 scope="module"을 사용하면, 이 Fixture는 같은 모듈 내의 모든 테스트에서 한 번만 생성됩니다.