litellm/tests/unit/images/test_image_generation_extra_headers.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

75 lines
2.6 KiB
Python

"""
Unit test for https://github.com/BerriAI/litellm/issues/22285
Verifies that extra_headers passed to image_generation() are forwarded
to the OpenAI SDK on the openai/litellm_proxy/openai_compatible_providers
code paths.
"""
from unittest.mock import MagicMock, patch
import pytest
import litellm
from litellm.images.main import image_generation
class TestImageGenerationExtraHeaders:
"""Test that extra_headers are forwarded on the OpenAI code path."""
@patch("litellm.images.main.openai_chat_completions")
def test_extra_headers_forwarded_to_openai_image_generation(
self, mock_openai_chat_completions
):
"""
extra_headers passed to image_generation() should appear in
optional_params["extra_headers"] when the provider is openai.
"""
mock_image_response = litellm.utils.ImageResponse(
created=1234567890,
data=[{"url": "https://example.com/image.png"}],
)
mock_openai_chat_completions.image_generation.return_value = mock_image_response
extra_headers = {"traceparent": "00-abc123-def456-01", "X-Custom": "value"}
image_generation(
model="openai/dall-e-3",
prompt="A red circle",
extra_headers=extra_headers,
)
mock_openai_chat_completions.image_generation.assert_called_once()
call_kwargs = mock_openai_chat_completions.image_generation.call_args
optional_params = call_kwargs.kwargs.get(
"optional_params", call_kwargs[1].get("optional_params", {})
)
assert "extra_headers" in optional_params
assert optional_params["extra_headers"] == extra_headers
@patch("litellm.images.main.openai_chat_completions")
def test_no_extra_headers_when_not_provided(self, mock_openai_chat_completions):
"""
When extra_headers is not passed, optional_params should not
contain extra_headers.
"""
mock_image_response = litellm.utils.ImageResponse(
created=1234567890,
data=[{"url": "https://example.com/image.png"}],
)
mock_openai_chat_completions.image_generation.return_value = mock_image_response
image_generation(
model="openai/dall-e-3",
prompt="A red circle",
)
mock_openai_chat_completions.image_generation.assert_called_once()
call_kwargs = mock_openai_chat_completions.image_generation.call_args
optional_params = call_kwargs.kwargs.get(
"optional_params", call_kwargs[1].get("optional_params", {})
)
assert "extra_headers" not in optional_params