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>
302 lines
8.5 KiB
Python
Executable File
302 lines
8.5 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""
|
|
Phase 4: Render reports from SQLite database.
|
|
|
|
Generates monthly and yearly statistics reports in HTML, TXT, and JSON
|
|
formats for both repeater and companion nodes.
|
|
|
|
Output structure:
|
|
out/reports/
|
|
index.html # Reports listing
|
|
repeater/
|
|
2025/
|
|
index.html # Yearly report (HTML)
|
|
report.txt # Yearly report (TXT)
|
|
report.json # Yearly report (JSON)
|
|
12/
|
|
index.html # Monthly report (HTML)
|
|
report.txt # Monthly report (TXT)
|
|
report.json # Monthly report (JSON)
|
|
companion/
|
|
... # Same structure
|
|
"""
|
|
|
|
import calendar
|
|
import json
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# Add src to path for imports
|
|
sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
|
|
|
|
from meshmon import log
|
|
from meshmon.db import init_db
|
|
from meshmon.env import get_config
|
|
from meshmon.html import render_report_page, render_reports_index
|
|
from meshmon.reports import (
|
|
LocationInfo,
|
|
aggregate_monthly,
|
|
aggregate_yearly,
|
|
format_monthly_txt,
|
|
format_yearly_txt,
|
|
get_available_periods,
|
|
monthly_to_json,
|
|
yearly_to_json,
|
|
)
|
|
|
|
|
|
def safe_write(path: Path, content: str) -> bool:
|
|
"""Write content to file with error handling.
|
|
|
|
Args:
|
|
path: File path to write to
|
|
content: Content to write
|
|
|
|
Returns:
|
|
True if write succeeded, False otherwise
|
|
"""
|
|
try:
|
|
path.write_text(content, encoding="utf-8")
|
|
return True
|
|
except OSError as e:
|
|
log.error(f"Failed to write {path}: {e}")
|
|
return False
|
|
|
|
|
|
def get_node_name(role: str) -> str:
|
|
"""Get display name for a node role from configuration."""
|
|
cfg = get_config()
|
|
if role == "repeater":
|
|
return cfg.repeater_display_name
|
|
elif role == "companion":
|
|
return cfg.companion_display_name
|
|
return role.capitalize()
|
|
|
|
|
|
def get_location() -> LocationInfo:
|
|
"""Get location info from config."""
|
|
cfg = get_config()
|
|
return LocationInfo(
|
|
name=cfg.report_location_name,
|
|
lat=cfg.report_lat,
|
|
lon=cfg.report_lon,
|
|
elev=cfg.report_elev,
|
|
)
|
|
|
|
|
|
def render_monthly_report(
|
|
role: str,
|
|
year: int,
|
|
month: int,
|
|
prev_period: tuple[int, int] | None = None,
|
|
next_period: tuple[int, int] | None = None,
|
|
) -> None:
|
|
"""Render monthly report in all formats.
|
|
|
|
Args:
|
|
role: "companion" or "repeater"
|
|
year: Report year
|
|
month: Report month (1-12)
|
|
prev_period: (year, month) of previous report, or None
|
|
next_period: (year, month) of next report, or None
|
|
"""
|
|
cfg = get_config()
|
|
node_name = get_node_name(role)
|
|
location = get_location()
|
|
|
|
log.info(f"Aggregating {role} monthly report for {year}-{month:02d}...")
|
|
agg = aggregate_monthly(role, year, month)
|
|
|
|
if not agg.daily:
|
|
log.warn(f"No data for {role} {year}-{month:02d}, skipping")
|
|
return
|
|
|
|
# Create output directory
|
|
out_dir = cfg.out_dir / "reports" / role / str(year) / f"{month:02d}"
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Build prev/next navigation
|
|
prev_report = None
|
|
next_report = None
|
|
if prev_period:
|
|
py, pm = prev_period
|
|
prev_report = {
|
|
"url": f"/reports/{role}/{py}/{pm:02d}/",
|
|
"label": f"{calendar.month_abbr[pm]} {py}",
|
|
}
|
|
if next_period:
|
|
ny, nm = next_period
|
|
next_report = {
|
|
"url": f"/reports/{role}/{ny}/{nm:02d}/",
|
|
"label": f"{calendar.month_abbr[nm]} {ny}",
|
|
}
|
|
|
|
# HTML
|
|
html = render_report_page(agg, node_name, "monthly", prev_report, next_report)
|
|
safe_write(out_dir / "index.html", html)
|
|
|
|
# TXT (WeeWX-style)
|
|
txt = format_monthly_txt(agg, node_name, location)
|
|
safe_write(out_dir / "report.txt", txt)
|
|
|
|
# JSON
|
|
json_data = monthly_to_json(agg)
|
|
safe_write(out_dir / "report.json", json.dumps(json_data, indent=2))
|
|
|
|
log.debug(f"Wrote monthly report: {out_dir}")
|
|
|
|
|
|
def render_yearly_report(
|
|
role: str,
|
|
year: int,
|
|
prev_year: int | None = None,
|
|
next_year: int | None = None,
|
|
) -> None:
|
|
"""Render yearly report in all formats.
|
|
|
|
Args:
|
|
role: "companion" or "repeater"
|
|
year: Report year
|
|
prev_year: Previous year with data, or None
|
|
next_year: Next year with data, or None
|
|
"""
|
|
cfg = get_config()
|
|
node_name = get_node_name(role)
|
|
location = get_location()
|
|
|
|
log.info(f"Aggregating {role} yearly report for {year}...")
|
|
agg = aggregate_yearly(role, year)
|
|
|
|
if not agg.monthly:
|
|
log.warn(f"No data for {role} {year}, skipping")
|
|
return
|
|
|
|
# Create output directory
|
|
out_dir = cfg.out_dir / "reports" / role / str(year)
|
|
out_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
# Build prev/next navigation
|
|
prev_report = None
|
|
next_report = None
|
|
if prev_year:
|
|
prev_report = {
|
|
"url": f"/reports/{role}/{prev_year}/",
|
|
"label": str(prev_year),
|
|
}
|
|
if next_year:
|
|
next_report = {
|
|
"url": f"/reports/{role}/{next_year}/",
|
|
"label": str(next_year),
|
|
}
|
|
|
|
# HTML
|
|
html = render_report_page(agg, node_name, "yearly", prev_report, next_report)
|
|
safe_write(out_dir / "index.html", html)
|
|
|
|
# TXT (WeeWX-style)
|
|
txt = format_yearly_txt(agg, node_name, location)
|
|
safe_write(out_dir / "report.txt", txt)
|
|
|
|
# JSON
|
|
json_data = yearly_to_json(agg)
|
|
safe_write(out_dir / "report.json", json.dumps(json_data, indent=2))
|
|
|
|
log.debug(f"Wrote yearly report: {out_dir}")
|
|
|
|
|
|
def build_reports_index_data() -> list[dict]:
|
|
"""Build data structure for reports index page.
|
|
|
|
Returns:
|
|
List of section dicts with 'role' and 'years' keys
|
|
"""
|
|
sections = []
|
|
|
|
for role in ["repeater", "companion"]:
|
|
periods = get_available_periods(role)
|
|
if not periods:
|
|
sections.append({"role": role, "years": []})
|
|
continue
|
|
|
|
# Group by year
|
|
years_data = {}
|
|
for year, month in periods:
|
|
if year not in years_data:
|
|
years_data[year] = []
|
|
years_data[year].append({
|
|
"month": month,
|
|
"name": calendar.month_name[month],
|
|
})
|
|
|
|
# Build years list, sorted descending
|
|
years = []
|
|
for year in sorted(years_data.keys(), reverse=True):
|
|
years.append({
|
|
"year": year,
|
|
"months": sorted(years_data[year], key=lambda m: m["month"]),
|
|
})
|
|
|
|
sections.append({"role": role, "years": years})
|
|
|
|
return sections
|
|
|
|
|
|
def main():
|
|
"""Generate all statistics reports."""
|
|
# Ensure database is initialized
|
|
init_db()
|
|
|
|
cfg = get_config()
|
|
|
|
log.info("Generating reports from database...")
|
|
|
|
# Ensure base reports directory exists
|
|
(cfg.out_dir / "reports").mkdir(parents=True, exist_ok=True)
|
|
|
|
total_monthly = 0
|
|
total_yearly = 0
|
|
|
|
for role in ["repeater", "companion"]:
|
|
periods = get_available_periods(role)
|
|
if not periods:
|
|
log.info(f"No data found for {role}")
|
|
continue
|
|
|
|
log.info(f"Found {len(periods)} months of data for {role}")
|
|
|
|
# Sort periods chronologically for prev/next navigation
|
|
sorted_periods = sorted(periods)
|
|
|
|
# Render monthly reports with prev/next links
|
|
for i, (year, month) in enumerate(sorted_periods):
|
|
prev_period = sorted_periods[i - 1] if i > 0 else None
|
|
next_period = sorted_periods[i + 1] if i < len(sorted_periods) - 1 else None
|
|
render_monthly_report(role, year, month, prev_period, next_period)
|
|
total_monthly += 1
|
|
|
|
# Get unique years
|
|
years = sorted(set(y for y, m in periods))
|
|
|
|
# Render yearly reports with prev/next links
|
|
for i, year in enumerate(years):
|
|
prev_year = years[i - 1] if i > 0 else None
|
|
next_year = years[i + 1] if i < len(years) - 1 else None
|
|
render_yearly_report(role, year, prev_year, next_year)
|
|
total_yearly += 1
|
|
|
|
# Render reports index
|
|
log.info("Rendering reports index...")
|
|
sections = build_reports_index_data()
|
|
index_html = render_reports_index(sections)
|
|
safe_write(cfg.out_dir / "reports" / "index.html", index_html)
|
|
|
|
log.info(
|
|
f"Generated {total_monthly} monthly + {total_yearly} yearly reports "
|
|
f"to {cfg.out_dir / 'reports'}"
|
|
)
|
|
log.info("Report generation complete")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|