"""Tests for notify_on_complete background process feature. Covers: - ProcessSession.notify_on_complete field - ProcessRegistry.completion_queue population on _move_to_finished() - Checkpoint persistence of notify_on_complete - Terminal tool schema includes notify_on_complete - Terminal tool handler passes notify_on_complete through """ import json import os import queue import time import pytest from pathlib import Path from unittest.mock import MagicMock, patch from tools.process_registry import ( ProcessRegistry, ProcessSession, ) @pytest.fixture() def registry(): """Create a fresh ProcessRegistry.""" return ProcessRegistry() def _make_session( sid="proc_test_notify", command="echo hello", task_id="t1", exited=False, exit_code=None, output="", notify_on_complete=False, ) -> ProcessSession: s = ProcessSession( id=sid, command=command, task_id=task_id, started_at=time.time(), exited=exited, exit_code=exit_code, output_buffer=output, notify_on_complete=notify_on_complete, ) return s # ========================================================================= # ProcessSession field # ========================================================================= class TestProcessSessionField: def test_default_false(self): s = ProcessSession(id="proc_1", command="echo hi") assert s.notify_on_complete is False def test_set_true(self): s = ProcessSession(id="proc_1", command="echo hi", notify_on_complete=True) assert s.notify_on_complete is True # ========================================================================= # Completion queue # ========================================================================= class TestCompletionQueue: def test_queue_exists(self, registry): assert hasattr(registry, "completion_queue") assert registry.completion_queue.empty() def test_move_to_finished_no_notify(self, registry): """Processes without notify_on_complete don't enqueue.""" s = _make_session(notify_on_complete=False, output="done") s.exited = True s.exit_code = 0 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) assert registry.completion_queue.empty() def test_move_to_finished_with_notify(self, registry): """Processes with notify_on_complete push to queue.""" s = _make_session( notify_on_complete=True, output="build succeeded", exit_code=0, ) s.exited = True s.exit_code = 0 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) assert not registry.completion_queue.empty() completion = registry.completion_queue.get_nowait() assert completion["session_id"] == s.id assert completion["command"] == "echo hello" assert completion["exit_code"] == 0 assert "build succeeded" in completion["output"] def test_move_to_finished_nonzero_exit(self, registry): """Nonzero exit codes are captured correctly.""" s = _make_session( notify_on_complete=True, output="FAILED", exit_code=1, ) s.exited = True s.exit_code = 1 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) completion = registry.completion_queue.get_nowait() assert completion["exit_code"] == 1 assert "FAILED" in completion["output"] def test_move_to_finished_idempotent_no_duplicate(self, registry): """Calling _move_to_finished twice must NOT enqueue two notifications. Regression test: kill_process() and the reader thread can both call _move_to_finished() for the same session, producing duplicate [SYSTEM: Background process ...] messages. """ s = _make_session(notify_on_complete=True, output="done", exit_code=-15) s.exited = True s.exit_code = -15 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) # first call — should enqueue s.exit_code = 143 # reader thread updates exit code registry._move_to_finished(s) # second call — should be no-op assert registry.completion_queue.qsize() == 1 completion = registry.completion_queue.get_nowait() assert completion["exit_code"] == -15 # from the first (kill) call def test_output_truncated_to_2000(self, registry): """Long output is truncated to last 2000 chars.""" long_output = "x" * 5000 s = _make_session( notify_on_complete=True, output=long_output, ) s.exited = True s.exit_code = 0 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) completion = registry.completion_queue.get_nowait() assert len(completion["output"]) == 2000 def test_multiple_completions_queued(self, registry): """Multiple notify processes all push to the same queue.""" for i in range(3): s = _make_session( sid=f"proc_{i}", notify_on_complete=True, output=f"output_{i}", ) s.exited = True s.exit_code = 0 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) completions = [] while not registry.completion_queue.empty(): completions.append(registry.completion_queue.get_nowait()) assert len(completions) == 3 ids = {c["session_id"] for c in completions} assert ids == {"proc_0", "proc_1", "proc_2"} # ========================================================================= # Checkpoint persistence # ========================================================================= class TestCheckpointNotify: def test_checkpoint_includes_notify(self, registry, tmp_path): with patch("tools.process_registry.CHECKPOINT_PATH", tmp_path / "procs.json"): s = _make_session(notify_on_complete=True) registry._running[s.id] = s registry._write_checkpoint() data = json.loads((tmp_path / "procs.json").read_text()) assert len(data) == 1 assert data[0]["notify_on_complete"] is True def test_checkpoint_without_notify(self, registry, tmp_path): with patch("tools.process_registry.CHECKPOINT_PATH", tmp_path / "procs.json"): s = _make_session(notify_on_complete=False) registry._running[s.id] = s registry._write_checkpoint() data = json.loads((tmp_path / "procs.json").read_text()) assert data[0]["notify_on_complete"] is False def test_recover_preserves_notify(self, registry, tmp_path): checkpoint = tmp_path / "procs.json" checkpoint.write_text(json.dumps([{ "session_id": "proc_live", "command": "sleep 999", "pid": os.getpid(), "task_id": "t1", "notify_on_complete": True, }])) with patch("tools.process_registry.CHECKPOINT_PATH", checkpoint): recovered = registry.recover_from_checkpoint() assert recovered == 1 s = registry.get("proc_live") assert s.notify_on_complete is True def test_recover_requeues_notify_watchers(self, registry, tmp_path): checkpoint = tmp_path / "procs.json" checkpoint.write_text(json.dumps([{ "session_id": "proc_live", "command": "sleep 999", "pid": os.getpid(), "task_id": "t1", "session_key": "sk1", "watcher_platform": "telegram", "watcher_chat_id": "123", "watcher_user_id": "u123", "watcher_user_name": "alice", "watcher_thread_id": "42", "watcher_interval": 5, "notify_on_complete": True, }])) with patch("tools.process_registry.CHECKPOINT_PATH", checkpoint): recovered = registry.recover_from_checkpoint() assert recovered == 1 assert len(registry.pending_watchers) == 1 assert registry.pending_watchers[0]["notify_on_complete"] is True assert registry.pending_watchers[0]["user_id"] == "u123" assert registry.pending_watchers[0]["user_name"] == "alice" def test_recover_defaults_false(self, registry, tmp_path): """Old checkpoint entries without the field default to False.""" checkpoint = tmp_path / "procs.json" checkpoint.write_text(json.dumps([{ "session_id": "proc_live", "command": "sleep 999", "pid": os.getpid(), "task_id": "t1", }])) with patch("tools.process_registry.CHECKPOINT_PATH", checkpoint): recovered = registry.recover_from_checkpoint() assert recovered == 1 s = registry.get("proc_live") assert s.notify_on_complete is False # ========================================================================= # Terminal tool schema # ========================================================================= class TestTerminalSchema: def test_schema_has_notify_on_complete(self): from tools.terminal_tool import TERMINAL_SCHEMA props = TERMINAL_SCHEMA["parameters"]["properties"] assert "notify_on_complete" in props assert props["notify_on_complete"]["type"] == "boolean" assert props["notify_on_complete"]["default"] is False def test_handler_passes_notify(self): """_handle_terminal passes notify_on_complete to terminal_tool.""" from tools.terminal_tool import _handle_terminal with patch("tools.terminal_tool.terminal_tool", return_value='{"ok":true}') as mock_tt: _handle_terminal( {"command": "echo hi", "background": True, "notify_on_complete": True}, task_id="t1", ) _, kwargs = mock_tt.call_args assert kwargs["notify_on_complete"] is True # ========================================================================= # Code execution blocked params # ========================================================================= class TestCodeExecutionBlocked: def test_notify_on_complete_blocked_in_sandbox(self): from tools.code_execution_tool import _TERMINAL_BLOCKED_PARAMS assert "notify_on_complete" in _TERMINAL_BLOCKED_PARAMS # ========================================================================= # Completion consumed suppression # ========================================================================= class TestCompletionConsumed: """Test that wait/poll/log suppress redundant completion notifications.""" def test_wait_marks_completion_consumed(self, registry): """wait() returning exited status marks session as consumed.""" s = _make_session(sid="proc_wait", notify_on_complete=True, output="done") s.exited = True s.exit_code = 0 registry._running[s.id] = s with patch.object(registry, "_write_checkpoint"): registry._move_to_finished(s) # Notification is in the queue assert not registry.completion_queue.empty() assert not registry.is_completion_consumed("proc_wait") # Agent calls wait() — gets the result directly result = registry.wait("proc_wait", timeout=1) assert result["status"] == "exited" # Now the completion is marked as consumed assert registry.is_completion_consumed("proc_wait") def test_poll_marks_completion_consumed(self, registry): """poll() returning exited status marks session as consumed.""" s = _make_session(sid="proc_poll", notify_on_complete=True, output="done") s.exited = True s.exit_code = 0 registry._finished[s.id] = s result = registry.poll("proc_poll") assert result["status"] == "exited" assert registry.is_completion_consumed("proc_poll") def test_log_marks_completion_consumed(self, registry): """read_log() on exited session marks as consumed.""" s = _make_session(sid="proc_log", notify_on_complete=True, output="line1\nline2") s.exited = True s.exit_code = 0 registry._finished[s.id] = s result = registry.read_log("proc_log") assert result["status"] == "exited" assert registry.is_completion_consumed("proc_log") def test_running_process_not_consumed(self, registry): """poll() on a still-running process does not mark as consumed.""" s = _make_session(sid="proc_running", notify_on_complete=True, output="partial") registry._running[s.id] = s result = registry.poll("proc_running") assert result["status"] == "running" assert not registry.is_completion_consumed("proc_running")