Files
meshcore-stats/tests/database/test_db_queries.py
T
Jorijn Schrijvershof a9f6926104 test: add comprehensive pytest test suite with 95% coverage (#29)
* test: add comprehensive pytest test suite with 95% coverage

Add full unit and integration test coverage for the meshcore-stats project:

- 1020 tests covering all modules (db, charts, html, reports, client, etc.)
- 95.95% code coverage with pytest-cov (95% threshold enforced)
- GitHub Actions CI workflow for automated testing on push/PR
- Proper mocking of external dependencies (meshcore, serial, filesystem)
- SVG snapshot infrastructure for chart regression testing
- Integration tests for collection and rendering pipelines

Test organization:
- tests/charts/: Chart rendering and statistics
- tests/client/: MeshCore client and connection handling
- tests/config/: Environment and configuration parsing
- tests/database/: SQLite operations and migrations
- tests/html/: HTML generation and Jinja templates
- tests/reports/: Report generation and formatting
- tests/retry/: Circuit breaker and retry logic
- tests/unit/: Pure unit tests for utilities
- tests/integration/: End-to-end pipeline tests

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore: add test-engineer agent configuration

Add project-local test-engineer agent for pytest test development,
coverage analysis, and test review tasks.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: comprehensive test suite review with 956 tests analyzed

Conducted thorough review of all 956 test cases across 47 test files:

- Unit Tests: 338 tests (battery, metrics, log, telemetry, env, charts, html, reports, formatters)
- Config Tests: 53 tests (env loading, config file parsing)
- Database Tests: 115 tests (init, insert, queries, migrations, maintenance, validation)
- Retry Tests: 59 tests (circuit breaker, async retries, factory)
- Charts Tests: 76 tests (transforms, statistics, timeseries, rendering, I/O)
- HTML Tests: 81 tests (site generation, Jinja2, metrics builders, reports index)
- Reports Tests: 149 tests (location, JSON/TXT formatting, aggregation, counter totals)
- Client Tests: 63 tests (contacts, connection, meshcore availability, commands)
- Integration Tests: 22 tests (reports, collection, rendering pipelines)

Results:
- Overall Pass Rate: 99.7% (953/956)
- 3 tests marked for improvement (empty test bodies in client tests)
- 0 tests requiring fixes

Key findings documented in test_review/tests.md including quality
observations, F.I.R.S.T. principle adherence, and recommendations.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* test: implement snapshot testing for charts and reports

Add comprehensive snapshot testing infrastructure:

SVG Chart Snapshots:
- Deterministic fixtures with fixed timestamps (2024-01-15 12:00:00)
- Tests for gauge/counter metrics in light/dark themes
- Empty chart and single-point edge cases
- Extended normalize_svg_for_snapshot_full() for reproducible comparisons

TXT Report Snapshots:
- Monthly/yearly report snapshots for repeater and companion
- Empty report handling tests
- Tests in tests/reports/test_snapshots.py

Infrastructure:
- tests/snapshots/conftest.py with shared fixtures
- UPDATE_SNAPSHOTS=1 environment variable for regeneration
- scripts/generate_snapshots.py for batch snapshot generation

Run `UPDATE_SNAPSHOTS=1 pytest tests/charts/test_chart_render.py::TestSvgSnapshots`
to generate initial snapshots.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* test: fix SVG normalization and generate initial snapshots

Fix normalize_svg_for_snapshot() to handle:
- clipPath IDs like id="p47c77a2a6e"
- url(#p...) references
- xlink:href="#p..." references
- <dc:date> timestamps

Generated initial snapshot files:
- 7 SVG chart snapshots (gauge, counter, empty, single-point in light/dark)
- 6 TXT report snapshots (monthly/yearly for repeater/companion + empty)

All 13 snapshot tests now pass.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* test: fix SVG normalization to preserve axis rendering

The SVG normalization was replacing all matplotlib-generated IDs with
the same value, causing duplicate IDs that broke SVG rendering:
- Font glyphs, clipPaths, and tick marks all got id="normalized"
- References couldn't resolve to the correct elements
- X and Y axes failed to render in normalized snapshots

Fix uses type-specific prefixes with sequential numbering:
- glyph_N for font glyphs (DejaVuSans-XX patterns)
- clip_N for clipPath definitions (p[0-9a-f]{8,} patterns)
- tick_N for tick marks (m[0-9a-f]{8,} patterns)

This ensures all IDs remain unique while still being deterministic
for snapshot comparison.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* chore: add coverage and pytest artifacts to gitignore

Add .coverage, .coverage.*, htmlcov/, and .pytest_cache/ to prevent
test artifacts from being committed.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style: fix all ruff lint errors across codebase

- Sort and organize imports (I001)
- Use modern type annotations (X | Y instead of Union, collections.abc)
- Remove unused imports (F401)
- Combine nested if statements (SIM102)
- Use ternary operators where appropriate (SIM108)
- Combine nested with statements (SIM117)
- Use contextlib.suppress instead of try-except-pass (SIM105)
- Add noqa comments for intentional SIM115 violations (file locks)
- Add TYPE_CHECKING import for forward references
- Fix exception chaining (B904)

All 1033 tests pass.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: add TDD workflow and pre-commit requirements to CLAUDE.md

- Add mandatory test-driven development workflow (write tests first)
- Add pre-commit requirements (must run lint and tests before committing)
- Document test organization and running commands
- Document 95% coverage requirement

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: resolve mypy type checking errors with proper structural fixes

- charts.py: Create PeriodConfig dataclass for type-safe period configuration,
  use mdates.date2num() for matplotlib datetime handling, fix x-axis limits
  for single-point charts
- db.py: Add explicit int() conversion with None handling for SQLite returns
- env.py: Add class-level type annotations to Config class
- html.py: Add MetricDisplay TypedDict, fix import order, add proper type
  annotations for table data functions
- meshcore_client.py: Add return type annotation

Update tests to use new dataclass attribute access and regenerate SVG
snapshots. Add mypy step to CLAUDE.md pre-commit requirements.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: cast Jinja2 template.render() to str for mypy

Jinja2's type stubs declare render() as returning Any, but it actually
returns str. Wrap with str() to satisfy mypy's no-any-return check.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* ci: improve workflow security and reliability

- test.yml: Pin all actions by SHA, add concurrency control to cancel
  in-progress runs on rapid pushes
- release-please.yml: Pin action by SHA, add 10-minute timeout
- conftest.py: Fix snapshot_base_time to use explicit UTC timezone for
  consistent behavior across CI and local environments

Regenerate SVG snapshots with UTC-aware timestamps.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: add mypy command to permissions in settings.local.json

* test: add comprehensive script tests with coroutine warning fixes

- Add tests/scripts/ with tests for collect_companion, collect_repeater,
  and render scripts (1135 tests total, 96% coverage)
- Fix unawaited coroutine warnings by using AsyncMock properly for async
  functions and async_context_manager_factory fixture for context managers
- Add --cov=scripts to CI workflow and pyproject.toml coverage config
- Omit scripts/generate_snapshots.py from coverage (dev utility)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* docs: migrate claude setup to codex skills

* feat: migrate dependencies to uv (#31)

* fix: run tests through uv

* test: fix ruff lint issues in tests

Consolidate patch context managers and clean unused imports/variables

Use datetime.UTC in snapshot fixtures

* test: avoid unawaited async mocks in entrypoint tests

* ci: replace codecov with github coverage artifacts

Add junit XML output and coverage summary in job output

Upload HTML and XML coverage artifacts (3.12 only) on every run

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-08 17:16:53 +01:00

313 lines
11 KiB
Python

"""Tests for database query functions."""
import time
import pytest
from meshmon.db import (
get_available_metrics,
get_distinct_timestamps,
get_latest_metrics,
get_metric_count,
get_metrics_for_period,
insert_metrics,
)
class TestGetMetricsForPeriod:
"""Tests for get_metrics_for_period function."""
def test_returns_dict_by_metric(self, initialized_db):
"""Returns dict with metric names as keys."""
ts = int(time.time())
insert_metrics(ts, "companion", {
"battery_mv": 3850.0,
"contacts": 5,
}, initialized_db)
result = get_metrics_for_period(
"companion", ts - 100, ts + 100, initialized_db
)
assert isinstance(result, dict)
assert "battery_mv" in result
assert "contacts" in result
def test_returns_timestamp_value_tuples(self, initialized_db):
"""Each metric has list of (ts, value) tuples."""
ts = int(time.time())
insert_metrics(ts, "companion", {"test": 1.0}, initialized_db)
result = get_metrics_for_period(
"companion", ts - 100, ts + 100, initialized_db
)
assert len(result["test"]) == 1
assert result["test"][0] == (ts, 1.0)
def test_sorted_by_timestamp(self, initialized_db):
"""Results are sorted by timestamp ascending."""
base_ts = int(time.time())
# Insert out of order
insert_metrics(base_ts + 200, "companion", {"test": 3.0}, initialized_db)
insert_metrics(base_ts, "companion", {"test": 1.0}, initialized_db)
insert_metrics(base_ts + 100, "companion", {"test": 2.0}, initialized_db)
result = get_metrics_for_period(
"companion", base_ts - 100, base_ts + 300, initialized_db
)
values = [v for ts, v in result["test"]]
assert values == [1.0, 2.0, 3.0]
def test_respects_time_range(self, initialized_db):
"""Only returns data within specified time range."""
base_ts = int(time.time())
insert_metrics(base_ts - 200, "companion", {"test": 1.0}, initialized_db) # Outside
insert_metrics(base_ts, "companion", {"test": 2.0}, initialized_db) # Inside
insert_metrics(base_ts + 200, "companion", {"test": 3.0}, initialized_db) # Outside
result = get_metrics_for_period(
"companion", base_ts - 100, base_ts + 100, initialized_db
)
assert len(result["test"]) == 1
assert result["test"][0][1] == 2.0
def test_filters_by_role(self, initialized_db):
"""Only returns data for specified role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"test": 1.0}, initialized_db)
insert_metrics(ts, "repeater", {"test": 2.0}, initialized_db)
result = get_metrics_for_period(
"companion", ts - 100, ts + 100, initialized_db
)
assert result["test"][0][1] == 1.0
def test_computes_bat_pct(self, initialized_db):
"""Computes bat_pct from battery voltage."""
ts = int(time.time())
# 4200 mV = 4.2V = 100%
insert_metrics(ts, "companion", {"battery_mv": 4200.0}, initialized_db)
result = get_metrics_for_period(
"companion", ts - 100, ts + 100, initialized_db
)
assert "bat_pct" in result
assert result["bat_pct"][0][1] == pytest.approx(100.0)
def test_bat_pct_for_repeater(self, initialized_db):
"""Computes bat_pct for repeater using 'bat' field."""
ts = int(time.time())
# 3000 mV = 3.0V = 0%
insert_metrics(ts, "repeater", {"bat": 3000.0}, initialized_db)
result = get_metrics_for_period(
"repeater", ts - 100, ts + 100, initialized_db
)
assert "bat_pct" in result
assert result["bat_pct"][0][1] == pytest.approx(0.0)
def test_empty_period_returns_empty(self, initialized_db):
"""Empty time period returns empty dict."""
result = get_metrics_for_period(
"companion", 0, 1, initialized_db
)
assert result == {}
def test_invalid_role_raises(self, initialized_db):
"""Invalid role raises ValueError."""
with pytest.raises(ValueError, match="Invalid role"):
get_metrics_for_period("invalid", 0, 100, initialized_db)
class TestGetLatestMetrics:
"""Tests for get_latest_metrics function."""
def test_returns_most_recent(self, initialized_db):
"""Returns metrics at most recent timestamp."""
base_ts = int(time.time())
insert_metrics(base_ts, "companion", {"test": 1.0}, initialized_db)
insert_metrics(base_ts + 100, "companion", {"test": 2.0}, initialized_db)
result = get_latest_metrics("companion", initialized_db)
assert result["test"] == 2.0
assert result["ts"] == base_ts + 100
def test_includes_ts(self, initialized_db):
"""Result includes 'ts' key with timestamp."""
ts = int(time.time())
insert_metrics(ts, "companion", {"test": 1.0}, initialized_db)
result = get_latest_metrics("companion", initialized_db)
assert "ts" in result
assert result["ts"] == ts
def test_includes_all_metrics(self, initialized_db):
"""Result includes all metrics at that timestamp."""
ts = int(time.time())
insert_metrics(ts, "companion", {
"battery_mv": 3850.0,
"contacts": 5,
"uptime_secs": 86400,
}, initialized_db)
result = get_latest_metrics("companion", initialized_db)
assert result["battery_mv"] == 3850.0
assert result["contacts"] == 5.0
assert result["uptime_secs"] == 86400.0
def test_computes_bat_pct(self, initialized_db):
"""Computes bat_pct from battery voltage."""
ts = int(time.time())
insert_metrics(ts, "companion", {"battery_mv": 3820.0}, initialized_db)
result = get_latest_metrics("companion", initialized_db)
assert "bat_pct" in result
assert result["bat_pct"] == pytest.approx(50.0)
def test_returns_none_when_empty(self, initialized_db):
"""Returns None when no data exists."""
result = get_latest_metrics("companion", initialized_db)
assert result is None
def test_filters_by_role(self, initialized_db):
"""Only returns data for specified role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"test": 1.0}, initialized_db)
insert_metrics(ts + 100, "repeater", {"test": 2.0}, initialized_db)
result = get_latest_metrics("companion", initialized_db)
assert result["ts"] == ts
assert result["test"] == 1.0
def test_invalid_role_raises(self, initialized_db):
"""Invalid role raises ValueError."""
with pytest.raises(ValueError, match="Invalid role"):
get_latest_metrics("invalid", initialized_db)
class TestGetMetricCount:
"""Tests for get_metric_count function."""
def test_counts_rows(self, initialized_db):
"""Counts total metric rows for role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"a": 1.0, "b": 2.0, "c": 3.0}, initialized_db)
count = get_metric_count("companion", initialized_db)
assert count == 3
def test_filters_by_role(self, initialized_db):
"""Only counts rows for specified role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"a": 1.0}, initialized_db)
insert_metrics(ts, "repeater", {"b": 2.0, "c": 3.0}, initialized_db)
assert get_metric_count("companion", initialized_db) == 1
assert get_metric_count("repeater", initialized_db) == 2
def test_returns_zero_when_empty(self, initialized_db):
"""Returns 0 when no data exists."""
count = get_metric_count("companion", initialized_db)
assert count == 0
def test_invalid_role_raises(self, initialized_db):
"""Invalid role raises ValueError."""
with pytest.raises(ValueError, match="Invalid role"):
get_metric_count("invalid", initialized_db)
class TestGetDistinctTimestamps:
"""Tests for get_distinct_timestamps function."""
def test_counts_unique_timestamps(self, initialized_db):
"""Counts distinct timestamps."""
ts = int(time.time())
insert_metrics(ts, "companion", {"a": 1.0, "b": 2.0}, initialized_db) # 1 ts
insert_metrics(ts + 100, "companion", {"a": 3.0}, initialized_db) # 2nd ts
count = get_distinct_timestamps("companion", initialized_db)
assert count == 2
def test_filters_by_role(self, initialized_db):
"""Only counts timestamps for specified role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"a": 1.0}, initialized_db)
insert_metrics(ts + 100, "companion", {"a": 2.0}, initialized_db)
insert_metrics(ts, "repeater", {"a": 3.0}, initialized_db)
assert get_distinct_timestamps("companion", initialized_db) == 2
assert get_distinct_timestamps("repeater", initialized_db) == 1
def test_returns_zero_when_empty(self, initialized_db):
"""Returns 0 when no data exists."""
count = get_distinct_timestamps("companion", initialized_db)
assert count == 0
class TestGetAvailableMetrics:
"""Tests for get_available_metrics function."""
def test_returns_metric_names(self, initialized_db):
"""Returns list of distinct metric names."""
ts = int(time.time())
insert_metrics(ts, "companion", {
"battery_mv": 3850.0,
"contacts": 5,
"recv": 100,
}, initialized_db)
metrics = get_available_metrics("companion", initialized_db)
assert "battery_mv" in metrics
assert "contacts" in metrics
assert "recv" in metrics
def test_sorted_alphabetically(self, initialized_db):
"""Metrics are sorted alphabetically."""
ts = int(time.time())
insert_metrics(ts, "companion", {
"zebra": 1.0,
"apple": 2.0,
"mango": 3.0,
}, initialized_db)
metrics = get_available_metrics("companion", initialized_db)
assert metrics == sorted(metrics)
def test_filters_by_role(self, initialized_db):
"""Only returns metrics for specified role."""
ts = int(time.time())
insert_metrics(ts, "companion", {"companion_metric": 1.0}, initialized_db)
insert_metrics(ts, "repeater", {"repeater_metric": 2.0}, initialized_db)
companion_metrics = get_available_metrics("companion", initialized_db)
repeater_metrics = get_available_metrics("repeater", initialized_db)
assert "companion_metric" in companion_metrics
assert "repeater_metric" not in companion_metrics
assert "repeater_metric" in repeater_metrics
def test_returns_empty_when_no_data(self, initialized_db):
"""Returns empty list when no data exists."""
metrics = get_available_metrics("companion", initialized_db)
assert metrics == []