Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

8.4 KB
Raw Blame
"""CLI smoke tests for the standalone ``deeptutor-cli`` package."""

from __future__ import annotations

import json
from typing import Any

import pytest
from typer.testing import CliRunner

from deeptutor.app import DeepTutorApp, TurnRequest
from deeptutor.runtime.bootstrap.builtin_capabilities import BUILTIN_CAPABILITY_CLASSES
from deeptutor_cli.main import app

runner = CliRunner()


def _install_fake_runtime(monkeypatch, captured_requests: list[TurnRequest]) -> None:
    async def _start_turn(self, request):  # noqa: ANN001
        if isinstance(request, dict):
            request = TurnRequest(**request)
        captured_requests.append(request)
        return {"id": request.session_id or "session-1"}, {"id": "turn-1"}

    async def _stream_turn(self, turn_id: str, after_seq: int = 0):  # noqa: ANN001
        yield {"type": "session", "turn_id": turn_id, "seq": after_seq}
        yield {"type": "stage_start", "stage": "responding"}
        yield {"type": "content", "content": "response body"}
        yield {"type": "result", "metadata": {"response": "response body"}}
        yield {"type": "done"}

    monkeypatch.setattr("deeptutor.app.facade.DeepTutorApp.start_turn", _start_turn)
    monkeypatch.setattr("deeptutor.app.facade.DeepTutorApp.stream_turn", _stream_turn)


def test_run_command_json_mode(monkeypatch) -> None:
    captured_requests: list[TurnRequest] = []
    _install_fake_runtime(monkeypatch, captured_requests)

    capabilities = list(BUILTIN_CAPABILITY_CLASSES)

    for cap in capabilities:
        result = runner.invoke(
            app,
            [
                "run",
                cap,
                "hello world",
                "--format",
                "json",
                "--tool",
                "rag",
                "--kb",
                "demo-kb",
                "--history-ref",
                "session-old",
                "--notebook-ref",
                "nb1:rec1,rec2",
            ],
        )

        assert result.exit_code == 0, result.output
        lines = [json.loads(line) for line in result.output.splitlines() if line.strip()]
        assert any(line["type"] == "result" for line in lines)

    assert len(captured_requests) == len(capabilities)
    assert captured_requests[0].capability == "chat"
    assert captured_requests[0].tools == ["rag"]
    assert captured_requests[0].knowledge_bases == ["demo-kb"]
    assert captured_requests[0].history_references == ["session-old"]
    assert [ref.model_dump() for ref in captured_requests[0].notebook_references] == [
        {"notebook_id": "nb1", "record_ids": ["rec1", "rec2"]}
    ]
    assert {request.capability for request in captured_requests} == set(capabilities)


def test_builtin_capability_aliases_resolve_to_canonical_names() -> None:
    runtime = DeepTutorApp()

    assert runtime.resolve_capability("solve") == "deep_solve"
    assert runtime.resolve_capability("ask") == "ask_questions"
    assert runtime.resolve_capability("quiz") == "deep_question"
    assert runtime.resolve_capability("research") == "deep_research"
    assert runtime.resolve_capability("viz") == "visualize"
    assert runtime.resolve_capability("animate") == "math_animator"
    assert runtime.resolve_capability("mastery") == "mastery_path"
    with pytest.raises(ValueError, match="Unknown capability `auto`"):
        runtime.resolve_capability("auto")


def test_run_command_rejects_removed_auto_capability() -> None:
    result = runner.invoke(app, ["run", "auto", "hello"])

    assert result.exit_code != 0
    assert isinstance(result.exception, ValueError)
    assert "Unknown capability `auto`" in str(result.exception)


def test_run_command_rich_mode(monkeypatch) -> None:
    captured_requests: list[TurnRequest] = []
    _install_fake_runtime(monkeypatch, captured_requests)

    result = runner.invoke(app, ["run", "chat", "hello rich"])

    assert result.exit_code == 0, result.output
    assert "response body" in result.output
    assert captured_requests[0].capability == "chat"


def test_run_command_with_config(monkeypatch) -> None:
    captured_requests: list[TurnRequest] = []
    _install_fake_runtime(monkeypatch, captured_requests)

    result = runner.invoke(
        app,
        [
            "run",
            "deep_research",
            "compare retrieval stacks",
            "--config-json",
            '{"mode":"report","depth":"deep"}',
        ],
    )

    assert result.exit_code == 0, result.output
    request = captured_requests[0]
    assert request.capability == "deep_research"
    assert request.config == {
        "mode": "report",
        "depth": "deep",
    }


def test_chat_repl_config_commands_match_docs_syntax(monkeypatch) -> None:
    captured_requests: list[TurnRequest] = []
    _install_fake_runtime(monkeypatch, captured_requests)

    result = runner.invoke(
        app,
        ["chat", "--config", "initial=true"],
        input=(
            "/config set num_questions 5\n"
            '/config set question_types \'["short_answer","mcq"]\'\n'
            "/refs\n"
            "Generate questions\n"
            "/quit\n"
        ),
    )

    assert result.exit_code == 0, result.output
    assert '"num_questions": 5' in result.output
    assert '"question_types"' in result.output
    assert captured_requests[0].config == {
        "initial": True,
        "num_questions": 5,
        "question_types": ["short_answer", "mcq"],
    }


def test_chat_repl_backslash_continuation_sends_single_message(monkeypatch) -> None:
    captured_requests: list[TurnRequest] = []
    _install_fake_runtime(monkeypatch, captured_requests)

    result = runner.invoke(
        app,
        ["chat"],
        input="Please review this code:\\\ndef fib(n): return n\n/quit\n",
    )

    assert result.exit_code == 0, result.output
    assert captured_requests[0].content == "Please review this code:\ndef fib(n): return n"


def test_chat_repl_survives_invalid_utf8_input(monkeypatch) -> None:
    inputs = iter(
        [
            UnicodeDecodeError("utf-8", b"\xe8\x83", 0, 2, "unexpected end of data"),
            "/quit",
        ]
    )

    def _read_input() -> str:
        value = next(inputs)
        if isinstance(value, Exception):
            raise value
        return value

    monkeypatch.setattr("deeptutor_cli.chat._read_repl_input", _read_input)

    result = runner.invoke(app, ["chat"])

    assert result.exit_code == 0, result.output
    assert "Unable to decode terminal input" in result.output


def test_plugin_info_includes_capability_aliases_and_availability() -> None:
    result = runner.invoke(app, ["plugin", "info", "deep_solve"])

    assert result.exit_code == 0, result.output
    payload = json.loads(result.output)
    assert payload["name"] == "deep_solve"
    assert payload["cli_aliases"] == ["solve"]
    assert payload["availability"]["available"] is True


def test_session_list_command_uses_shared_store(monkeypatch) -> None:
    async def _list_sessions(self, limit: int = 50, offset: int = 0):  # noqa: ANN001
        return [
            {
                "id": "session-1",
                "title": "Algebra",
                "capability": "chat",
                "status": "completed",
                "message_count": 4,
            }
        ]

    monkeypatch.setattr("deeptutor.app.facade.DeepTutorApp.list_sessions", _list_sessions)

    result = runner.invoke(app, ["session", "list"])

    assert result.exit_code == 0, result.output
    assert "session-1" in result.output
    assert "Algebra" in result.output


def test_start_command_delegates_to_runtime_launcher(monkeypatch) -> None:
    calls: list[object] = []

    def _fake_start(  # noqa: ANN001
        home=None,
        *,
        dev=False,
        detach=False,
        open_browser=True,
    ):
        calls.append((home, dev, detach, open_browser))

    monkeypatch.setattr("deeptutor.runtime.launcher.start", _fake_start)

    result = runner.invoke(app, ["start"])

    assert result.exit_code == 0, result.output
    assert calls == [(None, False, False, True)]

    result = runner.invoke(app, ["start", "--dev", "--detach", "--no-browser"])

    assert result.exit_code == 0, result.output
    assert calls[-1] == (None, True, True, False)


def test_stop_command_delegates_to_detached_launcher(monkeypatch) -> None:
    calls: list[object] = []
    monkeypatch.setattr(
        "deeptutor.runtime.launcher.stop",
        lambda home=None: calls.append(home) or True,
    )

    result = runner.invoke(app, ["stop"])

    assert result.exit_code == 0, result.output
    assert calls == [None]