litellm/tests/unit/test_stream_chunk_builder_images.py
yuneng-jiang f6882246d4
test: move tests/test_litellm root and small trees into tests/unit (#43186)
* ci: run the unit_selection.sh shard files on every event instead of only fork pull requests

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>

* ci: rename fork-flag to unit-flag now that it applies on every event

* test: move tests/test_litellm root and small trees into tests/unit

Pure renames, no content changes. Follow-up commits in this PR fix
references, merge the three files that already existed in tests/unit,
keep live-provider tests in tests/test_litellm and wire CI.

* test: carry tests/test_litellm conftest isolation into tests/unit

Callback lists, routing fallbacks, cached HTTP clients, logger state, AWS,
proxy-URL and keychain env, and session-end client cleanup now reset for
unit tests too. The environment isolation owns its MonkeyPatch so a test's
own monkeypatch is undone before the model-cost teardown runs.

* test: merge, split and prune the moved root and small-tree tests

Merge batches/test_batch_utils.py and the chat_completions and messages
dispatch tests into the files that already existed in tests/unit. Keep
the live Gemini interactions tests, the async image-fetch format test and
the OpenAI embedding scorer test in tests/test_litellm since they need
real network or keys. Put test_router.py under tests/unit/test_router so
the existing package no longer shadows it. Delete eight tests the audit
found superseded by stronger ones kept in this move.

* ci: run the moved root and small-tree tests under their legacy flags

Add the misc and responses-caching-types flags to unit_selection.sh and
CircleCI, extend enterprise-routing and mcp-integration, and point the
legacy GHA shards, Makefile, redis-compat workflow, merge smoke manifest
and change classifier at the new paths.

* test: make the new tests/unit directories packages

tests/unit/test_package_layout.py requires every directory to carry an
__init__.py, and without one the moved and retained
test_litellm_responses_bridge.py modules collide on import.

* test: scope the unit socket block to tests/unit in shared sessions

The GHA shards collect the legacy test-path and the unit selection in one
pytest session. The unit conftest's loopback-only block leaked into legacy
modules that reach the network at import. The legacy conftest now lifts the
restriction at collect and setup time, and the unit conftest re-applies it
when collecting its own modules.

* test: give the shard-script tests their own GITHUB_OUTPUT

They only passed where the runner set it. The CircleCI unit job's env
allowlist drops it, so the script's redirect failed there.

* test: point the router and module-deletion checks at tests/unit

router_code_coverage and code_qa_check_tests only searched tests/test_litellm,
so the moved router tests no longer counted. The two silent-experiment tests
the audit deleted were the only direct callers of those methods; they are
replaced with tests that assert the forwarded shadow request and the
recursion guard.

---------

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2026-09-25 11:30:43 -07:00

251 lines
8.1 KiB
Python

"""
Test that stream_chunk_builder correctly preserves images from streaming chunks.
This tests the fix for https://github.com/BerriAI/litellm/issues/19478
where images from models like gemini-2.5-flash-image were lost when
rebuilding the response from streaming chunks.
"""
import pytest
import litellm
from litellm import stream_chunk_builder
def test_stream_chunk_builder_preserves_images():
"""
Test that stream_chunk_builder correctly preserves images from streaming chunks.
"""
# Simulate streaming chunks from an image generation model
init_chunks = [
{
"id": "chatcmpl-image-test",
"choices": [
{
"index": 0,
"delta": {
"role": "assistant",
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-image-test",
"choices": [
{
"index": 0,
"delta": {
"images": [
{
"image_url": {
"url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
"detail": "auto",
},
"index": 0,
"type": "image_url",
}
],
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-image-test",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
]
chunks = []
for chunk in init_chunks:
chunks.append(litellm.ModelResponseStream(**chunk))
response = stream_chunk_builder(chunks=chunks)
# Verify that images are preserved in the rebuilt response
assert (
response.choices[0].message.images is not None
), "Images should be preserved in stream_chunk_builder"
assert len(response.choices[0].message.images) == 1, "Should have exactly 1 image"
assert response.choices[0].message.images[0]["type"] == "image_url"
assert "base64" in response.choices[0].message.images[0]["image_url"]["url"]
def test_stream_chunk_builder_preserves_multiple_images():
"""
Test that stream_chunk_builder correctly preserves multiple images from different chunks.
"""
init_chunks = [
{
"id": "chatcmpl-multi-image-test",
"choices": [
{
"index": 0,
"delta": {
"role": "assistant",
"content": "Here are your images:",
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-multi-image-test",
"choices": [
{
"index": 0,
"delta": {
"images": [
{
"image_url": {
"url": "data:image/png;base64,image1data",
"detail": "auto",
},
"index": 0,
"type": "image_url",
}
],
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-multi-image-test",
"choices": [
{
"index": 0,
"delta": {
"images": [
{
"image_url": {
"url": "data:image/png;base64,image2data",
"detail": "auto",
},
"index": 1,
"type": "image_url",
}
],
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-multi-image-test",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
}
],
"created": 1737654321,
"model": "gemini/gemini-2.5-flash-image",
"object": "chat.completion.chunk",
},
]
chunks = []
for chunk in init_chunks:
chunks.append(litellm.ModelResponseStream(**chunk))
response = stream_chunk_builder(chunks=chunks)
# Verify content is preserved
assert response.choices[0].message.content == "Here are your images:"
# Verify all images are preserved
assert response.choices[0].message.images is not None, "Images should be preserved"
assert len(response.choices[0].message.images) == 2, "Should have exactly 2 images"
assert "image1data" in response.choices[0].message.images[0]["image_url"]["url"]
assert "image2data" in response.choices[0].message.images[1]["image_url"]["url"]
def test_stream_chunk_builder_no_images():
"""
Test that stream_chunk_builder works correctly when there are no images (regression test).
"""
init_chunks = [
{
"id": "chatcmpl-no-image-test",
"choices": [
{
"index": 0,
"delta": {
"role": "assistant",
"content": "Hello, ",
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gpt-4",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-no-image-test",
"choices": [
{
"index": 0,
"delta": {
"content": "world!",
},
"finish_reason": None,
}
],
"created": 1737654321,
"model": "gpt-4",
"object": "chat.completion.chunk",
},
{
"id": "chatcmpl-no-image-test",
"choices": [
{
"index": 0,
"delta": {},
"finish_reason": "stop",
}
],
"created": 1737654321,
"model": "gpt-4",
"object": "chat.completion.chunk",
},
]
chunks = []
for chunk in init_chunks:
chunks.append(litellm.ModelResponseStream(**chunk))
response = stream_chunk_builder(chunks=chunks)
# Verify content is preserved
assert response.choices[0].message.content == "Hello, world!"
# Verify images attribute doesn't exist or is None (no images in this stream)
images = getattr(response.choices[0].message, "images", None)
assert images is None, "Should not have images when none were in the stream"