|
| 1 | +"""Tests for the OpenAI custom base URL settings write path. |
| 2 | +
|
| 3 | +Regression coverage: SettingsUpdateBody.openai_base_url and |
| 4 | +OnboardingBody.openai_base_url were accepted by the API but never written |
| 5 | +onto current_config.providers.openai.base_url — a client POSTing |
| 6 | +openai_base_url got a silent no-op. See src/api/settings/endpoints.py. |
| 7 | +""" |
| 8 | + |
| 9 | +from unittest.mock import AsyncMock |
| 10 | + |
| 11 | +import pytest |
| 12 | + |
| 13 | +import api.settings.endpoints as settings_api |
| 14 | +from config.config_manager import ( |
| 15 | + AgentConfig, |
| 16 | + AnthropicConfig, |
| 17 | + KnowledgeConfig, |
| 18 | + OllamaConfig, |
| 19 | + OnboardingState, |
| 20 | + OpenAIConfig, |
| 21 | + OpenRAGConfig, |
| 22 | + ProvidersConfig, |
| 23 | + WatsonXConfig, |
| 24 | +) |
| 25 | + |
| 26 | + |
| 27 | +class _FakeTask: |
| 28 | + def __init__(self): |
| 29 | + self.done_callback = None |
| 30 | + |
| 31 | + def add_done_callback(self, cb): |
| 32 | + self.done_callback = cb |
| 33 | + |
| 34 | + |
| 35 | +def _make_config(*, edited: bool = True) -> OpenRAGConfig: |
| 36 | + return OpenRAGConfig( |
| 37 | + providers=ProvidersConfig( |
| 38 | + openai=OpenAIConfig(), |
| 39 | + anthropic=AnthropicConfig(), |
| 40 | + watsonx=WatsonXConfig(), |
| 41 | + ollama=OllamaConfig(), |
| 42 | + ), |
| 43 | + knowledge=KnowledgeConfig(), |
| 44 | + agent=AgentConfig(), |
| 45 | + onboarding=OnboardingState(), |
| 46 | + edited=edited, |
| 47 | + ) |
| 48 | + |
| 49 | + |
| 50 | +def _patch_update_settings_deps(monkeypatch, config): |
| 51 | + """Mirrors the mocking pattern used in test_settings_async_post_save.py.""" |
| 52 | + fake_task = _FakeTask() |
| 53 | + |
| 54 | + async def _noop_refresh(): |
| 55 | + return None |
| 56 | + |
| 57 | + def _fake_create_task(coro): |
| 58 | + # We only care about the config write in these tests, not the |
| 59 | + # background Langflow sync that provider changes normally schedule. |
| 60 | + coro.close() |
| 61 | + return fake_task |
| 62 | + |
| 63 | + monkeypatch.setattr(settings_api, "get_openrag_config", lambda: config, raising=True) |
| 64 | + monkeypatch.setattr( |
| 65 | + settings_api.config_manager, |
| 66 | + "save_config_file", |
| 67 | + lambda updated_config: True, |
| 68 | + raising=True, |
| 69 | + ) |
| 70 | + monkeypatch.setattr( |
| 71 | + settings_api.clients, "refresh_patched_client", _noop_refresh, raising=True |
| 72 | + ) |
| 73 | + monkeypatch.setattr(settings_api.TelemetryClient, "send_event", AsyncMock(), raising=True) |
| 74 | + monkeypatch.setattr(settings_api.asyncio, "create_task", _fake_create_task, raising=True) |
| 75 | + return fake_task |
| 76 | + |
| 77 | + |
| 78 | +@pytest.mark.asyncio |
| 79 | +async def test_update_settings_persists_openai_base_url(monkeypatch): |
| 80 | + settings_api._background_tasks.clear() |
| 81 | + config = _make_config() |
| 82 | + _patch_update_settings_deps(monkeypatch, config) |
| 83 | + |
| 84 | + response = await settings_api.update_settings( |
| 85 | + settings_api.SettingsUpdateBody(openai_base_url="https://gateway.example.com/v1"), |
| 86 | + session_manager=object(), |
| 87 | + user=None, |
| 88 | + ) |
| 89 | + |
| 90 | + assert isinstance(response, settings_api.SettingsUpdateResponse) |
| 91 | + assert config.providers.openai.base_url == "https://gateway.example.com/v1" |
| 92 | + # An optional base_url override should not, by itself, mark OpenAI as |
| 93 | + # "configured" the way an api_key does. |
| 94 | + assert config.providers.openai.configured is False |
| 95 | + |
| 96 | + |
| 97 | +@pytest.mark.asyncio |
| 98 | +async def test_update_settings_strips_openai_base_url_whitespace(monkeypatch): |
| 99 | + settings_api._background_tasks.clear() |
| 100 | + config = _make_config() |
| 101 | + _patch_update_settings_deps(monkeypatch, config) |
| 102 | + |
| 103 | + await settings_api.update_settings( |
| 104 | + settings_api.SettingsUpdateBody(openai_base_url=" https://gateway.example.com/v1 "), |
| 105 | + session_manager=object(), |
| 106 | + user=None, |
| 107 | + ) |
| 108 | + |
| 109 | + assert config.providers.openai.base_url == "https://gateway.example.com/v1" |
| 110 | + |
| 111 | + |
| 112 | +@pytest.mark.asyncio |
| 113 | +async def test_onboarding_persists_openai_base_url(monkeypatch): |
| 114 | + config = _make_config(edited=False) |
| 115 | + |
| 116 | + async def _noop_refresh(): |
| 117 | + return None |
| 118 | + |
| 119 | + monkeypatch.setattr(settings_api, "get_openrag_config", lambda: config, raising=True) |
| 120 | + monkeypatch.setattr( |
| 121 | + settings_api.config_manager, |
| 122 | + "save_config_file", |
| 123 | + lambda updated_config: True, |
| 124 | + raising=True, |
| 125 | + ) |
| 126 | + monkeypatch.setattr( |
| 127 | + settings_api.clients, "refresh_patched_client", _noop_refresh, raising=True |
| 128 | + ) |
| 129 | + monkeypatch.setattr(settings_api.TelemetryClient, "send_event", AsyncMock(), raising=True) |
| 130 | + monkeypatch.setattr(settings_api, "wait_for_langflow", AsyncMock(), raising=True) |
| 131 | + |
| 132 | + response = await settings_api.onboarding( |
| 133 | + settings_api.OnboardingBody(openai_base_url="https://gateway.example.com/v1"), |
| 134 | + flows_service=None, |
| 135 | + session_manager=object(), |
| 136 | + document_service=None, |
| 137 | + models_service=None, |
| 138 | + task_service=None, |
| 139 | + langflow_file_service=None, |
| 140 | + knowledge_filter_service=None, |
| 141 | + user=None, |
| 142 | + ) |
| 143 | + |
| 144 | + assert isinstance(response, settings_api.OnboardingResponse) |
| 145 | + assert config.providers.openai.base_url == "https://gateway.example.com/v1" |
| 146 | + assert config.providers.openai.configured is False |
0 commit comments