Back to Repositories

Testing FastAPI Client Configuration in private-gpt

This test fixture implements a FastAPI test client setup for the private-gpt application. It provides a configurable test environment using pytest fixtures and dependency injection to facilitate comprehensive API testing.

Test Coverage Overview

The test suite enables thorough API endpoint testing by providing a configurable TestClient instance. Key functionality includes:

Dynamic settings configuration through pytest parametrization
Isolated test environment for each test case
Mock dependency injection support
Full FastAPI application context testing

Implementation Analysis

The implementation utilizes pytest’s fixture system combined with FastAPI’s TestClient to create isolated test environments. The approach leverages dependency injection through MockInjector to allow flexible configuration of application settings and dependencies during testing.

The pattern demonstrates clean separation of concerns between test setup and execution, with framework-specific features like pytest.FixtureRequest and TestClient being used effectively.

Technical Details

Testing Framework: pytest
API Testing: FastAPI TestClient
Dependency Injection: Custom MockInjector
Configuration: Dynamic settings binding
Application Factory: create_app function

Best Practices Demonstrated

The test fixture exemplifies several testing best practices in Python API testing. It demonstrates proper separation of concerns, efficient resource management, and flexible configuration options.

Modular test setup with dependency injection
Reusable fixture pattern
Parameterized test support
Clean application context management

zylon-ai/private-gpt

tests/fixtures/fast_api_test_client.py

            
import pytest
from fastapi.testclient import TestClient

from private_gpt.launcher import create_app
from tests.fixtures.mock_injector import MockInjector


@pytest.fixture
def test_client(request: pytest.FixtureRequest, injector: MockInjector) -> TestClient:
    if request is not None and hasattr(request, "param"):
        injector.bind_settings(request.param or {})

    app_under_test = create_app(injector.test_injector)
    return TestClient(app_under_test)