mirror of
https://github.com/jorijn/meshcore-stats.git
synced 2026-05-01 02:52:46 +02:00
a9f6926104
* 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>
196 lines
6.2 KiB
Python
196 lines
6.2 KiB
Python
"""Tests for write_site and related output functions."""
|
|
|
|
|
|
import pytest
|
|
|
|
from meshmon.db import get_latest_metrics
|
|
from meshmon.html import (
|
|
copy_static_assets,
|
|
write_site,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def metrics_rows(populated_db):
|
|
"""Get latest metrics rows for both roles."""
|
|
companion_row = get_latest_metrics("companion")
|
|
repeater_row = get_latest_metrics("repeater")
|
|
return {"companion": companion_row, "repeater": repeater_row}
|
|
|
|
|
|
class TestWriteSite:
|
|
"""Tests for write_site function."""
|
|
|
|
def test_creates_output_directory(self, configured_env, metrics_rows):
|
|
"""Creates output directory if it doesn't exist."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
assert out_dir.exists()
|
|
|
|
def test_generates_repeater_pages(self, configured_env, metrics_rows):
|
|
"""Generates repeater HTML pages at root."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
# Repeater pages are at root
|
|
for period in ["day", "week", "month", "year"]:
|
|
assert (out_dir / f"{period}.html").exists()
|
|
|
|
def test_generates_companion_pages(self, configured_env, metrics_rows):
|
|
"""Generates companion HTML pages in subdirectory."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
companion_dir = out_dir / "companion"
|
|
assert companion_dir.exists()
|
|
for period in ["day", "week", "month", "year"]:
|
|
assert (companion_dir / f"{period}.html").exists()
|
|
|
|
def test_html_files_are_valid(self, configured_env, metrics_rows):
|
|
"""Generated HTML files have valid structure."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
html_file = out_dir / "day.html"
|
|
content = html_file.read_text()
|
|
|
|
assert "<!DOCTYPE html>" in content or "<!doctype html>" in content.lower()
|
|
assert "</html>" in content
|
|
|
|
def test_handles_empty_database(self, configured_env, initialized_db):
|
|
"""Handles empty database gracefully."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
# Should not raise - pass None for empty database
|
|
write_site(None, None)
|
|
|
|
# Should still generate pages
|
|
assert (out_dir / "day.html").exists()
|
|
|
|
|
|
class TestCopyStaticAssets:
|
|
"""Tests for copy_static_assets function."""
|
|
|
|
def test_copies_css(self, configured_env):
|
|
"""Copies CSS stylesheet."""
|
|
out_dir = configured_env["out_dir"]
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
copy_static_assets()
|
|
|
|
css_file = out_dir / "styles.css"
|
|
assert css_file.exists()
|
|
|
|
def test_copies_javascript(self, configured_env):
|
|
"""Copies JavaScript files."""
|
|
out_dir = configured_env["out_dir"]
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
copy_static_assets()
|
|
|
|
js_file = out_dir / "chart-tooltip.js"
|
|
assert js_file.exists()
|
|
|
|
def test_css_is_valid(self, configured_env):
|
|
"""Copied CSS has expected content."""
|
|
out_dir = configured_env["out_dir"]
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
copy_static_assets()
|
|
|
|
css_file = out_dir / "styles.css"
|
|
content = css_file.read_text()
|
|
|
|
# Should have CSS variables
|
|
assert "--" in content or "{" in content
|
|
|
|
def test_requires_output_directory(self, configured_env):
|
|
"""Requires output directory to exist."""
|
|
out_dir = configured_env["out_dir"]
|
|
# Ensure out_dir exists
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Should not raise when directory exists
|
|
copy_static_assets()
|
|
|
|
assert (out_dir / "styles.css").exists()
|
|
|
|
def test_overwrites_existing(self, configured_env):
|
|
"""Overwrites existing static files."""
|
|
out_dir = configured_env["out_dir"]
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Create a fake CSS file
|
|
css_file = out_dir / "styles.css"
|
|
css_file.write_text("/* fake */")
|
|
|
|
copy_static_assets()
|
|
|
|
# Should be overwritten with real content
|
|
content = css_file.read_text()
|
|
assert "/* fake */" not in content or len(content) > 20
|
|
|
|
|
|
class TestHtmlOutput:
|
|
"""Tests for HTML output structure."""
|
|
|
|
def test_pages_include_navigation(self, configured_env, metrics_rows):
|
|
"""HTML pages include navigation."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
content = (out_dir / "day.html").read_text()
|
|
|
|
# Should have links to other periods
|
|
assert "week" in content.lower()
|
|
assert "month" in content.lower()
|
|
|
|
def test_pages_include_meta_tags(self, configured_env, metrics_rows):
|
|
"""HTML pages include meta tags."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
content = (out_dir / "day.html").read_text()
|
|
|
|
assert "<meta" in content
|
|
assert "charset" in content.lower() or "utf-8" in content.lower()
|
|
|
|
def test_pages_include_title(self, configured_env, metrics_rows):
|
|
"""HTML pages include title tag."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
content = (out_dir / "day.html").read_text()
|
|
|
|
assert "<title>" in content
|
|
assert "</title>" in content
|
|
|
|
def test_pages_reference_css(self, configured_env, metrics_rows):
|
|
"""HTML pages reference stylesheet."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
content = (out_dir / "day.html").read_text()
|
|
|
|
assert "styles.css" in content
|
|
|
|
def test_companion_pages_relative_css(self, configured_env, metrics_rows):
|
|
"""Companion pages use relative path to CSS."""
|
|
out_dir = configured_env["out_dir"]
|
|
|
|
write_site(metrics_rows["companion"], metrics_rows["repeater"])
|
|
|
|
content = (out_dir / "companion" / "day.html").read_text()
|
|
|
|
# Should reference parent directory CSS
|
|
assert "../styles.css" in content or "styles.css" in content
|