mirror of
https://github.com/jorijn/meshcore-stats.git
synced 2026-03-28 17:42:55 +01:00
* 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>
283 lines
11 KiB
Python
283 lines
11 KiB
Python
"""Tests for telemetry data extraction from Cayenne LPP format."""
|
|
|
|
from meshmon.telemetry import extract_lpp_from_payload, extract_telemetry_metrics
|
|
|
|
|
|
class TestExtractLppFromPayload:
|
|
"""Test extract_lpp_from_payload function."""
|
|
|
|
def test_dict_payload_with_lpp_key(self):
|
|
"""Extract LPP data from dict payload with 'lpp' key."""
|
|
payload = {"pubkey_pre": "abc123", "lpp": [{"type": "temperature", "value": 23.5}]}
|
|
result = extract_lpp_from_payload(payload)
|
|
assert result == [{"type": "temperature", "value": 23.5}]
|
|
|
|
def test_dict_payload_empty_lpp_list(self):
|
|
"""Extract empty LPP list from dict payload."""
|
|
payload = {"pubkey_pre": "abc123", "lpp": []}
|
|
result = extract_lpp_from_payload(payload)
|
|
assert result == []
|
|
|
|
def test_direct_list_payload(self):
|
|
"""Extract LPP data from direct list payload."""
|
|
payload = [{"type": "humidity", "channel": 0, "value": 65.0}]
|
|
result = extract_lpp_from_payload(payload)
|
|
assert result == [{"type": "humidity", "channel": 0, "value": 65.0}]
|
|
|
|
def test_none_payload(self):
|
|
"""None payload returns None."""
|
|
result = extract_lpp_from_payload(None)
|
|
assert result is None
|
|
|
|
def test_dict_without_lpp_key(self):
|
|
"""Dict payload without 'lpp' key returns None."""
|
|
payload = {"pubkey_pre": "abc123", "data": []}
|
|
result = extract_lpp_from_payload(payload)
|
|
assert result is None
|
|
|
|
def test_dict_with_non_list_lpp(self):
|
|
"""Dict payload with non-list 'lpp' value returns None."""
|
|
payload = {"lpp": "invalid"}
|
|
result = extract_lpp_from_payload(payload)
|
|
assert result is None
|
|
|
|
def test_unexpected_type_returns_none(self):
|
|
"""Unexpected payload type (string, int, etc.) returns None."""
|
|
assert extract_lpp_from_payload("string") is None
|
|
assert extract_lpp_from_payload(12345) is None
|
|
assert extract_lpp_from_payload(12.34) is None
|
|
|
|
def test_empty_dict(self):
|
|
"""Empty dict returns None."""
|
|
result = extract_lpp_from_payload({})
|
|
assert result is None
|
|
|
|
|
|
class TestExtractTelemetryMetrics:
|
|
"""Test extract_telemetry_metrics function."""
|
|
|
|
# ==========================================================================
|
|
# Basic scalar values
|
|
# ==========================================================================
|
|
|
|
def test_temperature_reading(self):
|
|
"""Extract temperature reading."""
|
|
lpp_data = [{"type": "temperature", "channel": 0, "value": 23.5}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 23.5}
|
|
|
|
def test_humidity_reading(self):
|
|
"""Extract humidity reading."""
|
|
lpp_data = [{"type": "humidity", "channel": 0, "value": 65}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.humidity.0": 65.0}
|
|
|
|
def test_barometer_reading(self):
|
|
"""Extract barometer/pressure reading."""
|
|
lpp_data = [{"type": "barometer", "channel": 0, "value": 1013.25}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.barometer.0": 1013.25}
|
|
|
|
def test_multiple_channels(self):
|
|
"""Different channels produce different metric keys."""
|
|
lpp_data = [
|
|
{"type": "temperature", "channel": 0, "value": 23.5},
|
|
{"type": "temperature", "channel": 1, "value": 25.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.temperature.0": 23.5,
|
|
"telemetry.temperature.1": 25.0,
|
|
}
|
|
|
|
def test_default_channel_zero(self):
|
|
"""Missing channel defaults to 0."""
|
|
lpp_data = [{"type": "temperature", "value": 20.0}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 20.0}
|
|
|
|
# ==========================================================================
|
|
# Compound values (GPS, etc.)
|
|
# ==========================================================================
|
|
|
|
def test_gps_compound_value(self):
|
|
"""Extract GPS reading with nested lat/lon/alt."""
|
|
lpp_data = [
|
|
{
|
|
"type": "gps",
|
|
"channel": 0,
|
|
"value": {"latitude": 51.5074, "longitude": -0.1278, "altitude": 11.0},
|
|
}
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.gps.0.latitude": 51.5074,
|
|
"telemetry.gps.0.longitude": -0.1278,
|
|
"telemetry.gps.0.altitude": 11.0,
|
|
}
|
|
|
|
def test_accelerometer_compound_value(self):
|
|
"""Extract accelerometer reading with x/y/z axes."""
|
|
lpp_data = [
|
|
{
|
|
"type": "accelerometer",
|
|
"channel": 0,
|
|
"value": {"x": 0.02, "y": -0.01, "z": 9.81},
|
|
}
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.accelerometer.0.x": 0.02,
|
|
"telemetry.accelerometer.0.y": -0.01,
|
|
"telemetry.accelerometer.0.z": 9.81,
|
|
}
|
|
|
|
# ==========================================================================
|
|
# Boolean values
|
|
# ==========================================================================
|
|
|
|
def test_boolean_true_value(self):
|
|
"""Boolean True is converted to 1.0."""
|
|
lpp_data = [{"type": "digital_input", "channel": 0, "value": True}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.digital_input.0": 1.0}
|
|
|
|
def test_boolean_false_value(self):
|
|
"""Boolean False is converted to 0.0."""
|
|
lpp_data = [{"type": "digital_input", "channel": 0, "value": False}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.digital_input.0": 0.0}
|
|
|
|
def test_boolean_in_compound_value(self):
|
|
"""Boolean in nested dict is converted to float."""
|
|
lpp_data = [
|
|
{
|
|
"type": "status",
|
|
"channel": 0,
|
|
"value": {"active": True, "error": False},
|
|
}
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.status.0.active": 1.0,
|
|
"telemetry.status.0.error": 0.0,
|
|
}
|
|
|
|
# ==========================================================================
|
|
# Type normalization
|
|
# ==========================================================================
|
|
|
|
def test_type_normalized_lowercase(self):
|
|
"""Sensor type is converted to lowercase."""
|
|
lpp_data = [{"type": "TEMPERATURE", "channel": 0, "value": 23.5}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert "telemetry.temperature.0" in result
|
|
|
|
def test_type_normalized_spaces_to_underscores(self):
|
|
"""Spaces in sensor type are converted to underscores."""
|
|
lpp_data = [{"type": "analog input", "channel": 0, "value": 3.3}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert "telemetry.analog_input.0" in result
|
|
|
|
def test_type_trimmed(self):
|
|
"""Whitespace around type is trimmed."""
|
|
lpp_data = [{"type": " temperature ", "channel": 0, "value": 23.5}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert "telemetry.temperature.0" in result
|
|
|
|
# ==========================================================================
|
|
# Invalid/edge cases
|
|
# ==========================================================================
|
|
|
|
def test_empty_list(self):
|
|
"""Empty LPP list returns empty dict."""
|
|
result = extract_telemetry_metrics([])
|
|
assert result == {}
|
|
|
|
def test_non_list_input(self):
|
|
"""Non-list input returns empty dict."""
|
|
result = extract_telemetry_metrics({"type": "temperature"})
|
|
assert result == {}
|
|
result = extract_telemetry_metrics("invalid")
|
|
assert result == {}
|
|
result = extract_telemetry_metrics(None)
|
|
assert result == {}
|
|
|
|
def test_skips_non_dict_readings(self):
|
|
"""Non-dict entries in list are skipped."""
|
|
lpp_data = [
|
|
{"type": "temperature", "channel": 0, "value": 23.5},
|
|
"invalid_entry",
|
|
{"type": "humidity", "channel": 0, "value": 65.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.temperature.0": 23.5,
|
|
"telemetry.humidity.0": 65.0,
|
|
}
|
|
|
|
def test_skips_missing_type(self):
|
|
"""Entries without 'type' key are skipped."""
|
|
lpp_data = [
|
|
{"channel": 0, "value": 23.5},
|
|
{"type": "humidity", "channel": 0, "value": 65.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.humidity.0": 65.0}
|
|
|
|
def test_skips_empty_type(self):
|
|
"""Entries with empty type are skipped."""
|
|
lpp_data = [
|
|
{"type": "", "channel": 0, "value": 23.5},
|
|
{"type": " ", "channel": 0, "value": 20.0},
|
|
{"type": "temperature", "channel": 0, "value": 25.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 25.0}
|
|
|
|
def test_skips_non_string_type(self):
|
|
"""Entries with non-string type are skipped."""
|
|
lpp_data = [
|
|
{"type": 123, "channel": 0, "value": 23.5},
|
|
{"type": "temperature", "channel": 0, "value": 25.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 25.0}
|
|
|
|
def test_skips_string_value(self):
|
|
"""String values are skipped (not numeric)."""
|
|
lpp_data = [
|
|
{"type": "name", "channel": 0, "value": "Sensor1"},
|
|
{"type": "temperature", "channel": 0, "value": 25.0},
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 25.0}
|
|
|
|
def test_invalid_channel_defaults_to_zero(self):
|
|
"""Non-integer channel defaults to 0."""
|
|
lpp_data = [{"type": "temperature", "channel": "invalid", "value": 23.5}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.temperature.0": 23.5}
|
|
|
|
def test_integer_value(self):
|
|
"""Integer values are converted to float."""
|
|
lpp_data = [{"type": "count", "channel": 0, "value": 42}]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {"telemetry.count.0": 42.0}
|
|
assert isinstance(result["telemetry.count.0"], float)
|
|
|
|
def test_nested_non_numeric_subvalue_skipped(self):
|
|
"""Non-numeric subvalues in compound readings are skipped."""
|
|
lpp_data = [
|
|
{
|
|
"type": "mixed",
|
|
"channel": 0,
|
|
"value": {"numeric": 42.0, "text": "hello", "valid": 3.14},
|
|
}
|
|
]
|
|
result = extract_telemetry_metrics(lpp_data)
|
|
assert result == {
|
|
"telemetry.mixed.0.numeric": 42.0,
|
|
"telemetry.mixed.0.valid": 3.14,
|
|
}
|