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>
180 lines
6.3 KiB
Python
180 lines
6.3 KiB
Python
"""Tests for database initialization and migrations."""
|
|
|
|
import sqlite3
|
|
|
|
import pytest
|
|
|
|
from meshmon.db import (
|
|
_get_schema_version,
|
|
get_connection,
|
|
init_db,
|
|
)
|
|
|
|
|
|
class TestInitDb:
|
|
"""Tests for init_db function."""
|
|
|
|
def test_creates_database_file(self, db_path, configured_env):
|
|
"""Creates database file if it doesn't exist."""
|
|
assert not db_path.exists()
|
|
|
|
init_db(db_path)
|
|
|
|
assert db_path.exists()
|
|
|
|
def test_creates_parent_directories(self, tmp_path, configured_env):
|
|
"""Creates parent directories if needed."""
|
|
nested_path = tmp_path / "deep" / "nested" / "metrics.db"
|
|
assert not nested_path.parent.exists()
|
|
|
|
init_db(nested_path)
|
|
|
|
assert nested_path.exists()
|
|
|
|
def test_applies_migrations(self, db_path, configured_env):
|
|
"""Applies schema migrations."""
|
|
init_db(db_path)
|
|
|
|
with get_connection(db_path, readonly=True) as conn:
|
|
version = _get_schema_version(conn)
|
|
assert version >= 1
|
|
|
|
def test_safe_to_call_multiple_times(self, db_path, configured_env):
|
|
"""Can be called multiple times without error."""
|
|
init_db(db_path)
|
|
init_db(db_path) # Should not raise
|
|
init_db(db_path) # Should not raise
|
|
|
|
with get_connection(db_path, readonly=True) as conn:
|
|
version = _get_schema_version(conn)
|
|
assert version >= 1
|
|
|
|
def test_enables_wal_mode(self, db_path, configured_env):
|
|
"""Enables WAL journal mode."""
|
|
init_db(db_path)
|
|
|
|
conn = sqlite3.connect(db_path)
|
|
try:
|
|
cursor = conn.execute("PRAGMA journal_mode")
|
|
mode = cursor.fetchone()[0]
|
|
assert mode.lower() == "wal"
|
|
finally:
|
|
conn.close()
|
|
|
|
def test_creates_metrics_table(self, db_path, configured_env):
|
|
"""Creates metrics table with correct schema."""
|
|
init_db(db_path)
|
|
|
|
with get_connection(db_path, readonly=True) as conn:
|
|
# Check table exists
|
|
cursor = conn.execute(
|
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='metrics'"
|
|
)
|
|
assert cursor.fetchone() is not None
|
|
|
|
# Check columns
|
|
cursor = conn.execute("PRAGMA table_info(metrics)")
|
|
columns = {row["name"]: row for row in cursor}
|
|
assert "ts" in columns
|
|
assert "role" in columns
|
|
assert "metric" in columns
|
|
assert "value" in columns
|
|
|
|
def test_creates_db_meta_table(self, db_path, configured_env):
|
|
"""Creates db_meta table for schema versioning."""
|
|
init_db(db_path)
|
|
|
|
with get_connection(db_path, readonly=True) as conn:
|
|
cursor = conn.execute(
|
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='db_meta'"
|
|
)
|
|
assert cursor.fetchone() is not None
|
|
|
|
|
|
class TestGetConnection:
|
|
"""Tests for get_connection context manager."""
|
|
|
|
def test_returns_connection(self, initialized_db):
|
|
"""Returns a working connection."""
|
|
with get_connection(initialized_db) as conn:
|
|
assert conn is not None
|
|
cursor = conn.execute("SELECT 1")
|
|
assert cursor.fetchone()[0] == 1
|
|
|
|
def test_row_factory_enabled(self, initialized_db):
|
|
"""Row factory is set to sqlite3.Row."""
|
|
with get_connection(initialized_db) as conn:
|
|
conn.execute(
|
|
"INSERT INTO metrics (ts, role, metric, value) VALUES (1, 'companion', 'test', 1.0)"
|
|
)
|
|
with get_connection(initialized_db, readonly=True) as conn:
|
|
cursor = conn.execute("SELECT * FROM metrics WHERE metric = 'test'")
|
|
row = cursor.fetchone()
|
|
# sqlite3.Row supports dict-like access
|
|
assert row["metric"] == "test"
|
|
assert row["value"] == 1.0
|
|
|
|
def test_commits_on_success(self, initialized_db):
|
|
"""Commits transaction on normal exit."""
|
|
with get_connection(initialized_db) as conn:
|
|
conn.execute(
|
|
"INSERT INTO metrics (ts, role, metric, value) VALUES (1, 'companion', 'test', 1.0)"
|
|
)
|
|
|
|
# Check data persisted
|
|
with get_connection(initialized_db, readonly=True) as conn:
|
|
cursor = conn.execute("SELECT COUNT(*) FROM metrics WHERE metric = 'test'")
|
|
assert cursor.fetchone()[0] == 1
|
|
|
|
def test_rollback_on_exception(self, initialized_db):
|
|
"""Rolls back transaction on exception."""
|
|
try:
|
|
with get_connection(initialized_db) as conn:
|
|
conn.execute(
|
|
"INSERT INTO metrics (ts, role, metric, value) VALUES (2, 'companion', 'test2', 1.0)"
|
|
)
|
|
raise ValueError("Test error")
|
|
except ValueError:
|
|
pass
|
|
|
|
# Check data was rolled back
|
|
with get_connection(initialized_db, readonly=True) as conn:
|
|
cursor = conn.execute("SELECT COUNT(*) FROM metrics WHERE metric = 'test2'")
|
|
assert cursor.fetchone()[0] == 0
|
|
|
|
def test_readonly_mode(self, initialized_db):
|
|
"""Read-only mode prevents writes."""
|
|
with (
|
|
get_connection(initialized_db, readonly=True) as conn,
|
|
pytest.raises(sqlite3.OperationalError),
|
|
):
|
|
conn.execute(
|
|
"INSERT INTO metrics (ts, role, metric, value) VALUES (1, 'companion', 'test', 1.0)"
|
|
)
|
|
|
|
|
|
class TestMigrationsDirectory:
|
|
"""Tests for migrations directory and files."""
|
|
|
|
def test_migrations_dir_exists(self, migrations_dir):
|
|
"""Migrations directory exists."""
|
|
assert migrations_dir.exists()
|
|
assert migrations_dir.is_dir()
|
|
|
|
def test_has_initial_migration(self, migrations_dir):
|
|
"""Has at least the initial schema migration."""
|
|
sql_files = list(migrations_dir.glob("*.sql"))
|
|
assert len(sql_files) >= 1
|
|
|
|
# Check for 001 prefixed file
|
|
initial = [f for f in sql_files if f.stem.startswith("001")]
|
|
assert len(initial) == 1
|
|
|
|
def test_migrations_are_numbered(self, migrations_dir):
|
|
"""Migration files follow NNN_description.sql pattern."""
|
|
import re
|
|
|
|
pattern = re.compile(r"^\d{3}_.*\.sql$")
|
|
for sql_file in migrations_dir.glob("*.sql"):
|
|
assert pattern.match(sql_file.name), f"{sql_file.name} doesn't match pattern"
|