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

131 lines
5.1 KiB
Python

"""
Tests for project_alias and project_id tracking through callback kwargs / metadata.
Verifies that project_alias flows from UserAPIKeyAuth through the metadata pipeline
to StandardLoggingMetadata, mirroring how team_alias already works.
"""
import pytest
from litellm.litellm_core_utils.litellm_logging import StandardLoggingPayloadSetup
from litellm.proxy._types import LiteLLM_VerificationTokenView, UserAPIKeyAuth
from litellm.proxy.litellm_pre_call_utils import LiteLLMProxyRequestSetup
from litellm.types.utils import StandardLoggingUserAPIKeyMetadata
class TestProjectAliasOnTypes:
"""project_alias field exists on the relevant types."""
def test_verification_token_view_has_project_alias(self):
token_view = LiteLLM_VerificationTokenView(
token="test-token",
project_id="proj-123",
project_alias="My Project",
)
assert token_view.project_alias == "My Project"
def test_verification_token_view_project_alias_defaults_none(self):
token_view = LiteLLM_VerificationTokenView(token="test-token")
assert token_view.project_alias is None
def test_user_api_key_auth_inherits_project_alias(self):
"""UserAPIKeyAuth extends LiteLLM_VerificationTokenView, so it gets project_alias."""
auth = UserAPIKeyAuth(
api_key="sk-test",
project_id="proj-1",
project_alias="billing-service",
)
assert auth.project_alias == "billing-service"
def test_standard_logging_metadata_has_project_alias_field(self):
metadata = StandardLoggingUserAPIKeyMetadata(
user_api_key_hash="hash",
user_api_key_alias=None,
user_api_key_spend=None,
user_api_key_max_budget=None,
user_api_key_budget_reset_at=None,
user_api_key_org_id=None,
user_api_key_team_id=None,
user_api_key_project_id="proj-1",
user_api_key_project_alias="billing-service",
user_api_key_user_id=None,
user_api_key_user_email=None,
user_api_key_team_alias=None,
user_api_key_end_user_id=None,
user_api_key_request_route=None,
user_api_key_auth_metadata=None,
)
assert metadata["user_api_key_project_alias"] == "billing-service"
class TestProjectAliasThroughMetadataPipeline:
"""project_alias flows through the full metadata pipeline."""
def test_get_sanitized_user_information_includes_project_alias(self):
user_api_key_dict = UserAPIKeyAuth(
api_key="sk-hashed",
project_id="proj-123",
project_alias="My Cool Project",
team_id="team-1",
team_alias="my-team",
)
result = LiteLLMProxyRequestSetup.get_sanitized_user_information_from_key(
user_api_key_dict=user_api_key_dict
)
assert result["user_api_key_project_id"] == "proj-123"
assert result["user_api_key_project_alias"] == "My Cool Project"
def test_get_sanitized_user_information_project_alias_none_when_no_project(self):
user_api_key_dict = UserAPIKeyAuth(api_key="sk-hashed")
result = LiteLLMProxyRequestSetup.get_sanitized_user_information_from_key(
user_api_key_dict=user_api_key_dict
)
assert result["user_api_key_project_id"] is None
assert result["user_api_key_project_alias"] is None
def test_project_alias_flows_to_standard_logging_metadata(self):
"""get_standard_logging_metadata picks up project_alias from input metadata."""
metadata = {
"user_api_key_project_id": "proj-123",
"user_api_key_project_alias": "My Cool Project",
"user_api_key_team_id": "team-1",
"user_api_key_team_alias": "my-team",
}
result = StandardLoggingPayloadSetup.get_standard_logging_metadata(metadata)
assert result["user_api_key_project_alias"] == "My Cool Project"
def test_project_alias_defaults_to_none_in_logging_metadata(self):
result = StandardLoggingPayloadSetup.get_standard_logging_metadata({})
assert result["user_api_key_project_alias"] is None
def test_end_to_end_project_alias_flow(self):
"""Full flow: UserAPIKeyAuth -> get_sanitized -> get_standard_logging_metadata."""
auth = UserAPIKeyAuth(
api_key="sk-test",
project_id="proj-abc",
project_alias="analytics-pipeline",
team_id="team-1",
team_alias="data-team",
)
# Step 1: Auth → sanitized metadata
sanitized = LiteLLMProxyRequestSetup.get_sanitized_user_information_from_key(
user_api_key_dict=auth
)
# Step 2: Sanitized metadata → standard logging metadata
logging_metadata = StandardLoggingPayloadSetup.get_standard_logging_metadata(
dict(sanitized)
)
assert logging_metadata["user_api_key_project_id"] == "proj-abc"
assert logging_metadata["user_api_key_project_alias"] == "analytics-pipeline"
assert logging_metadata["user_api_key_team_id"] == "team-1"
assert logging_metadata["user_api_key_team_alias"] == "data-team"