mirror of
https://github.com/jorijn/meshcore-stats.git
synced 2026-06-12 09:34:49 +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>
128 lines
4.1 KiB
Python
128 lines
4.1 KiB
Python
"""Retry logic and circuit breaker state management."""
|
|
|
|
import asyncio
|
|
import json
|
|
import time
|
|
from collections.abc import Callable, Coroutine
|
|
from pathlib import Path
|
|
from typing import Any, TypeVar
|
|
|
|
from . import log
|
|
from .env import get_config
|
|
|
|
T = TypeVar("T")
|
|
|
|
|
|
class CircuitBreaker:
|
|
"""
|
|
Simple circuit breaker for remote requests.
|
|
State is persisted to JSON file.
|
|
"""
|
|
|
|
def __init__(self, state_file: Path):
|
|
self.state_file = state_file
|
|
self.consecutive_failures = 0
|
|
self.cooldown_until: float = 0
|
|
self.last_success: float = 0
|
|
self._load()
|
|
|
|
def _load(self) -> None:
|
|
"""Load state from file."""
|
|
if self.state_file.exists():
|
|
try:
|
|
data = json.loads(self.state_file.read_text())
|
|
self.consecutive_failures = data.get("consecutive_failures", 0)
|
|
self.cooldown_until = data.get("cooldown_until", 0)
|
|
self.last_success = data.get("last_success", 0)
|
|
except (json.JSONDecodeError, OSError) as e:
|
|
log.warn(f"Failed to load circuit breaker state: {e}")
|
|
|
|
def _save(self) -> None:
|
|
"""Save state to file."""
|
|
self.state_file.parent.mkdir(parents=True, exist_ok=True)
|
|
data = {
|
|
"consecutive_failures": self.consecutive_failures,
|
|
"cooldown_until": self.cooldown_until,
|
|
"last_success": self.last_success,
|
|
}
|
|
self.state_file.write_text(json.dumps(data, indent=2), encoding="utf-8")
|
|
|
|
def is_open(self) -> bool:
|
|
"""Check if circuit is open (in cooldown)."""
|
|
return time.time() < self.cooldown_until
|
|
|
|
def cooldown_remaining(self) -> int:
|
|
"""Return seconds remaining in cooldown, or 0 if not in cooldown."""
|
|
remaining = self.cooldown_until - time.time()
|
|
return max(0, int(remaining))
|
|
|
|
def record_success(self) -> None:
|
|
"""Record a successful call."""
|
|
self.consecutive_failures = 0
|
|
self.last_success = time.time()
|
|
self._save()
|
|
|
|
def record_failure(self, max_failures: int, cooldown_s: int) -> None:
|
|
"""Record a failed call and potentially open the circuit."""
|
|
self.consecutive_failures += 1
|
|
if self.consecutive_failures >= max_failures:
|
|
self.cooldown_until = time.time() + cooldown_s
|
|
log.warn(
|
|
f"Circuit breaker opened: {self.consecutive_failures} failures, "
|
|
f"cooldown for {cooldown_s}s"
|
|
)
|
|
self._save()
|
|
|
|
def to_dict(self) -> dict:
|
|
"""Return state as dict for snapshot."""
|
|
return {
|
|
"consecutive_failures": self.consecutive_failures,
|
|
"cooldown_until": self.cooldown_until,
|
|
"last_success": self.last_success,
|
|
"is_open": self.is_open(),
|
|
"cooldown_remaining_s": self.cooldown_remaining(),
|
|
}
|
|
|
|
|
|
async def with_retries(
|
|
fn: Callable[[], Coroutine[Any, Any, T]],
|
|
attempts: int = 2,
|
|
backoff_s: float = 4.0,
|
|
name: str = "operation",
|
|
) -> tuple[bool, T | None, Exception | None]:
|
|
"""
|
|
Execute async function with retries.
|
|
|
|
Args:
|
|
fn: Async function to call
|
|
attempts: Max number of attempts
|
|
backoff_s: Seconds to wait between retries
|
|
name: Name for logging
|
|
|
|
Returns:
|
|
(success, result, last_exception)
|
|
"""
|
|
last_exception: Exception | None = None
|
|
|
|
for attempt in range(1, attempts + 1):
|
|
try:
|
|
result = await fn()
|
|
if attempt > 1:
|
|
log.info(f"{name}: succeeded on attempt {attempt}/{attempts}")
|
|
return (True, result, None)
|
|
except Exception as e:
|
|
last_exception = e
|
|
log.info(f"{name}: attempt {attempt}/{attempts} failed: {e}")
|
|
if attempt < attempts:
|
|
log.debug(f"{name}: retrying in {backoff_s}s...")
|
|
await asyncio.sleep(backoff_s)
|
|
|
|
return (False, None, last_exception)
|
|
|
|
|
|
def get_repeater_circuit_breaker() -> CircuitBreaker:
|
|
"""Get the circuit breaker for repeater requests."""
|
|
cfg = get_config()
|
|
state_file = cfg.state_dir / "repeater_circuit.json"
|
|
return CircuitBreaker(state_file)
|