# 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 __future__ import annotations from unittest.mock import AsyncMock from unittest.mock import Mock from google.adk.agents.invocation_context import InvocationContext from google.adk.artifacts.base_artifact_service import ArtifactVersion from google.adk.plugins.save_files_as_artifacts_plugin import SaveFilesAsArtifactsPlugin from google.genai import types import pytest class TestSaveFilesAsArtifactsPlugin: """Test suite for SaveFilesAsArtifactsPlugin.""" def setup_method(self): """Set up test fixtures.""" self.plugin = SaveFilesAsArtifactsPlugin() # Mock invocation context self.mock_context = Mock(spec=InvocationContext) self.mock_context.app_name = "test_app" self.mock_context.user_id = "test_user" self.mock_context.invocation_id = "test_invocation_123" self.mock_context.session = Mock() self.mock_context.session.id = "test_session" self.mock_context.session.state = {} artifact_service = Mock() artifact_service.save_artifact = AsyncMock(return_value=0) async def _mock_get_artifact_version(**kwargs): filename = kwargs.get("filename", "unknown_file") version = kwargs.get("version", 0) return ArtifactVersion( version=version, canonical_uri=f"gs://mock-bucket/{filename}/versions/{version}", mime_type="application/pdf", ) artifact_service.get_artifact_version = AsyncMock( side_effect=_mock_get_artifact_version ) self.mock_context.artifact_service = artifact_service @pytest.mark.asyncio async def test_save_files_with_display_name(self): """Test saving files when inline_data has display_name.""" inline_data = types.Blob( display_name="test_document.pdf", data=b"test data", mime_type="application/pdf", ) original_part = types.Part(inline_data=inline_data) user_message = types.Content(parts=[original_part]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) self.mock_context.artifact_service.save_artifact.assert_called_once_with( app_name="test_app", user_id="test_user", session_id="test_session", filename="test_document.pdf", artifact=original_part, ) assert result assert len(result.parts) == 2 assert result.parts[0].text == '[Uploaded Artifact: "test_document.pdf"]' assert result.parts[1].file_data assert ( result.parts[1].file_data.file_uri == "gs://mock-bucket/test_document.pdf/versions/0" ) assert result.parts[1].file_data.display_name == "test_document.pdf" assert result.parts[1].file_data.mime_type == "application/pdf" @pytest.mark.asyncio async def test_attach_file_reference_false(self): """Test that file reference is not attached when attach_file_reference is False.""" plugin = SaveFilesAsArtifactsPlugin(attach_file_reference=False) inline_data = types.Blob( display_name="test_document.pdf", data=b"test data", mime_type="application/pdf", ) original_part = types.Part(inline_data=inline_data) user_message = types.Content(parts=[original_part]) result = await plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) self.mock_context.artifact_service.save_artifact.assert_called_once_with( app_name="test_app", user_id="test_user", session_id="test_session", filename="test_document.pdf", artifact=original_part, ) assert result assert len(result.parts) == 1 assert result.parts[0].text == '[Uploaded Artifact: "test_document.pdf"]' @pytest.mark.asyncio async def test_save_files_without_display_name(self): """Test saving files when inline_data has no display_name.""" inline_data = types.Blob( display_name=None, data=b"test data", mime_type="application/pdf" ) original_part = types.Part(inline_data=inline_data) user_message = types.Content(parts=[original_part]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) expected_filename = "artifact_test_invocation_123_0" self.mock_context.artifact_service.save_artifact.assert_called_once_with( app_name="test_app", user_id="test_user", session_id="test_session", filename=expected_filename, artifact=original_part, ) assert result assert len(result.parts) == 2 assert result.parts[0].text == f'[Uploaded Artifact: "{expected_filename}"]' assert result.parts[1].file_data assert ( result.parts[1].file_data.file_uri == "gs://mock-bucket/artifact_test_invocation_123_0/versions/0" ) assert result.parts[1].file_data.display_name == expected_filename @pytest.mark.asyncio async def test_multiple_files_in_message(self): """Test handling multiple files in a single message.""" inline_data1 = types.Blob( display_name="file1.txt", data=b"file1 content", mime_type="text/plain" ) inline_data2 = types.Blob( display_name="file2.jpg", data=b"file2 content", mime_type="image/jpeg" ) user_message = types.Content( parts=[ types.Part(inline_data=inline_data1), types.Part(text="Some text between files"), types.Part(inline_data=inline_data2), ] ) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert self.mock_context.artifact_service.save_artifact.call_count == 2 first_call = ( self.mock_context.artifact_service.save_artifact.call_args_list[0] ) second_call = ( self.mock_context.artifact_service.save_artifact.call_args_list[1] ) assert first_call[1]["filename"] == "file1.txt" assert second_call[1]["filename"] == "file2.jpg" assert result assert len(result.parts) == 5 assert result.parts[0].text == '[Uploaded Artifact: "file1.txt"]' assert result.parts[1].file_data assert ( result.parts[1].file_data.file_uri == "gs://mock-bucket/file1.txt/versions/0" ) assert result.parts[1].file_data.display_name == "file1.txt" assert result.parts[2].text == "Some text between files" assert result.parts[3].text == '[Uploaded Artifact: "file2.jpg"]' assert result.parts[4].file_data assert ( result.parts[4].file_data.file_uri == "gs://mock-bucket/file2.jpg/versions/0" ) assert result.parts[4].file_data.display_name == "file2.jpg" @pytest.mark.asyncio async def test_no_artifact_service(self): """Test behavior when artifact service is not available.""" self.mock_context.artifact_service = None inline_data = types.Blob( display_name="test.pdf", data=b"test data", mime_type="application/pdf" ) user_message = types.Content(parts=[types.Part(inline_data=inline_data)]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert result == user_message assert result.parts[0].inline_data == inline_data @pytest.mark.asyncio async def test_no_parts_in_message(self): """Test behavior when message has no parts.""" user_message = types.Content(parts=[]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert result is None self.mock_context.artifact_service.save_artifact.assert_not_called() @pytest.mark.asyncio async def test_parts_without_inline_data(self): """Test behavior with parts that don't have inline_data.""" user_message = types.Content( parts=[types.Part(text="Hello world"), types.Part(text="No files here")] ) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert result is None self.mock_context.artifact_service.save_artifact.assert_not_called() @pytest.mark.asyncio async def test_save_artifact_failure(self): """Test behavior when saving artifact fails.""" self.mock_context.artifact_service.save_artifact.side_effect = Exception( "Storage error" ) inline_data = types.Blob( display_name="test.pdf", data=b"test data", mime_type="application/pdf" ) user_message = types.Content(parts=[types.Part(inline_data=inline_data)]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert result is None @pytest.mark.asyncio async def test_mixed_success_and_failure(self): """Test behavior when some files save successfully and others fail.""" save_calls = 0 async def _save_side_effect(*_args, **_kwargs): nonlocal save_calls save_calls += 1 if save_calls == 2: raise Exception("Storage error on second file") return 0 self.mock_context.artifact_service.save_artifact.side_effect = ( _save_side_effect ) inline_data1 = types.Blob( display_name="success.pdf", data=b"success data", mime_type="application/pdf", ) inline_data2 = types.Blob( display_name="failure.pdf", data=b"failure data", mime_type="application/pdf", ) original_part2 = types.Part(inline_data=inline_data2) user_message = types.Content( parts=[types.Part(inline_data=inline_data1), original_part2] ) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) assert result assert len(result.parts) == 3 assert result.parts[0].text == '[Uploaded Artifact: "success.pdf"]' assert result.parts[1].file_data assert result.parts[2] == original_part2 assert result.parts[2].inline_data == inline_data2 @pytest.mark.asyncio async def test_placeholder_text_format(self): """Test that placeholder text is formatted correctly.""" inline_data = types.Blob( display_name="test file with spaces.docx", data=b"document data", mime_type=( "application/vnd.openxmlformats-officedocument." "wordprocessingml.document" ), ) user_message = types.Content(parts=[types.Part(inline_data=inline_data)]) result = await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) expected_text = '[Uploaded Artifact: "test file with spaces.docx"]' assert result.parts[0].text == expected_text assert result.parts[1].file_data def test_plugin_name_default(self): """Test that plugin has correct default name.""" plugin = SaveFilesAsArtifactsPlugin() assert plugin.name == "save_files_as_artifacts_plugin" @pytest.mark.asyncio async def test_artifact_delta_reporting(self): """Test that the artifact delta is written to state then event actions.""" # 1. First Turn - Trigger user message callback blob = types.Blob( display_name="blob.pdf", data=b"test data", mime_type="application/pdf", ) user_message = types.Content(parts=[types.Part(inline_data=blob)]) await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message ) # Verify state is updated key = "save_files_as_artifacts_plugin:pending_delta" assert key in self.mock_context.session.state assert self.mock_context.session.state[key] == {"blob.pdf": 0} # 2. First Turn - Trigger before agent callback callback_context = Mock() callback_context.state = self.mock_context.session.state callback_context.actions = Mock() callback_context.actions.artifact_delta = {} await self.plugin.before_agent_callback( agent=Mock(), callback_context=callback_context ) # Verify artifact_delta is updated and state is cleared assert callback_context.actions.artifact_delta == {"blob.pdf": 0} assert self.mock_context.session.state[key] == {} # 3. Second Turn - Trigger user message callback blob_2 = types.Blob( display_name="blob_2.pdf", data=b"test data 2", mime_type="application/pdf", ) user_message_2 = types.Content(parts=[types.Part(inline_data=blob_2)]) await self.plugin.on_user_message_callback( invocation_context=self.mock_context, user_message=user_message_2 ) # Verify state is updated assert self.mock_context.session.state[key] == {"blob_2.pdf": 0} # 4. Second Turn - Trigger before agent callback callback_context_2 = Mock() callback_context_2.state = self.mock_context.session.state callback_context_2.actions = Mock() callback_context_2.actions.artifact_delta = {} await self.plugin.before_agent_callback( agent=Mock(), callback_context=callback_context_2 ) # Verify artifact_delta is updated and state is cleared assert callback_context_2.actions.artifact_delta == {"blob_2.pdf": 0} assert self.mock_context.session.state[key] == {}