litellm/tests/integration/providers/test_malformed_tools_wire.py
Mateo Wang 91724bb0a7
fix(responses)!: count input tokens the way inference sends the request (#47363)
* fix(count-tokens): translate chat tool use before Claude token counts

Responses and chat tool use (function tools, function_call items, tool messages) is now converted the way Claude chat inference converts it before the Anthropic, Azure AI and Vertex partner counters call count_tokens. Translation errors answer 400 before any provider call. Anthropic-shaped requests and /v1/messages/count_tokens keep their body as sent.

* test(count-tokens): compare Claude count bodies with inference for Responses tool use

* fix(responses): forward the caller's Responses body to OpenAI token counts

OpenAI deployments now get the caller's /v1/responses/input_tokens body as sent, minus LiteLLM-only fields, so OpenAI's own count and errors come back. previous_response_id is checked for ownership like inference and routes to the deployment that served it

* fix(responses)!: count Claude Responses bodies the way inference sends them

Non-native Responses counts now run the body through the inference bridge, so
text.format, tool_choice, reasoning, built-in tools, and file_search count the
way inference sends them on Anthropic, Azure AI, Vertex, and Bedrock. The
OpenAI native count body uses the drop_params-resolved tool fields.

* fix(responses): honor drop_params and replay previous turns in Claude counts

Claude input_tokens counts now read the same drop_params setting inference merges from the deployment, router defaults, and request, so a forced tool_choice downgrades to auto under drop_params. previous_response_id replays the stored turns through inference's session loader, and chat messages carrying fields beyond role and content go through the provider's chat translation

* fix(responses): keep proxy-only request keys out of OpenAI counts and map chat tools in Bedrock counts

* fix(count-tokens): import on Python 3.11 and keep stored prompts in OpenAI counts under drop_params

* fix(responses): leave tool_choice out of counts when drop_params drops every tool

* fix(count-tokens): count Mantle options, drop cache marks, and reject input inference cannot send

The Bedrock Mantle fallback now counts thinking, tool_choice and output_config
like the runtime count. Claude Responses counts leave out cache_control marks
again, so more than four marks count instead of failing. Counts answer 400
before any provider call for user blocks chat inference refuses and for
Responses tools with no Chat Completions equivalent, instead of dropping the
block or counting a placeholder tool. Adds the wire tests for these paths

* fix(count-tokens): count Responses tools the way the inference bridge sends them

A Claude count now hoists additional_tools input items into tools, strips a malformed tool flag under drop_params and rejects it without, and leaves tools out when the deployment lists tools in additional_drop_params, so the count matches the body Claude inference sends for the same request

* fix(count-tokens): keep Bedrock runtime counts option-free and send OpenAI the provider file id

* test(count-tokens): capture the Anthropic count request at the HTTP layer instead of patching the handler

* fix(count-tokens): ignore a caller-sent file id mapping and keep non-string file ids as sent
2026-10-20 15:13:59 +00:00

2732 lines
107 KiB
Python

from __future__ import annotations
import asyncio
import http.client
import json
import os
import re
import uuid
from collections.abc import Callable, Iterator, Mapping
from contextlib import contextmanager
from dataclasses import dataclass, replace
from itertools import chain, product
from pathlib import Path
from types import MappingProxyType
from typing import Final
import anthropic
import httpx
import openai
import pytest
from google import genai
from google.genai import types
from integration._support.anthropic_sse import error_body, message_json, message_stream
from integration._support.client import (
Gateway,
Scenario,
eventually,
gateway_from_environment,
held,
object_value,
string_value,
)
from integration._support.database import read_rows
from integration._support.openai_wire import chat_reply, openai_error, responses_reply
from integration._support.process import graceful_stop_seconds, owned_proxy_process
from integration._support.responses_vendor import same_response
from integration._support.wire import Reply, Request, Wire, wire_server
from integration._support.worker_readiness import wait_for_worker_readiness
from integration.authorization._guardrail_opt_out import upstream_observations
from pydantic import JsonValue, TypeAdapter
from tests.integration.caching.response_cache_case import await_entry, redis_store
_OPENAI_BACKEND: Final = "gpt-4o-mini"
_CLAUDE_BACKEND: Final = "claude-haiku-4-5"
_GEMINI_BACKEND: Final = "gemini-2.5-flash"
_PROVIDER_KEY: Final = "scripted-malformed-tools-key"
_COUNT: Final = 37
_PROVIDER_SOURCE: Final[Mapping[str, JsonValue]] = MappingProxyType({"litellm_count_source": "provider"})
_CONFIG_STORE: Final = "vs_integration_config_store"
_OTHER_STORE: Final = "vs_malformed_tools_other_store"
_CLAUDE_CODE_AGENT: Final = "claude-cli/2.1.0 (external, cli)"
_CODEX_AGENT: Final = "codex_cli_rs/0.50.0 (Linux 6.8; x86_64) xterm-256color"
_REJECT_MARK: Final = "upstream-401"
_DOWN: Final = "/down/"
_REFUSALS: Final = MappingProxyType(
{
"context_window_fallbacks": (
"/context-full/",
{
"message": "This model's maximum context length is 8192 tokens.",
"type": "invalid_request_error",
"param": "messages",
"code": "context_length_exceeded",
},
),
"content_policy_fallbacks": (
"/content-policy/",
{
"message": "Your request was rejected as a result of our safety system.",
"type": "invalid_request_error",
"param": None,
"code": "content_policy_violation",
},
),
}
)
_MARKER: Final = re.compile(r"marker-([0-9a-f]{32})")
_PROXY_WORKERS: Final = max(1, int(os.environ.get("INTEGRATION_PROXY_WORKERS", "1")))
_JSON_OBJECT: Final = TypeAdapter(dict[str, JsonValue])
_SPEND_ROWS: Final = (
'SELECT call_type, status, cache_hit FROM "LiteLLM_SpendLogs" WHERE request_id = %s OR litellm_call_id = %s'
)
_NOT_A_LIST: Final = "tools: Input should be a valid list"
_NOT_AN_OBJECT: Final = "tools.0: Input should be a valid dictionary"
_SECOND_NOT_AN_OBJECT: Final = "tools.1: Input should be a valid dictionary"
_OWNED_PROXY_CELL_SECONDS: Final = 2 * graceful_stop_seconds() + 120
_TOOL_FIELDS: Final = ("tools", "tool_choice", "parallel_tool_calls", "toolConfig", "tool_config")
_WEATHER_SCHEMA: Final[dict[str, JsonValue]] = {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"],
}
def _marker() -> str:
return f"marker-{uuid.uuid4().hex}"
def _tag(text: str) -> str:
found: Final = _MARKER.search(text)
return found.group(1) if found else "none"
def _answer(tag: str) -> str:
return f"answer {tag}"
def _gemini_body(tag: str) -> dict[str, JsonValue]:
return {
"responseId": f"gemini-{tag}-{uuid.uuid4().hex}",
"candidates": [
{"content": {"role": "model", "parts": [{"text": _answer(tag)}]}, "index": 0, "finishReason": "STOP"}
],
"usageMetadata": {"promptTokenCount": 9, "candidatesTokenCount": 2, "totalTokenCount": 11},
"modelVersion": _GEMINI_BACKEND,
}
def _interaction_body(tag: str) -> dict[str, JsonValue]:
return {
"id": f"interaction-{tag}",
"object": "interaction",
"model": _GEMINI_BACKEND,
"status": "completed",
"created": "2026-10-15T00:00:00Z",
"steps": [{"type": "content", "content": {"type": "text", "text": _answer(tag)}}],
"usage": {"total_tokens": 11},
}
def _rejected_by_provider(path: str) -> Reply:
if path.startswith("/v1/messages"):
return Reply(status=401, body=error_body(401, "scripted 401"))
if path == "/v1beta/interactions":
return Reply(
status=401,
body=json.dumps({"error": {"code": 401, "message": "scripted 401", "status": "UNAUTHENTICATED"}}).encode(),
)
return openai_error(401)
def _unavailable(path: str) -> Reply:
if "/v1/messages" in path:
return Reply(status=503, body=error_body(503, "scripted outage"))
return openai_error(503)
def _respond(request: Request) -> Reply:
text: Final = request.body.decode()
tag: Final = _tag(text)
path: Final = request.target.split("?")[0]
if path.startswith(_DOWN):
return _unavailable(path)
refusal: Final = next((error for prefix, error in _REFUSALS.values() if path.startswith(prefix)), None)
if refusal is not None:
return Reply(status=400, body=json.dumps({"error": refusal}).encode())
if _REJECT_MARK in text:
return _rejected_by_provider(path)
stream: Final = bool(text) and _JSON_OBJECT.validate_json(request.body).get("stream") is True
if path == "/v1/chat/completions":
return chat_reply(f"chatcmpl-{tag}", _OPENAI_BACKEND, _answer(tag), stream=stream)
if path == "/v1/responses":
return responses_reply(f"resp_{tag}", _OPENAI_BACKEND, _answer(tag), stream=stream)
if path == "/v1/messages/count_tokens":
return Reply(body=json.dumps({"input_tokens": _COUNT}).encode())
if path == "/v1/messages" and stream:
return Reply(
content_type="text/event-stream", chunks=message_stream(f"msg_{tag}", _CLAUDE_BACKEND, _answer(tag))
)
if path == "/v1/messages":
return Reply(body=message_json(f"msg_{tag}", _CLAUDE_BACKEND, _answer(tag)))
if path.endswith(":streamGenerateContent"):
return Reply(
content_type="text/event-stream", chunks=(f"data: {json.dumps(_gemini_body(tag))}\r\n\r\n".encode(),)
)
if path.endswith(":generateContent"):
return Reply(body=json.dumps(_gemini_body(tag)).encode())
if path == "/v1beta/interactions":
return Reply(body=json.dumps(_interaction_body(tag)).encode())
return Reply(status=404, body=json.dumps({"error": f"unscripted {request.target}"}).encode())
@dataclass(frozen=True, slots=True)
class _Rig:
gateway: Gateway
wire: Wire
openai: str
anthropic: str
gemini: str
drop_group: str
gemini_drop_group: str
mixed_group: str
field_group: str
tools_drop_group: str
def _deployment_ids(scenario: Scenario, name: str, deployments: tuple[dict[str, JsonValue], ...]) -> tuple[str, ...]:
created: Final = tuple(
scenario.gateway.post("/model/new", {"model_name": name, "litellm_params": params, "model_info": {}})
for params in deployments
)
identities: Final = tuple(string_value(object_value(deployment["model_info"])["id"]) for deployment in created)
for identity in identities:
scenario.cleanups.callback(scenario.delete_model, identity)
return identities
def _same_name_deployments(scenario: Scenario, api_base: str, variants: tuple[Mapping[str, JsonValue], ...]) -> str:
name: Final = f"integration-mixed-{uuid.uuid4().hex}"
_deployment_ids(
scenario,
name,
tuple(
{"model": f"openai/{_OPENAI_BACKEND}", "api_key": _PROVIDER_KEY, "api_base": api_base, **variant}
for variant in variants
),
)
return name
@pytest.fixture(scope="module")
def rig() -> Iterator[_Rig]:
with gateway_from_environment() as gateway, wire_server(_respond) as wire, gateway.scenario() as scenario:
openai_base: Final = f"{wire.url}/v1"
built: Final = _Rig(
gateway=gateway,
wire=wire,
openai=scenario.model(api_base=openai_base, api_key=_PROVIDER_KEY),
anthropic=scenario.model(model=f"anthropic/{_CLAUDE_BACKEND}", api_base=wire.url, api_key=_PROVIDER_KEY),
gemini=scenario.model(model=f"gemini/{_GEMINI_BACKEND}", api_base=wire.url, api_key=_PROVIDER_KEY),
drop_group=scenario.model(api_base=openai_base, api_key=_PROVIDER_KEY, drop_params=True),
gemini_drop_group=scenario.model(
model=f"gemini/{_GEMINI_BACKEND}", api_base=wire.url, api_key=_PROVIDER_KEY, drop_params=True
),
mixed_group=_same_name_deployments(scenario, openai_base, ({"drop_params": True}, {})),
field_group=scenario.model(api_base=openai_base, api_key=_PROVIDER_KEY, additional_drop_params=["tools"]),
tools_drop_group=scenario.model(
api_base=openai_base, api_key=_PROVIDER_KEY, drop_params=True, tools=[CHAT.tool]
),
)
for group, deployments in (
(built.openai, 1),
(built.anthropic, 1),
(built.gemini, 1),
(built.drop_group, 1),
(built.gemini_drop_group, 1),
(built.mixed_group, 2),
(built.field_group, 1),
(built.tools_drop_group, 1),
):
wait_for_worker_readiness(gateway, group, deployments, _PROXY_WORKERS)
yield built
@pytest.fixture(autouse=True)
def _drained(rig: _Rig) -> None:
rig.wire.drain()
@dataclass(frozen=True, slots=True)
class _FieldGroups:
anthropic: str
gemini: str
@pytest.fixture(scope="module")
def field_groups(rig: _Rig) -> Iterator[_FieldGroups]:
with rig.gateway.scenario() as scenario:
built: Final = _FieldGroups(
anthropic=scenario.model(
model=f"anthropic/{_CLAUDE_BACKEND}",
api_base=rig.wire.url,
api_key=_PROVIDER_KEY,
additional_drop_params=["tools"],
),
gemini=scenario.model(
model=f"gemini/{_GEMINI_BACKEND}",
api_base=rig.wire.url,
api_key=_PROVIDER_KEY,
additional_drop_params=["tools"],
),
)
for group in (built.anthropic, built.gemini):
wait_for_worker_readiness(rig.gateway, group, 1, _PROXY_WORKERS)
yield built
@pytest.fixture(scope="module")
def limited_key(rig: _Rig) -> Iterator[str]:
with rig.gateway.scenario() as scenario:
yield scenario.key(rpm_limit=0)
@dataclass(frozen=True, slots=True)
class _Family:
name: str
tool: dict[str, JsonValue]
model: Callable[[_Rig], str]
path: Callable[[str, bool], str]
body: Callable[[str, str, bool], dict[str, JsonValue]]
target: Callable[[bool], str]
call_type: Callable[[bool], str]
upstream_id: Callable[[str], str | None]
tool_choice: tuple[str, JsonValue]
exact_tools: bool
def _chat_body(model: str, marker: str, stream: bool) -> dict[str, JsonValue]:
return {"model": model, "messages": [{"role": "user", "content": marker}], "stream": stream}
def _messages_body(model: str, marker: str, stream: bool) -> dict[str, JsonValue]:
return {"model": model, "max_tokens": 16, "messages": [{"role": "user", "content": marker}], "stream": stream}
def _responses_body(model: str, marker: str, stream: bool) -> dict[str, JsonValue]:
return {"model": model, "input": marker, "stream": stream}
def _generate_body(model: str, marker: str, stream: bool) -> dict[str, JsonValue]:
return {"contents": [{"role": "user", "parts": [{"text": marker}]}]}
def _generate_path(model: str, stream: bool) -> str:
return (
f"/v1beta/models/{model}:streamGenerateContent?alt=sse" if stream else f"/v1beta/models/{model}:generateContent"
)
CHAT: Final = _Family(
name="chat",
tool={
"type": "function",
"function": {"name": "get_weather", "description": "Look up the weather", "parameters": _WEATHER_SCHEMA},
},
model=lambda rig: rig.openai,
path=lambda model, stream: "/v1/chat/completions",
body=_chat_body,
target=lambda stream: "/v1/chat/completions",
call_type=lambda stream: "acompletion",
upstream_id=lambda tag: f"chatcmpl-{tag}",
tool_choice=("tool_choice", {"type": "function", "function": {"name": "get_weather"}}),
exact_tools=True,
)
MESSAGES: Final = _Family(
name="messages",
tool={"name": "get_weather", "description": "Look up the weather", "input_schema": _WEATHER_SCHEMA},
model=lambda rig: rig.anthropic,
path=lambda model, stream: "/v1/messages",
body=_messages_body,
target=lambda stream: "/v1/messages",
call_type=lambda stream: "anthropic_messages",
upstream_id=lambda tag: f"msg_{tag}",
tool_choice=("tool_choice", {"type": "tool", "name": "get_weather"}),
exact_tools=True,
)
RESPONSES: Final = _Family(
name="responses",
tool={
"type": "function",
"name": "get_weather",
"description": "Look up the weather",
"parameters": _WEATHER_SCHEMA,
},
model=lambda rig: rig.openai,
path=lambda model, stream: "/v1/responses",
body=_responses_body,
target=lambda stream: "/v1/responses",
call_type=lambda stream: "aresponses",
upstream_id=lambda tag: None,
tool_choice=("tool_choice", {"type": "function", "name": "get_weather"}),
exact_tools=True,
)
GENERATE: Final = _Family(
name="generate_content",
tool={
"functionDeclarations": [
{"name": "get_weather", "description": "Look up the weather", "parameters": _WEATHER_SCHEMA}
]
},
model=lambda rig: rig.gemini,
path=_generate_path,
body=_generate_body,
target=lambda stream: ":streamGenerateContent" if stream else ":generateContent",
call_type=lambda stream: "agenerate_content_stream" if stream else "agenerate_content",
upstream_id=lambda tag: None,
tool_choice=("toolConfig", {"functionCallingConfig": {"mode": "ANY", "allowedFunctionNames": ["get_weather"]}}),
exact_tools=False,
)
_FAMILIES: Final = (CHAT, MESSAGES, RESPONSES, GENERATE)
_FAMILY_IDS: Final = tuple(family.name for family in _FAMILIES)
_STREAMS: Final = pytest.mark.parametrize("stream", [False, True], ids=["non_stream", "stream"])
_EACH_FAMILY: Final = pytest.mark.parametrize("family", _FAMILIES, ids=_FAMILY_IDS)
@dataclass(frozen=True, slots=True)
class _Route:
path: Callable[[str], str]
body: Callable[[str, str], dict[str, JsonValue]]
model: Callable[[_Rig], str]
_ROUTES: Final[Mapping[str, _Route]] = MappingProxyType(
{
"chat": _Route(lambda model: "/v1/chat/completions", lambda m, k: _chat_body(m, k, False), CHAT.model),
"chat_unversioned": _Route(lambda model: "/chat/completions", lambda m, k: _chat_body(m, k, False), CHAT.model),
"chat_azure_alias": _Route(
lambda model: f"/openai/deployments/{model}/chat/completions",
lambda m, k: _chat_body(m, k, False),
CHAT.model,
),
"chat_stream": _Route(lambda model: "/v1/chat/completions", lambda m, k: _chat_body(m, k, True), CHAT.model),
"messages": _Route(lambda model: "/v1/messages", lambda m, k: _messages_body(m, k, False), MESSAGES.model),
"messages_stream": _Route(
lambda model: "/v1/messages", lambda m, k: _messages_body(m, k, True), MESSAGES.model
),
"responses": _Route(lambda model: "/v1/responses", lambda m, k: _responses_body(m, k, False), RESPONSES.model),
"responses_stream": _Route(
lambda model: "/v1/responses", lambda m, k: _responses_body(m, k, True), RESPONSES.model
),
"responses_compact": _Route(
lambda model: "/v1/responses/compact", lambda m, k: {"model": m, "input": k}, RESPONSES.model
),
"generate_content": _Route(
lambda model: _generate_path(model, False), lambda m, k: _generate_body(m, k, False), GENERATE.model
),
"stream_generate_content": _Route(
lambda model: _generate_path(model, True), lambda m, k: _generate_body(m, k, True), GENERATE.model
),
"interactions": _Route(
lambda model: "/v1beta/interactions", lambda m, k: {"model": m, "input": k}, lambda rig: rig.gemini
),
}
)
_MALFORMED_TOOLS: Final[Mapping[str, tuple[JsonValue, str]]] = MappingProxyType(
{
"int": (5, _NOT_A_LIST),
"empty_string": ("", _NOT_A_LIST),
"five_kb_string": ("x" * 5120, _NOT_A_LIST),
"list_of_names": (["get_weather"], _NOT_AN_OBJECT),
"empty_object": ({}, _NOT_A_LIST),
"false": (False, _NOT_A_LIST),
"zero": (0, _NOT_A_LIST),
}
)
_MALFORMED_ENTRIES: Final[Mapping[str, tuple[JsonValue, str]]] = MappingProxyType(
{
"int_entry": (5, _NOT_AN_OBJECT),
"string_function": (
{"type": "function", "function": "get_weather"},
"tools.0.function: Input should be a valid dictionary",
),
"string_function_parameters": (
{"type": "function", "function": {"name": "get_weather", "parameters": "bad"}},
"tools.0.function.parameters: Input should be a valid dictionary",
),
"list_input_schema": (
{"name": "get_weather", "input_schema": [1]},
"tools.0.input_schema: Input should be a valid dictionary",
),
"int_parameters": (
{"type": "function", "name": "get_weather", "parameters": 5},
"tools.0.parameters: Input should be a valid dictionary",
),
"string_vector_store_ids": (
{"type": "file_search", "vector_store_ids": _OTHER_STORE},
"tools.0.vector_store_ids: Input should be a valid list",
),
}
)
def _send(
rig: _Rig,
family: _Family,
marker: str,
stream: bool,
*,
model: str | None = None,
key: str | None = None,
call_id: str | None = None,
user_agent: str | None = None,
**fields: JsonValue,
) -> httpx.Response:
chosen: Final = model or family.model(rig)
headers: Final = {
**({"x-litellm-call-id": call_id} if call_id else {}),
**({"user-agent": user_agent} if user_agent else {}),
}
return rig.gateway.request(
"POST", family.path(chosen, stream), {**family.body(chosen, marker, stream), **fields}, key=key, headers=headers
)
def _delivered(rig: _Rig, marker: str) -> tuple[Request, ...]:
return tuple(request for request in rig.wire.drain() if marker in request.body.decode())
def _one_delivery(rig: _Rig, marker: str, target: str) -> dict[str, JsonValue]:
(sent,) = _delivered(rig, marker)
assert sent.method == "POST" and target in sent.target, sent.target
return _JSON_OBJECT.validate_json(sent.body)
def _tool_names(family: _Family, body: Mapping[str, JsonValue]) -> tuple[str, ...]:
tools: Final = body.get("tools")
if not isinstance(tools, list):
return ()
if family is GENERATE:
declarations: Final = chain.from_iterable(_declarations(object_value(tool)) for tool in tools)
return tuple(string_value(object_value(declaration)["name"]) for declaration in declarations)
if family is CHAT:
return tuple(string_value(object_value(object_value(tool)["function"])["name"]) for tool in tools)
return tuple(string_value(object_value(tool)["name"]) for tool in tools)
def _declarations(tool: Mapping[str, JsonValue]) -> list[JsonValue]:
declarations: Final = tool.get("functionDeclarations", tool.get("function_declarations"))
assert isinstance(declarations, list), tool
return declarations
def _assert_answered(family: _Family, response: httpx.Response, marker: str) -> None:
assert response.status_code == 200, response.text
tag: Final = _tag(marker)
assert _answer(tag) in response.text, response.text
upstream_id: Final = family.upstream_id(tag)
if upstream_id is not None:
assert upstream_id in response.text, response.text
if family is RESPONSES and not response.headers.get("content-type", "").startswith("text/event-stream"):
assert same_response(string_value(_JSON_OBJECT.validate_json(response.content)["id"]), f"resp_{tag}")
def _rejection(response: httpx.Response) -> tuple[str, str, JsonValue]:
body: Final = _JSON_OBJECT.validate_json(response.content)
error: Final = object_value(body["error"])
if body.get("type") == "error":
return string_value(error["type"]), string_value(error["message"]), None
return string_value(error["type"]), string_value(error["message"]), error.get("param")
def _assert_rejected(response: httpx.Response, message: str, param: str = "tools") -> None:
assert response.status_code == 400, response.text
kind, said, named = _rejection(response)
assert kind == "invalid_request_error", response.text
assert message in said, response.text
assert named in (param, None), response.text
def _spend_rows(call_id: str) -> list[dict[str, JsonValue]]:
return read_rows(_SPEND_ROWS, (call_id, call_id))
def _logged_once(call_id: str) -> dict[str, JsonValue]:
(row,) = held(lambda: _spend_rows(call_id), lambda rows: len(rows) == 1, holding=3, seconds=70)
return row
def _tool_values(sent: Mapping[str, JsonValue]) -> frozenset[str]:
return frozenset(name for name in _TOOL_FIELDS if sent.get(name) is not None)
def _call_id() -> str:
return f"malformed-tools-{uuid.uuid4().hex}"
@_STREAMS
@_EACH_FAMILY
def test_well_formed_tools_reach_the_provider_and_log_one_success_row(rig: _Rig, family: _Family, stream: bool) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = _send(rig, family, marker, stream, call_id=call_id, tools=[family.tool])
_assert_answered(family, response, marker)
sent: Final = _one_delivery(rig, marker, family.target(stream))
assert _tool_names(family, sent) == ("get_weather",), sent
if family.exact_tools:
assert sent["tools"] == [family.tool], sent
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (family.call_type(stream), "success"), row
def test_openai_sdk_chat_with_tools_answers_with_the_provider_reply(rig: _Rig) -> None:
marker: Final = _marker()
client: Final = openai.OpenAI(
base_url=f"{rig.gateway.client.base_url}/v1",
api_key=rig.gateway.key,
max_retries=0,
http_client=httpx.Client(trust_env=False),
)
completion: Final = client.chat.completions.create(
model=rig.openai,
messages=[{"role": "user", "content": marker}],
tools=[
{
"type": "function",
"function": {
"name": "get_weather",
"description": "Look up the weather",
"parameters": _WEATHER_SCHEMA,
},
}
],
)
assert completion.id == f"chatcmpl-{_tag(marker)}", completion
assert completion.choices[0].message.content == _answer(_tag(marker)), completion
assert _one_delivery(rig, marker, "/v1/chat/completions")["tools"] == [CHAT.tool]
def test_openai_sdk_rejects_malformed_tools_with_a_400(rig: _Rig) -> None:
marker: Final = _marker()
client: Final = openai.OpenAI(
base_url=f"{rig.gateway.client.base_url}/v1",
api_key=rig.gateway.key,
max_retries=0,
http_client=httpx.Client(trust_env=False),
)
with pytest.raises(openai.BadRequestError) as raised:
client.chat.completions.create(
model=rig.openai, messages=[{"role": "user", "content": marker}], extra_body={"tools": 5}
)
assert raised.value.status_code == 400, raised.value
assert object_value(raised.value.body)["param"] == "tools", raised.value.body
assert _delivered(rig, marker) == ()
def test_async_openai_sdk_streams_responses_with_tools(rig: _Rig) -> None:
marker: Final = _marker()
async def stream_text() -> str:
client: Final = openai.AsyncOpenAI(
base_url=f"{rig.gateway.client.base_url}/v1",
api_key=rig.gateway.key,
max_retries=0,
http_client=httpx.AsyncClient(trust_env=False),
)
events: Final = await client.responses.create(
model=rig.openai,
input=marker,
stream=True,
tools=[
{
"type": "function",
"name": "get_weather",
"description": "Look up the weather",
"parameters": _WEATHER_SCHEMA,
"strict": False,
}
],
)
completed: Final = [event async for event in events if event.type == "response.completed"]
assert len(completed) == 1, completed
return completed[0].response.output_text
assert asyncio.run(stream_text()) == _answer(_tag(marker))
assert _tool_names(RESPONSES, _one_delivery(rig, marker, "/v1/responses")) == ("get_weather",)
def test_anthropic_sdk_streams_messages_with_tools(rig: _Rig) -> None:
marker: Final = _marker()
client: Final = anthropic.Anthropic(
base_url=str(rig.gateway.client.base_url),
api_key=rig.gateway.key,
max_retries=0,
http_client=httpx.Client(trust_env=False),
)
with client.messages.stream(
model=rig.anthropic,
max_tokens=16,
messages=[{"role": "user", "content": marker}],
tools=[{"name": "get_weather", "description": "Look up the weather", "input_schema": _WEATHER_SCHEMA}],
) as stream:
final: Final = stream.get_final_message()
assert final.id == f"msg_{_tag(marker)}", final
assert _one_delivery(rig, marker, "/v1/messages")["tools"] == [MESSAGES.tool]
def test_google_genai_sdk_generates_with_tools(rig: _Rig) -> None:
marker: Final = _marker()
client: Final = genai.Client(api_key=rig.gateway.key, http_options={"base_url": str(rig.gateway.client.base_url)})
response: Final = client.models.generate_content(
model=rig.gemini,
contents=marker,
config=types.GenerateContentConfig(
tools=[
types.Tool(
function_declarations=[
types.FunctionDeclaration(
name="get_weather",
description="Look up the weather",
parameters_json_schema=_WEATHER_SCHEMA,
)
]
)
],
automatic_function_calling=types.AutomaticFunctionCallingConfig(disable=True),
),
)
assert response.text == _answer(_tag(marker)), response
assert _tool_names(GENERATE, _one_delivery(rig, marker, ":generateContent")) == ("get_weather",)
@pytest.mark.parametrize("value", _MALFORMED_TOOLS.values(), ids=_MALFORMED_TOOLS.keys())
@pytest.mark.parametrize("route", _ROUTES.values(), ids=_ROUTES.keys())
def test_malformed_tools_answer_400_and_never_reach_the_provider(
rig: _Rig, route: _Route, value: tuple[JsonValue, str]
) -> None:
marker: Final = _marker()
model: Final = route.model(rig)
tools, message = value
response: Final = rig.gateway.request("POST", route.path(model), {**route.body(model, marker), "tools": tools})
_assert_rejected(response, message)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize("entry", _MALFORMED_ENTRIES.values(), ids=_MALFORMED_ENTRIES.keys())
@pytest.mark.parametrize("family", (CHAT, MESSAGES), ids=("chat", "messages"))
def test_a_malformed_tool_entry_answers_400_naming_its_index(
rig: _Rig, family: _Family, entry: tuple[JsonValue, str]
) -> None:
marker: Final = _marker()
tool, message = entry
_assert_rejected(_send(rig, family, marker, False, tools=[tool]), message)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize("value", [5, "x", []], ids=["int", "string", "list"])
def test_malformed_web_search_options_answer_400(rig: _Rig, value: JsonValue) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, web_search_options=value)
expected: Final = "web_search_options: Input should be a valid dictionary"
_assert_rejected(response, expected, param="web_search_options")
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize("value", [5, "x", []], ids=["int", "string", "list"])
def test_malformed_web_search_options_drop_under_drop_params(rig: _Rig, value: JsonValue) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, web_search_options=value, drop_params=True)
_assert_answered(CHAT, response, marker)
assert "web_search_options" not in _one_delivery(rig, marker, "/v1/chat/completions")
@_EACH_FAMILY
def test_wrong_key_with_malformed_tools_answers_401(rig: _Rig, family: _Family) -> None:
marker: Final = _marker()
response: Final = _send(rig, family, marker, False, key=f"sk-wrong-{uuid.uuid4().hex}", tools=5)
assert response.status_code == 401, response.text
assert _delivered(rig, marker) == ()
def _count_body(rig: _Rig, marker: str, **fields: JsonValue) -> dict[str, JsonValue]:
return {"model": rig.anthropic, "messages": [{"role": "user", "content": marker}], **fields}
@pytest.mark.parametrize(
"fields",
[
{"tools": 5},
{"tools": ""},
{"tools": "x" * 5120},
{"tools": ["get_weather"]},
{"messages": "x"},
],
ids=["int_tools", "empty_string_tools", "five_kb_tools", "list_of_names", "string_messages"],
)
def test_count_tokens_answers_an_anthropic_400_and_keeps_the_connection(
rig: _Rig, fields: dict[str, JsonValue]
) -> None:
marker: Final = _marker()
port: Final = rig.gateway.client.base_url.port
assert port is not None
connection: Final = http.client.HTTPConnection(rig.gateway.client.base_url.host, port, timeout=30)
headers: Final = {"Authorization": f"Bearer {rig.gateway.key}", "Content-Type": "application/json"}
try:
connection.request(
"POST", "/v1/messages/count_tokens", body=json.dumps(_count_body(rig, marker, **fields)), headers=headers
)
counted: Final = connection.getresponse()
counted_body: Final = _JSON_OBJECT.validate_json(counted.read())
socket_after_count: Final = connection.sock
connection.request(
"POST", "/v1/messages", body=json.dumps(_messages_body(rig.anthropic, marker, False)), headers=headers
)
followed: Final = connection.getresponse()
followed_body: Final = followed.read().decode()
socket_after_follow_up: Final = connection.sock
finally:
connection.close()
assert counted.status == 400, counted_body
assert counted_body["type"] == "error", counted_body
error: Final = object_value(counted_body["error"])
assert error["type"] == "invalid_request_error", counted_body
assert string_value(error["message"]).startswith(next(iter(fields))), counted_body
assert followed.status == 200, followed_body
assert f"msg_{_tag(marker)}" in followed_body, followed_body
assert socket_after_count is not None and socket_after_follow_up is socket_after_count
(sent,) = _delivered(rig, marker)
assert sent.target == "/v1/messages", sent.target
def test_anthropic_sdk_count_tokens_rejects_malformed_tools(rig: _Rig) -> None:
marker: Final = _marker()
client: Final = anthropic.Anthropic(
base_url=str(rig.gateway.client.base_url),
api_key=rig.gateway.key,
max_retries=0,
http_client=httpx.Client(trust_env=False),
)
with pytest.raises(anthropic.BadRequestError) as raised:
client.messages.count_tokens(
model=rig.anthropic, messages=[{"role": "user", "content": marker}], extra_body={"tools": 5}
)
assert raised.value.status_code == 400, raised.value
assert object_value(object_value(raised.value.body)["error"])["message"] == _NOT_A_LIST, raised.value.body
assert _delivered(rig, marker) == ()
def test_count_tokens_forwards_well_formed_tools(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST", "/v1/messages/count_tokens", _count_body(rig, marker, tools=[MESSAGES.tool])
)
assert response.status_code == 200, response.text
assert _JSON_OBJECT.validate_json(response.content) == {"input_tokens": _COUNT, **_PROVIDER_SOURCE}, response.text
assert _one_delivery(rig, marker, "/v1/messages/count_tokens")["tools"] == [MESSAGES.tool]
@pytest.mark.parametrize(
("headers", "fields"),
[({}, {"drop_params": True}), ({"user-agent": _CLAUDE_CODE_AGENT}, {})],
ids=["drop_params", "claude_code_agent"],
)
def test_count_tokens_drops_only_the_bad_entry(
rig: _Rig, headers: dict[str, str], fields: dict[str, JsonValue]
) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/messages/count_tokens",
_count_body(rig, marker, tools=[MESSAGES.tool, 5], **fields),
headers=headers,
)
assert response.status_code == 200, response.text
assert _one_delivery(rig, marker, "/v1/messages/count_tokens")["tools"] == [MESSAGES.tool]
def test_responses_input_tokens_counts_well_formed_tools(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST", "/v1/responses/input_tokens", {"model": rig.anthropic, "input": marker, "tools": [RESPONSES.tool]}
)
assert response.status_code == 200, response.text
assert _JSON_OBJECT.validate_json(response.content) == {
"object": "response.input_tokens",
"input_tokens": _COUNT,
**_PROVIDER_SOURCE,
}, response.text
sent: Final = _one_delivery(rig, marker, "/v1/messages/count_tokens")
assert "get_weather" in json.dumps(sent["tools"]), sent
def test_responses_input_tokens_rejects_malformed_tools(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST", "/v1/responses/input_tokens", {"model": rig.anthropic, "input": marker, "tools": 5}
)
_assert_rejected(response, _NOT_A_LIST)
assert _delivered(rig, marker) == ()
def test_responses_input_tokens_drops_only_the_bad_entry(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/responses/input_tokens",
{"model": rig.anthropic, "input": marker, "tools": [RESPONSES.tool, 5], "drop_params": True},
)
assert response.status_code == 200, response.text
sent: Final = _one_delivery(rig, marker, "/v1/messages/count_tokens")
tools: Final = sent["tools"]
assert isinstance(tools, list) and len(tools) == 1 and "get_weather" in json.dumps(tools), sent
def _allowlisted_key(scenario: Scenario) -> str:
return scenario.key(metadata={"allowed_tools": ["get_weather"]})
@_EACH_FAMILY
def test_allowlisted_key_keeps_its_allowlist_with_malformed_tools(rig: _Rig, family: _Family) -> None:
with rig.gateway.scenario() as scenario:
key: Final = _allowlisted_key(scenario)
allowed: Final = _marker()
_assert_answered(family, _send(rig, family, allowed, False, key=key, tools=[family.tool]), allowed)
assert len(_delivered(rig, allowed)) == 1
malformed: Final = _marker()
_assert_rejected(_send(rig, family, malformed, False, key=key, tools=5), _NOT_A_LIST)
denied_tool: Final = json.loads(json.dumps(family.tool).replace("get_weather", "delete_files"))
denied: Final = _marker()
refused: Final = _send(rig, family, denied, False, key=key, tools=[denied_tool])
assert refused.status_code == 403, refused.text
assert "delete_files" in refused.text, refused.text
assert _delivered(rig, malformed) + _delivered(rig, denied) == ()
def _file_search(store_ids: JsonValue) -> dict[str, JsonValue]:
return {"type": "file_search", "vector_store_ids": store_ids}
def test_store_limited_key_searches_its_store_from_a_file_search_tool(rig: _Rig) -> None:
marker: Final = _marker()
with rig.gateway.scenario() as scenario:
key: Final = scenario.key(object_permission={"vector_stores": [_CONFIG_STORE]})
response: Final = _send(rig, CHAT, marker, False, key=key, tools=[_file_search([_CONFIG_STORE])])
_assert_answered(CHAT, response, marker)
sent: Final = _one_delivery(rig, marker, "/v1/chat/completions")
assert "file_search" not in json.dumps(sent), sent
searches: Final = eventually(
lambda: tuple(
observation
for observation in upstream_observations(rig.gateway)
if observation["path"] == f"/vector_stores/{_CONFIG_STORE}/search" and marker in json.dumps(observation)
),
lambda found: len(found) == 1,
)
assert len(searches) == 1, searches
@pytest.mark.parametrize(
("store_ids", "status", "named"),
[
([_OTHER_STORE], 401, _OTHER_STORE),
(_CONFIG_STORE, 400, "tools.0.vector_store_ids: Input should be a valid list"),
(_OTHER_STORE, 401, _OTHER_STORE),
([5, _OTHER_STORE], 401, _OTHER_STORE),
([5, _CONFIG_STORE], 400, "tools.0.vector_store_ids.0: Input should be a valid string"),
],
ids=["other_store", "allowed_store_as_string", "other_store_as_string", "int_beside_other", "int_beside_allowed"],
)
def test_store_limited_key_reads_every_string_store_id(
rig: _Rig, store_ids: JsonValue, status: int, named: str
) -> None:
marker: Final = _marker()
with rig.gateway.scenario() as scenario:
key: Final = scenario.key(object_permission={"vector_stores": [_CONFIG_STORE]})
response: Final = _send(rig, CHAT, marker, False, key=key, tools=[_file_search(store_ids)])
assert response.status_code == status, response.text
assert named in response.text, response.text
assert _delivered(rig, marker) == ()
def test_store_limited_key_treats_null_store_ids_as_none(rig: _Rig) -> None:
marker: Final = _marker()
with rig.gateway.scenario() as scenario:
key: Final = scenario.key(object_permission={"vector_stores": [_CONFIG_STORE]})
response: Final = _send(rig, CHAT, marker, False, key=key, tools=[_file_search(None)])
_assert_answered(CHAT, response, marker)
assert _one_delivery(rig, marker, "/v1/chat/completions")["tools"] == [_file_search(None)]
@pytest.mark.parametrize(
("first", "last", "status"),
[("5", "WELL_FORMED", 200), ("WELL_FORMED", "5", 400)],
ids=["well_formed_last", "malformed_last"],
)
def test_duplicate_tools_keys_use_the_last_one(rig: _Rig, first: str, last: str, status: int) -> None:
marker: Final = _marker()
well_formed: Final = json.dumps([CHAT.tool])
prefix: Final = json.dumps({"model": rig.openai, "messages": [{"role": "user", "content": marker}]})[:-1]
raw: Final = (
f'{prefix}, "tools": {first.replace("WELL_FORMED", well_formed)}, '
f'"tools": {last.replace("WELL_FORMED", well_formed)}}}'
)
response: Final = rig.gateway.client.post(
"/v1/chat/completions",
content=raw.encode(),
headers={"Authorization": f"Bearer {rig.gateway.key}", "Content-Type": "application/json"},
)
assert response.status_code == status, response.text
delivered: Final = _delivered(rig, marker)
if status == 400:
_assert_rejected(response, _NOT_A_LIST)
assert delivered == ()
return
(sent,) = delivered
assert _JSON_OBJECT.validate_json(sent.body)["tools"] == [CHAT.tool]
@pytest.mark.parametrize(
("family", "route", "expected"),
[
(CHAT, None, "acompletion"),
(MESSAGES, None, "anthropic_messages"),
(RESPONSES, None, "aresponses"),
(GENERATE, None, "agenerate_content"),
(None, "interactions", "acreate_interaction"),
],
ids=["chat", "messages", "responses", "generate_content", "interactions"],
)
def test_a_malformed_tools_rejection_logs_one_failure_row_with_its_call_type(
rig: _Rig, family: _Family | None, route: str | None, expected: str
) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = (
_send(rig, family, marker, False, call_id=call_id, tools=5)
if family is not None
else rig.gateway.request(
"POST",
"/v1beta/interactions",
{"model": rig.gemini, "input": [{"type": "text", "text": marker}], "tools": 5},
headers={"x-litellm-call-id": call_id},
)
)
_assert_rejected(response, _NOT_A_LIST)
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (expected, "failure"), row
@pytest.mark.parametrize(
("path", "body", "expected"),
[
("/v1/chat/completions", "chat", "acompletion"),
("/v1/messages", "messages", "anthropic_messages"),
("/v1beta/interactions", "interactions", "acreate_interaction"),
],
ids=["chat", "messages", "interactions_list_input"],
)
def test_a_provider_401_with_well_formed_tools_logs_its_endpoint_call_type(
rig: _Rig, path: str, body: str, expected: str
) -> None:
marker: Final = f"{_marker()} {_REJECT_MARK}"
call_id: Final = _call_id()
payloads: Final[Mapping[str, dict[str, JsonValue]]] = {
"chat": {**_chat_body(rig.openai, marker, False), "tools": [CHAT.tool]},
"messages": {**_messages_body(rig.anthropic, marker, False), "tools": [MESSAGES.tool]},
"interactions": {
"model": rig.gemini,
"input": [{"type": "text", "text": marker}],
"tools": [{"type": "function", "name": "get_weather", "parameters": _WEATHER_SCHEMA}],
},
}
response: Final = rig.gateway.request("POST", path, payloads[body], headers={"x-litellm-call-id": call_id})
assert response.status_code == 401, response.text
assert len(_delivered(rig, marker)) == 1
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (expected, "failure"), row
@pytest.mark.parametrize("drop", [True, "true"], ids=["bool", "string"])
@_EACH_FAMILY
def test_request_drop_params_drops_malformed_tools_and_their_companions(
rig: _Rig, family: _Family, drop: JsonValue
) -> None:
marker: Final = _marker()
companion, value = family.tool_choice
response: Final = _send(rig, family, marker, False, tools=5, drop_params=drop, **{companion: value})
_assert_answered(family, response, marker)
sent: Final = _one_delivery(rig, marker, family.target(False))
assert _tool_values(sent) == frozenset(), sent
@_EACH_FAMILY
def test_drop_params_keeps_the_good_entries_and_the_tool_choice(rig: _Rig, family: _Family) -> None:
marker: Final = _marker()
companion, value = family.tool_choice
response: Final = _send(rig, family, marker, False, tools=[family.tool, 5], drop_params=True, **{companion: value})
_assert_answered(family, response, marker)
sent: Final = _one_delivery(rig, marker, family.target(False))
assert _tool_names(family, sent) == ("get_weather",), sent
if family.exact_tools:
assert sent["tools"] == [family.tool], sent
assert companion in sent, sent
def test_additional_drop_params_naming_tools_drops_them(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, tools=5, additional_drop_params=["tools"])
_assert_answered(CHAT, response, marker)
assert "tools" not in _one_delivery(rig, marker, "/v1/chat/completions")
def test_additional_drop_params_naming_another_field_still_rejects_tools(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, tools=5, additional_drop_params=["web_search_options"])
_assert_rejected(response, _NOT_A_LIST)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize("family", (CHAT, GENERATE), ids=("chat", "generate_content"))
def test_a_drop_params_deployment_group_drops_malformed_tools(rig: _Rig, family: _Family) -> None:
marker: Final = _marker()
model: Final = rig.drop_group if family is CHAT else rig.gemini_drop_group
response: Final = _send(rig, family, marker, False, model=model, tools=5)
_assert_answered(family, response, marker)
assert _tool_values(_one_delivery(rig, marker, family.target(False))) == frozenset()
def test_a_drop_params_deployment_keeps_its_own_tools_when_it_drops_malformed_request_tools(rig: _Rig) -> None:
marker: Final = _marker()
companion, value = CHAT.tool_choice
response: Final = _send(
rig, CHAT, marker, False, model=rig.tools_drop_group, tools=5, parallel_tool_calls=False, **{companion: value}
)
_assert_answered(CHAT, response, marker)
sent: Final = _one_delivery(rig, marker, "/v1/chat/completions")
assert _tool_names(CHAT, sent) == _tool_names(CHAT, {"tools": [CHAT.tool]}), sent
assert _tool_values(sent) == frozenset({"tools"}), sent
@pytest.mark.parametrize("drop", [False, None], ids=["false", "null"])
def test_an_explicit_request_drop_params_overrides_the_deployment_group(rig: _Rig, drop: JsonValue) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, model=rig.drop_group, tools=5, drop_params=drop)
_assert_rejected(response, _NOT_A_LIST)
assert _delivered(rig, marker) == ()
def test_a_mixed_group_answers_malformed_tools_by_the_drop_params_of_the_deployment_it_picks(rig: _Rig) -> None:
markers: Final = tuple(_marker() for _ in range(20))
statuses: Final = tuple(
_send(rig, CHAT, marker, False, model=rig.mixed_group, tools=5).status_code for marker in markers
)
sent: Final = tuple(request.body.decode() for request in rig.wire.drain())
deliveries: Final = tuple(
tuple(_JSON_OBJECT.validate_json(body) for body in sent if marker in body) for marker in markers
)
assert sorted(set(statuses)) == [200, 400], statuses
assert all((status, len(bodies)) in ((200, 1), (400, 0)) for status, bodies in zip(statuses, deliveries)), (
statuses,
deliveries,
)
assert all(all("tools" not in body for body in bodies) for bodies in deliveries), deliveries
def test_a_deployment_dropping_tools_drops_every_tool(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, model=rig.field_group, tools=[CHAT.tool, 5])
_assert_answered(CHAT, response, marker)
assert "tools" not in _one_delivery(rig, marker, "/v1/chat/completions")
def test_a_request_additional_drop_params_list_keeps_tools_a_deployment_list_drops(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
model=rig.field_group,
tools=[CHAT.tool],
additional_drop_params=["web_search_options"],
)
_assert_answered(CHAT, response, marker)
assert _tool_names(CHAT, _one_delivery(rig, marker, "/v1/chat/completions")) == ("get_weather",)
def test_a_request_additional_drop_params_list_replaces_the_deployment_list(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
model=rig.field_group,
tools=[CHAT.tool, 5],
additional_drop_params=["web_search_options"],
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize(
("family", "agent"),
[(MESSAGES, _CLAUDE_CODE_AGENT), (RESPONSES, _CODEX_AGENT), (CHAT, _CLAUDE_CODE_AGENT)],
ids=["claude_code_messages", "codex_responses", "claude_code_chat"],
)
def test_an_agentic_cli_drops_only_the_bad_entry(rig: _Rig, family: _Family, agent: str) -> None:
marker: Final = _marker()
response: Final = _send(rig, family, marker, False, user_agent=agent, tools=[family.tool, 5])
_assert_answered(family, response, marker)
assert _one_delivery(rig, marker, family.target(False))["tools"] == [family.tool]
def test_an_agentic_cli_with_explicit_drop_params_false_rejects(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(
rig, MESSAGES, marker, False, user_agent=_CLAUDE_CODE_AGENT, tools=[MESSAGES.tool, 5], drop_params=False
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize(
"fields", [{"tools": None}, {"tools": []}, {}], ids=["null_tools", "empty_list_tools", "missing_tools"]
)
def test_empty_null_and_missing_tools_still_answer(rig: _Rig, fields: dict[str, JsonValue]) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, **fields)
_assert_answered(CHAT, response, marker)
assert not _one_delivery(rig, marker, "/v1/chat/completions").get("tools")
def test_null_web_search_options_answers_and_logs_success(rig: _Rig) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = _send(rig, CHAT, marker, False, call_id=call_id, web_search_options=None)
_assert_answered(CHAT, response, marker)
assert _one_delivery(rig, marker, "/v1/chat/completions").get("web_search_options") is None
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == ("acompletion", "success"), row
@_EACH_FAMILY
def test_request_drop_params_with_well_formed_tools_logs_one_success_row(rig: _Rig, family: _Family) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = _send(rig, family, marker, False, call_id=call_id, tools=[family.tool], drop_params=True)
_assert_answered(family, response, marker)
assert _tool_names(family, _one_delivery(rig, marker, family.target(False))) == ("get_weather",)
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (family.call_type(False), "success"), row
def test_repeated_identical_dropped_requests_each_log_once(rig: _Rig) -> None:
marker: Final = _marker()
call_ids: Final = tuple(_call_id() for _ in range(3))
for call_id in call_ids:
response = _send(rig, GENERATE, marker, False, call_id=call_id, tools=[GENERATE.tool, 5], drop_params=True)
_assert_answered(GENERATE, response, marker)
delivered: Final = _delivered(rig, marker)
assert (
tuple(_tool_names(GENERATE, _JSON_OBJECT.validate_json(sent.body)) for sent in delivered)
== (("get_weather",),) * 3
)
rows: Final = tuple(_logged_once(call_id) for call_id in call_ids)
assert tuple((row["call_type"], row["status"]) for row in rows) == (("agenerate_content", "success"),) * 3
@pytest.mark.parametrize("family", (CHAT, MESSAGES, RESPONSES), ids=("chat", "messages", "responses"))
def test_a_cache_hit_twin_answers_from_the_cache_and_logs_once_each(rig: _Rig, family: _Family) -> None:
marker: Final = _marker()
first_id: Final = _call_id()
second_id: Final = _call_id()
first: Final = _send(rig, family, marker, False, call_id=first_id, tools=[family.tool])
_assert_answered(family, first, marker)
await_entry(redis_store(), _answer(_tag(marker)))
second: Final = _send(rig, family, marker, False, call_id=second_id, tools=[family.tool])
_assert_answered(family, second, marker)
assert len(_delivered(rig, marker)) == 1
first_row: Final = _logged_once(first_id)
second_row: Final = _logged_once(second_id)
assert (first_row["call_type"], second_row["call_type"]) == (family.call_type(False),) * 2, (first_row, second_row)
assert second_row["cache_hit"] == "True", second_row
def test_a_dropped_request_shares_the_cache_entry_of_its_clean_twin(rig: _Rig) -> None:
marker: Final = _marker()
dropped: Final = _send(rig, CHAT, marker, False, tools=[CHAT.tool, 5], drop_params=True)
_assert_answered(CHAT, dropped, marker)
await_entry(redis_store(), _answer(_tag(marker)))
clean: Final = _send(rig, CHAT, marker, False, tools=[CHAT.tool], drop_params=True)
_assert_answered(CHAT, clean, marker)
(sent,) = _delivered(rig, marker)
assert _JSON_OBJECT.validate_json(sent.body)["tools"] == [CHAT.tool]
def _field_group(rig: _Rig, groups: _FieldGroups, family: _Family) -> str:
return {MESSAGES.name: groups.anthropic, GENERATE.name: groups.gemini}.get(family.name, rig.field_group)
_FIELD_GROUP_FAMILIES: Final = pytest.mark.parametrize(
"family", (MESSAGES, RESPONSES, GENERATE), ids=("messages", "responses", "generate_content")
)
@_FIELD_GROUP_FAMILIES
def test_each_family_rejects_malformed_tools_when_a_request_list_replaces_the_deployment_list(
rig: _Rig, field_groups: _FieldGroups, family: _Family
) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
family,
marker,
False,
model=_field_group(rig, field_groups, family),
tools=[family.tool, 5],
additional_drop_params=["web_search_options"],
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize(
("family", "forwarded"),
[(MESSAGES, ()), (RESPONSES, ()), (GENERATE, ("get_weather",))],
ids=("messages", "responses", "generate_content"),
)
def test_each_family_answers_malformed_tools_a_deployment_list_drops(
rig: _Rig, field_groups: _FieldGroups, family: _Family, forwarded: tuple[str, ...]
) -> None:
marker: Final = _marker()
response: Final = _send(
rig, family, marker, False, model=_field_group(rig, field_groups, family), tools=[family.tool, 5]
)
_assert_answered(family, response, marker)
assert _tool_names(family, _one_delivery(rig, marker, family.target(False))) == forwarded
@_FIELD_GROUP_FAMILIES
def test_each_family_forwards_well_formed_tools_a_request_list_keeps(
rig: _Rig, field_groups: _FieldGroups, family: _Family
) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
family,
marker,
False,
model=_field_group(rig, field_groups, family),
tools=[family.tool],
additional_drop_params=["web_search_options"],
)
_assert_answered(family, response, marker)
assert _tool_names(family, _one_delivery(rig, marker, family.target(False))) == ("get_weather",)
_NOT_A_NAME_LIST: Final[Mapping[str, JsonValue]] = MappingProxyType(
{
"empty_list": [],
"null": None,
"string": "tools",
"empty_string": "",
"five_kb_string": "x" * 5120,
"int": 5,
}
)
@pytest.mark.parametrize("value", _NOT_A_NAME_LIST.values(), ids=_NOT_A_NAME_LIST.keys())
def test_a_request_additional_drop_params_that_is_no_list_of_names_still_replaces_the_deployment_list(
rig: _Rig, value: JsonValue
) -> None:
marker: Final = _marker()
response: Final = _send(
rig, CHAT, marker, False, model=rig.field_group, tools=[CHAT.tool, 5], additional_drop_params=value
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
@pytest.mark.parametrize(
"value",
[[], None, "tools", "", "x" * 5120],
ids=["empty_list", "null", "string", "empty_string", "five_kb_string"],
)
def test_a_request_additional_drop_params_replacing_the_deployment_list_keeps_well_formed_tools(
rig: _Rig, value: JsonValue
) -> None:
marker: Final = _marker()
response: Final = _send(
rig, CHAT, marker, False, model=rig.field_group, tools=[CHAT.tool], additional_drop_params=value
)
_assert_answered(CHAT, response, marker)
assert _one_delivery(rig, marker, "/v1/chat/completions")["tools"] == [CHAT.tool]
@pytest.mark.parametrize(
("first", "last", "status"),
[('["tools"]', '["web_search_options"]', 400), ('["web_search_options"]', '["tools"]', 200)],
ids=["other_field_last", "tools_last"],
)
def test_duplicate_additional_drop_params_keys_use_the_last_one(rig: _Rig, first: str, last: str, status: int) -> None:
marker: Final = _marker()
prefix: Final = json.dumps(
{"model": rig.openai, "messages": [{"role": "user", "content": marker}], "tools": [CHAT.tool, 5]}
)[:-1]
response: Final = rig.gateway.client.post(
"/v1/chat/completions",
content=f'{prefix}, "additional_drop_params": {first}, "additional_drop_params": {last}}}'.encode(),
headers={"Authorization": f"Bearer {rig.gateway.key}", "Content-Type": "application/json"},
)
assert response.status_code == status, response.text
if status == 400:
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
return
_assert_answered(CHAT, response, marker)
assert "tools" not in _one_delivery(rig, marker, "/v1/chat/completions")
def test_count_tokens_drops_the_bad_entry_a_deployment_list_names(rig: _Rig, field_groups: _FieldGroups) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/messages/count_tokens",
{**_count_body(rig, marker, tools=[MESSAGES.tool, 5]), "model": field_groups.anthropic},
)
assert response.status_code == 200, response.text
assert _JSON_OBJECT.validate_json(response.content) == {"input_tokens": _COUNT, **_PROVIDER_SOURCE}, response.text
assert _one_delivery(rig, marker, "/v1/messages/count_tokens")["tools"] == [MESSAGES.tool]
def test_count_tokens_rejects_malformed_tools_when_a_request_list_replaces_the_deployment_list(
rig: _Rig, field_groups: _FieldGroups
) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/messages/count_tokens",
{
**_count_body(rig, marker, tools=[MESSAGES.tool, 5], additional_drop_params=["web_search_options"]),
"model": field_groups.anthropic,
},
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
def test_responses_input_tokens_drops_the_tools_a_deployment_list_names(
rig: _Rig, field_groups: _FieldGroups
) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/responses/input_tokens",
{"model": field_groups.anthropic, "input": marker, "tools": [RESPONSES.tool, 5]},
)
assert response.status_code == 200, response.text
assert "tools" not in _one_delivery(rig, marker, "/v1/messages/count_tokens")
def test_responses_input_tokens_rejects_malformed_tools_when_a_request_list_replaces_the_deployment_list(
rig: _Rig, field_groups: _FieldGroups
) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/responses/input_tokens",
{
"model": field_groups.anthropic,
"input": marker,
"tools": [RESPONSES.tool, 5],
"additional_drop_params": ["web_search_options"],
},
)
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
def _text_items(marker: str) -> list[JsonValue]:
return [{"role": "user", "content": marker}]
@pytest.mark.parametrize("compact_input", [_text_items, lambda marker: marker], ids=["list_input", "string_input"])
def test_a_compact_rejection_logs_one_failure_row_as_compact(
rig: _Rig, compact_input: Callable[[str], JsonValue]
) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = rig.gateway.request(
"POST",
"/v1/responses/compact",
{"model": rig.openai, "input": compact_input(marker), "tools": 5},
headers={"x-litellm-call-id": call_id},
)
_assert_rejected(response, _NOT_A_LIST)
assert _delivered(rig, marker) == ()
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == ("acompact_responses", "failure"), row
@dataclass(frozen=True, slots=True)
class _Limited:
path: Callable[[_Rig], str]
body: Callable[[_Rig, str], dict[str, JsonValue]]
call_type: str
_LIMITED: Final[Mapping[str, _Limited]] = MappingProxyType(
{
"chat": _Limited(
lambda rig: "/v1/chat/completions", lambda rig, k: _chat_body(rig.openai, k, False), "acompletion"
),
"messages": _Limited(
lambda rig: "/v1/messages", lambda rig, k: _messages_body(rig.anthropic, k, False), "anthropic_messages"
),
"responses_list_input": _Limited(
lambda rig: "/v1/responses", lambda rig, k: {"model": rig.openai, "input": _text_items(k)}, "aresponses"
),
"compact_list_input": _Limited(
lambda rig: "/v1/responses/compact",
lambda rig, k: {"model": rig.openai, "input": _text_items(k)},
"acompact_responses",
),
"generate_content": _Limited(
lambda rig: _generate_path(rig.gemini, False),
lambda rig, k: _generate_body(rig.gemini, k, False),
"agenerate_content",
),
"interactions_list_input": _Limited(
lambda rig: "/v1beta/interactions",
lambda rig, k: {"model": rig.gemini, "input": [{"type": "text", "text": k}]},
"acreate_interaction",
),
"video_generation": _Limited(
lambda rig: "/v1/videos", lambda rig, k: {"model": rig.openai, "prompt": k}, "avideo_generation"
),
}
)
@pytest.mark.parametrize("limited", _LIMITED.values(), ids=_LIMITED.keys())
def test_a_rate_limited_request_logs_one_failure_row_with_its_endpoint_call_type(
rig: _Rig, limited_key: str, limited: _Limited
) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = rig.gateway.request(
"POST",
limited.path(rig),
limited.body(rig, marker),
key=limited_key,
headers={"x-litellm-call-id": call_id},
)
assert response.status_code == 429, response.text
assert _delivered(rig, marker) == ()
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (limited.call_type, "failure"), row
@pytest.mark.parametrize("family", (CHAT, MESSAGES), ids=("chat", "messages"))
def test_a_rate_limited_twin_of_a_cached_request_logs_its_endpoint_call_type(
rig: _Rig, limited_key: str, family: _Family
) -> None:
marker: Final = _marker()
_assert_answered(family, _send(rig, family, marker, False, tools=[family.tool]), marker)
await_entry(redis_store(), _answer(_tag(marker)))
call_id: Final = _call_id()
response: Final = _send(rig, family, marker, False, key=limited_key, call_id=call_id, tools=[family.tool])
assert response.status_code == 429, response.text
assert len(_delivered(rig, marker)) == 1
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == (family.call_type(False), "failure"), row
def test_a_rate_limited_image_edit_logs_one_failure_row_as_an_image_edit(rig: _Rig, limited_key: str) -> None:
marker: Final = _marker()
call_id: Final = _call_id()
response: Final = rig.gateway.client.post(
"/v1/images/edits",
data={"model": rig.openai, "prompt": marker},
files={"image": ("edit.png", b"\x89PNG\r\n\x1a\n", "image/png")},
headers={"Authorization": f"Bearer {limited_key}", "x-litellm-call-id": call_id},
)
assert response.status_code == 429, response.text
assert _delivered(rig, marker) == ()
row: Final = _logged_once(call_id)
assert (row["call_type"], row["status"]) == ("aimage_edit", "failure"), row
_Sender = Callable[[_Rig, str, str, Mapping[str, JsonValue]], httpx.Response]
@dataclass(frozen=True, slots=True)
class _Checked:
provider: str
tool: dict[str, JsonValue]
named_as: _Family
send: _Sender
target: str
answered: Callable[[httpx.Response, str], None]
kept_by_a_tools_list: tuple[str, ...]
bad_entry: dict[str, JsonValue]
def _family_sender(family: _Family) -> _Sender:
return lambda rig, model, marker, fields: _send(rig, family, marker, False, model=model, **fields)
def _family_answered(family: _Family) -> Callable[[httpx.Response, str], None]:
return lambda response, marker: _assert_answered(family, response, marker)
def _count_tokens(rig: _Rig, model: str, marker: str, fields: Mapping[str, JsonValue]) -> httpx.Response:
return rig.gateway.request(
"POST",
"/v1/messages/count_tokens",
{"model": model, "messages": [{"role": "user", "content": marker}], **fields},
)
def _input_tokens(rig: _Rig, model: str, marker: str, fields: Mapping[str, JsonValue]) -> httpx.Response:
return rig.gateway.request("POST", "/v1/responses/input_tokens", {"model": model, "input": marker, **fields})
def _counted(expected: Mapping[str, JsonValue]) -> Callable[[httpx.Response, str], None]:
def check(response: httpx.Response, marker: str) -> None:
assert response.status_code == 200, response.text
assert _JSON_OBJECT.validate_json(response.content) == expected, (marker, response.text)
return check
_CHAT_BAD_ENTRY: Final[dict[str, JsonValue]] = {
"type": "function",
"function": {"name": "get_weather", "parameters": "bad"},
}
_MESSAGES_BAD_ENTRY: Final[dict[str, JsonValue]] = {"name": "get_weather", "input_schema": [1]}
_RESPONSES_BAD_ENTRY: Final[dict[str, JsonValue]] = {"type": "function", "name": "get_weather", "parameters": 5}
_CHECKED: Final[Mapping[str, _Checked]] = MappingProxyType(
{
"chat": _Checked(
provider="openai",
tool=CHAT.tool,
named_as=CHAT,
send=_family_sender(CHAT),
target="/v1/chat/completions",
answered=_family_answered(CHAT),
kept_by_a_tools_list=(),
bad_entry=_CHAT_BAD_ENTRY,
),
"messages": _Checked(
provider="anthropic",
tool=MESSAGES.tool,
named_as=MESSAGES,
send=_family_sender(MESSAGES),
target="/v1/messages",
answered=_family_answered(MESSAGES),
kept_by_a_tools_list=(),
bad_entry=_MESSAGES_BAD_ENTRY,
),
"responses": _Checked(
provider="openai",
tool=RESPONSES.tool,
named_as=RESPONSES,
send=_family_sender(RESPONSES),
target="/v1/responses",
answered=_family_answered(RESPONSES),
kept_by_a_tools_list=(),
bad_entry=_RESPONSES_BAD_ENTRY,
),
"generate_content": _Checked(
provider="gemini",
tool=GENERATE.tool,
named_as=GENERATE,
send=_family_sender(GENERATE),
target=":generateContent",
answered=_family_answered(GENERATE),
kept_by_a_tools_list=("get_weather",),
bad_entry={"parameters": 5},
),
"count_tokens": _Checked(
provider="anthropic",
tool=MESSAGES.tool,
named_as=MESSAGES,
send=_count_tokens,
target="/v1/messages/count_tokens",
answered=_counted({"input_tokens": _COUNT, **_PROVIDER_SOURCE}),
kept_by_a_tools_list=("get_weather",),
bad_entry=_MESSAGES_BAD_ENTRY,
),
"input_tokens": _Checked(
provider="anthropic",
tool=RESPONSES.tool,
named_as=MESSAGES,
send=_input_tokens,
target="/v1/messages/count_tokens",
answered=_counted({"object": "response.input_tokens", "input_tokens": _COUNT, **_PROVIDER_SOURCE}),
kept_by_a_tools_list=(),
bad_entry=_RESPONSES_BAD_ENTRY,
),
}
)
_EACH_CHECKED: Final = pytest.mark.parametrize("checked", _CHECKED.values(), ids=_CHECKED.keys())
_CHAT_AND_COUNT: Final = pytest.mark.parametrize(
"checked", (_CHECKED["chat"], _CHECKED["count_tokens"]), ids=("chat", "count_tokens")
)
_ENTRY_SHAPES: Final = pytest.mark.parametrize(
"bad_entry",
[lambda checked: 5, lambda checked: checked.bad_entry],
ids=["int_entry", "dict_entry"],
)
_BadEntry = Callable[[_Checked], JsonValue]
def _assert_forwarded(
rig: _Rig, checked: _Checked, response: httpx.Response, marker: str, names: tuple[str, ...]
) -> None:
checked.answered(response, marker)
assert _tool_names(checked.named_as, _one_delivery(rig, marker, checked.target)) == names
def _assert_held_back(rig: _Rig, response: httpx.Response, marker: str) -> None:
_assert_rejected(response, _SECOND_NOT_AN_OBJECT)
assert _delivered(rig, marker) == ()
_PROVIDERS: Final[Mapping[str, Callable[[str], dict[str, JsonValue]]]] = MappingProxyType(
{
"openai": lambda wire: {
"model": f"openai/{_OPENAI_BACKEND}",
"api_base": f"{wire}/v1",
"api_key": _PROVIDER_KEY,
},
"anthropic": lambda wire: {"model": f"anthropic/{_CLAUDE_BACKEND}", "api_base": wire, "api_key": _PROVIDER_KEY},
"gemini": lambda wire: {"model": f"gemini/{_GEMINI_BACKEND}", "api_base": wire, "api_key": _PROVIDER_KEY},
}
)
_DROP_VARIANTS: Final[Mapping[str, dict[str, JsonValue]]] = MappingProxyType(
{
"plain": {},
"lists_web_search": {"additional_drop_params": ["web_search_options"]},
"lists_tools": {"additional_drop_params": ["tools"]},
"keeps": {"drop_params": False},
}
)
@dataclass(frozen=True, slots=True)
class _Owned:
rig: _Rig
suffix: str
def _owned_name(suffix: str, variant: str, provider: str) -> str:
return f"malformed-tools-{variant}-{provider}-{suffix}"
def _owned_id(suffix: str, variant: str, provider: str) -> str:
return f"{_owned_name(suffix, variant, provider)}-id"
@dataclass(frozen=True, slots=True)
class _OwnedSetup:
router_settings: Callable[[str], dict[str, JsonValue]]
general: Mapping[str, JsonValue] = MappingProxyType({})
extra_models: Callable[[str, str], tuple[dict[str, JsonValue], ...]] = lambda wire, suffix: ()
def _router_defaults(defaults: dict[str, JsonValue]) -> _OwnedSetup:
return _OwnedSetup(router_settings=lambda suffix: {"default_litellm_params": defaults})
def _owned_config(path: Path, wire: str, suffix: str, setup: _OwnedSetup) -> Path:
path.write_text(
json.dumps(
{
"model_list": [
*(
{
"model_name": _owned_name(suffix, variant, provider),
"litellm_params": {**deployment(wire), **extra},
"model_info": {"id": _owned_id(suffix, variant, provider)},
}
for (variant, extra), (provider, deployment) in product(
_DROP_VARIANTS.items(), _PROVIDERS.items()
)
),
*setup.extra_models(wire, suffix),
],
"general_settings": {
"master_key": "os.environ/LITELLM_MASTER_KEY",
"database_url": "os.environ/DATABASE_URL",
**setup.general,
},
"router_settings": setup.router_settings(suffix),
}
)
)
return path
@contextmanager
def _owned_proxy(rig: _Rig, directory: Path, setup: _OwnedSetup) -> Iterator[_Owned]:
suffix: Final = uuid.uuid4().hex[:12]
config: Final = _owned_config(directory / "owned.yaml", rig.wire.url, suffix, setup)
with owned_proxy_process(rig.gateway, directory, {}, config=config, workers=2) as proxy:
yield _Owned(replace(rig, gateway=proxy.gateway), suffix)
@pytest.fixture(scope="module")
def tools_default(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Owned]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-tools-default")
with _owned_proxy(rig, directory, _router_defaults({"additional_drop_params": ["tools"]})) as owned:
yield owned
@pytest.fixture(scope="module")
def drop_default(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Owned]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-drop-default")
with _owned_proxy(rig, directory, _router_defaults({"drop_params": True, "additional_drop_params": None})) as owned:
yield owned
@pytest.fixture(scope="module")
def client_side(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Owned]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-client-side")
setup: Final = replace(
_router_defaults({"additional_drop_params": "tools"}),
general=MappingProxyType({"allow_client_side_credentials": True}),
)
with _owned_proxy(rig, directory, setup) as owned:
yield owned
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
@_EACH_CHECKED
def test_a_router_default_list_naming_tools_answers_malformed_tools(
tools_default: _Owned, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
model: Final = _owned_name(tools_default.suffix, "plain", checked.provider)
response: Final = checked.send(tools_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(tools_default.rig, checked, response, marker, checked.kept_by_a_tools_list)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_EACH_CHECKED
def test_a_request_list_replaces_a_router_default_list(tools_default: _Owned, checked: _Checked) -> None:
marker: Final = _marker()
model: Final = _owned_name(tools_default.suffix, "plain", checked.provider)
response: Final = checked.send(
tools_default.rig,
model,
marker,
{"tools": [checked.tool, 5], "additional_drop_params": ["web_search_options"]},
)
_assert_held_back(tools_default.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
@_EACH_CHECKED
def test_a_router_default_list_replaces_a_deployment_list(
tools_default: _Owned, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
model: Final = _owned_name(tools_default.suffix, "lists_web_search", checked.provider)
response: Final = checked.send(tools_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(tools_default.rig, checked, response, marker, checked.kept_by_a_tools_list)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
def test_a_router_default_list_replaces_the_list_of_a_deployment_named_by_id(
tools_default: _Owned, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["chat"]
model: Final = _owned_id(tools_default.suffix, "lists_web_search", checked.provider)
response: Final = checked.send(tools_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(tools_default.rig, checked, response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize("value", [None, [], 5], ids=["null", "empty_list", "int"])
def test_a_request_list_naming_nothing_replaces_a_router_default_list(tools_default: _Owned, value: JsonValue) -> None:
marker: Final = _marker()
model: Final = _owned_name(tools_default.suffix, "plain", "openai")
response: Final = _send(
tools_default.rig, CHAT, marker, False, model=model, tools=[CHAT.tool, 5], additional_drop_params=value
)
_assert_held_back(tools_default.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_a_router_default_list_naming_tools_drops_well_formed_tools(tools_default: _Owned) -> None:
marker: Final = _marker()
model: Final = _owned_name(tools_default.suffix, "plain", "openai")
response: Final = _send(tools_default.rig, CHAT, marker, False, model=model, tools=[CHAT.tool])
_assert_forwarded(tools_default.rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
@_EACH_CHECKED
def test_a_router_default_drop_params_keeps_the_good_entries(
drop_default: _Owned, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
model: Final = _owned_name(drop_default.suffix, "plain", checked.provider)
response: Final = checked.send(drop_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(drop_default.rig, checked, response, marker, ("get_weather",))
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize("drop", [False, None], ids=["false", "null"])
def test_a_request_drop_params_replaces_a_router_default_drop_params(drop_default: _Owned, drop: JsonValue) -> None:
marker: Final = _marker()
model: Final = _owned_name(drop_default.suffix, "plain", "openai")
response: Final = _send(drop_default.rig, CHAT, marker, False, model=model, tools=[CHAT.tool, 5], drop_params=drop)
_assert_held_back(drop_default.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
@_CHAT_AND_COUNT
def test_a_router_default_drop_params_replaces_a_deployment_drop_params(
drop_default: _Owned, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
model: Final = _owned_name(drop_default.suffix, "keeps", checked.provider)
response: Final = checked.send(drop_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(drop_default.rig, checked, response, marker, ("get_weather",))
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_ENTRY_SHAPES
@_CHAT_AND_COUNT
def test_a_null_router_default_list_leaves_the_deployment_list_in_force(
drop_default: _Owned, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
model: Final = _owned_name(drop_default.suffix, "lists_tools", checked.provider)
response: Final = checked.send(
drop_default.rig, model, marker, {"tools": [checked.tool, bad_entry(checked)], "drop_params": False}
)
_assert_forwarded(drop_default.rig, checked, response, marker, checked.kept_by_a_tools_list)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_a_router_default_list_that_is_a_string_still_rejects_a_bad_tool_entry(client_side: _Owned) -> None:
marker: Final = _marker()
model: Final = _owned_name(client_side.suffix, "plain", "openai")
response: Final = _send(client_side.rig, CHAT, marker, False, model=model, tools=[CHAT.tool, 5])
_assert_held_back(client_side.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_a_router_default_list_that_is_a_string_keeps_well_formed_tools(client_side: _Owned) -> None:
marker: Final = _marker()
model: Final = _owned_name(client_side.suffix, "plain", "openai")
response: Final = _send(client_side.rig, CHAT, marker, False, model=model, tools=[CHAT.tool])
_assert_answered(CHAT, response, marker)
assert _one_delivery(client_side.rig, marker, "/v1/chat/completions")["tools"] == [CHAT.tool]
_USER_CONFIG_DROPS: Final[Mapping[str, tuple[dict[str, JsonValue], dict[str, JsonValue], tuple[str, ...]]]] = (
MappingProxyType(
{
"deployment_list": ({"additional_drop_params": ["tools"]}, {}, ()),
"router_default_list": ({}, {"additional_drop_params": ["tools"]}, ()),
"router_default_drop_params": ({}, {"drop_params": True}, ("get_weather",)),
}
)
)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize(("deployment", "defaults", "kept"), _USER_CONFIG_DROPS.values(), ids=_USER_CONFIG_DROPS.keys())
def test_a_user_config_router_decides_which_malformed_tools_drop(
client_side: _Owned,
deployment: dict[str, JsonValue],
defaults: dict[str, JsonValue],
kept: tuple[str, ...],
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["chat"]
name: Final = f"malformed-tools-user-config-{uuid.uuid4().hex}"
user_config: Final[dict[str, JsonValue]] = {
"model_list": [
{"model_name": name, "litellm_params": {**_PROVIDERS["openai"](client_side.rig.wire.url), **deployment}}
],
"default_litellm_params": defaults,
}
response: Final = checked.send(
client_side.rig, name, marker, {"tools": [checked.tool, checked.bad_entry], "user_config": user_config}
)
_assert_forwarded(client_side.rig, checked, response, marker, kept)
@dataclass(frozen=True, slots=True)
class _ById:
lists_tools: Mapping[str, str]
drops: str
mixed_drops: str
mixed_keeps: str
shadowed: str
@pytest.fixture(scope="module")
def by_id(rig: _Rig) -> Iterator[_ById]:
openai_deployment: Final = _PROVIDERS["openai"](rig.wire.url)
lists_tools: Final[dict[str, JsonValue]] = {"additional_drop_params": ["tools"]}
names: Final = MappingProxyType({provider: f"integration-by-id-{uuid.uuid4().hex}" for provider in _PROVIDERS})
drops_name: Final = f"integration-by-id-drops-{uuid.uuid4().hex}"
mixed: Final = f"integration-by-id-mixed-{uuid.uuid4().hex}"
shadow_name: Final = f"integration-by-id-shadow-{uuid.uuid4().hex}"
with rig.gateway.scenario() as scenario:
listed: Final = MappingProxyType(
{
provider: _deployment_ids(scenario, names[provider], ({**deployment(rig.wire.url), **lists_tools},))[0]
for provider, deployment in _PROVIDERS.items()
}
)
(drops,) = _deployment_ids(scenario, drops_name, ({**openai_deployment, "drop_params": True},))
mixed_drops, mixed_keeps = _deployment_ids(
scenario, mixed, ({**openai_deployment, **lists_tools}, openai_deployment)
)
(shadowed,) = _deployment_ids(scenario, shadow_name, ({**openai_deployment, **lists_tools},))
_deployment_ids(scenario, shadowed, (openai_deployment,))
for group, deployments in (
*((name, 1) for name in names.values()),
(drops_name, 1),
(mixed, 2),
(shadow_name, 1),
(shadowed, 1),
):
wait_for_worker_readiness(rig.gateway, group, deployments, _PROXY_WORKERS)
yield _ById(listed, drops, mixed_drops, mixed_keeps, shadowed)
@_ENTRY_SHAPES
@_EACH_CHECKED
def test_a_deployment_id_answers_malformed_tools_its_deployment_list_drops(
rig: _Rig, by_id: _ById, checked: _Checked, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
response: Final = checked.send(
rig, by_id.lists_tools[checked.provider], marker, {"tools": [checked.tool, bad_entry(checked)]}
)
_assert_forwarded(rig, checked, response, marker, checked.kept_by_a_tools_list)
@_EACH_CHECKED
def test_a_request_list_replaces_the_list_of_a_deployment_named_by_id(
rig: _Rig, by_id: _ById, checked: _Checked
) -> None:
marker: Final = _marker()
response: Final = checked.send(
rig,
by_id.lists_tools[checked.provider],
marker,
{"tools": [checked.tool, 5], "additional_drop_params": ["web_search_options"]},
)
_assert_held_back(rig, response, marker)
@_ENTRY_SHAPES
def test_the_id_of_the_dropping_deployment_in_a_mixed_group_drops_malformed_tools(
rig: _Rig, by_id: _ById, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["chat"]
response: Final = checked.send(rig, by_id.mixed_drops, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(rig, checked, response, marker, ())
def test_the_keeping_id_of_a_mixed_group_rejects_malformed_tools(rig: _Rig, by_id: _ById) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, model=by_id.mixed_keeps, tools=[CHAT.tool, 5])
_assert_held_back(rig, response, marker)
@_ENTRY_SHAPES
def test_the_id_of_a_drop_params_deployment_keeps_the_good_entries(
rig: _Rig, by_id: _ById, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["chat"]
response: Final = checked.send(rig, by_id.drops, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(rig, checked, response, marker, ("get_weather",))
def test_a_model_name_wins_over_an_equal_deployment_id(rig: _Rig, by_id: _ById) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, model=by_id.shadowed, tools=[CHAT.tool, 5])
_assert_held_back(rig, response, marker)
def test_a_deployment_id_with_a_tools_list_drops_well_formed_tools(rig: _Rig, by_id: _ById) -> None:
marker: Final = _marker()
response: Final = _send(rig, CHAT, marker, False, model=by_id.lists_tools["openai"], tools=[CHAT.tool])
_assert_forwarded(rig, _CHECKED["chat"], response, marker, ())
def _failed_over(request: Request) -> bool:
return request.target.startswith((_DOWN, *(prefix for prefix, _ in _REFUSALS.values())))
def _assert_failed_over(
rig: _Rig, checked: _Checked, response: httpx.Response, marker: str, names: tuple[str, ...]
) -> None:
checked.answered(response, marker)
delivered: Final = _delivered(rig, marker)
(served,) = tuple(request for request in delivered if not _failed_over(request))
assert checked.target in served.target, served.target
assert _tool_names(checked.named_as, _JSON_OBJECT.validate_json(served.body)) == names
_FALLBACK_CHECKED: Final = pytest.mark.parametrize(
"checked",
tuple(_CHECKED[name] for name in ("chat", "messages", "responses")),
ids=("chat", "messages", "responses"),
)
_TOKEN_COUNTS: Final = pytest.mark.parametrize(
"checked", (_CHECKED["count_tokens"], _CHECKED["input_tokens"]), ids=("count_tokens", "input_tokens")
)
@dataclass(frozen=True, slots=True)
class _Reroute:
down: Mapping[str, str]
lists_tools: Mapping[str, str]
refusing: Mapping[str, str]
fallback_keys: Mapping[str, str]
team_key: str
team_models: Mapping[str, str]
@pytest.fixture(scope="module")
def reroute(rig: _Rig, field_groups: _FieldGroups) -> Iterator[_Reroute]:
lists_tools: Final = MappingProxyType({"openai": rig.field_group, "anthropic": field_groups.anthropic})
with rig.gateway.scenario() as scenario:
down: Final = MappingProxyType(
{provider: scenario.model(**_PROVIDERS[provider](f"{rig.wire.url}/down")) for provider in lists_tools}
)
refusing: Final = MappingProxyType(
{
chain: scenario.model(**_PROVIDERS["openai"](f"{rig.wire.url}{prefix.rstrip('/')}"))
for chain, (prefix, _) in _REFUSALS.items()
}
)
router_settings: Final[dict[str, JsonValue]] = {"fallbacks": [{down["openai"]: [rig.field_group]}]}
public_team: Final = scenario.team()
team_models: Final = MappingProxyType(
{
provider: scenario.model(
**_PROVIDERS[provider](rig.wire.url),
additional_drop_params=["tools"],
model_info={"team_id": public_team},
)
for provider in lists_tools
}
)
built: Final = _Reroute(
down=down,
lists_tools=lists_tools,
refusing=refusing,
fallback_keys=MappingProxyType(
{
"key": scenario.key(router_settings=router_settings),
"team": scenario.key(team_id=scenario.team(router_settings=router_settings)),
}
),
team_key=scenario.key(team_id=public_team),
team_models=team_models,
)
for group in (*down.values(), *refusing.values(), *team_models.values()):
wait_for_worker_readiness(rig.gateway, group, 1, _PROXY_WORKERS)
yield built
@_FALLBACK_CHECKED
def test_a_request_fallback_to_a_group_listing_tools_answers_a_bad_tool_entry(
rig: _Rig, reroute: _Reroute, checked: _Checked
) -> None:
marker: Final = _marker()
response: Final = checked.send(
rig,
reroute.down[checked.provider],
marker,
{"tools": [checked.tool, checked.bad_entry], "fallbacks": [reroute.lists_tools[checked.provider]]},
)
_assert_failed_over(rig, checked, response, marker, ())
def test_a_generic_request_fallback_to_a_group_listing_tools_answers_a_bad_tool_entry(
rig: _Rig, reroute: _Reroute
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["chat"]
response: Final = checked.send(
rig,
reroute.down["openai"],
marker,
{"tools": [checked.tool, checked.bad_entry], "fallbacks": [{"*": [rig.field_group]}]},
)
_assert_failed_over(rig, checked, response, marker, ())
@pytest.mark.parametrize(
"fallbacks",
[[], None, lambda rig: [{rig.drop_group: [rig.field_group]}]],
ids=["empty_list", "null", "chain_of_another_group"],
)
def test_a_request_fallback_that_cannot_apply_still_rejects_a_bad_tool_entry(
rig: _Rig, fallbacks: JsonValue | Callable[[_Rig], JsonValue]
) -> None:
marker: Final = _marker()
chains: Final = fallbacks(rig) if callable(fallbacks) else fallbacks
response: Final = _send(rig, CHAT, marker, False, tools=[CHAT.tool, 5], fallbacks=chains)
_assert_held_back(rig, response, marker)
@pytest.mark.parametrize("owner", ["key", "team"])
def test_router_settings_fallbacks_of_a_key_or_team_answer_a_bad_tool_entry(
rig: _Rig, reroute: _Reroute, owner: str
) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
model=reroute.down["openai"],
key=reroute.fallback_keys[owner],
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
)
_assert_failed_over(rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.parametrize("chain", tuple(_REFUSALS))
def test_an_error_specific_fallback_never_sees_a_bad_tool_entry_the_first_deployment_rejects(
rig: _Rig, reroute: _Reroute, chain: str
) -> None:
marker: Final = _marker()
refusing: Final = reroute.refusing[chain]
response: Final = _send(
rig,
CHAT,
marker,
False,
model=refusing,
tools=[CHAT.tool, 5],
**{chain: [{refusing: [rig.field_group]}]},
)
_assert_held_back(rig, response, marker)
def test_a_comma_batch_lets_each_group_decide_on_a_bad_tool_entry(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(
rig, CHAT, marker, False, model=f"{rig.field_group},{rig.openai}", tools=[CHAT.tool, _CHAT_BAD_ENTRY]
)
assert response.status_code == 200, response.text
assert _answer(_tag(marker)) in response.text, response.text
delivered: Final = sorted(
(_JSON_OBJECT.validate_json(request.body).get("tools") for request in _delivered(rig, marker)), key=bool
)
assert delivered == [None]
def test_a_team_public_model_name_answers_a_bad_tool_entry_its_deployment_list_drops(
rig: _Rig, reroute: _Reroute
) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
model=reroute.team_models["openai"],
key=reroute.team_key,
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
)
_assert_forwarded(rig, _CHECKED["chat"], response, marker, ())
def test_count_tokens_by_a_team_public_model_name_rejects_a_bad_tool_entry(rig: _Rig, reroute: _Reroute) -> None:
marker: Final = _marker()
response: Final = rig.gateway.request(
"POST",
"/v1/messages/count_tokens",
{
"model": reroute.team_models["anthropic"],
"messages": [{"role": "user", "content": marker}],
"tools": [MESSAGES.tool, 5],
},
key=reroute.team_key,
)
_assert_held_back(rig, response, marker)
def test_a_request_list_naming_web_search_options_on_a_fallback_chain_still_rejects_a_bad_tool_entry(
rig: _Rig,
) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
tools=[CHAT.tool, 5],
web_search_options=5,
additional_drop_params=["web_search_options"],
fallbacks=[{rig.openai: [rig.field_group]}],
)
_assert_held_back(rig, response, marker)
def test_request_drop_params_on_a_fallback_chain_keeps_the_good_entries(rig: _Rig) -> None:
marker: Final = _marker()
response: Final = _send(
rig,
CHAT,
marker,
False,
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
drop_params=True,
fallbacks=[{rig.openai: [rig.field_group]}],
)
_assert_forwarded(rig, _CHECKED["chat"], response, marker, ("get_weather",))
@_ENTRY_SHAPES
def test_a_request_list_with_a_non_string_entry_drops_tools_it_names_on_messages(
rig: _Rig, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["messages"]
response: Final = checked.send(
rig,
rig.anthropic,
marker,
{"tools": [checked.tool, bad_entry(checked)], "additional_drop_params": ["tools", 5]},
)
_assert_forwarded(rig, checked, response, marker, ())
@_ENTRY_SHAPES
def test_a_deployment_list_with_a_non_string_entry_drops_tools_it_names_on_messages(
rig: _Rig, bad_entry: _BadEntry
) -> None:
marker: Final = _marker()
checked: Final = _CHECKED["messages"]
with rig.gateway.scenario() as scenario:
group: Final = scenario.model(**_PROVIDERS["anthropic"](rig.wire.url), additional_drop_params=["tools", 5])
wait_for_worker_readiness(rig.gateway, group, 1, _PROXY_WORKERS)
response: Final = checked.send(rig, group, marker, {"tools": [checked.tool, bad_entry(checked)]})
_assert_forwarded(rig, checked, response, marker, ())
@_TOKEN_COUNTS
def test_token_counting_with_a_request_list_with_a_non_string_entry_counts_the_tools_its_route_keeps(
rig: _Rig, checked: _Checked
) -> None:
marker: Final = _marker()
response: Final = checked.send(
rig, rig.anthropic, marker, {"tools": [checked.tool, 5], "additional_drop_params": ["tools", 5]}
)
_assert_forwarded(rig, checked, response, marker, checked.kept_by_a_tools_list)
def _alias(suffix: str, variant: str) -> str:
return f"malformed-tools-alias-{variant}-{suffix}"
def _routing_group(suffix: str, provider: str) -> str:
return f"malformed-tools-routed-{provider}-{suffix}"
def _wildcard(suffix: str) -> str:
return f"malformed-tools-wild-{suffix}"
def _direct(suffix: str) -> str:
return f"malformed-tools-direct-{suffix}"
def _down_models(wire: str, suffix: str) -> tuple[dict[str, JsonValue], ...]:
return tuple(
{"model_name": _owned_name(suffix, "down", provider), "litellm_params": _PROVIDERS[provider](f"{wire}/down")}
for provider in ("openai", "anthropic")
)
def _rerouting_models(wire: str, suffix: str) -> tuple[dict[str, JsonValue], ...]:
lists_tools: Final = _owned_name(suffix, "lists_tools", "openai")
return (
*_down_models(wire, suffix),
{
"model_name": _owned_name(suffix, "auto", "openai"),
"litellm_params": {
"model": "auto_router/complexity_router",
"complexity_router_default_model": lists_tools,
"complexity_router_config": {
"tiers": dict.fromkeys(("SIMPLE", "MEDIUM", "COMPLEX", "REASONING"), lists_tools)
},
},
},
{
"model_name": _owned_name(suffix, "direct", "openai"),
"litellm_params": {
**_PROVIDERS["openai"](wire),
"model": f"openai/{_direct(suffix)}",
"additional_drop_params": ["tools"],
},
},
{
"model_name": f"{_wildcard(suffix)}/*",
"litellm_params": {**_PROVIDERS["openai"](wire), "model": "openai/*", "additional_drop_params": ["tools"]},
},
)
def _rerouting_settings(suffix: str) -> dict[str, JsonValue]:
return {
"fallbacks": [
{_owned_name(suffix, "down", provider): [_owned_name(suffix, "lists_tools", provider)]}
for provider in ("openai", "anthropic")
],
"model_group_alias": {
_alias(suffix, variant): _owned_name(suffix, variant, "openai") for variant in ("lists_tools", "plain")
},
"routing_groups": [
{
"group_name": _routing_group(suffix, provider),
"models": [_owned_name(suffix, "lists_tools", provider)],
"routing_strategy": "simple-shuffle",
}
for provider in ("openai", "anthropic")
],
"num_retries": 0,
"disable_cooldowns": True,
}
@pytest.fixture(scope="module")
def rerouting(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Owned]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-rerouting")
setup: Final = _OwnedSetup(router_settings=_rerouting_settings, extra_models=_rerouting_models)
with _owned_proxy(rig, directory, setup) as owned:
yield owned
@pytest.fixture(scope="module")
def default_fallbacks(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Owned]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-default-fallbacks")
setup: Final = _OwnedSetup(
router_settings=lambda suffix: {
"default_fallbacks": [_owned_name(suffix, "lists_tools", "openai")],
"num_retries": 0,
"disable_cooldowns": True,
},
extra_models=_down_models,
)
with _owned_proxy(rig, directory, setup) as owned:
yield owned
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize("checked", (_CHECKED["chat"], _CHECKED["messages"]), ids=("chat", "messages"))
def test_a_router_fallback_to_a_group_listing_tools_answers_a_bad_tool_entry(
rerouting: _Owned, checked: _Checked
) -> None:
marker: Final = _marker()
model: Final = _owned_name(rerouting.suffix, "down", checked.provider)
response: Final = checked.send(rerouting.rig, model, marker, {"tools": [checked.tool, checked.bad_entry]})
_assert_failed_over(rerouting.rig, checked, response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize(
("variant", "fields"),
[("plain", {}), ("down", {"fallbacks": []})],
ids=["group_outside_the_chain", "chain_cleared_by_the_request"],
)
def test_a_router_fallback_that_cannot_apply_still_rejects_a_bad_tool_entry(
rerouting: _Owned, variant: str, fields: dict[str, JsonValue]
) -> None:
marker: Final = _marker()
model: Final = _owned_name(rerouting.suffix, variant, "openai")
response: Final = _send(rerouting.rig, CHAT, marker, False, model=model, tools=[CHAT.tool, 5], **fields)
_assert_held_back(rerouting.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_TOKEN_COUNTS
def test_token_counting_on_a_group_with_a_router_fallback_rejects_a_bad_tool_entry(
rerouting: _Owned, checked: _Checked
) -> None:
marker: Final = _marker()
model: Final = _owned_name(rerouting.suffix, "down", "anthropic")
response: Final = checked.send(rerouting.rig, model, marker, {"tools": [checked.tool, 5]})
_assert_held_back(rerouting.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_an_alias_of_a_group_listing_tools_answers_a_bad_tool_entry(rerouting: _Owned) -> None:
marker: Final = _marker()
response: Final = _send(
rerouting.rig,
CHAT,
marker,
False,
model=_alias(rerouting.suffix, "lists_tools"),
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
)
_assert_forwarded(rerouting.rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_an_alias_of_a_plain_group_rejects_a_bad_tool_entry(rerouting: _Owned) -> None:
marker: Final = _marker()
response: Final = _send(
rerouting.rig, CHAT, marker, False, model=_alias(rerouting.suffix, "plain"), tools=[CHAT.tool, 5]
)
_assert_held_back(rerouting.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_a_routing_group_over_a_group_listing_tools_answers_a_bad_tool_entry(rerouting: _Owned) -> None:
marker: Final = _marker()
response: Final = _send(
rerouting.rig,
CHAT,
marker,
False,
model=_routing_group(rerouting.suffix, "openai"),
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
)
_assert_forwarded(rerouting.rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_count_tokens_by_a_routing_group_rejects_a_bad_tool_entry(rerouting: _Owned) -> None:
marker: Final = _marker()
response: Final = _count_tokens(
rerouting.rig, _routing_group(rerouting.suffix, "anthropic"), marker, {"tools": [MESSAGES.tool, 5]}
)
_assert_held_back(rerouting.rig, response, marker)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@pytest.mark.parametrize(
("model", "fields"),
[
(lambda suffix: _owned_name(suffix, "auto", "openai"), {}),
(lambda suffix: f"{_wildcard(suffix)}/{_OPENAI_BACKEND}", {}),
(lambda suffix: f"openai/{_direct(suffix)}", {}),
(lambda suffix: f"openai/{_direct(suffix)}", {"specific_deployment": True}),
],
ids=["auto_router", "wildcard_route", "model_string", "specific_deployment"],
)
def test_a_model_the_router_resolves_later_answers_a_bad_tool_entry_its_deployment_list_drops(
rerouting: _Owned, model: Callable[[str], str], fields: dict[str, JsonValue]
) -> None:
marker: Final = _marker()
response: Final = _send(
rerouting.rig,
CHAT,
marker,
False,
model=model(rerouting.suffix),
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
**fields,
)
_assert_forwarded(rerouting.rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_default_fallbacks_to_a_group_listing_tools_answer_a_bad_tool_entry(default_fallbacks: _Owned) -> None:
marker: Final = _marker()
response: Final = _send(
default_fallbacks.rig,
CHAT,
marker,
False,
model=_owned_name(default_fallbacks.suffix, "down", "openai"),
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
)
_assert_failed_over(default_fallbacks.rig, _CHECKED["chat"], response, marker, ())
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
def test_a_user_config_model_named_like_a_proxy_group_drops_tools_its_own_list_names(client_side: _Owned) -> None:
marker: Final = _marker()
name: Final = _owned_name(client_side.suffix, "plain", "openai")
user_config: Final[dict[str, JsonValue]] = {
"model_list": [
{
"model_name": name,
"litellm_params": {
**_PROVIDERS["openai"](client_side.rig.wire.url),
"additional_drop_params": ["tools"],
},
}
],
}
response: Final = _send(
client_side.rig,
CHAT,
marker,
False,
model=name,
tools=[CHAT.tool, _CHAT_BAD_ENTRY],
user_config=user_config,
)
_assert_forwarded(client_side.rig, _CHECKED["chat"], response, marker, ())
_GUARDED_NAMES: Final = ("chat", "messages", "responses", "generate_content")
_EACH_GUARDED: Final = pytest.mark.parametrize(
"checked", tuple(_CHECKED[name] for name in _GUARDED_NAMES), ids=_GUARDED_NAMES
)
_GUARDRAIL_VENDOR_PATH: Final = "/beta/litellm_basic_guardrail_api"
@dataclass(frozen=True, slots=True)
class _Guarded:
rig: _Rig
vendor: Wire
models: Mapping[str, str]
def _guarded_config(path: Path, wire: str, vendor: str, models: Mapping[str, str]) -> Path:
path.write_text(
json.dumps(
{
"model_list": [
{"model_name": name, "litellm_params": _PROVIDERS[provider](wire)}
for provider, name in models.items()
],
"general_settings": {
"master_key": "os.environ/LITELLM_MASTER_KEY",
"database_url": "os.environ/DATABASE_URL",
},
"guardrails": [
{
"guardrail_name": "malformed-tools-vendor",
"litellm_params": {
"guardrail": "generic_guardrail_api",
"mode": "pre_call",
"default_on": True,
"api_base": vendor,
"api_key": "synthetic-guardrail-key",
},
}
],
}
)
)
return path
def _guardrail_verdict(request: Request) -> Reply:
assert request.target == _GUARDRAIL_VENDOR_PATH, request.target
return Reply(body=json.dumps({"action": "NONE"}).encode())
@pytest.fixture(scope="module")
def guarded(rig: _Rig, tmp_path_factory: pytest.TempPathFactory) -> Iterator[_Guarded]:
directory: Final = tmp_path_factory.mktemp("malformed-tools-guarded")
suffix: Final = uuid.uuid4().hex[:12]
models: Final = MappingProxyType(
{provider: f"malformed-tools-guarded-{provider}-{suffix}" for provider in _PROVIDERS}
)
with wire_server(_guardrail_verdict) as vendor:
config: Final = _guarded_config(directory / "guarded.yaml", rig.wire.url, vendor.url, models)
with owned_proxy_process(rig.gateway, directory, {}, config=config, workers=2) as proxy:
yield _Guarded(replace(rig, gateway=proxy.gateway), vendor, models)
def _vendor_payloads(guarded: _Guarded, marker: str) -> tuple[dict[str, JsonValue], ...]:
return tuple(
_JSON_OBJECT.validate_json(request.body)
for request in guarded.vendor.drain()
if marker in request.body.decode()
)
@pytest.mark.timeout(_OWNED_PROXY_CELL_SECONDS)
@_EACH_GUARDED
def test_a_pre_call_guardrail_passes_well_formed_tools_through_to_the_provider(
guarded: _Guarded, checked: _Checked
) -> None:
marker: Final = _marker()
response: Final = checked.send(guarded.rig, guarded.models[checked.provider], marker, {"tools": [checked.tool]})
_assert_forwarded(guarded.rig, checked, response, marker, ("get_weather",))
payloads: Final = _vendor_payloads(guarded, marker)
assert len(payloads) == 1, payloads
assert all(payload.get("tools") is None or isinstance(payload["tools"], list) for payload in payloads), payloads
_PROVIDER_WIRES: Final[Mapping[str, tuple[_Family, Callable[[bool], str]]]] = MappingProxyType(
{
"openai": (CHAT, lambda stream: "/v1/chat/completions"),
"openai_responses": (RESPONSES, lambda stream: "/v1/responses"),
"anthropic": (MESSAGES, lambda stream: "/v1/messages"),
"gemini": (GENERATE, lambda stream: ":streamGenerateContent" if stream else ":generateContent"),
}
)
_NATIVE_PROVIDERS: Final[Mapping[str, tuple[str, ...]]] = MappingProxyType(
{
"chat": ("openai",),
"messages": ("anthropic",),
"responses": ("openai", "openai_responses"),
"generate_content": ("gemini",),
}
)
_ROUTED_ELSEWHERE: Final[Mapping[tuple[str, str], str]] = MappingProxyType({("messages", "openai"): "openai_responses"})
_BRIDGES: Final = tuple(
(family, provider)
for family, provider in product(_FAMILIES, _PROVIDER_WIRES)
if provider not in _NATIVE_PROVIDERS[family.name]
)
@pytest.fixture(scope="module")
def bridge_groups(rig: _Rig) -> Iterator[Mapping[str, str]]:
with rig.gateway.scenario() as scenario:
responses_group: Final = scenario.model(
model=f"openai/responses/{_OPENAI_BACKEND}", api_base=f"{rig.wire.url}/v1", api_key=_PROVIDER_KEY
)
wait_for_worker_readiness(rig.gateway, responses_group, 1, _PROXY_WORKERS)
yield MappingProxyType(
{
"openai": rig.openai,
"openai_responses": responses_group,
"anthropic": rig.anthropic,
"gemini": rig.gemini,
}
)
@_STREAMS
@pytest.mark.parametrize(
("family", "provider"), _BRIDGES, ids=tuple(f"{family.name}_to_{provider}" for family, provider in _BRIDGES)
)
def test_well_formed_tools_cross_the_bridge_to_another_provider(
rig: _Rig, bridge_groups: Mapping[str, str], family: _Family, provider: str, stream: bool
) -> None:
marker: Final = _marker()
response: Final = _send(rig, family, marker, stream, model=bridge_groups[provider], tools=[family.tool])
assert response.status_code == 200, response.text
assert _answer(_tag(marker)) in response.text, response.text
named_as, target = _PROVIDER_WIRES[_ROUTED_ELSEWHERE.get((family.name, provider), provider)]
assert _tool_names(named_as, _one_delivery(rig, marker, target(stream))) == ("get_weather",)