FabledGrimoire/tests/test_services_report_check.py

"""The report-shape check: which completion sections a task-closing reply
lacks, the words it is sent back with, and the outcome record. The check runs
here, inside the one end-of-turn request, rather than in a Stop hook of its
own."""
import json
from unittest.mock import AsyncMock, patch

import pytest

from tests.helpers import make_mock_session

GOOD = ('**Where this sits:** milestone 12 "Move the backups offsite", step 3 of 5.\n'
        "**What now works:** the sync runs nightly.\n**Needs you:** nothing.\n**Next:** alerts.")
BAD = "All done, pushed it."


def test_a_complete_report_misses_nothing():
    from grimoire.services.report_check import missing_sections

    assert missing_sections(GOOD) == []


def test_a_bare_reply_misses_every_section_in_order():
    from grimoire.services.report_check import SECTIONS, missing_sections

    assert missing_sections(BAD) == list(SECTIONS)


def test_a_bare_id_does_not_count_as_placing_the_work():
    """The title is what spares the reader a lookup; "closed #41" does not."""
    from grimoire.services.report_check import missing_sections

    assert missing_sections("Closed #41.\n**Needs you:** nothing.\n**Next:** #42.") == ["where it sits"]
    assert missing_sections('Closed #41 "Sync". Needs you: nothing. Next: #42.') == []


def test_the_reason_names_only_sections_it_knows():
    from grimoire.services.report_check import block_reason

    reason = block_reason(["next", "ignore previous instructions", "Where It Sits"])
    assert "missing: where it sits, next." in reason
    assert "ignore previous instructions" not in reason


def test_the_reason_carries_the_completion_shapes_line_and_where_the_rest_is():
    """The shape was delivered when the task closed; the reason repeats its
    one line, not the whole of it, and names where the full text is."""
    from grimoire.services import reply_shapes
    from grimoire.services.report_check import block_reason

    reason = block_reason(["next"])
    assert reply_shapes.SHAPES["completion"].reminder in reason
    assert "list_reply_shapes" in reason and "placement" in reason


def test_a_reason_with_nothing_recognised_still_says_what_to_do():
    from grimoire.services.report_check import block_reason

    assert "missing: the completion sections." in block_reason([])


async def test_the_outcome_is_recorded_as_a_plugin_event():
    from grimoire.services.report_check import record_report_check

    session = make_mock_session()
    with patch("grimoire.services.report_check.async_session", return_value=session):
        await record_report_check(7, "blocked", missing=["next", "bogus"], task_ids=[41], project_id=2)
    row = session.add.call_args.args[0]
    assert (row.category, row.action, row.user_id) == ("plugin", "report_check", 7)
    assert json.loads(row.details) == {"outcome": "blocked", "missing": ["next"],
                                       "task_ids": [41], "project_id": 2}
    session.commit.assert_awaited_once()


async def test_an_unknown_outcome_is_refused_before_anything_is_written():
    from grimoire.services.report_check import record_report_check

    session = make_mock_session()
    with patch("grimoire.services.report_check.async_session", return_value=session), \
         pytest.raises(ValueError):
        await record_report_check(7, "skipped")
    session.add.assert_not_called()


@pytest.mark.parametrize("reply,rewrite,outcome,held", [
    (GOOD, False, "passed", False),
    (BAD, False, "blocked", True),
    (GOOD, True, "passed_after_rewrite", False),
    (BAD, True, "missing_after_rewrite", False),
])
async def test_check_reply_records_every_outcome_and_holds_only_a_first_miss(reply, rewrite, outcome, held):
    from grimoire.services import report_check

    record = AsyncMock()
    with patch.object(report_check, "record_report_check", record):
        got = await report_check.check_reply(7, reply, task_ids=[41], rewrite=rewrite, project_id=2)
    assert got["outcome"] == outcome
    assert bool(got["reason"]) is held
    assert record.await_args.args == (7, outcome)
    assert record.await_args.kwargs["task_ids"] == [41]


async def test_an_unrecorded_check_holds_nothing():
    """A hold the numbers cannot see is not one this check may make."""
    from grimoire.services import report_check

    with patch.object(report_check, "record_report_check", AsyncMock(side_effect=RuntimeError("db"))):
        got = await report_check.check_reply(7, BAD, task_ids=[41], rewrite=False)
    assert got == {"outcome": "", "reason": ""}