Files
grm/tests/unit/test_report.py
T
Emil Simeonov 3f7507500b GRM-14: feat: use click.echo() for user-facing messages with dual logging
- Create ui.py with say() helper that routes messages to both click.echo()
  (console/stdout, user-facing) and logging.getLogger('grm') (file audit trail)
- Update executor.py: replace logger.info() with say() for start, status, done
  messages; use say(level=ERROR, err=True) before raising AnsibleError
- Update report.py: replace logger.info() with say() for operation report lines
- Update all unit tests to patch say() instead of using capsys or get_logger
- Add test_ui.py with coverage for say() calling both click.echo and logging
- 117 tests, 100% coverage, pyright clean, ruff clean
2026-06-19 01:30:14 +02:00

109 lines
3.9 KiB
Python

"""Unit tests for the operation report tracker."""
from __future__ import annotations
from unittest.mock import patch
import pytest
from gitea_runner_manager.exceptions import AnsibleError
from gitea_runner_manager.report import Step, StepTracker, track_steps
class TestStep:
def test_init(self) -> None:
step = Step("test")
assert step.name == "test"
assert step.status == "pending"
class TestStepTracker:
def test_begin(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
assert len(tracker.steps) == 1
assert tracker.steps[0].name == "step1"
assert tracker.steps[0].status == "in_progress"
def test_done(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
tracker.done()
assert tracker.steps[0].status == "completed"
def test_done_no_steps(self) -> None:
tracker = StepTracker()
tracker.done() # should not raise
assert tracker.steps == []
def test_done_last_not_in_progress(self) -> None:
tracker = StepTracker()
tracker.begin("step1")
tracker.done()
tracker.done() # second done is a no-op
assert tracker.steps[0].status == "completed"
class TestTrackSteps:
def test_success(self) -> None:
with patch("gitea_runner_manager.report.say") as mock_say:
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
tracker.done()
messages = [call.args[0] for call in mock_say.call_args_list]
assert any("Operation Report" in msg for msg in messages)
assert any("step1" in msg for msg in messages)
assert any("step2" in msg for msg in messages)
assert any("✓" in msg for msg in messages)
assert any("completed" in msg for msg in messages)
def test_failure_marks_step(self) -> None:
with patch("gitea_runner_manager.report.say") as mock_say:
with pytest.raises(AnsibleError, match="fail"):
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
tracker.begin("step2")
raise AnsibleError("fail")
messages = [call.args[0] for call in mock_say.call_args_list]
assert any("step1" in msg for msg in messages)
assert any("step2" in msg for msg in messages)
assert any("✓" in msg for msg in messages)
assert any("✗" in msg for msg in messages)
assert any("completed" in msg for msg in messages)
assert any("failed" in msg for msg in messages)
def test_pending_shown_on_failure(self) -> None:
with patch("gitea_runner_manager.report.say") as mock_say:
with pytest.raises(AnsibleError, match="fail"):
with track_steps() as tracker:
tracker.begin("step1")
raise AnsibleError("fail")
messages = [call.args[0] for call in mock_say.call_args_list]
assert any("✗" in msg for msg in messages)
assert any("failed" in msg for msg in messages)
def test_empty_report(self) -> None:
with patch("gitea_runner_manager.report.say") as mock_say:
with track_steps():
pass
messages = [call.args[0] for call in mock_say.call_args_list]
assert any("Operation Report" in msg for msg in messages)
def test_translated_report(self, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("GRM_LANG", "bg")
with patch("gitea_runner_manager.report.say") as mock_say:
with track_steps() as tracker:
tracker.begin("step1")
tracker.done()
messages = [call.args[0] for call in mock_say.call_args_list]
assert any("Отчет за операцията" in msg for msg in messages)
assert any("завършено" in msg for msg in messages)