mirror of
https://github.com/BerriAI/litellm.git
synced 2026-09-09 22:31:41 +00:00
Merge pull request #24741 from BerriAI/litellm_gha_p2
[Fix] Test Isolation and Path Resolution for GHA Unit Tests
This commit is contained in:
yuneng-jiang
GitHub
commit
666a31d47a
4 changed files with 105 additions and 7 deletions
67
.github/workflows/test-unit-documentation.yml
vendored
Normal file
67
.github/workflows/test-unit-documentation.yml
vendored
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
name: "Unit Tests: Documentation Validation"
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
documentation:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
|
||||
with:
|
||||
python-version: "3.12"
|
||||
|
||||
- name: Install Poetry
|
||||
run: pip install 'poetry==2.3.2'
|
||||
|
||||
- name: Cache Poetry dependencies
|
||||
uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
|
||||
with:
|
||||
path: |
|
||||
~/.cache/pypoetry
|
||||
~/.cache/pip
|
||||
.venv
|
||||
key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-poetry-
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
poetry config virtualenvs.in-project true
|
||||
poetry install --with dev,proxy-dev --extras "proxy semantic-router"
|
||||
poetry run pip install google-genai==1.22.0 \
|
||||
google-cloud-aiplatform==1.115.0 fastapi-offline==1.7.3 python-multipart==0.0.22 openapi-core==0.23.0
|
||||
|
||||
- name: Setup litellm-enterprise
|
||||
run: |
|
||||
poetry run pip install --force-reinstall --no-deps -e enterprise/
|
||||
|
||||
- name: Generate Prisma client
|
||||
env:
|
||||
PRISMA_BINARY_CACHE_DIR: ${{ runner.temp }}/prisma-cache
|
||||
run: |
|
||||
poetry run pip install nodejs-wheel-binaries==24.13.1
|
||||
poetry run prisma generate --schema litellm/proxy/schema.prisma
|
||||
|
||||
# Run the same documentation tests that CircleCI ran (as direct Python scripts)
|
||||
- name: Run documentation validation tests
|
||||
run: |
|
||||
poetry run python ./tests/documentation_tests/test_env_keys.py
|
||||
poetry run python ./tests/documentation_tests/test_router_settings.py
|
||||
poetry run python ./tests/documentation_tests/test_api_docs.py
|
||||
poetry run python ./tests/documentation_tests/test_circular_imports.py
|
||||
|
|
@ -279,6 +279,33 @@ router_settings:
|
|||
| forward_client_headers_to_llm_api | boolean | If true, forwards the client headers (any `x-` headers and `anthropic-beta` headers) to the backend LLM call |
|
||||
| maximum_spend_logs_retention_period | str | Used to set the max retention time for spend logs in the db, after which they will be auto-purged |
|
||||
| maximum_spend_logs_retention_interval | str | Used to set the interval in which the spend log cleanup task should run in. |
|
||||
| alert_type_config | dict | Configuration mapping alert types to their handler settings |
|
||||
| always_include_stream_usage | boolean | If true, includes usage metrics in every streaming response chunk |
|
||||
| auto_redirect_ui_login_to_sso | boolean | If true, automatically redirects UI login page to SSO provider |
|
||||
| control_plane_url | string | URL of the control plane for cross-instance state sharing |
|
||||
| custom_auth_run_common_checks | boolean | If true, runs standard auth validation checks alongside custom auth handlers |
|
||||
| custom_ui_sso_sign_in_handler | string | Custom handler for SSO sign-in logic in the UI |
|
||||
| database_connection_pool_timeout | integer | Database connection pool timeout in seconds |
|
||||
| disable_error_logs | boolean | If true, suppresses error tracking and storage in the database |
|
||||
| enable_health_check_routing | boolean | If true, enables health check-driven request routing to avoid unhealthy deployments |
|
||||
| enable_mcp_registry | boolean | If true, enables access to the centralized MCP server registry |
|
||||
| enforce_rbac | boolean | If true, enables role-based access control (RBAC) for all proxy operations |
|
||||
| forward_llm_provider_auth_headers | boolean | If true, forwards provider-specific auth headers to LLM API calls |
|
||||
| health_check_concurrency | integer | Maximum number of concurrent health check operations |
|
||||
| health_check_staleness_threshold | integer | Maximum age in seconds for health check results before marking deployments as stale |
|
||||
| maximum_spend_logs_cleanup_cron | string | Cron expression for scheduling automatic spend log cleanup tasks |
|
||||
| mcp_client_side_auth_header_name | string | HTTP header name for client-side MCP server credentials |
|
||||
| mcp_internal_ip_ranges | list | CIDR ranges considered internal for non-public MCP server access control |
|
||||
| mcp_required_fields | list | List of required field names for MCP server submissions |
|
||||
| mcp_trusted_proxy_ranges | list | CIDR ranges of proxies trusted to forward X-Forwarded-For headers for MCP |
|
||||
| require_end_user_mcp_access_defined | boolean | If true, requires end users to have explicit MCP access permissions defined |
|
||||
| role_permissions | list | List of role-based permission configurations |
|
||||
| search_tools | list | List of search tool configurations for enabling web search capabilities |
|
||||
| token_rate_limit_type | string | Rate limit counting method: "total", "output", or "input" tokens |
|
||||
| use_redis_transaction_buffer | boolean | If true, buffers database transactions in Redis before writing |
|
||||
| use_shared_health_check | boolean | If true, uses Redis-backed shared health check state across multiple proxy instances |
|
||||
| user_header_mappings | dict | Map custom request headers to user IDs using lookup rules |
|
||||
| user_header_name | string | HTTP header name to extract user identity from requests |
|
||||
|
||||
### router_settings - Reference
|
||||
|
||||
|
|
@ -367,6 +394,8 @@ router_settings:
|
|||
| ignore_invalid_deployments | boolean | If true, ignores invalid deployments. Default for proxy is True - to prevent invalid models from blocking other models from being loaded. |
|
||||
| search_tools | List[SearchToolTypedDict] | List of search tool configurations for Search API integration. Each tool specifies a search_tool_name and litellm_params with search_provider, api_key, api_base, etc. [Further Docs](../search/index.md) |
|
||||
| guardrail_list | List[GuardrailTypedDict] | List of guardrail configurations for guardrail load balancing. Enables load balancing across multiple guardrail deployments with the same guardrail_name. [Further Docs](./guardrails/guardrail_load_balancing.md) |
|
||||
| enable_health_check_routing | boolean | If true, enables health check-driven deployment filtering to avoid routing requests to unhealthy deployments |
|
||||
| health_check_staleness_threshold | integer | Maximum age in seconds for cached health check results before marking deployments as stale |
|
||||
|
||||
|
||||
### environment variables - Reference
|
||||
|
|
|
|||
|
|
@ -37,14 +37,12 @@ print(router_init_params)
|
|||
router_init_params.remove("model_list")
|
||||
|
||||
# Parse the documentation to extract documented keys
|
||||
repo_base = "./"
|
||||
print(os.listdir(repo_base))
|
||||
docs_path = (
|
||||
"./docs/my-website/docs/proxy/config_settings.md" # Path to the documentation
|
||||
_test_dir = os.path.dirname(os.path.abspath(__file__))
|
||||
_repo_root = os.path.abspath(os.path.join(_test_dir, "..", ".."))
|
||||
print(os.listdir(_repo_root))
|
||||
docs_path = os.path.join(
|
||||
_repo_root, "docs", "my-website", "docs", "proxy", "config_settings.md"
|
||||
)
|
||||
# docs_path = (
|
||||
# "../../docs/my-website/docs/proxy/config_settings.md" # Path to the documentation
|
||||
# )
|
||||
documented_keys = set()
|
||||
try:
|
||||
with open(docs_path, "r", encoding="utf-8") as docs_file:
|
||||
|
|
|
|||
|
|
@ -454,6 +454,10 @@ class TestAgentHealthCheck:
|
|||
self.admin_client = _make_app_with_role(LitellmUserRoles.PROXY_ADMIN)
|
||||
self.mock_registry = MagicMock()
|
||||
monkeypatch.setattr(ar_mod, "global_agent_registry", self.mock_registry)
|
||||
# Ensure prisma_client is None so the endpoint skips DB queries.
|
||||
# In CI with parallel workers, a MagicMock can leak from other test
|
||||
# scopes, causing "object MagicMock can't be used in 'await'" errors.
|
||||
monkeypatch.setattr("litellm.proxy.proxy_server.prisma_client", None)
|
||||
|
||||
def _make_agent(self, agent_id: str, url: str | None = None) -> AgentResponse:
|
||||
card = _sample_agent_card_params()
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue