Python으로 REST API 자동 테스트 프레임워크 구축하기

현대 소프트웨어 개발에서 API는 서비스 간 데이터를 주고받는 핵심 통로입니다. API의 안정성과 정확성을 지키기 위해서는 지속 가능한 자동화 테스트 체계가 필수적입니다. 이 글에서는 Python과 requests를 기반으로 재사용 가능하고 계층별 책임이 명확한 API 자동 테스트 프레임워크를 만드는 방법을 살봅니다.

1단계: 공통 헤더를 한 곳에서 관리하기

API 요청마다 인증 토큰이나 Content-Type을 일일이 입력하면 실수할 가능성이 커집니다. 더 생성 로직을 별도 팩토리 클래스로 분리하면 중복을 줄이고, 토큰 만료 시 자동 재발급 같은 정책도 한 곳에서 처리할 수 있습니다.

# config/settings.py
API_USER = "admin"
API_PASSWORD = "admin_password"
AUTH_IP = "192.168.1.100"

# public/auth.py
def authenticate(username, password):
    """토큰 발급 API 호출 예시"""
    ...

# utils/header.py
from config.settings import API_USER, API_PASSWORD, AUTH_IP
from public.auth import authenticate


class HeaderFactory:
    DEFAULT_CONTENT_TYPE = "application/json"
    FORM_CONTENT_TYPE = "application/x-www-form-urlencoded"

    @classmethod
    def make(cls, content_type=None, school_uid=None, access_token=None):
        if content_type is None:
            content_type = cls.DEFAULT_CONTENT_TYPE

        # 토큰이 없으면 자동 로그인
        token = access_token or authenticate(API_USER, API_PASSWORD)

        return {
            "Content-Type": content_type,
            "x-auth-token": token,
            "x-auth-ip": AUTH_IP,
            "x-auth-schoolUid": school_uid or "",
        }
  • 설정 분리: 계정 정보와 IP는 config/settings.py에서 관리해 코드와 환경 설정을 분리합니다.
  • 단일 책임: HeaderFactory는 오직 헤더 조립만 담당하며, Content-Type을 인자로 받아 다양한 요청에 대응합니다.
  • 자동 구: 호출자가 토큰을 전달하지 않으면 내부에서 인증을 시도하므로, 테스트 코드는 로그인 과정을 몰라도 됩니다.

2단계: 중앙집중식 HTTP 요청 엔진 만들기

실제 HTTP 통신은 ApiClient 클래스 하나에서 담당합니다. 세션을 공유하고, 로깅과 예외 처리를 중앙에서 처리하면 테스트 코드는 비즈니스 로직에만 집중할 수 있습니다.

# utils/http_client.py
import requests
from utils.logger import logger


class ApiClient:
    def __init__(self, verify_ssl=False, timeout=10):
        self.session = requests.Session()
        self.verify = verify_ssl
        self.timeout = timeout

    def request(self, method, url, **kwargs):
        kwargs.setdefault("verify", self.verify)
        kwargs.setdefault("timeout", self.timeout)

        logger.info(f"[{method.upper()}] {url} | headers={kwargs.get('headers')}")

        try:
            response = self.session.request(method, url, **kwargs)
            response.raise_for_status()
        except Exception as exc:
            logger.error(f"[{method.upper()}] 요청 실패: {exc}")
            raise
        else:
            logger.info(f"[{method.upper()}] 응답 성공: {response.text[:200]}")
            return response

    def get(self, url, params=None, **kwargs):
        return self.request("get", url, params=params, **kwargs)

    def post(self, url, data=None, json=None, **kwargs):
        return self.request("post", url, data=data, json=json, **kwargs)

    def put(self, url, data=None, json=None, **kwargs):
        return self.request("put", url, data=data, json=json, **kwargs)

    def delete(self, url, json=None, **kwargs):
        return self.request("delete", url, json=json, **kwargs)


# 어서나 동일한 인스턴스를 사용
client = ApiClient()
  • 세션 유지: requests.Session()을 사용하면 쿠키와 커넥션 풀이 유지되어 로그인 후 후속 요청을 안정적으로 처리합니다.
  • 유연한 메서드 분기: request() 메서드가 실제 HTTP 메서드를 문자열로 받아 처리하로, run_main 같은 거대한 if-else 블록이 필요 없습니다.
  • 일관된 예외·로깅: 모든 요청의 성공/실패가 한 곳에서 기록되어 문제 추적이 워집니다.

3단계: 비즈니스 API 테스트 코드 작성하기

기반 클래스가 준비되면 구체적인 업무 테스트 함수는 간결해집니다. 아래 예시는 문서 처리 상태 조회와 자원 삭제 기능을 담당합니다.

# services/document.py
from config.settings import BASE_URL
from utils.header import HeaderFactory
from utils.http_client import client


def fetch_task_status(task_uid, token=None):
    url = f"{BASE_URL}/web/resource/v1/document/task/{task_uid}/status"
    headers = HeaderFactory.make(access_token=token)
    response = client.get(url, headers=headers)
    return response.json()["data"]["status"]


def remove_publication(publication_id, token=None):
    url = f"{BASE_URL}/resource/v1/publications"
    headers = HeaderFactory.make(access_token=token)
    payload = {"publishIds": [publication_id]}
    return client.delete(url, json=payload, headers=headers)
  • 관심사 분리: fetch_task_status와 remove_publication은 URL과 파라미터 조합에만 집중합니다.
  • 재사용성: HeaderFactory와 ApiClient를 재활용하므로 새로운 API 추가 시 반복 코드가 거의 없습니다.
  • 명확한 계층:
    • 비즈니스 로직 계층: services/document.py
    • 통신 엔진 계층: ApiClient
    • 공용 도구 계층: HeaderFactory
    • 설정 계층: config/settings.py

태그: python REST API requests HTTP Session API Testing

10월 18일 03:40에 게시됨