"""Tests for app/api/openai.py module.""" from unittest.mock import MagicMock, patch import pytest @pytest.mark.integration class TestOpenAIEndpoints: """Tests for OpenAI API endpoints.""" def test_test_openai_connection(self, client): """Test the OpenAI connection test endpoint.""" response = client.get("/api/openai/test") assert response.status_code == 200 data = response.json() assert "status" in data def test_openai_test_returns_status(self, client): """Test that OpenAI test returns appropriate status.""" response = client.get("/api/openai/test") data = response.json() # Should be success or error depending on API key validity assert data["status"] in ("success", "error") @pytest.mark.unit class TestOpenAIConnectionErrors: """Test error handling in OpenAI connection test.""" @patch("app.api.openai.settings") def test_openai_no_api_key_configured(self, mock_settings, client): """Test OpenAI test endpoint when no API key is configured.""" mock_settings.openai_api_key = None response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert "openai" in data["message"].lower() and "configured" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_key_validation_success(self, mock_settings, mock_openai_class, client): """Test OpenAI API key validation success.""" mock_settings.openai_api_key = "sk-test-key" mock_settings.openai_base_url = "https://api.openai.com/v1" mock_client = MagicMock() mock_models = MagicMock() mock_models.data = [{"id": "gpt-4"}, {"id": "gpt-3.5-turbo"}] mock_client.models.list.return_value = mock_models mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "success" assert "valid" in data["message"].lower() assert data["models_available"] == 2 @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_uses_configured_base_url(self, mock_settings, mock_openai_class, client): """Test that the client is created with the configured base_url from settings. Regression test: previously the endpoint created openai.OpenAI without base_url, causing the OpenAI library to read the raw OPENAI_BASE_URL env var which may contain literal quote characters (e.g. in Kubernetes). Those quotes are URL-encoded by httpx to %22 and produce an UnsupportedProtocol error. """ mock_settings.openai_api_key = "sk-test-key" mock_settings.openai_base_url = "http://litellm.example.com/v1" mock_client = MagicMock() mock_models = MagicMock() mock_models.data = [] mock_client.models.list.return_value = mock_models mock_openai_class.return_value = mock_client client.get("/api/openai/test") # The OpenAI client must be constructed with the configured base_url so # that Settings' strip_outer_quotes sanitisation takes effect. mock_openai_class.assert_called_once_with( api_key="sk-test-key", base_url="http://litellm.example.com/v1", ) @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_key_validation_auth_error(self, mock_settings, mock_openai_class, client): """Test OpenAI API key validation with auth error.""" import openai as openai_module mock_settings.openai_api_key = "sk-invalid-key" mock_client = MagicMock() auth_exc = openai_module.AuthenticationError( message="Incorrect API key provided", response=MagicMock(status_code=401, headers={}), body={"error": {"message": "Incorrect API key provided"}}, ) mock_client.models.list.side_effect = auth_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("is_auth_error") is True assert data.get("error_type") == "authentication_error" @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_key_validation_network_error(self, mock_settings, mock_openai_class, client): """Test OpenAI API key validation with network/connection error.""" import openai as openai_module mock_settings.openai_api_key = "sk-test-key" mock_client = MagicMock() conn_exc = openai_module.APIConnectionError(request=MagicMock()) mock_client.models.list.side_effect = conn_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("is_auth_error") is False assert data.get("error_type") == "connection_error" assert "connection error" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_connection_error_with_dns_cause(self, mock_settings, mock_openai_class, client): """Test that DNS resolution failures are surfaced in the connection error message.""" import openai as openai_module mock_settings.openai_api_key = "sk-test-key" dns_err = OSError("[Errno -2] Name or service not known") conn_exc = openai_module.APIConnectionError(request=MagicMock()) conn_exc.__cause__ = dns_err mock_client = MagicMock() mock_client.models.list.side_effect = conn_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("error_type") == "connection_error" # The DNS detail should be propagated to the message assert "name or service not known" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_timeout_error(self, mock_settings, mock_openai_class, client): """Test OpenAI API key validation with timeout error.""" import openai as openai_module mock_settings.openai_api_key = "sk-test-key" mock_client = MagicMock() timeout_exc = openai_module.APITimeoutError(request=MagicMock()) mock_client.models.list.side_effect = timeout_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("is_auth_error") is False assert data.get("error_type") == "timeout" assert "timed out" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_status_error(self, mock_settings, mock_openai_class, client): """Test OpenAI API returning an unexpected HTTP status code.""" import openai as openai_module mock_settings.openai_api_key = "sk-test-key" mock_response = MagicMock() mock_response.status_code = 500 mock_response.headers = {"x-request-id": "test-req-id"} status_exc = openai_module.InternalServerError( message="Internal Server Error", response=mock_response, body={"error": {"message": "Internal Server Error"}}, ) mock_client = MagicMock() mock_client.models.list.side_effect = status_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("error_type") == "api_status_error" assert data.get("http_status") == 500 @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_api_rate_limit_error(self, mock_settings, mock_openai_class, client): """Test OpenAI API returning a rate-limit error.""" import openai as openai_module mock_settings.openai_api_key = "sk-test-key" mock_response = MagicMock() mock_response.status_code = 429 mock_response.headers = {} rate_exc = openai_module.RateLimitError( message="Rate limit exceeded", response=mock_response, body={"error": {"message": "Rate limit exceeded"}}, ) mock_client = MagicMock() mock_client.models.list.side_effect = rate_exc mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("error_type") == "rate_limit" assert data.get("is_auth_error") is False @patch("app.api.openai.settings") def test_openai_import_error(self, mock_settings, client): """Test handling when openai package is not installed.""" mock_settings.openai_api_key = "sk-test-key" # Mock ImportError by patching the import at module level with patch.dict("sys.modules", {"openai": None}): response = client.get("/api/openai/test") # The endpoint should still respond, even if openai is missing assert response.status_code == 200 data = response.json() assert data["status"] == "error" assert "openai package" in data["message"].lower() or "not installed" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_models_without_data_attribute(self, mock_settings, mock_openai_class, client): """Test OpenAI API when models response doesn't have data attribute.""" mock_settings.openai_api_key = "sk-test-key" mock_client = MagicMock() mock_models = MagicMock(spec=[]) # No data attribute del mock_models.data # Ensure data attribute doesn't exist mock_client.models.list.return_value = mock_models mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "success" assert data["models_available"] == "Unknown" @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_unexpected_exception(self, mock_settings, mock_openai_class, client): """Test handling of unexpected exceptions.""" mock_settings.openai_api_key = "sk-test-key" # Raise an unexpected exception during OpenAI client creation mock_openai_class.side_effect = RuntimeError("Unexpected error") response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert "unexpected error" in data["message"].lower() @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_generic_error_still_detects_auth(self, mock_settings, mock_openai_class, client): """Test that generic exception fallback still detects auth-related errors.""" mock_settings.openai_api_key = "sk-test-key" mock_client = MagicMock() mock_client.models.list.side_effect = Exception("Incorrect API key provided") mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("is_auth_error") is True @patch("openai.OpenAI") @patch("app.api.openai.settings") def test_openai_generic_network_error_not_auth(self, mock_settings, mock_openai_class, client): """Test that generic network errors are not flagged as auth errors.""" mock_settings.openai_api_key = "sk-test-key" mock_client = MagicMock() mock_client.models.list.side_effect = Exception("Network timeout") mock_openai_class.return_value = mock_client response = client.get("/api/openai/test") data = response.json() assert data["status"] == "error" assert data.get("is_auth_error") is False