mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
672 lines
21 KiB
Python
672 lines
21 KiB
Python
# Copyright 2025 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.
|
|
|
|
import os
|
|
import sys
|
|
from typing import Optional
|
|
from unittest import mock
|
|
|
|
from google.adk import version as adk_version
|
|
from google.adk.models.gemini_llm_connection import GeminiLlmConnection
|
|
from google.adk.models.google_llm import _AGENT_ENGINE_TELEMETRY_ENV_VARIABLE_NAME
|
|
from google.adk.models.google_llm import _AGENT_ENGINE_TELEMETRY_TAG
|
|
from google.adk.models.google_llm import Gemini
|
|
from google.adk.models.llm_request import LlmRequest
|
|
from google.adk.models.llm_response import LlmResponse
|
|
from google.adk.utils.variant_utils import GoogleLLMVariant
|
|
from google.genai import types
|
|
from google.genai import version as genai_version
|
|
from google.genai.types import Content
|
|
from google.genai.types import Part
|
|
import pytest
|
|
|
|
|
|
@pytest.fixture
|
|
def generate_content_response():
|
|
return types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model",
|
|
parts=[Part.from_text(text="Hello, how can I help you?")],
|
|
),
|
|
finish_reason=types.FinishReason.STOP,
|
|
)
|
|
]
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def gemini_llm():
|
|
return Gemini(model="gemini-1.5-flash")
|
|
|
|
|
|
@pytest.fixture
|
|
def llm_request():
|
|
return LlmRequest(
|
|
model="gemini-1.5-flash",
|
|
contents=[Content(role="user", parts=[Part.from_text(text="Hello")])],
|
|
config=types.GenerateContentConfig(
|
|
temperature=0.1,
|
|
response_modalities=[types.Modality.TEXT],
|
|
system_instruction="You are a helpful assistant",
|
|
),
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_os_environ():
|
|
initial_env = os.environ.copy()
|
|
with mock.patch.dict(os.environ, initial_env, clear=False) as m:
|
|
yield m
|
|
|
|
|
|
def test_supported_models():
|
|
models = Gemini.supported_models()
|
|
assert len(models) == 3
|
|
assert models[0] == r"gemini-.*"
|
|
assert models[1] == r"projects\/.+\/locations\/.+\/endpoints\/.+"
|
|
assert (
|
|
models[2]
|
|
== r"projects\/.+\/locations\/.+\/publishers\/google\/models\/gemini.+"
|
|
)
|
|
|
|
|
|
def test_client_version_header():
|
|
model = Gemini(model="gemini-1.5-flash")
|
|
client = model.api_client
|
|
adk_header = (
|
|
f"google-adk/{adk_version.__version__} gl-python/{sys.version.split()[0]}"
|
|
)
|
|
genai_header = (
|
|
f"google-genai-sdk/{genai_version.__version__} gl-python/{sys.version.split()[0]} "
|
|
)
|
|
expected_header = genai_header + adk_header
|
|
|
|
assert (
|
|
expected_header
|
|
in client._api_client._http_options.headers["x-goog-api-client"]
|
|
)
|
|
assert (
|
|
expected_header in client._api_client._http_options.headers["user-agent"]
|
|
)
|
|
|
|
|
|
def test_client_version_header_with_agent_engine(mock_os_environ):
|
|
os.environ[_AGENT_ENGINE_TELEMETRY_ENV_VARIABLE_NAME] = "my_test_project"
|
|
model = Gemini(model="gemini-1.5-flash")
|
|
client = model.api_client
|
|
adk_header_base = f"google-adk/{adk_version.__version__}"
|
|
adk_header_with_telemetry = (
|
|
f"{adk_header_base}+{_AGENT_ENGINE_TELEMETRY_TAG}"
|
|
f" gl-python/{sys.version.split()[0]}"
|
|
)
|
|
genai_header = (
|
|
f"google-genai-sdk/{genai_version.__version__} "
|
|
f"gl-python/{sys.version.split()[0]} "
|
|
)
|
|
expected_header = genai_header + adk_header_with_telemetry
|
|
|
|
assert (
|
|
expected_header
|
|
in client._api_client._http_options.headers["x-goog-api-client"]
|
|
)
|
|
assert (
|
|
expected_header in client._api_client._http_options.headers["user-agent"]
|
|
)
|
|
|
|
|
|
def test_maybe_append_user_content(gemini_llm, llm_request):
|
|
# Test with user content already present
|
|
gemini_llm._maybe_append_user_content(llm_request)
|
|
assert len(llm_request.contents) == 1
|
|
|
|
# Test with model content as the last message
|
|
llm_request.contents.append(
|
|
Content(role="model", parts=[Part.from_text(text="Response")])
|
|
)
|
|
gemini_llm._maybe_append_user_content(llm_request)
|
|
assert len(llm_request.contents) == 3
|
|
assert llm_request.contents[-1].role == "user"
|
|
assert "Continue processing" in llm_request.contents[-1].parts[0].text
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async(
|
|
gemini_llm, llm_request, generate_content_response
|
|
):
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
# Create a mock coroutine that returns the generate_content_response
|
|
async def mock_coro():
|
|
return generate_content_response
|
|
|
|
# Assign the coroutine to the mocked method
|
|
mock_client.aio.models.generate_content.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=False
|
|
)
|
|
]
|
|
|
|
assert len(responses) == 1
|
|
assert isinstance(responses[0], LlmResponse)
|
|
assert responses[0].content.parts[0].text == "Hello, how can I help you?"
|
|
mock_client.aio.models.generate_content.assert_called_once()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async_stream(gemini_llm, llm_request):
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
# Create mock stream responses
|
|
class MockAsyncIterator:
|
|
|
|
def __init__(self, seq):
|
|
self.iter = iter(seq)
|
|
|
|
def __aiter__(self):
|
|
return self
|
|
|
|
async def __anext__(self):
|
|
try:
|
|
return next(self.iter)
|
|
except StopIteration:
|
|
raise StopAsyncIteration
|
|
|
|
mock_responses = [
|
|
types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model", parts=[Part.from_text(text="Hello")]
|
|
),
|
|
finish_reason=None,
|
|
)
|
|
]
|
|
),
|
|
types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model", parts=[Part.from_text(text=", how")]
|
|
),
|
|
finish_reason=None,
|
|
)
|
|
]
|
|
),
|
|
types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model",
|
|
parts=[Part.from_text(text=" can I help you?")],
|
|
),
|
|
finish_reason=types.FinishReason.STOP,
|
|
)
|
|
]
|
|
),
|
|
]
|
|
|
|
# Create a mock coroutine that returns the MockAsyncIterator
|
|
async def mock_coro():
|
|
return MockAsyncIterator(mock_responses)
|
|
|
|
# Set the mock to return the coroutine
|
|
mock_client.aio.models.generate_content_stream.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=True
|
|
)
|
|
]
|
|
|
|
# Assertions remain the same
|
|
assert len(responses) == 4
|
|
assert responses[0].partial is True
|
|
assert responses[1].partial is True
|
|
assert responses[2].partial is True
|
|
assert responses[3].content.parts[0].text == "Hello, how can I help you?"
|
|
mock_client.aio.models.generate_content_stream.assert_called_once()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async_stream_preserves_thinking_and_text_parts(
|
|
gemini_llm, llm_request
|
|
):
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
|
|
class MockAsyncIterator:
|
|
|
|
def __init__(self, seq):
|
|
self._iter = iter(seq)
|
|
|
|
def __aiter__(self):
|
|
return self
|
|
|
|
async def __anext__(self):
|
|
try:
|
|
return next(self._iter)
|
|
except StopIteration:
|
|
raise StopAsyncIteration
|
|
|
|
response1 = types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model",
|
|
parts=[Part(text="Think1", thought=True)],
|
|
),
|
|
finish_reason=None,
|
|
)
|
|
]
|
|
)
|
|
response2 = types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model",
|
|
parts=[Part(text="Think2", thought=True)],
|
|
),
|
|
finish_reason=None,
|
|
)
|
|
]
|
|
)
|
|
response3 = types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model",
|
|
parts=[Part.from_text(text="Answer.")],
|
|
),
|
|
finish_reason=types.FinishReason.STOP,
|
|
)
|
|
]
|
|
)
|
|
|
|
async def mock_coro():
|
|
return MockAsyncIterator([response1, response2, response3])
|
|
|
|
mock_client.aio.models.generate_content_stream.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=True
|
|
)
|
|
]
|
|
|
|
assert len(responses) == 4
|
|
assert responses[0].partial is True
|
|
assert responses[1].partial is True
|
|
assert responses[2].partial is True
|
|
assert responses[3].content.parts[0].text == "Think1Think2"
|
|
assert responses[3].content.parts[0].thought is True
|
|
assert responses[3].content.parts[1].text == "Answer."
|
|
mock_client.aio.models.generate_content_stream.assert_called_once()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_connect(gemini_llm, llm_request):
|
|
# Create a mock connection
|
|
mock_connection = mock.MagicMock(spec=GeminiLlmConnection)
|
|
|
|
# Create a mock context manager
|
|
class MockContextManager:
|
|
|
|
async def __aenter__(self):
|
|
return mock_connection
|
|
|
|
async def __aexit__(self, *args):
|
|
pass
|
|
|
|
# Mock the connect method at the class level
|
|
with mock.patch(
|
|
"google.adk.models.google_llm.Gemini.connect",
|
|
return_value=MockContextManager(),
|
|
):
|
|
async with gemini_llm.connect(llm_request) as connection:
|
|
assert connection is mock_connection
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async_with_custom_headers(
|
|
gemini_llm, llm_request, generate_content_response
|
|
):
|
|
"""Test that tracking headers are updated when custom headers are provided."""
|
|
# Add custom headers to the request config
|
|
custom_headers = {"custom-header": "custom-value"}
|
|
for key in gemini_llm._tracking_headers:
|
|
custom_headers[key] = "custom " + gemini_llm._tracking_headers[key]
|
|
llm_request.config.http_options = types.HttpOptions(headers=custom_headers)
|
|
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
# Create a mock coroutine that returns the generate_content_response
|
|
async def mock_coro():
|
|
return generate_content_response
|
|
|
|
mock_client.aio.models.generate_content.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=False
|
|
)
|
|
]
|
|
|
|
# Verify that the config passed to generate_content contains merged headers
|
|
mock_client.aio.models.generate_content.assert_called_once()
|
|
call_args = mock_client.aio.models.generate_content.call_args
|
|
config_arg = call_args.kwargs["config"]
|
|
|
|
for key, value in config_arg.http_options.headers.items():
|
|
if key in gemini_llm._tracking_headers:
|
|
assert value == gemini_llm._tracking_headers[key]
|
|
else:
|
|
assert value == custom_headers[key]
|
|
|
|
assert len(responses) == 1
|
|
assert isinstance(responses[0], LlmResponse)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async_stream_with_custom_headers(
|
|
gemini_llm, llm_request
|
|
):
|
|
"""Test that tracking headers are updated when custom headers are provided in streaming mode."""
|
|
# Add custom headers to the request config
|
|
custom_headers = {"custom-header": "custom-value"}
|
|
llm_request.config.http_options = types.HttpOptions(headers=custom_headers)
|
|
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
# Create mock stream responses
|
|
class MockAsyncIterator:
|
|
|
|
def __init__(self, seq):
|
|
self.iter = iter(seq)
|
|
|
|
def __aiter__(self):
|
|
return self
|
|
|
|
async def __anext__(self):
|
|
try:
|
|
return next(self.iter)
|
|
except StopIteration:
|
|
raise StopAsyncIteration
|
|
|
|
mock_responses = [
|
|
types.GenerateContentResponse(
|
|
candidates=[
|
|
types.Candidate(
|
|
content=Content(
|
|
role="model", parts=[Part.from_text(text="Hello")]
|
|
),
|
|
finish_reason=types.FinishReason.STOP,
|
|
)
|
|
]
|
|
)
|
|
]
|
|
|
|
async def mock_coro():
|
|
return MockAsyncIterator(mock_responses)
|
|
|
|
mock_client.aio.models.generate_content_stream.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=True
|
|
)
|
|
]
|
|
|
|
# Verify that the config passed to generate_content_stream contains merged headers
|
|
mock_client.aio.models.generate_content_stream.assert_called_once()
|
|
call_args = mock_client.aio.models.generate_content_stream.call_args
|
|
config_arg = call_args.kwargs["config"]
|
|
|
|
expected_headers = custom_headers.copy()
|
|
expected_headers.update(gemini_llm._tracking_headers)
|
|
assert config_arg.http_options.headers == expected_headers
|
|
|
|
assert len(responses) == 2
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_generate_content_async_without_custom_headers(
|
|
gemini_llm, llm_request, generate_content_response
|
|
):
|
|
"""Test that tracking headers are not modified when no custom headers exist."""
|
|
# Ensure no http_options exist initially
|
|
llm_request.config.http_options = None
|
|
|
|
with mock.patch.object(gemini_llm, "api_client") as mock_client:
|
|
|
|
async def mock_coro():
|
|
return generate_content_response
|
|
|
|
mock_client.aio.models.generate_content.return_value = mock_coro()
|
|
|
|
responses = [
|
|
resp
|
|
async for resp in gemini_llm.generate_content_async(
|
|
llm_request, stream=False
|
|
)
|
|
]
|
|
|
|
# Verify that the config passed to generate_content has no http_options
|
|
mock_client.aio.models.generate_content.assert_called_once()
|
|
call_args = mock_client.aio.models.generate_content.call_args
|
|
config_arg = call_args.kwargs["config"]
|
|
assert config_arg.http_options is None
|
|
|
|
assert len(responses) == 1
|
|
|
|
|
|
def test_live_api_version_vertex_ai(gemini_llm):
|
|
"""Test that _live_api_version returns 'v1beta1' for Vertex AI backend."""
|
|
with mock.patch.object(
|
|
gemini_llm, "_api_backend", GoogleLLMVariant.VERTEX_AI
|
|
):
|
|
assert gemini_llm._live_api_version == "v1beta1"
|
|
|
|
|
|
def test_live_api_version_gemini_api(gemini_llm):
|
|
"""Test that _live_api_version returns 'v1alpha' for Gemini API backend."""
|
|
with mock.patch.object(
|
|
gemini_llm, "_api_backend", GoogleLLMVariant.GEMINI_API
|
|
):
|
|
assert gemini_llm._live_api_version == "v1alpha"
|
|
|
|
|
|
def test_live_api_client_properties(gemini_llm):
|
|
"""Test that _live_api_client is properly configured with tracking headers and API version."""
|
|
with mock.patch.object(
|
|
gemini_llm, "_api_backend", GoogleLLMVariant.VERTEX_AI
|
|
):
|
|
client = gemini_llm._live_api_client
|
|
|
|
# Verify that the client has the correct headers and API version
|
|
http_options = client._api_client._http_options
|
|
assert http_options.api_version == "v1beta1"
|
|
|
|
# Check that tracking headers are included
|
|
tracking_headers = gemini_llm._tracking_headers
|
|
for key, value in tracking_headers.items():
|
|
assert key in http_options.headers
|
|
assert value in http_options.headers[key]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_connect_with_custom_headers(gemini_llm, llm_request):
|
|
"""Test that connect method updates tracking headers and API version when custom headers are provided."""
|
|
# Setup request with live connect config and custom headers
|
|
custom_headers = {"custom-live-header": "live-value"}
|
|
llm_request.live_connect_config = types.LiveConnectConfig(
|
|
http_options=types.HttpOptions(headers=custom_headers)
|
|
)
|
|
|
|
mock_live_session = mock.AsyncMock()
|
|
|
|
# Mock the _live_api_client to return a mock client
|
|
with mock.patch.object(gemini_llm, "_live_api_client") as mock_live_client:
|
|
# Create a mock context manager
|
|
class MockLiveConnect:
|
|
|
|
async def __aenter__(self):
|
|
return mock_live_session
|
|
|
|
async def __aexit__(self, *args):
|
|
pass
|
|
|
|
mock_live_client.aio.live.connect.return_value = MockLiveConnect()
|
|
|
|
async with gemini_llm.connect(llm_request) as connection:
|
|
# Verify that the connect method was called with the right config
|
|
mock_live_client.aio.live.connect.assert_called_once()
|
|
call_args = mock_live_client.aio.live.connect.call_args
|
|
config_arg = call_args.kwargs["config"]
|
|
|
|
# Verify that tracking headers were merged with custom headers
|
|
expected_headers = custom_headers.copy()
|
|
expected_headers.update(gemini_llm._tracking_headers)
|
|
assert config_arg.http_options.headers == expected_headers
|
|
|
|
# Verify that API version was set
|
|
assert config_arg.http_options.api_version == gemini_llm._live_api_version
|
|
|
|
# Verify that system instruction and tools were set
|
|
assert config_arg.system_instruction is not None
|
|
assert config_arg.tools == llm_request.config.tools
|
|
|
|
# Verify connection is properly wrapped
|
|
assert isinstance(connection, GeminiLlmConnection)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_connect_without_custom_headers(gemini_llm, llm_request):
|
|
"""Test that connect method works properly when no custom headers are provided."""
|
|
# Setup request with live connect config but no custom headers
|
|
llm_request.live_connect_config = types.LiveConnectConfig()
|
|
|
|
mock_live_session = mock.AsyncMock()
|
|
|
|
with mock.patch.object(gemini_llm, "_live_api_client") as mock_live_client:
|
|
|
|
class MockLiveConnect:
|
|
|
|
async def __aenter__(self):
|
|
return mock_live_session
|
|
|
|
async def __aexit__(self, *args):
|
|
pass
|
|
|
|
mock_live_client.aio.live.connect.return_value = MockLiveConnect()
|
|
|
|
async with gemini_llm.connect(llm_request) as connection:
|
|
# Verify that the connect method was called with the right config
|
|
mock_live_client.aio.live.connect.assert_called_once()
|
|
call_args = mock_live_client.aio.live.connect.call_args
|
|
config_arg = call_args.kwargs["config"]
|
|
|
|
# Verify that http_options remains None since no custom headers were provided
|
|
assert config_arg.http_options is None
|
|
|
|
# Verify that system instruction and tools were still set
|
|
assert config_arg.system_instruction is not None
|
|
assert config_arg.tools == llm_request.config.tools
|
|
|
|
assert isinstance(connection, GeminiLlmConnection)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
(
|
|
"api_backend, "
|
|
"expected_file_display_name, "
|
|
"expected_inline_display_name, "
|
|
"expected_labels"
|
|
),
|
|
[
|
|
(
|
|
GoogleLLMVariant.GEMINI_API,
|
|
None,
|
|
None,
|
|
None,
|
|
),
|
|
(
|
|
GoogleLLMVariant.VERTEX_AI,
|
|
"My Test PDF",
|
|
"My Test Image",
|
|
{"key": "value"},
|
|
),
|
|
],
|
|
)
|
|
def test_preprocess_request_handles_backend_specific_fields(
|
|
gemini_llm: Gemini,
|
|
api_backend: GoogleLLMVariant,
|
|
expected_file_display_name: Optional[str],
|
|
expected_inline_display_name: Optional[str],
|
|
expected_labels: Optional[str],
|
|
):
|
|
"""
|
|
Tests that _preprocess_request correctly sanitizes fields based on the API backend.
|
|
|
|
- For GEMINI_API, it should remove 'display_name' from file/inline data
|
|
and remove 'labels' from the config.
|
|
- For VERTEX_AI, it should leave these fields untouched.
|
|
"""
|
|
# Arrange: Create a request with fields that need to be preprocessed.
|
|
llm_request_with_files = LlmRequest(
|
|
model="gemini-1.5-flash",
|
|
contents=[
|
|
Content(
|
|
role="user",
|
|
parts=[
|
|
Part(
|
|
file_data=types.FileData(
|
|
file_uri="gs://bucket/file.pdf",
|
|
mime_type="application/pdf",
|
|
display_name="My Test PDF",
|
|
)
|
|
),
|
|
Part(
|
|
inline_data=types.Blob(
|
|
data=b"some_bytes",
|
|
mime_type="image/png",
|
|
display_name="My Test Image",
|
|
)
|
|
),
|
|
],
|
|
)
|
|
],
|
|
config=types.GenerateContentConfig(labels={"key": "value"}),
|
|
)
|
|
|
|
# Mock the _api_backend property to control the test scenario
|
|
with mock.patch.object(
|
|
Gemini, "_api_backend", new_callable=mock.PropertyMock
|
|
) as mock_backend:
|
|
mock_backend.return_value = api_backend
|
|
|
|
# Act: Run the preprocessing method
|
|
gemini_llm._preprocess_request(llm_request_with_files)
|
|
|
|
# Assert: Check if the fields were correctly processed
|
|
file_part = llm_request_with_files.contents[0].parts[0]
|
|
inline_part = llm_request_with_files.contents[0].parts[1]
|
|
|
|
assert file_part.file_data.display_name == expected_file_display_name
|
|
assert inline_part.inline_data.display_name == expected_inline_display_name
|
|
assert llm_request_with_files.config.labels == expected_labels
|