Skip to content

TESTING.md

Latest commit

 

History

History
72 lines (58 loc) · 3.54 KB

TESTING.md

File metadata and controls

72 lines (58 loc) · 3.54 KB
Raw

Testing

Unit and API-route tests for the collector/api code base live under collector/tests/ and run with pytest (+ pytest-asyncio, pytest-cov, pytest-httpx).

Running

./scripts/run-tests.sh                     # full suite + coverage summary
./scripts/run-tests.sh tests/test_config.py    # a single file
./scripts/run-tests.sh -k dedup            # by keyword

run-tests.sh executes the suite inside the gyanam-collector image so the exact runtime dependencies are used, installing the dev-only test deps (pytest-cov, pytest-httpx) into the ephemeral container. Behind a TLS-intercepting proxy, set PIP_TRUSTED_HOST=1 (in .env or the environment) so the dev-dep install can reach PyPI.

To run locally instead of via Docker:

cd collector
pip install -r requirements.txt -r requirements-dev.txt
PYTHONPATH=. python -m pytest

Layout

File Covers
test_alert_parsing.py timestamp parser, severity normalization/filtering, baseline member ordering
test_alert_repository.py alert store: dedup, occurred_at ordering/window, count/grouped-count, pagination, deferred vs. include_raw, cursors, bulk delete
test_extractor.py / test_discovery.py / test_schema.py schema-based extraction, auto-discovery, schema loading
test_redfish_log_parser.py / test_unpacker.py log-block parsing, blob extraction + path-traversal / size limits
test_config.py YAML load, env overrides, alert defaults
test_csrf.py / test_auth.py CSRF tokens; password hashing, session cookies, request typing
test_exporters.py / test_influxdb_exporter.py Metric/Prometheus formatting; InfluxDB buffering, cap/drop, health
test_client.py Redfish client pure helpers (auth headers, attachment URI)
test_alert_subscriber_more.py SSE error classification, backoff, event parsing
test_validators.py / test_log_collector.py target name/host (SSRF) validators; filename sanitization + delete path-traversal
test_routes_*.py FastAPI routes: auth enforcement, CSRF, alerts, targets CRUD + bulk CSV import, health

Conventions

  • asyncio_mode = auto (collector/pytest.ini) — async tests need no explicit marker.
  • Tests run against SQLite (throwaway temp DBs via the repo fixture); no PostgreSQL or live InfluxDB/BMC is required. HTTP is mocked (pytest-httpx) or exercised in-process (httpx.ASGITransport).
  • Route tests use client (authenticated) / noauth_client fixtures with the app wired to a temp repository (see conftest.py).

Coverage

run-tests.sh prints a coverage summary and enforces --cov-fail-under=50 (on full runs; subset runs skip the gate). Current overall coverage is ~56% across 220+ tests.

Well-covered: parser (extractor/discovery/schema/log-parser/unpacker), config, auth/CSRF, exporters (Prometheus + InfluxDB buffering/flush), Redfish client (helpers + HTTP task flow), webhook subscriber, baseline log pull, alert repository + manager + subscriber, validators, log-collector, the collector health app + webhook receiver, poller helpers, and the API routes (auth, CSRF, targets CRUD + bulk import, alerts, logs, schemas, health, login/pages).

Lower coverage / future work — the async orchestration loops that are costly/brittle to test in isolation: poller scheduling loop, sse_subscriber manager, ssh_transport (asyncssh), alert_subscriber reconnect loop, influxdb reconnect/flush-loop internals, and the collector_main/api_main lifespans. Raise the --cov-fail-under floor as these are covered.