Co-authored-by: Alexis Tacnet <alexis@mistral.ai> Co-authored-by: Clément Drouin <clement.drouin@mistral.ai> Co-authored-by: Guillaume LE GOFF <guillaume.lgf@gmail.com> Co-authored-by: Lucas Marandat <31749711+lucasmrdt@users.noreply.github.com> Co-authored-by: Maxime Dolores <maxime.dolores@ext.mistral.ai> Co-authored-by: Pierre Rossinès <pierre.rossines@mistral.ai> Co-authored-by: Quentin <quentin.torroba@mistral.ai> Co-authored-by: Val <102326092+vdeva@users.noreply.github.com> Co-authored-by: Vincent G <10739306+VinceOPS@users.noreply.github.com> Co-authored-by: p.vezia <166131032+le-codeur-rapide@users.noreply.github.com> Co-authored-by: Hiba Chaabnia <Hiba-Chaabnia@users.noreply.github.com> Co-authored-by: Nikhil Bhima <nikhilbhima@users.noreply.github.com> Co-authored-by: Nkipohcs <Nkipohcs@users.noreply.github.com> Co-authored-by: Mistral Vibe <vibe@mistral.ai>
331 lines
11 KiB
Python
331 lines
11 KiB
Python
from __future__ import annotations
|
|
|
|
from pathlib import Path
|
|
|
|
from acp import ReadTextFileResponse
|
|
import pytest
|
|
|
|
from tests.mock.utils import collect_result
|
|
from vibe.acp.tools.builtins.edit import AcpEditState, Edit
|
|
from vibe.core.tools.base import ToolError
|
|
from vibe.core.tools.builtins.edit import EditArgs, EditConfig, EditResult
|
|
from vibe.core.types import ToolCallEvent, ToolResultEvent
|
|
|
|
|
|
class MockClient:
|
|
def __init__(
|
|
self,
|
|
file_content: str = "original line 1\noriginal line 2\noriginal line 3",
|
|
read_error: Exception | None = None,
|
|
write_error: Exception | None = None,
|
|
) -> None:
|
|
self._file_content = file_content
|
|
self._read_error = read_error
|
|
self._write_error = write_error
|
|
self._read_text_file_called = False
|
|
self._write_text_file_called = False
|
|
self._session_update_called = False
|
|
self._last_read_params: dict[str, str | int | None] = {}
|
|
self._last_write_params: dict[str, str] = {}
|
|
self._write_calls: list[dict[str, str]] = []
|
|
|
|
async def read_text_file(
|
|
self,
|
|
path: str,
|
|
session_id: str,
|
|
limit: int | None = None,
|
|
line: int | None = None,
|
|
**kwargs,
|
|
) -> ReadTextFileResponse:
|
|
self._read_text_file_called = True
|
|
self._last_read_params = {
|
|
"path": path,
|
|
"session_id": session_id,
|
|
"limit": limit,
|
|
"line": line,
|
|
}
|
|
|
|
if self._read_error:
|
|
raise self._read_error
|
|
|
|
return ReadTextFileResponse(content=self._file_content)
|
|
|
|
async def write_text_file(
|
|
self, content: str, path: str, session_id: str, **kwargs
|
|
) -> None:
|
|
self._write_text_file_called = True
|
|
params = {"content": content, "path": path, "session_id": session_id}
|
|
self._last_write_params = params
|
|
self._write_calls.append(params)
|
|
|
|
if self._write_error:
|
|
raise self._write_error
|
|
|
|
async def session_update(self, session_id: str, update, **kwargs) -> None:
|
|
self._session_update_called = True
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_client() -> MockClient:
|
|
return MockClient()
|
|
|
|
|
|
@pytest.fixture
|
|
def acp_edit_tool(
|
|
mock_client: MockClient, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> Edit:
|
|
monkeypatch.chdir(tmp_path)
|
|
config = EditConfig()
|
|
state = AcpEditState.model_construct(
|
|
client=mock_client, session_id="test_session_123"
|
|
)
|
|
return Edit(config_getter=lambda: config, state=state)
|
|
|
|
|
|
class TestAcpEditBasic:
|
|
def test_get_name(self) -> None:
|
|
assert Edit.get_name() == "edit"
|
|
|
|
|
|
class TestAcpEditExecution:
|
|
@pytest.mark.asyncio
|
|
async def test_run_success(
|
|
self, acp_edit_tool: Edit, mock_client: MockClient, tmp_path: Path
|
|
) -> None:
|
|
test_file = tmp_path / "test_file.txt"
|
|
test_file.write_text("original line 1\noriginal line 2\noriginal line 3")
|
|
args = EditArgs(
|
|
file_path=str(test_file),
|
|
old_string="original line 2",
|
|
new_string="modified line 2",
|
|
)
|
|
result = await collect_result(acp_edit_tool.run(args))
|
|
|
|
assert isinstance(result, EditResult)
|
|
assert result.file == str(test_file)
|
|
assert mock_client._read_text_file_called
|
|
assert mock_client._write_text_file_called
|
|
|
|
read_params = mock_client._last_read_params
|
|
assert read_params["session_id"] == "test_session_123"
|
|
assert read_params["path"] == str(test_file)
|
|
|
|
write_params = mock_client._last_write_params
|
|
assert write_params["session_id"] == "test_session_123"
|
|
assert write_params["path"] == str(test_file)
|
|
assert (
|
|
write_params["content"]
|
|
== "original line 1\nmodified line 2\noriginal line 3"
|
|
)
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("newline", ["\r\n", "\r", "\n"])
|
|
async def test_run_preserves_line_endings(
|
|
self,
|
|
newline: str,
|
|
mock_client: MockClient,
|
|
tmp_path: Path,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
monkeypatch.chdir(tmp_path)
|
|
mock_client._file_content = newline.join([
|
|
"original line 1",
|
|
"original line 2",
|
|
"original line 3",
|
|
])
|
|
|
|
tool = Edit(
|
|
config_getter=lambda: EditConfig(),
|
|
state=AcpEditState.model_construct(
|
|
client=mock_client, session_id="test_session"
|
|
),
|
|
)
|
|
|
|
test_file = tmp_path / "test_file.txt"
|
|
test_file.touch()
|
|
args = EditArgs(
|
|
file_path=str(test_file),
|
|
old_string="original line 2",
|
|
new_string="modified line 2",
|
|
)
|
|
await collect_result(tool.run(args))
|
|
|
|
assert mock_client._last_write_params["content"] == newline.join([
|
|
"original line 1",
|
|
"modified line 2",
|
|
"original line 3",
|
|
])
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_read_error(
|
|
self, mock_client: MockClient, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
monkeypatch.chdir(tmp_path)
|
|
mock_client._read_error = RuntimeError("File not found")
|
|
|
|
tool = Edit(
|
|
config_getter=lambda: EditConfig(),
|
|
state=AcpEditState.model_construct(
|
|
client=mock_client, session_id="test_session"
|
|
),
|
|
)
|
|
|
|
test_file = tmp_path / "test.txt"
|
|
test_file.touch()
|
|
args = EditArgs(file_path=str(test_file), old_string="old", new_string="new")
|
|
with pytest.raises(ToolError) as exc_info:
|
|
await collect_result(tool.run(args))
|
|
|
|
assert str(exc_info.value) == f"Error reading {test_file}: File not found"
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_write_error(
|
|
self, mock_client: MockClient, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
) -> None:
|
|
monkeypatch.chdir(tmp_path)
|
|
mock_client._write_error = RuntimeError("Permission denied")
|
|
test_file = tmp_path / "test.txt"
|
|
test_file.touch()
|
|
mock_client._file_content = "old"
|
|
|
|
tool = Edit(
|
|
config_getter=lambda: EditConfig(),
|
|
state=AcpEditState.model_construct(
|
|
client=mock_client, session_id="test_session"
|
|
),
|
|
)
|
|
|
|
args = EditArgs(file_path=str(test_file), old_string="old", new_string="new")
|
|
with pytest.raises(ToolError) as exc_info:
|
|
await collect_result(tool.run(args))
|
|
|
|
assert str(exc_info.value) == f"Error writing {test_file}: Permission denied"
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize(
|
|
"client,session_id,expected_error",
|
|
[
|
|
(
|
|
None,
|
|
"test_session",
|
|
"Client not available in tool state. This tool can only be used within an ACP session.",
|
|
),
|
|
(
|
|
MockClient(),
|
|
None,
|
|
"Session ID not available in tool state. This tool can only be used within an ACP session.",
|
|
),
|
|
],
|
|
)
|
|
async def test_run_without_required_state(
|
|
self,
|
|
tmp_path: Path,
|
|
client: MockClient | None,
|
|
session_id: str | None,
|
|
expected_error: str,
|
|
monkeypatch: pytest.MonkeyPatch,
|
|
) -> None:
|
|
monkeypatch.chdir(tmp_path)
|
|
test_file = tmp_path / "test.txt"
|
|
test_file.touch()
|
|
tool = Edit(
|
|
config_getter=lambda: EditConfig(),
|
|
state=AcpEditState.model_construct(client=client, session_id=session_id),
|
|
)
|
|
|
|
args = EditArgs(file_path=str(test_file), old_string="old", new_string="new")
|
|
with pytest.raises(ToolError) as exc_info:
|
|
await collect_result(tool.run(args))
|
|
|
|
assert str(exc_info.value) == expected_error
|
|
|
|
|
|
class TestAcpEditSessionUpdates:
|
|
def test_tool_call_session_update(self) -> None:
|
|
event = ToolCallEvent(
|
|
tool_name="edit",
|
|
tool_call_id="test_call_123",
|
|
args=EditArgs(
|
|
file_path="/tmp/test.txt", old_string="old text", new_string="new text"
|
|
),
|
|
tool_class=Edit,
|
|
)
|
|
|
|
update = Edit.tool_call_session_update(event)
|
|
assert update is not None
|
|
assert update.session_update == "tool_call"
|
|
assert update.tool_call_id == "test_call_123"
|
|
assert update.kind == "edit"
|
|
assert update.title is not None
|
|
assert update.content is not None
|
|
assert isinstance(update.content, list)
|
|
assert len(update.content) == 1
|
|
assert update.content[0].type == "diff"
|
|
assert update.content[0].path == "/tmp/test.txt"
|
|
assert update.content[0].old_text == "old text"
|
|
assert update.content[0].new_text == "new text"
|
|
assert update.locations is not None
|
|
assert len(update.locations) == 1
|
|
assert update.locations[0].path == str(Path("/tmp/test.txt").resolve())
|
|
|
|
def test_tool_call_session_update_invalid_args(self) -> None:
|
|
class InvalidArgs:
|
|
pass
|
|
|
|
event = ToolCallEvent.model_construct(
|
|
tool_name="edit",
|
|
tool_call_id="test_call_123",
|
|
args=InvalidArgs(), # type: ignore[arg-type]
|
|
tool_class=Edit,
|
|
)
|
|
|
|
update = Edit.tool_call_session_update(event)
|
|
assert update is not None
|
|
assert update.title == "edit"
|
|
|
|
def test_tool_result_session_update(self) -> None:
|
|
result = EditResult(
|
|
file="/tmp/test.txt",
|
|
message="The file has been updated successfully.",
|
|
old_string="old text",
|
|
new_string="new text",
|
|
)
|
|
|
|
event = ToolResultEvent(
|
|
tool_name="edit",
|
|
tool_call_id="test_call_123",
|
|
result=result,
|
|
tool_class=Edit,
|
|
)
|
|
|
|
update = Edit.tool_result_session_update(event)
|
|
assert update is not None
|
|
assert update.session_update == "tool_call_update"
|
|
assert update.tool_call_id == "test_call_123"
|
|
assert update.status == "completed"
|
|
assert update.kind == "edit"
|
|
assert update.content is not None
|
|
assert isinstance(update.content, list)
|
|
assert len(update.content) == 1
|
|
assert update.content[0].type == "diff"
|
|
assert update.content[0].path == "/tmp/test.txt"
|
|
assert update.content[0].old_text == "old text"
|
|
assert update.content[0].new_text == "new text"
|
|
assert update.locations is not None
|
|
assert len(update.locations) == 1
|
|
assert update.locations[0].path == str(Path("/tmp/test.txt").resolve())
|
|
|
|
def test_tool_result_session_update_invalid_result(self) -> None:
|
|
class InvalidResult:
|
|
pass
|
|
|
|
event = ToolResultEvent.model_construct(
|
|
tool_name="edit",
|
|
tool_call_id="test_call_123",
|
|
result=InvalidResult(), # type: ignore[arg-type]
|
|
tool_class=Edit,
|
|
)
|
|
|
|
update = Edit.tool_result_session_update(event)
|
|
assert update is not None
|
|
assert update.status == "failed"
|