# Copyright 2026 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. from pathlib import Path from unittest.mock import MagicMock, patch from artemis.context import ArtemisContext from artemis.graph.state import State from artemis.tools.base import ArtemisTool from artemis.tools.scratchpad import ( SaveNote, SaveNoteArgs, SaveNoteTool, get_save_note_tool, get_save_note_tool_pure, save_note, save_note_wrapper, ) from langchain_core.messages import ToolMessage import pytest @pytest.fixture def mock_ctx(tmp_path): ctx = MagicMock(spec=ArtemisContext) ctx.data_engine = MagicMock() ctx.data_engine.base_dir = str(tmp_path) return ctx def test_save_note_tool_subclass(): """Verify SaveNoteTool is a subclass of ArtemisTool.""" assert issubclass(SaveNoteTool, ArtemisTool) assert issubclass(SaveNote, ArtemisTool) assert isinstance(save_note, ArtemisTool) assert isinstance(save_note, SaveNoteTool) assert save_note.name == "save_note" assert save_note.category == "memory" assert save_note.args_schema == SaveNoteArgs # GenAI FunctionDeclaration export declaration = save_note.to_tool_declaration() assert declaration.name == "save_note" assert "key" in declaration.parameters["properties"] assert "content" in declaration.parameters["properties"] # Wrapper check assert save_note_wrapper is not None assert save_note_wrapper.tool_fn_getter == get_save_note_tool @pytest.mark.asyncio async def test_save_note_direct_execution_success(mock_ctx, tmp_path): """Verify direct execution of SaveNoteTool.execute creates note file.""" result = await save_note.execute( ctx=mock_ctx, key="test_note", content="Hello Artemis memory", ) assert result == "Saved note 'test_note'." note_path = Path(tmp_path) / "notes" / "test_note.md" assert note_path.exists() assert note_path.read_text(encoding="utf-8") == "Hello Artemis memory" @pytest.mark.asyncio async def test_save_note_callable_execution(mock_ctx, tmp_path): """Verify invoking save_note directly as a callable.""" result = await save_note( ctx=mock_ctx, key="callable_note", content="Callable invocation test", ) assert result == "Saved note 'callable_note'." note_path = Path(tmp_path) / "notes" / "callable_note.md" assert note_path.exists() assert note_path.read_text(encoding="utf-8") == "Callable invocation test" @pytest.mark.asyncio async def test_save_note_with_state_tool_message(mock_ctx, tmp_path): """Verify SaveNoteTool.execute with state returns a ToolMessage directly.""" mock_state = MagicMock(spec=State) result = await save_note.execute( ctx=mock_ctx, key="state_note", content="Note with state", state=mock_state, tool_call_id="call_save_999", ) assert isinstance(result, ToolMessage) assert result.tool_call_id == "call_save_999" assert result.content == "Saved note 'state_note'." assert result.status == "success" note_path = Path(tmp_path) / "notes" / "state_note.md" assert note_path.exists() assert note_path.read_text(encoding="utf-8") == "Note with state" @pytest.mark.asyncio async def test_save_note_execution_failure(mock_ctx): """Verify error handling when saving note fails.""" with patch( "artemis.tools.scratchpad.save_note_content", side_effect=PermissionError("Permission denied"), ): result = await save_note.execute( ctx=mock_ctx, key="fail_note", content="Fail content", ) assert "Failed to save note fail_note.md: Permission denied" in result @pytest.mark.asyncio async def test_get_save_note_tool_langchain_ainvoke(mock_ctx, tmp_path): """Verify get_save_note_tool exports a LangChain tool that works with ainvoke.""" lc_tool = get_save_note_tool(mock_ctx) assert lc_tool.name == "save_note" result = await lc_tool.ainvoke( { "key": "lc_note", "content": "Saved via LangChain BaseTool", } ) assert result == "Saved note 'lc_note'." note_path = Path(tmp_path) / "notes" / "lc_note.md" assert note_path.exists() assert note_path.read_text(encoding="utf-8") == "Saved via LangChain BaseTool" @pytest.mark.asyncio async def test_get_save_note_tool_pure(mock_ctx, tmp_path): """Verify get_save_note_tool_pure returns a pure LangChain tool.""" pure_tool = get_save_note_tool_pure(mock_ctx) assert pure_tool.name == "save_note" result = await pure_tool.ainvoke( { "key": "pure_note", "content": "Saved via pure tool", } ) assert result == "Saved note 'pure_note'." note_path = Path(tmp_path) / "notes" / "pure_note.md" assert note_path.exists() assert note_path.read_text(encoding="utf-8") == "Saved via pure tool"