Developer Testing Guide

Use this guide when contributing to DRF API Logger.

Setup

git clone https://github.com/vishalanandl177/DRF-API-Logger.git
cd DRF-API-Logger
python -m venv .venv

On Windows:

.venv\Scripts\activate
python -m pip install -r requirements-dev.txt

On macOS or Linux:

source .venv/bin/activate
python -m pip install -r requirements-dev.txt

Required Checks

Run the fast smoke suite:

python test_runner_simple.py

Run the full Django suite:

python -m django test tests --settings=tests.test_settings --verbosity=1

Run the metrics and security signal tests:

python -m django test tests.test_metrics --settings=tests.test_settings --verbosity=2

Run coverage:

coverage run --source=drf_api_logger -m django test tests --settings=tests.test_settings --verbosity=1
coverage report

Run the dependency matrix:

tox

Build and validate package metadata:

python -m build --sdist --wheel
python -m twine check dist/*

Test Matrix

The CI workflow tests representative supported combinations:

Python 3.10, Django 4.2, DRF 3.16
Python 3.11, Django 4.2, DRF 3.16
Python 3.12, Django 5.2, DRF 3.16
Python 3.13, Django 6.0, DRF 3.17

This matrix is representative coverage, not the complete Django 4.2+ support list.

Coverage Expectations

Add or update tests for every behavior change. Cover the touched surface:

Middleware request and response behavior.
ASGI middleware behavior through direct async calls and Django AsyncClient.
Sensitive data masking in bodies, responses, headers, and URL query parameters.
Signal listener behavior and exception isolation.
Observability helper behavior for Prometheus labels, OpenTelemetry span attributes, Sentry context, optional dependency safety, and high-cardinality label prevention.
First-party metrics behavior for safe labels, optional Prometheus dependency, no-op disabled mode, system checks, middleware hooks, queue metrics, security signals, and internal endpoint safety.
Policy gate behavior for full log drops, metadata-only logging, extra mask keys, signal/export gating, safe failures, and default backward compatibility.
Production diagnostics and doctor command behavior, including JSON output, fail-level behavior, database readiness, queue health, payload limits, masking, and profiling risk.
Background queue flushing, stats, shutdown, and database alias handling.
Admin display, filters, CSV export, and profiling diagnosis.
Management commands such as prune_api_logs.
Backward compatibility for defaults and payloads.

ASGI Checks

Run the ASGI-specific middleware tests when touching middleware, correlation, queueing, profiling, or request/response capture:

python -m django test tests.test_asgi_middleware --settings=tests.test_settings --verbosity=2

These tests cover AsyncClient integration, concurrent contextvars isolation, async database enqueue behavior, and queue failure isolation.

For SCRUM-13-style release evidence, measure sync and ASGI overhead against the demo project:

$env:PYTHONPATH='J:\projects\DRF-API-Logger'
& 'J:\projects\drf-demo\venv\Scripts\python.exe' J:\projects\DRF-API-Logger\scripts\measure_asgi_overhead.py --settings config.settings --path /api/echo/ --requests 100 --concurrency 10

Operational Test Surfaces

Retention command:

python manage.py prune_api_logs --days 30 --dry-run
python manage.py prune_api_logs --days 30 --batch-size 1000

Production diagnostics:

python manage.py drf_api_logger_doctor
python manage.py drf_api_logger_doctor --format json
python manage.py drf_api_logger_doctor --fail-level warning

Queue health:

from drf_api_logger.apps import LOGGER_THREAD

status = LOGGER_THREAD.get_status() if LOGGER_THREAD else {"enabled": False}

Review Gates

Before a pull request is ready:

Confirm tests pass locally.
Confirm package metadata builds and passes twine check.
Confirm README and docs/ are updated together for behavior, settings, support policy, security posture, or operational guidance changes.
Confirm no generated artifacts are staged.