stage-9: heartbeat system with periodic checks
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
MoltBot Service
312
tests/test_heartbeat.py
Normal file
312
tests/test_heartbeat.py
Normal file
@@ -0,0 +1,312 @@
|
||||
"""Tests for src/heartbeat.py — Periodic health checks."""
|
||||
|
||||
import json
|
||||
import time
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
from src.heartbeat import (
|
||||
_check_calendar,
|
||||
_check_email,
|
||||
_check_git,
|
||||
_check_kb_index,
|
||||
_is_quiet_hour,
|
||||
_load_state,
|
||||
_save_state,
|
||||
run_heartbeat,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def tmp_env(tmp_path, monkeypatch):
|
||||
"""Redirect PROJECT_ROOT, STATE_FILE, TOOLS_DIR to tmp_path."""
|
||||
root = tmp_path / "project"
|
||||
root.mkdir()
|
||||
tools = root / "tools"
|
||||
tools.mkdir()
|
||||
mem = root / "memory"
|
||||
mem.mkdir()
|
||||
state_file = mem / "heartbeat-state.json"
|
||||
|
||||
monkeypatch.setattr("src.heartbeat.PROJECT_ROOT", root)
|
||||
monkeypatch.setattr("src.heartbeat.STATE_FILE", state_file)
|
||||
monkeypatch.setattr("src.heartbeat.TOOLS_DIR", tools)
|
||||
return {"root": root, "tools": tools, "memory": mem, "state_file": state_file}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _is_quiet_hour
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestIsQuietHour:
|
||||
"""Test quiet hour detection with overnight and daytime ranges."""
|
||||
|
||||
def test_overnight_range_before_midnight(self):
|
||||
assert _is_quiet_hour(23, (23, 8)) is True
|
||||
|
||||
def test_overnight_range_after_midnight(self):
|
||||
assert _is_quiet_hour(3, (23, 8)) is True
|
||||
|
||||
def test_overnight_range_outside(self):
|
||||
assert _is_quiet_hour(12, (23, 8)) is False
|
||||
|
||||
def test_overnight_range_at_end_boundary(self):
|
||||
# hour == end is NOT quiet (end is exclusive)
|
||||
assert _is_quiet_hour(8, (23, 8)) is False
|
||||
|
||||
def test_daytime_range_inside(self):
|
||||
assert _is_quiet_hour(12, (9, 17)) is True
|
||||
|
||||
def test_daytime_range_at_start(self):
|
||||
assert _is_quiet_hour(9, (9, 17)) is True
|
||||
|
||||
def test_daytime_range_at_end(self):
|
||||
assert _is_quiet_hour(17, (9, 17)) is False
|
||||
|
||||
def test_daytime_range_outside(self):
|
||||
assert _is_quiet_hour(20, (9, 17)) is False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _check_email
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestCheckEmail:
|
||||
"""Test email check via tools/email_check.py."""
|
||||
|
||||
def test_no_script(self, tmp_env):
|
||||
"""Returns None when email_check.py does not exist."""
|
||||
assert _check_email({}) is None
|
||||
|
||||
def test_with_output(self, tmp_env):
|
||||
"""Returns formatted email string when script outputs something."""
|
||||
script = tmp_env["tools"] / "email_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=0, stdout="3 new messages\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_email({}) == "Email: 3 new messages"
|
||||
|
||||
def test_zero_output(self, tmp_env):
|
||||
"""Returns None when script outputs '0' (no new mail)."""
|
||||
script = tmp_env["tools"] / "email_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=0, stdout="0\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_email({}) is None
|
||||
|
||||
def test_empty_output(self, tmp_env):
|
||||
"""Returns None when script outputs empty string."""
|
||||
script = tmp_env["tools"] / "email_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=0, stdout="\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_email({}) is None
|
||||
|
||||
def test_nonzero_returncode(self, tmp_env):
|
||||
"""Returns None when script exits with error."""
|
||||
script = tmp_env["tools"] / "email_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=1, stdout="error")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_email({}) is None
|
||||
|
||||
def test_subprocess_exception(self, tmp_env):
|
||||
"""Returns None when subprocess raises (e.g. timeout)."""
|
||||
script = tmp_env["tools"] / "email_check.py"
|
||||
script.write_text("pass")
|
||||
with patch("src.heartbeat.subprocess.run", side_effect=TimeoutError):
|
||||
assert _check_email({}) is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _check_calendar
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestCheckCalendar:
|
||||
"""Test calendar check via tools/calendar_check.py."""
|
||||
|
||||
def test_no_script(self, tmp_env):
|
||||
"""Returns None when calendar_check.py does not exist."""
|
||||
assert _check_calendar({}) is None
|
||||
|
||||
def test_with_events(self, tmp_env):
|
||||
"""Returns formatted calendar string when script outputs events."""
|
||||
script = tmp_env["tools"] / "calendar_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=0, stdout="Meeting at 3pm\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_calendar({}) == "Calendar: Meeting at 3pm"
|
||||
|
||||
def test_empty_output(self, tmp_env):
|
||||
"""Returns None when no upcoming events."""
|
||||
script = tmp_env["tools"] / "calendar_check.py"
|
||||
script.write_text("pass")
|
||||
mock_result = MagicMock(returncode=0, stdout="\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_calendar({}) is None
|
||||
|
||||
def test_subprocess_exception(self, tmp_env):
|
||||
"""Returns None when subprocess raises."""
|
||||
script = tmp_env["tools"] / "calendar_check.py"
|
||||
script.write_text("pass")
|
||||
with patch("src.heartbeat.subprocess.run", side_effect=OSError("fail")):
|
||||
assert _check_calendar({}) is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _check_kb_index
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestCheckKbIndex:
|
||||
"""Test KB index freshness check."""
|
||||
|
||||
def test_missing_index(self, tmp_env):
|
||||
"""Returns warning when index.json does not exist."""
|
||||
assert _check_kb_index() == "KB: index missing"
|
||||
|
||||
def test_up_to_date(self, tmp_env):
|
||||
"""Returns None when all .md files are older than index."""
|
||||
kb_dir = tmp_env["root"] / "memory" / "kb"
|
||||
kb_dir.mkdir(parents=True)
|
||||
md_file = kb_dir / "notes.md"
|
||||
md_file.write_text("old notes")
|
||||
time.sleep(0.05)
|
||||
index = kb_dir / "index.json"
|
||||
index.write_text("{}")
|
||||
assert _check_kb_index() is None
|
||||
|
||||
def test_needs_reindex(self, tmp_env):
|
||||
"""Returns reindex warning when .md files are newer than index."""
|
||||
kb_dir = tmp_env["root"] / "memory" / "kb"
|
||||
kb_dir.mkdir(parents=True)
|
||||
index = kb_dir / "index.json"
|
||||
index.write_text("{}")
|
||||
time.sleep(0.05)
|
||||
md1 = kb_dir / "a.md"
|
||||
md1.write_text("new")
|
||||
md2 = kb_dir / "b.md"
|
||||
md2.write_text("also new")
|
||||
assert _check_kb_index() == "KB: 2 files need reindex"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _check_git
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestCheckGit:
|
||||
"""Test git status check."""
|
||||
|
||||
def test_clean(self, tmp_env):
|
||||
"""Returns None when working tree is clean."""
|
||||
mock_result = MagicMock(returncode=0, stdout="\n")
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_git() is None
|
||||
|
||||
def test_dirty(self, tmp_env):
|
||||
"""Returns uncommitted count when there are changes."""
|
||||
mock_result = MagicMock(
|
||||
returncode=0,
|
||||
stdout=" M file1.py\n?? file2.py\n M file3.py\n",
|
||||
)
|
||||
with patch("src.heartbeat.subprocess.run", return_value=mock_result):
|
||||
assert _check_git() == "Git: 3 uncommitted"
|
||||
|
||||
def test_subprocess_exception(self, tmp_env):
|
||||
"""Returns None when git command fails."""
|
||||
with patch("src.heartbeat.subprocess.run", side_effect=OSError):
|
||||
assert _check_git() is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _load_state / _save_state
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestState:
|
||||
"""Test state persistence."""
|
||||
|
||||
def test_load_missing_file(self, tmp_env):
|
||||
"""Returns default state when file does not exist."""
|
||||
state = _load_state()
|
||||
assert state == {"last_run": None, "checks": {}}
|
||||
|
||||
def test_round_trip(self, tmp_env):
|
||||
"""State survives save then load."""
|
||||
original = {"last_run": "2025-01-01T00:00:00", "checks": {"email": True}}
|
||||
_save_state(original)
|
||||
loaded = _load_state()
|
||||
assert loaded == original
|
||||
|
||||
def test_load_corrupt_json(self, tmp_env):
|
||||
"""Returns default state when JSON is corrupt."""
|
||||
tmp_env["state_file"].write_text("not valid json {{{")
|
||||
state = _load_state()
|
||||
assert state == {"last_run": None, "checks": {}}
|
||||
|
||||
def test_save_creates_parent_dir(self, tmp_path, monkeypatch):
|
||||
"""_save_state creates parent directory if missing."""
|
||||
state_file = tmp_path / "deep" / "nested" / "state.json"
|
||||
monkeypatch.setattr("src.heartbeat.STATE_FILE", state_file)
|
||||
_save_state({"last_run": None, "checks": {}})
|
||||
assert state_file.exists()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# run_heartbeat (integration)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestRunHeartbeat:
|
||||
"""Test the top-level run_heartbeat orchestrator."""
|
||||
|
||||
def test_all_ok(self, tmp_env):
|
||||
"""Returns HEARTBEAT_OK when all checks pass with no issues."""
|
||||
with patch("src.heartbeat._check_email", return_value=None), \
|
||||
patch("src.heartbeat._check_calendar", return_value=None), \
|
||||
patch("src.heartbeat._check_kb_index", return_value=None), \
|
||||
patch("src.heartbeat._check_git", return_value=None):
|
||||
result = run_heartbeat()
|
||||
assert result == "HEARTBEAT_OK"
|
||||
|
||||
def test_with_results(self, tmp_env):
|
||||
"""Returns joined results when checks report issues."""
|
||||
with patch("src.heartbeat._check_email", return_value="Email: 2 new"), \
|
||||
patch("src.heartbeat._check_calendar", return_value=None), \
|
||||
patch("src.heartbeat._check_kb_index", return_value="KB: 1 files need reindex"), \
|
||||
patch("src.heartbeat._check_git", return_value=None), \
|
||||
patch("src.heartbeat._is_quiet_hour", return_value=False):
|
||||
result = run_heartbeat()
|
||||
assert result == "Email: 2 new | KB: 1 files need reindex"
|
||||
|
||||
def test_quiet_hours_suppression(self, tmp_env):
|
||||
"""Returns HEARTBEAT_OK during quiet hours even with issues."""
|
||||
with patch("src.heartbeat._check_email", return_value="Email: 5 new"), \
|
||||
patch("src.heartbeat._check_calendar", return_value="Calendar: meeting"), \
|
||||
patch("src.heartbeat._check_kb_index", return_value=None), \
|
||||
patch("src.heartbeat._check_git", return_value="Git: 2 uncommitted"), \
|
||||
patch("src.heartbeat._is_quiet_hour", return_value=True):
|
||||
result = run_heartbeat()
|
||||
assert result == "HEARTBEAT_OK"
|
||||
|
||||
def test_saves_state_after_run(self, tmp_env):
|
||||
"""State file is updated after heartbeat runs."""
|
||||
with patch("src.heartbeat._check_email", return_value=None), \
|
||||
patch("src.heartbeat._check_calendar", return_value=None), \
|
||||
patch("src.heartbeat._check_kb_index", return_value=None), \
|
||||
patch("src.heartbeat._check_git", return_value=None):
|
||||
run_heartbeat()
|
||||
state = json.loads(tmp_env["state_file"].read_text())
|
||||
assert "last_run" in state
|
||||
assert state["last_run"] is not None
|
||||
Reference in New Issue
Block a user