bambuddy/backend/tests/integration/test_system_api.py
maziggy 4dcd37bc87 feat(system): NTP-gate state on /api/v1/system/appliance
Extends the appliance endpoint that landed in the previous commit with a
  time_synced field, sourced from /run/bambuddy/time-synced (the appliance's
  ntp-gate.sh writes this once chronyd reports sync, or with a "warning"
  marker after the 3-minute timeout). The RPi 5 has no battery-backed RTC,
  so on a fresh boot the system clock is wrong until NTP catches up -- JWT
  expiries and TLS certificate validity windows depend on this being right.
  Exposing the gate lets the SPA render a "time not synced" indicator while
  that's still true and clear it once "ok" comes through.

  backend/app/core/local_config.py

  New read_ntp_gate(path) function alongside read_local_toml. Three states:

    "ok"       chrony reported sync within the 3-minute window
    "warning"  3-minute timeout elapsed without sync; user already waited
               and the wizard proceeded with a degraded clock
    None       file absent (non-appliance install), OSError, empty content,
               unknown marker, or binary garbage -- "unknown / don't gate"

  Defensive read mode (errors="replace") survives non-utf8 content without
  crashing. Module docstring broadened from "local.toml reader" to "small
  readers for appliance-set state files".

  backend/app/api/routes/system.py

  /system/appliance now returns:

    {hostname, timezone, locale, time_synced}

  with the same no-auth posture: bootstrap surfaces (i18n init, time-sync
  banner) read this before auth might be set up, and the contents are
  non-secret (user-set defaults + a public sync flag). The endpoint
  docstring expands to explain the RTC motivation -- otherwise the
  time_synced field reads like a leftover.
2026-06-22 14:23:30 +02:00

605 lines
26 KiB
Python

"""Integration tests for System API endpoints.
Tests the full request/response cycle for /api/v1/system/ endpoints.
"""
from unittest.mock import MagicMock, patch
import pytest
from httpx import AsyncClient
class TestSystemAPI:
"""Integration tests for /api/v1/system/ endpoints."""
# ========================================================================
# System Info Endpoint
# ========================================================================
@pytest.mark.asyncio
@pytest.mark.integration
async def test_get_system_info(self, async_client: AsyncClient):
"""Verify system info endpoint returns expected structure."""
# Mock psutil to avoid system-specific values
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
assert response.status_code == 200
result = response.json()
# Verify top-level structure
assert "app" in result
assert "database" in result
assert "printers" in result
assert "storage" in result
assert "system" in result
assert "memory" in result
assert "cpu" in result
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_app_section(self, async_client: AsyncClient):
"""Verify app section contains version and directory info."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
result = response.json()
app_info = result["app"]
assert "version" in app_info
assert "base_dir" in app_info
assert "archive_dir" in app_info
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_database_section(self, async_client: AsyncClient):
"""Verify database section contains counts and statistics."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
result = response.json()
db_info = result["database"]
assert "archives" in db_info
assert "archives_completed" in db_info
assert "archives_failed" in db_info
assert "printers" in db_info
assert "filaments" in db_info
assert "projects" in db_info
assert "smart_plugs" in db_info
assert "total_print_time_seconds" in db_info
assert "total_print_time_formatted" in db_info
assert "total_filament_grams" in db_info
assert "total_filament_kg" in db_info
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_storage_section(self, async_client: AsyncClient):
"""Verify storage section contains disk usage info."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
result = response.json()
storage_info = result["storage"]
assert "archive_size_bytes" in storage_info
assert "archive_size_formatted" in storage_info
assert "database_size_bytes" in storage_info
assert "database_size_formatted" in storage_info
assert "disk_total_bytes" in storage_info
assert "disk_total_formatted" in storage_info
assert "disk_used_bytes" in storage_info
assert "disk_free_bytes" in storage_info
assert "disk_percent_used" in storage_info
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_memory_section(self, async_client: AsyncClient):
"""Verify memory section contains RAM usage info."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
result = response.json()
memory_info = result["memory"]
assert "total_bytes" in memory_info
assert "total_formatted" in memory_info
assert "available_bytes" in memory_info
assert "used_bytes" in memory_info
assert "percent_used" in memory_info
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_cpu_section(self, async_client: AsyncClient):
"""Verify CPU section contains processor info."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
result = response.json()
cpu_info = result["cpu"]
assert "count" in cpu_info
assert "count_logical" in cpu_info
assert "percent" in cpu_info
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_printers_section(self, async_client: AsyncClient, printer_factory):
"""Verify printers section contains connected printer info."""
# Create a test printer
_printer = await printer_factory(name="Test Printer", model="X1C")
with (
patch("backend.app.api.routes.system.psutil") as mock_psutil,
patch("backend.app.api.routes.system.printer_manager") as mock_pm,
):
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
# Mock no connected printers for simplicity
mock_pm._clients = {}
response = await async_client.get("/api/v1/system/info")
result = response.json()
printers_info = result["printers"]
assert "total" in printers_info
assert "connected" in printers_info
assert "connected_list" in printers_info
assert printers_info["total"] >= 1 # At least our test printer
@pytest.mark.asyncio
@pytest.mark.integration
async def test_system_info_with_archives(self, async_client: AsyncClient, printer_factory, archive_factory):
"""Verify database stats include archive counts.
Post-#1593 `total_print_time_seconds` is summed from
`PrintLogEntry.duration_seconds` (the *actual* per-run duration),
not `PrintArchive.print_time_seconds` (the slicer estimate). The
archive_factory derives the run's duration from
``completed_at - started_at`` on the archive, so the test sets
those so each run carries a duration the system route can sum.
"""
from datetime import datetime, timezone
printer = await printer_factory()
await archive_factory(
printer.id,
status="completed",
print_time_seconds=3600,
started_at=datetime(2026, 5, 1, 10, 0, tzinfo=timezone.utc),
completed_at=datetime(2026, 5, 1, 11, 0, tzinfo=timezone.utc),
)
await archive_factory(
printer.id,
status="failed",
print_time_seconds=1800,
started_at=datetime(2026, 5, 2, 10, 0, tzinfo=timezone.utc),
completed_at=datetime(2026, 5, 2, 10, 30, tzinfo=timezone.utc),
)
with (
patch("backend.app.api.routes.system.psutil") as mock_psutil,
patch("backend.app.api.routes.system.printer_manager") as mock_pm,
):
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700000000.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
mock_pm._clients = {}
response = await async_client.get("/api/v1/system/info")
result = response.json()
db_info = result["database"]
assert db_info["archives"] >= 2
assert db_info["archives_completed"] >= 1
assert db_info["archives_failed"] >= 1
assert db_info["total_print_time_seconds"] >= 5400
@pytest.mark.asyncio
@pytest.mark.integration
async def test_boot_time_uses_pid1_create_time(self, async_client: AsyncClient):
"""#1690: container installs (Docker/LXC) share the host kernel, so
psutil.boot_time() returns the host's boot time instead of the
container's. Reading PID 1's create_time gives the container start
time on containers and matches host boot on bare metal."""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
# Host boot is FOUR DAYS earlier than the container's PID 1 start.
# The route must report the PID 1 value, not the host value.
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700345600.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
assert response.status_code == 200
result = response.json()
assert result["system"]["boot_time"].startswith("2023-11-18T") # 1700345600 UTC
# PID 1 was queried with pid=1 (not the worker pid).
mock_psutil.Process.assert_called_with(1)
@pytest.mark.asyncio
@pytest.mark.integration
async def test_boot_time_falls_back_to_psutil_boot_time_on_pid1_failure(self, async_client: AsyncClient):
"""If PID 1 is unreadable (rare — locked-down container, /proc not
mounted), fall back to psutil.boot_time() so the endpoint still
returns 200 with the best available answer."""
import psutil as real_psutil
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
# Use the real exception classes so the route's except clause matches.
mock_psutil.Error = real_psutil.Error
mock_psutil.Process.side_effect = real_psutil.NoSuchProcess(1)
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
assert response.status_code == 200
result = response.json()
assert result["system"]["boot_time"].startswith("2023-11-14T") # 1700000000 UTC
@pytest.mark.asyncio
@pytest.mark.integration
async def test_boot_time_isoformat_carries_utc_marker(self, async_client: AsyncClient):
"""#1690 follow-up: the boot_time string must include a UTC tz marker.
Without it the frontend's parseUTCDate(...) appends 'Z' to a naive-
local-time string, treats it as UTC, and converts to local — applying
the local offset twice. The reporter (UTC+3) saw boot_time +3h ahead
even though uptime was correct (uptime is computed backend-side from
two naive-local values whose delta is right). The fix is to make both
ends tz-aware UTC and emit an explicit offset.
"""
with patch("backend.app.api.routes.system.psutil") as mock_psutil:
mock_psutil.disk_usage.return_value = MagicMock(
total=500000000000, used=250000000000, free=250000000000, percent=50.0
)
mock_psutil.virtual_memory.return_value = MagicMock(
total=16000000000, available=8000000000, used=8000000000, percent=50.0
)
mock_psutil.boot_time.return_value = 1700000000.0
mock_psutil.Process.return_value.create_time.return_value = 1700345600.0
mock_psutil.cpu_count.return_value = 4
mock_psutil.cpu_percent.return_value = 25.0
response = await async_client.get("/api/v1/system/info")
assert response.status_code == 200
boot_time = response.json()["system"]["boot_time"]
assert boot_time.endswith("+00:00") or boot_time.endswith("Z"), (
f"boot_time {boot_time!r} must carry a UTC tz marker; without one the "
"frontend double-converts via parseUTCDate"
)
class TestSystemHelperFunctions:
"""Tests for system info helper functions."""
def test_format_bytes_bytes(self):
"""Verify format_bytes handles bytes correctly."""
from backend.app.api.routes.system import format_bytes
assert format_bytes(500) == "500.0 B"
def test_format_bytes_kilobytes(self):
"""Verify format_bytes handles kilobytes correctly."""
from backend.app.api.routes.system import format_bytes
result = format_bytes(1536)
assert "KB" in result
def test_format_bytes_megabytes(self):
"""Verify format_bytes handles megabytes correctly."""
from backend.app.api.routes.system import format_bytes
result = format_bytes(1536 * 1024)
assert "MB" in result
def test_format_bytes_gigabytes(self):
"""Verify format_bytes handles gigabytes correctly."""
from backend.app.api.routes.system import format_bytes
result = format_bytes(1536 * 1024 * 1024)
assert "GB" in result
def test_format_uptime_minutes(self):
"""Verify format_uptime handles minutes correctly."""
from backend.app.api.routes.system import format_uptime
result = format_uptime(300) # 5 minutes
assert "5m" in result
def test_format_uptime_hours(self):
"""Verify format_uptime handles hours correctly."""
from backend.app.api.routes.system import format_uptime
result = format_uptime(7200) # 2 hours
assert "2h" in result
def test_format_uptime_days(self):
"""Verify format_uptime handles days correctly."""
from backend.app.api.routes.system import format_uptime
result = format_uptime(86400 * 2 + 3600 * 5) # 2 days 5 hours
assert "2d" in result
assert "5h" in result
def test_format_uptime_less_than_minute(self):
"""Verify format_uptime handles < 1 minute correctly."""
from backend.app.api.routes.system import format_uptime
result = format_uptime(30) # 30 seconds
assert result == "< 1m"
class TestSystemHealthAPI:
"""Integration tests for GET /api/v1/system/health (log-health scan)."""
@pytest.mark.asyncio
@pytest.mark.integration
async def test_health_clean_log(self, async_client: AsyncClient, tmp_path, monkeypatch):
"""A log with no known issues returns an empty, healthy result."""
from backend.app.core.config import settings
(tmp_path / "bambuddy.log").write_text(
"2026-05-22 10:00:00,000 INFO [backend.app.main] Application startup complete\n",
encoding="utf-8",
)
monkeypatch.setattr(settings, "log_dir", tmp_path)
response = await async_client.get("/api/v1/system/health")
assert response.status_code == 200
result = response.json()
assert result["log_available"] is True
assert result["findings"] == []
assert result["summary"]["total"] == 0
@pytest.mark.asyncio
@pytest.mark.integration
async def test_health_detects_known_issue(self, async_client: AsyncClient, tmp_path, monkeypatch):
"""A known signature in the log surfaces as a finding."""
from backend.app.core.config import settings
(tmp_path / "bambuddy.log").write_text(
"2026-05-22 10:00:00,000 WARNING [backend.app.services.bambu_ftp] "
"FTP connection permission error to 10.0.0.9: 530\n",
encoding="utf-8",
)
monkeypatch.setattr(settings, "log_dir", tmp_path)
response = await async_client.get("/api/v1/system/health")
assert response.status_code == 200
result = response.json()
ids = [f["signature_id"] for f in result["findings"]]
assert "ftp-auth-rejected" in ids
assert result["summary"]["layer8"] >= 1
class TestSystemApplianceAPI:
"""Integration tests for GET /api/v1/system/appliance (appliance locale defaults)."""
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_returns_nulls_when_no_local_toml(
self, async_client: AsyncClient, tmp_path, monkeypatch
):
"""Non-appliance install: file is absent, every field is null."""
from backend.app.api.routes import system as system_routes
absent = tmp_path / "nope.toml"
monkeypatch.setattr(
system_routes,
"read_local_toml",
lambda: __import__("backend.app.core.local_config", fromlist=["read_local_toml"]).read_local_toml(absent),
)
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
body = response.json()
assert body == {"hostname": None, "timezone": None, "locale": None, "time_synced": None}
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_returns_wizard_values(self, async_client: AsyncClient, tmp_path, monkeypatch):
"""Appliance install: wizard's local.toml values surface verbatim."""
from backend.app.api.routes import system as system_routes
from backend.app.core import local_config
toml = tmp_path / "local.toml"
toml.write_text('hostname = "workshop-pi"\ntimezone = "Europe/Berlin"\nlocale = "de"\n')
monkeypatch.setattr(system_routes, "read_local_toml", lambda: local_config.read_local_toml(toml))
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
body = response.json()
assert body["hostname"] == "workshop-pi"
assert body["timezone"] == "Europe/Berlin"
assert body["locale"] == "de"
# time_synced state is host-dependent in this test; just assert the field exists.
assert "time_synced" in body
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_partial(self, async_client: AsyncClient, tmp_path, monkeypatch):
"""Only locale set: hostname + timezone surface as null."""
from backend.app.api.routes import system as system_routes
from backend.app.core import local_config
toml = tmp_path / "local.toml"
toml.write_text('locale = "ja"\n')
monkeypatch.setattr(system_routes, "read_local_toml", lambda: local_config.read_local_toml(toml))
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
body = response.json()
assert body["locale"] == "ja"
assert body["hostname"] is None
assert body["timezone"] is None
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_requires_no_auth(self, async_client: AsyncClient):
"""The frontend i18n bootstrap reads this before auth might be set up.
The endpoint must respond 200 even when auth is enabled and the caller
is unauthenticated — its contents are non-secret (user-set defaults).
"""
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_time_synced_ok(self, async_client: AsyncClient, tmp_path, monkeypatch):
"""NTP gate written by ntp-gate.sh with 'ok' surfaces as time_synced='ok'."""
from backend.app.api.routes import system as system_routes
from backend.app.core import local_config
gate = tmp_path / "time-synced"
gate.write_text("ok\n")
monkeypatch.setattr(system_routes, "read_ntp_gate", lambda: local_config.read_ntp_gate(gate))
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
assert response.json()["time_synced"] == "ok"
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_time_synced_warning(
self,
async_client: AsyncClient,
tmp_path,
monkeypatch,
):
"""3-minute NTP timeout marker surfaces as time_synced='warning'."""
from backend.app.api.routes import system as system_routes
from backend.app.core import local_config
gate = tmp_path / "time-synced"
gate.write_text("warning: ntp sync timed out\n")
monkeypatch.setattr(system_routes, "read_ntp_gate", lambda: local_config.read_ntp_gate(gate))
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
assert response.json()["time_synced"] == "warning"
@pytest.mark.asyncio
@pytest.mark.integration
async def test_appliance_endpoint_time_synced_absent(
self,
async_client: AsyncClient,
tmp_path,
monkeypatch,
):
"""Non-appliance install: no gate file -> time_synced is null."""
from backend.app.api.routes import system as system_routes
from backend.app.core import local_config
absent = tmp_path / "no-gate-here"
monkeypatch.setattr(system_routes, "read_ntp_gate", lambda: local_config.read_ntp_gate(absent))
response = await async_client.get("/api/v1/system/appliance")
assert response.status_code == 200
assert response.json()["time_synced"] is None