Files
autocad-mcp-pro/tests/test_pid_from_spec.py
Umut CANandClaude Opus 5 2e101b95e2 fix(task-5): a rollback that fails after a cancellation no longer kills the session, and the COM rollback goes back to an UNDO Mark instead of prompting
Two review findings on 32821c6.

1. Once the shielded rollback body runs after a real client cancellation it
   can fail (the COM hard timeout, _safe_send_command's own deadline, an
   ezdxf quarantine refusal). That RuntimeError escaped run_spec as an
   ordinary error and the mcp lowlevel server, which had already answered
   the cancelled request, tried to respond a second time: `assert not
   self._completed` in mcp/shared/session.py escaped the server task group
   and the whole session died (measured through the real transport: the next
   system_status was never answered and Client.__aexit__ re-raised the
   AssertionError). run_spec now decides by the exception it is handling:
   after a cancellation the rollback error is logged and the cancellation is
   what propagates, so the SDK's cancellation suppression applies; after any
   other error the rollback error propagates as before, with the original
   chained as its context.

2. The docstring promised the rollback on both engines, but on the live
   AutoCAD 2026 ComBackend.transaction_rollback sent `_UNDO B` with no UNDO
   Mark in the stack (StartUndoMark/EndUndoMark form an undo *group*, not a
   Mark), AutoCAD answered "This will undo everything. OK? <Y>", SendCommand
   blocked at that prompt, _run gave up after 60 s, the entities stayed and
   every COM client was rejected until a human pressed ESC. transaction_begin
   now types `_.UNDO _M` before StartUndoMark (refused with ok:false while
   CMDACTIVE, where the Mark would be swallowed as input), and
   transaction_rollback ends the group and sends `_.UNDO _B`, which returns
   exactly to that Mark - also on an empty transaction, where `_UNDO 1` would
   be one step too many. A rollback with no transaction is refused the way the
   headless engine refuses it, because an unmarked Back is that prompt.
   Measured with the real ComBackend in a scratch Documents.Add() document on
   the running AutoCAD 2026 (closed with Close(False)): begin 31 ms ->
   entity_create_line + circle -> rollback 63 ms -> 3 entities back to 1,
   CMDACTIVE 0, no prompt; an empty begin/rollback leaves the older line;
   begin/commit unchanged.

Tests: the two failure modes on run_spec (anyio scope cancellation with a
raising rollback completes the task group and logs; a ValueError with a
raising rollback still raises the rollback error with the ValueError as
context), the real-transport case (client.cancel mid-run, rollback raises,
the next request is answered, cleanup through the real rollback), the COM
shape now pins `_.UNDO _M, StartUndoMark, EndUndoMark, _.UNDO _B`, and
test_com_sprint3 grows a Mark-keeping fake document whose unmarked Back
fails the way the prompt does: begin before the group, rollback consumes the
Mark, rollback without a transaction sends nothing, begin refuses on
CMDACTIVE.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FKFStjEFzpGyLq5bMpWxTd
2026-09-21 21:46:08 +03:00

432 lines
17 KiB
Python

"""pid_from_spec: one call, one transaction, graph + critique back."""
from __future__ import annotations
import copy
import pytest
import pytest_asyncio
from fastmcp import Client
import server
from engineering.pid.spec import EXAMPLE_SPEC, run_spec, validate_spec
pytestmark = pytest.mark.asyncio
async def test_example_draws_a_connected_pid(backend):
result = await run_spec(backend, EXAMPLE_SPEC)
assert set(result["handles"]) == {"P-101", "V-201", "FCV-101", "FIC-101", "OP-1"}
graph = result["graph"]
assert graph["stats"]["nodes_by_kind"] == {
"connector": 1,
"equipment": 2,
"instrument": 1,
"valve": 1,
}
assert len(graph["edges"]) == 4 and graph["stats"]["dangling"] == 0
assert result["critique"] == [] and result["crossings_total"] == 0
assert backend.get_plan_spec()["layer_set_id"] == "pid"
async def test_bad_reference_rolls_back(backend):
before = await backend.entity_count()
bad = copy.deepcopy(EXAMPLE_SPEC)
bad["lines"].append({"from": "P-101.discharge", "to": "V-201.NOPE", "class": "process_major"})
with pytest.raises(ValueError, match=r"lines\[3\]"):
await run_spec(backend, bad)
assert await backend.entity_count() == before
async def test_dry_run_routes_in_memory_and_writes_nothing(backend):
before = await backend.entity_count()
result = await run_spec(backend, EXAMPLE_SPEC, dry_run=True)
assert result["dry_run"] is True and len(result["lines"]) == 4
assert all(len(line["vertices"]) >= 2 for line in result["lines"])
assert await backend.entity_count() == before
@pytest.mark.parametrize(
"mutate, fragment",
[
(
lambda s: s["equipment"].append({"id": "P-101", "symbol": "fan", "x": 0, "y": 0}),
"equipment[2].id",
),
(lambda s: s["lines"][0].update({"class": "steam"}), "lines[0].class"),
(lambda s: s["instruments"][0].pop("x"), "instruments[0].x"),
(lambda s: s.update({"bogus": []}), "bogus"),
(lambda s: s["connectors"][0].update({"to": "V-201.N1"}), "connectors[0]"),
],
)
async def test_validation_names_the_path(mutate, fragment):
spec = copy.deepcopy(EXAMPLE_SPEC)
mutate(spec)
with pytest.raises(ValueError) as exc:
validate_spec(spec)
assert fragment in str(exc.value)
@pytest_asyncio.fixture
async def client(monkeypatch):
monkeypatch.setenv("AUTOCAD_MCP_BACKEND", "ezdxf")
async with Client(server.mcp) as connected:
await connected.call_tool("drawing_new", {})
yield connected
async def test_finalize_scores_the_example_at_ninety_or_better(client, tmp_path):
result = (await client.call_tool("pid_from_spec", {"spec": EXAMPLE_SPEC})).structured_content
assert result["graph"]["stats"]["dangling"] == 0
# The validator's first step refuses an unsaved drawing (`not_saved`), so
# finalize saves first — the same shape `tests/test_pid_critique.py` uses.
final = (
await client.call_tool("drawing_finalize", {"save_path": str(tmp_path / "pid.dxf")})
).structured_content
assert final["score"]["score"] >= 90, final["score"]
assert not [i for i in final.get("critique", []) if str(i.get("focus", "")).startswith("pid_")]
# ── Track A hardening (track E wave 0, Task 5) ───────────────────────────────
@pytest.mark.parametrize(
"mutate, fragment",
[
(lambda s: s["equipment"][0].update({"x": float("nan")}), "equipment[0].x"),
(lambda s: s["valves"][0].update({"y": float("inf")}), "valves[0].y"),
(lambda s: s["instruments"][0].update({"rotation": 10**400}), "instruments[0].rotation"),
(lambda s: s["lines"][0].update({"stub": float("-inf")}), "lines[0].stub"),
],
)
async def test_non_finite_numbers_are_refused_by_path_before_any_write(backend, mutate, fragment):
before = await backend.entity_count()
spec = copy.deepcopy(EXAMPLE_SPEC)
mutate(spec)
with pytest.raises(ValueError, match="finite") as exc:
await run_spec(backend, spec)
assert fragment in str(exc.value)
assert await backend.entity_count() == before
assert (await backend.system_status())["transaction_depth"] == 0
async def _wait_until(predicate, *, timeout: float = 5.0) -> None:
"""Poll an async predicate; a rollback that never lands fails here, not by hanging."""
import asyncio
import time
deadline = time.monotonic() + timeout
while not await predicate():
if time.monotonic() > deadline:
raise AssertionError(f"condition not met within {timeout:.1f}s")
await asyncio.sleep(0.02)
@pytest.mark.parametrize("how", ["scope", "native"])
async def test_a_cancellation_mid_run_rolls_the_sheet_back(backend, monkeypatch, how):
"""A *real* cancellation, not a ``CancelledError`` raised from a mock.
The MCP SDK cancels a request through an anyio cancel scope, which is
level-triggered: ``task.cancel()`` is re-issued on every loop iteration
while the task is inside the cancelled scope, so an unshielded rollback
was cancelled at its first ``await`` before its body ran (five symbols
left in an open transaction). A native ``Task.cancel()`` is delivered once
and clears — raising from the mock only ever exercised that easy case.
"""
import asyncio
import anyio
from engineering.pid import spec as spec_module
before = await backend.entity_count()
in_flight = asyncio.Event()
async def slow_draw_line(*args, **kwargs):
in_flight.set()
await asyncio.sleep(30)
monkeypatch.setattr(spec_module, "draw_line", slow_draw_line)
if how == "scope":
async with anyio.create_task_group() as tg:
tg.start_soon(run_spec, backend, EXAMPLE_SPEC)
await in_flight.wait()
assert await backend.entity_count() > before, "symbols placed before the cancel"
tg.cancel_scope.cancel()
else:
task = asyncio.ensure_future(run_spec(backend, EXAMPLE_SPEC))
await in_flight.wait()
assert await backend.entity_count() > before, "symbols placed before the cancel"
task.cancel()
with pytest.raises(asyncio.CancelledError):
await task
assert await backend.entity_count() == before, "the placed symbols were rolled back"
assert (await backend.system_status())["transaction_depth"] == 0, "no open transaction"
async def test_a_client_cancellation_through_the_transport_rolls_the_sheet_back(
client, monkeypatch
):
"""The docstring's promise, measured end to end: ``notifications/cancelled``
from a real ``fastmcp.Client`` mid-run leaves no half-drawn sheet and no
open transaction."""
import asyncio
from fastmcp.exceptions import McpError
from engineering.pid import spec as spec_module
async def slow_draw_line(*args, **kwargs):
await asyncio.sleep(30)
monkeypatch.setattr(spec_module, "draw_line", slow_draw_line)
async def depth() -> int:
return (await client.call_tool("system_status", {})).structured_content["transaction_depth"]
async def entities() -> int:
return (await client.call_tool("analysis_entity_stats", {})).structured_content[
"total_entities"
]
before = await entities()
# The session hands out ids sequentially, so the next one is the tool
# call's — provided nothing else is sent before the call goes out. Yield
# (no requests) until the counter has moved, then start polling.
request_id = client.session._request_id
call = asyncio.ensure_future(client.call_tool("pid_from_spec", {"spec": EXAMPLE_SPEC}))
async def call_sent() -> bool:
return client.session._request_id > request_id
await _wait_until(call_sent)
await _wait_until(lambda: _is_mid_run(depth, entities, before))
await client.cancel(request_id)
with pytest.raises(McpError, match="cancelled"):
await call
# The SDK answers the cancel before the handler's rollback has landed.
await _wait_until(lambda: _is_clean(depth, entities, before))
async def _is_mid_run(depth, entities, before) -> bool:
return await depth() == 1 and await entities() > before
async def _is_clean(depth, entities, before) -> bool:
return await depth() == 0 and await entities() == before
async def test_a_cancellation_with_a_com_call_in_flight_still_closes_the_undo_mark(
monkeypatch,
):
"""COM shape: real ``ComBackend._run``, a real single-thread executor and the
real ``transaction_rollback``; only the ActiveX document is a recorder.
With a COM call blocking the worker when the scope is cancelled, the
unshielded rollback's ``_run`` was cancelled while queued behind it — so
``EndUndoMark`` / ``_UNDO _B`` never reached AutoCAD — yet its ``finally``
cleared ``_transaction_active``: ``system_status`` said "no transaction"
while the undo mark was open, and the next ``transaction_begin`` nested a
second ``StartUndoMark``.
The order pinned here is the one measured on the live AutoCAD 2026: the
UNDO *Mark* goes in before the undo group, so ``_UNDO _B`` lands at the
transaction's start instead of prompting "This will undo everything".
"""
import asyncio
import time
import types
from concurrent.futures import ThreadPoolExecutor
import anyio
from backends import com_backend as module
from engineering.pid import spec as spec_module
sent: list[str] = []
doc = types.SimpleNamespace(
Name="Drawing1.dwg",
FullName="",
GetVariable=lambda name: 0, # CMDACTIVE clear
SendCommand=lambda cmd: sent.append(cmd.strip()),
StartUndoMark=lambda: sent.append("StartUndoMark"),
EndUndoMark=lambda: sent.append("EndUndoMark"),
)
app = types.SimpleNamespace(Documents=types.SimpleNamespace(Count=1), ActiveDocument=doc)
monkeypatch.setattr(module, "_acad_app", lambda: app) # _ensure_document_state
monkeypatch.setattr(module, "_acad_doc", lambda: doc) # begin / rollback
monkeypatch.setattr(
module.ComBackend,
"_safe_send_command",
staticmethod(lambda doc, cmd, deadline_s=8.0: sent.append(cmd) or []),
)
backend = module.ComBackend()
backend._executor = ThreadPoolExecutor(max_workers=1) # no CoInitialize: nothing is COM here
try:
placed = 0
async def fake_place(backend, section, item):
nonlocal placed
placed += 1
return {"handle": f"H{placed}"}
in_flight = asyncio.Event()
async def slow_draw_line(backend, *args, **kwargs):
in_flight.set()
await backend._run(time.sleep, 0.5) # the worker is inside a COM call
monkeypatch.setattr(spec_module, "_place", fake_place)
monkeypatch.setattr(spec_module, "draw_line", slow_draw_line)
async with anyio.create_task_group() as tg:
tg.start_soon(run_spec, backend, EXAMPLE_SPEC)
await in_flight.wait()
tg.cancel_scope.cancel()
assert sent == ["_.UNDO _M", "StartUndoMark", "EndUndoMark", "_.UNDO _B"], sent
assert backend._transaction_active is False
# The mark really is closed, so the next transaction is a fresh one.
assert (await backend.transaction_begin())["ok"] is True
assert sent[-2:] == ["_.UNDO _M", "StartUndoMark"]
finally:
backend._executor.shutdown(wait=True)
# ── a rollback that fails after a cancellation must not kill the session ─────
async def _cancel_mid_run(run, *, in_flight) -> None:
"""Cancel ``run`` through an anyio scope — the SDK's mechanism — once it is
inside ``draw_line``; returns normally only if the cancellation itself is
what left the task (a task group swallows its own cancellation and
re-raises anything else)."""
import anyio
async with anyio.create_task_group() as tg:
tg.start_soon(run)
await in_flight.wait()
tg.cancel_scope.cancel()
async def test_a_rollback_failure_after_a_cancellation_is_logged_not_raised(
backend, monkeypatch, caplog
):
"""Now that the shielded rollback body runs after a real cancellation it
can fail (the COM hard timeout, ``_safe_send_command``'s deadline, an ezdxf
quarantine refusal). That failure must not replace the cancellation: the
SDK has already answered the cancelled request and suppresses only a
cancellation exception — an ordinary error makes it respond a second time
and ``assert not self._completed`` kills the whole session."""
import asyncio
import logging
from engineering.pid import spec as spec_module
in_flight = asyncio.Event()
async def slow_draw_line(*args, **kwargs):
in_flight.set()
await asyncio.sleep(30)
async def failing_rollback():
raise RuntimeError("AutoCAD did not respond within 60s")
monkeypatch.setattr(spec_module, "draw_line", slow_draw_line)
monkeypatch.setattr(backend, "transaction_rollback", failing_rollback)
with caplog.at_level(logging.ERROR, logger="engineering.pid.spec"):
# With the rollback error escaping, the task group would raise it here.
await _cancel_mid_run(lambda: run_spec(backend, EXAMPLE_SPEC), in_flight=in_flight)
messages = [r.getMessage() for r in caplog.records if r.name == "engineering.pid.spec"]
assert any("did not respond within 60s" in m and "half-drawn" in m for m in messages), messages
monkeypatch.undo()
assert (await backend.transaction_rollback())["ok"] is True # the test's own cleanup
async def test_a_rollback_failure_after_an_ordinary_error_still_propagates(backend, monkeypatch):
"""Only a cancellation is special. After a ``ValueError`` the rollback's
own failure is the error the caller gets, with the original chained."""
from engineering.pid import spec as spec_module
async def bad_place(backend, section, item):
raise ValueError("placement refused")
async def failing_rollback():
raise RuntimeError("AutoCAD did not respond within 60s")
monkeypatch.setattr(spec_module, "_place", bad_place)
monkeypatch.setattr(backend, "transaction_rollback", failing_rollback)
with pytest.raises(RuntimeError, match="did not respond") as exc:
await run_spec(backend, EXAMPLE_SPEC)
assert isinstance(exc.value.__context__, ValueError)
assert "equipment[0]: placement refused" in str(exc.value.__context__)
monkeypatch.undo()
assert (await backend.transaction_rollback())["ok"] is True
async def test_a_rollback_failure_after_a_client_cancellation_leaves_the_session_alive(
client, monkeypatch
):
"""The same through the real transport: ``client.cancel(request id)``
mid-run, the rollback raises, and the *next* request is still answered.
Before the fix the server tried to respond twice to the cancelled request,
the lowlevel server's ``assert not self._completed`` escaped its task
group, ``system_status`` was never answered and ``Client.__aexit__``
re-raised the AssertionError."""
import asyncio
from fastmcp.exceptions import McpError
from backends import ezdxf_backend
from engineering.pid import spec as spec_module
async def slow_draw_line(*args, **kwargs):
await asyncio.sleep(30)
real_rollback = ezdxf_backend.EzdxfBackend.transaction_rollback
fail = True
calls: list[str] = []
async def rollback(self):
calls.append("rollback")
if fail:
raise RuntimeError("simulated rollback failure")
return await real_rollback(self)
monkeypatch.setattr(spec_module, "draw_line", slow_draw_line)
monkeypatch.setattr(ezdxf_backend.EzdxfBackend, "transaction_rollback", rollback)
async def depth() -> int:
return (await client.call_tool("system_status", {})).structured_content["transaction_depth"]
request_id = client.session._request_id
call = asyncio.ensure_future(client.call_tool("pid_from_spec", {"spec": EXAMPLE_SPEC}))
async def call_sent() -> bool:
return client.session._request_id > request_id
await _wait_until(call_sent)
await _wait_until(lambda: _is_depth(depth, 1))
await client.cancel(request_id)
with pytest.raises(McpError, match="cancelled"):
await call
async def rolled_back() -> bool:
return bool(calls)
await _wait_until(rolled_back)
# The session is alive: the next request is answered.
assert await asyncio.wait_for(depth(), timeout=5) == 1, "the failed rollback left it open"
fail = False # the test's own cleanup, through the real rollback
assert (await client.call_tool("transaction_rollback", {})).structured_content["ok"] is True
assert await depth() == 0
async def _is_depth(depth, wanted: int) -> bool:
return await depth() == wanted