pytest-django for Django testing - Framework Patterns

Framework Mode - pytest-django for Django testing

Folder Structure

my_django_project/
├── myapp/
│   ├── migrations/
│   ├── __init__.py
│   ├── models.py
│   ├── views.py
│   └── tests/
│       ├── __init__.py
│       ├── test_models.py
│       ├── test_views.py
│       └── test_forms.py
├── my_django_project/
│   ├── __init__.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── tests/
│   ├── __init__.py
│   ├── conftest.py
│   └── test_integration.py
├── pytest.ini
├── manage.py
└── requirements.txt
    

Test Framework Layers

• Test Cases Layer: Located in myapp/tests/ and tests/ folders. Contains pytest test functions or classes that test Django models, views, forms, and integration scenarios.
• Fixtures Layer: Defined in tests/conftest.py. Provides reusable setup like database objects, client instances, or user authentication states.
• Configuration Layer: pytest.ini configures pytest-django settings such as Django settings module and markers.
• Django Application Layer: The Django project and apps themselves, which are tested by pytest-django.
• Utilities Layer: Helper functions or custom pytest plugins can be added in tests/utils.py or similar files for common test logic.

Configuration Patterns

• pytest.ini: Set DJANGO_SETTINGS_MODULE to point to your Django settings, e.g., my_django_project.settings.
• Environment Variables: Use environment variables or .env files to manage secrets and different environment configs (development, staging, CI).
• Database Setup: pytest-django automatically uses Django's test database setup. Use fixtures to create test data.
• Browser or Client: Use Django's client fixture or third-party tools for integration tests if needed.
• Markers: Use pytest markers to categorize tests (e.g., @pytest.mark.django_db for tests requiring database access).

Test Reporting and CI/CD Integration

• Test Reports: Use pytest options like --junitxml=report.xml to generate XML reports readable by CI tools.
• Verbose Output: Use -v for detailed test output during local runs.
• CI/CD Integration: Integrate pytest runs in CI pipelines (GitHub Actions, GitLab CI, Jenkins) by running pytest commands and collecting reports.
• Coverage: Use pytest-cov plugin to measure test coverage and fail builds if coverage is below threshold.
• Fail Fast: Use --maxfail=1 to stop on first failure during CI for faster feedback.

Best Practices

• Use Fixtures for Setup: Avoid repeating setup code by using pytest fixtures for database objects and clients.
• Mark Database Tests: Always mark tests that access the database with @pytest.mark.django_db to ensure proper transaction handling.
• Keep Tests Small and Focused: Each test should check one behavior to make failures easy to understand.
• Isolate Tests: Tests should not depend on each other. Use fixtures to provide fresh data for each test.
• Use pytest.ini for Config: Centralize pytest-django settings in pytest.ini for easy maintenance.

Self Check

Where would you add a new fixture that creates a test user for multiple tests to reuse?

Key Result

Organize Django tests with pytest-django using fixtures, clear folder structure, and pytest.ini configuration for maintainable and scalable testing.