pytest.ini

# =============================================================================
# Pytest Configuration
# https://docs.pytest.org/en/stable/reference/customize.html
# =============================================================================
#
# This file is portable - copy to other repos without modification.
#
# Run tests:
#   poetry run pytest              # Run all tests
#   poetry run pytest -x           # Stop on first failure
#   poetry run pytest -k "test_"   # Run tests matching pattern
#   poetry run pytest -m "unit"    # Run only unit tests
#   poetry run pytest --no-cov     # Skip coverage (faster)
#
# =============================================================================


# =============================================================================
# Core Settings
# =============================================================================

[pytest]

# Minimum pytest version required
minversion = 8.0

# Directory containing tests (relative to pytest.ini)
testpaths = tst

# Patterns for test file discovery
python_files = tests.py test_*.py *_tests.py

# Patterns for test class discovery
python_classes = Test*

# Patterns for test function discovery
python_functions = test_*

# Add src/ and current directory to Python path for imports
pythonpath = .


# =============================================================================
# Django Integration (pytest-django)
# =============================================================================

# Django settings module for test environment
DJANGO_SETTINGS_MODULE = tst.settings

# Don't auto-discover Django project (we set it explicitly)
django_find_project = false


# =============================================================================
# Test Output & Display
# =============================================================================

# Output style: progress, classic, short, long, count, line
console_output_style = progress

# Assertion introspection verbosity (0-2)
verbosity_assertions = 2


# =============================================================================
# JUnit XML Report
# =============================================================================

# JUnit XML format: legacy, xunit1, xunit2
junit_family = xunit2

# Suite name is auto-generated from package name


# =============================================================================
# Custom Markers
# =============================================================================
#
# Register markers to avoid warnings and enable filtering:
#   pytest -m "unit"           # Run only unit tests
#   pytest -m "not slow"       # Skip slow tests
#   pytest -m "integration"    # Run only integration tests
#
# =============================================================================

markers =
    slow: marks tests as slow (deselect with '-m "not slow"')
    integration: marks tests as integration tests
    unit: marks tests as unit tests
    transactional_db: marks tests needing database access without transaction wrapping


# =============================================================================
# Warnings Configuration
# =============================================================================
#
# Convert warnings to errors by default, with specific exceptions.
# This helps catch deprecation warnings early.
#
# =============================================================================

filterwarnings =
    error
    ignore::DeprecationWarning
    ignore::PendingDeprecationWarning
    ignore::django.utils.deprecation.RemovedInDjango61Warning
    ignore::ResourceWarning


# =============================================================================
# Default Command Line Options
# =============================================================================
#
# These options are applied automatically on every pytest run.
# Override with explicit flags: pytest --no-cov --maxfail=10
#
# =============================================================================

addopts =
    # Show extra test summary info for all except passed
    -ra
    # Quiet mode (less verbose output)
    -q
    # Error on unknown markers or config keys
    --strict-config
    --strict-markers
    # Skip Django migrations (faster tests)
    --nomigrations
    # Stop after N failures (fail fast)
    --maxfail=3
    # Show N slowest tests
    --durations=10
    # Shorter traceback format
    --tb=short
    # Coverage: measure swing.status package
    --cov=swing.status
    # Coverage: include branch coverage
    --cov-branch
    # Coverage: fail if below threshold
    --cov-fail-under=60
    # Coverage: terminal report (skip fully covered)
    --cov-report=term-missing:skip-covered
    # Coverage: HTML report
    --cov-report=html:tst/reports/htmlcov
    # Coverage: XML report (for CI)
    --cov-report=xml:tst/reports/coverage.xml
    # JUnit XML report (for CI)
    --junitxml=tst/reports/junit.xml
    # Reuse database between test runs (faster)
    --reuse-db


# =============================================================================
# Logging Configuration
# =============================================================================

# Show logs in CLI output (useful for debugging)
log_cli = false

# Minimum log level for CLI output
log_cli_level = WARNING

# Log format for CLI output
log_cli_format = %(asctime)s [%(levelname)8s] %(name)s: %(message)s

# Date format for CLI logs
log_cli_date_format = %Y-%m-%d %H:%M:%S


# =============================================================================
# Required Plugins
# =============================================================================
#
# Pytest will fail if these plugins are not installed.
# Install with: poetry install --with dev
#
# =============================================================================

required_plugins =
    pytest-django>=4.5
    pytest-cov>=4.0