412 lines
9.2 KiB
Markdown
412 lines
9.2 KiB
Markdown
# Python Testing Patterns — Advanced Reference
|
|
|
|
Advanced testing patterns including async code, monkeypatching, temporary files, conftest setup, property-based testing, database testing, CI/CD integration, and configuration.
|
|
|
|
## Pattern 6: Testing Async Code
|
|
|
|
```python
|
|
# test_async.py
|
|
import pytest
|
|
import asyncio
|
|
|
|
async def fetch_data(url: str) -> dict:
|
|
"""Fetch data asynchronously."""
|
|
await asyncio.sleep(0.1)
|
|
return {"url": url, "data": "result"}
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_fetch_data():
|
|
"""Test async function."""
|
|
result = await fetch_data("https://api.example.com")
|
|
assert result["url"] == "https://api.example.com"
|
|
assert "data" in result
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_concurrent_fetches():
|
|
"""Test concurrent async operations."""
|
|
urls = ["url1", "url2", "url3"]
|
|
tasks = [fetch_data(url) for url in urls]
|
|
results = await asyncio.gather(*tasks)
|
|
|
|
assert len(results) == 3
|
|
assert all("data" in r for r in results)
|
|
|
|
|
|
@pytest.fixture
|
|
async def async_client():
|
|
"""Async fixture."""
|
|
client = {"connected": True}
|
|
yield client
|
|
client["connected"] = False
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_with_async_fixture(async_client):
|
|
"""Test using async fixture."""
|
|
assert async_client["connected"] is True
|
|
```
|
|
|
|
## Pattern 7: Monkeypatch for Testing
|
|
|
|
```python
|
|
# test_environment.py
|
|
import os
|
|
import pytest
|
|
|
|
def get_database_url() -> str:
|
|
"""Get database URL from environment."""
|
|
return os.environ.get("DATABASE_URL", "sqlite:///:memory:")
|
|
|
|
|
|
def test_database_url_default():
|
|
"""Test default database URL."""
|
|
# Will use actual environment variable if set
|
|
url = get_database_url()
|
|
assert url
|
|
|
|
|
|
def test_database_url_custom(monkeypatch):
|
|
"""Test custom database URL with monkeypatch."""
|
|
monkeypatch.setenv("DATABASE_URL", "postgresql://localhost/test")
|
|
assert get_database_url() == "postgresql://localhost/test"
|
|
|
|
|
|
def test_database_url_not_set(monkeypatch):
|
|
"""Test when env var is not set."""
|
|
monkeypatch.delenv("DATABASE_URL", raising=False)
|
|
assert get_database_url() == "sqlite:///:memory:"
|
|
|
|
|
|
class Config:
|
|
"""Configuration class."""
|
|
|
|
def __init__(self):
|
|
self.api_key = "production-key"
|
|
|
|
def get_api_key(self):
|
|
return self.api_key
|
|
|
|
|
|
def test_monkeypatch_attribute(monkeypatch):
|
|
"""Test monkeypatching object attributes."""
|
|
config = Config()
|
|
monkeypatch.setattr(config, "api_key", "test-key")
|
|
assert config.get_api_key() == "test-key"
|
|
```
|
|
|
|
## Pattern 8: Temporary Files and Directories
|
|
|
|
```python
|
|
# test_file_operations.py
|
|
import pytest
|
|
from pathlib import Path
|
|
|
|
def save_data(filepath: Path, data: str):
|
|
"""Save data to file."""
|
|
filepath.write_text(data)
|
|
|
|
|
|
def load_data(filepath: Path) -> str:
|
|
"""Load data from file."""
|
|
return filepath.read_text()
|
|
|
|
|
|
def test_file_operations(tmp_path):
|
|
"""Test file operations with temporary directory."""
|
|
# tmp_path is a pathlib.Path object
|
|
test_file = tmp_path / "test_data.txt"
|
|
|
|
# Save data
|
|
save_data(test_file, "Hello, World!")
|
|
|
|
# Verify file exists
|
|
assert test_file.exists()
|
|
|
|
# Load and verify data
|
|
data = load_data(test_file)
|
|
assert data == "Hello, World!"
|
|
|
|
|
|
def test_multiple_files(tmp_path):
|
|
"""Test with multiple temporary files."""
|
|
files = {
|
|
"file1.txt": "Content 1",
|
|
"file2.txt": "Content 2",
|
|
"file3.txt": "Content 3"
|
|
}
|
|
|
|
for filename, content in files.items():
|
|
filepath = tmp_path / filename
|
|
save_data(filepath, content)
|
|
|
|
# Verify all files created
|
|
assert len(list(tmp_path.iterdir())) == 3
|
|
|
|
# Verify contents
|
|
for filename, expected_content in files.items():
|
|
filepath = tmp_path / filename
|
|
assert load_data(filepath) == expected_content
|
|
```
|
|
|
|
## Pattern 9: Custom Fixtures and Conftest
|
|
|
|
```python
|
|
# conftest.py
|
|
"""Shared fixtures for all tests."""
|
|
import pytest
|
|
|
|
@pytest.fixture(scope="session")
|
|
def database_url():
|
|
"""Provide database URL for all tests."""
|
|
return "postgresql://localhost/test_db"
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def reset_database(database_url):
|
|
"""Auto-use fixture that runs before each test."""
|
|
# Setup: Clear database
|
|
print(f"Clearing database: {database_url}")
|
|
yield
|
|
# Teardown: Clean up
|
|
print("Test completed")
|
|
|
|
|
|
@pytest.fixture
|
|
def sample_user():
|
|
"""Provide sample user data."""
|
|
return {
|
|
"id": 1,
|
|
"name": "Test User",
|
|
"email": "test@example.com"
|
|
}
|
|
|
|
|
|
@pytest.fixture
|
|
def sample_users():
|
|
"""Provide list of sample users."""
|
|
return [
|
|
{"id": 1, "name": "User 1"},
|
|
{"id": 2, "name": "User 2"},
|
|
{"id": 3, "name": "User 3"},
|
|
]
|
|
|
|
|
|
# Parametrized fixture
|
|
@pytest.fixture(params=["sqlite", "postgresql", "mysql"])
|
|
def db_backend(request):
|
|
"""Fixture that runs tests with different database backends."""
|
|
return request.param
|
|
|
|
|
|
def test_with_db_backend(db_backend):
|
|
"""This test will run 3 times with different backends."""
|
|
print(f"Testing with {db_backend}")
|
|
assert db_backend in ["sqlite", "postgresql", "mysql"]
|
|
```
|
|
|
|
## Pattern 10: Property-Based Testing
|
|
|
|
```python
|
|
# test_properties.py
|
|
from hypothesis import given, strategies as st
|
|
import pytest
|
|
|
|
def reverse_string(s: str) -> str:
|
|
"""Reverse a string."""
|
|
return s[::-1]
|
|
|
|
|
|
@given(st.text())
|
|
def test_reverse_twice_is_original(s):
|
|
"""Property: reversing twice returns original."""
|
|
assert reverse_string(reverse_string(s)) == s
|
|
|
|
|
|
@given(st.text())
|
|
def test_reverse_length(s):
|
|
"""Property: reversed string has same length."""
|
|
assert len(reverse_string(s)) == len(s)
|
|
|
|
|
|
@given(st.integers(), st.integers())
|
|
def test_addition_commutative(a, b):
|
|
"""Property: addition is commutative."""
|
|
assert a + b == b + a
|
|
|
|
|
|
@given(st.lists(st.integers()))
|
|
def test_sorted_list_properties(lst):
|
|
"""Property: sorted list is ordered."""
|
|
sorted_lst = sorted(lst)
|
|
|
|
# Same length
|
|
assert len(sorted_lst) == len(lst)
|
|
|
|
# All elements present
|
|
assert set(sorted_lst) == set(lst)
|
|
|
|
# Is ordered
|
|
for i in range(len(sorted_lst) - 1):
|
|
assert sorted_lst[i] <= sorted_lst[i + 1]
|
|
```
|
|
|
|
## Testing Database Code
|
|
|
|
```python
|
|
# test_database_models.py
|
|
import pytest
|
|
from sqlalchemy import create_engine, Column, Integer, String
|
|
from sqlalchemy.ext.declarative import declarative_base
|
|
from sqlalchemy.orm import sessionmaker, Session
|
|
|
|
Base = declarative_base()
|
|
|
|
|
|
class User(Base):
|
|
"""User model."""
|
|
__tablename__ = "users"
|
|
|
|
id = Column(Integer, primary_key=True)
|
|
name = Column(String(50))
|
|
email = Column(String(100), unique=True)
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def db_session() -> Session:
|
|
"""Create in-memory database for testing."""
|
|
engine = create_engine("sqlite:///:memory:")
|
|
Base.metadata.create_all(engine)
|
|
|
|
SessionLocal = sessionmaker(bind=engine)
|
|
session = SessionLocal()
|
|
|
|
yield session
|
|
|
|
session.close()
|
|
|
|
|
|
def test_create_user(db_session):
|
|
"""Test creating a user."""
|
|
user = User(name="Test User", email="test@example.com")
|
|
db_session.add(user)
|
|
db_session.commit()
|
|
|
|
assert user.id is not None
|
|
assert user.name == "Test User"
|
|
|
|
|
|
def test_query_user(db_session):
|
|
"""Test querying users."""
|
|
user1 = User(name="User 1", email="user1@example.com")
|
|
user2 = User(name="User 2", email="user2@example.com")
|
|
|
|
db_session.add_all([user1, user2])
|
|
db_session.commit()
|
|
|
|
users = db_session.query(User).all()
|
|
assert len(users) == 2
|
|
|
|
|
|
def test_unique_email_constraint(db_session):
|
|
"""Test unique email constraint."""
|
|
from sqlalchemy.exc import IntegrityError
|
|
|
|
user1 = User(name="User 1", email="same@example.com")
|
|
user2 = User(name="User 2", email="same@example.com")
|
|
|
|
db_session.add(user1)
|
|
db_session.commit()
|
|
|
|
db_session.add(user2)
|
|
|
|
with pytest.raises(IntegrityError):
|
|
db_session.commit()
|
|
```
|
|
|
|
## CI/CD Integration
|
|
|
|
```yaml
|
|
# .github/workflows/test.yml
|
|
name: Tests
|
|
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
|
|
strategy:
|
|
matrix:
|
|
python-version: ["3.9", "3.10", "3.11", "3.12"]
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
pip install -e ".[dev]"
|
|
pip install pytest pytest-cov
|
|
|
|
- name: Run tests
|
|
run: |
|
|
pytest --cov=myapp --cov-report=xml
|
|
|
|
- name: Upload coverage
|
|
uses: codecov/codecov-action@v3
|
|
with:
|
|
file: ./coverage.xml
|
|
```
|
|
|
|
## Configuration Files
|
|
|
|
```ini
|
|
# pytest.ini
|
|
[pytest]
|
|
testpaths = tests
|
|
python_files = test_*.py
|
|
python_classes = Test*
|
|
python_functions = test_*
|
|
addopts =
|
|
-v
|
|
--strict-markers
|
|
--tb=short
|
|
--cov=myapp
|
|
--cov-report=term-missing
|
|
markers =
|
|
slow: marks tests as slow
|
|
integration: marks integration tests
|
|
unit: marks unit tests
|
|
e2e: marks end-to-end tests
|
|
```
|
|
|
|
```toml
|
|
# pyproject.toml
|
|
[tool.pytest.ini_options]
|
|
testpaths = ["tests"]
|
|
python_files = ["test_*.py"]
|
|
addopts = [
|
|
"-v",
|
|
"--cov=myapp",
|
|
"--cov-report=term-missing",
|
|
]
|
|
|
|
[tool.coverage.run]
|
|
source = ["myapp"]
|
|
omit = ["*/tests/*", "*/migrations/*"]
|
|
|
|
[tool.coverage.report]
|
|
exclude_lines = [
|
|
"pragma: no cover",
|
|
"def __repr__",
|
|
"raise AssertionError",
|
|
"raise NotImplementedError",
|
|
]
|
|
```
|