feature: add Azure Identity for Azure OpenAI and Azure AI Search authentication (#3262)

2025-08-21 02:00:27 +05:30
parent e4c5582808
commit 4487785cec
12 changed files with 686 additions and 15 deletions
@@ -124,7 +124,135 @@ def test_generate_with_http_proxies(default_headers):
            http_client=mock_http_client_instance,
            azure_deployment=None,
            azure_endpoint=None,
+            azure_ad_token_provider=None,
            api_version=None,
            default_headers=default_headers,
        )
        mock_http_client.assert_called_once_with(proxies="http://testproxy.mem0.net:8000")
+
+
+def test_init_with_api_key(monkeypatch):
+    # Patch environment variables to None to force config usage
+    monkeypatch.delenv("LLM_AZURE_OPENAI_API_KEY", raising=False)
+    monkeypatch.delenv("LLM_AZURE_DEPLOYMENT", raising=False)
+    monkeypatch.delenv("LLM_AZURE_ENDPOINT", raising=False)
+    monkeypatch.delenv("LLM_AZURE_API_VERSION", raising=False)
+
+    config = AzureOpenAIConfig(
+        model=MODEL,
+        temperature=TEMPERATURE,
+        max_tokens=MAX_TOKENS,
+        top_p=TOP_P,
+    )
+    # Set Azure kwargs directly
+    config.azure_kwargs.api_key = "test-key"
+    config.azure_kwargs.azure_deployment = "test-deployment"
+    config.azure_kwargs.azure_endpoint = "https://test-endpoint"
+    config.azure_kwargs.api_version = "2024-01-01"
+    config.azure_kwargs.default_headers = {"x-test": "header"}
+    config.http_client = None
+
+    with patch("mem0.llms.azure_openai.AzureOpenAI") as mock_azure_openai:
+        llm = AzureOpenAILLM(config)
+        mock_azure_openai.assert_called_once_with(
+            azure_deployment="test-deployment",
+            azure_endpoint="https://test-endpoint",
+            azure_ad_token_provider=None,
+            api_version="2024-01-01",
+            api_key="test-key",
+            http_client=None,
+            default_headers={"x-test": "header"},
+        )
+        assert llm.config.model == MODEL
+
+
+def test_init_with_env_vars(monkeypatch):
+    monkeypatch.setenv("LLM_AZURE_OPENAI_API_KEY", "env-key")
+    monkeypatch.setenv("LLM_AZURE_DEPLOYMENT", "env-deployment")
+    monkeypatch.setenv("LLM_AZURE_ENDPOINT", "https://env-endpoint")
+    monkeypatch.setenv("LLM_AZURE_API_VERSION", "2024-02-02")
+
+    config = AzureOpenAIConfig(model=None)
+    config.azure_kwargs.api_key = None
+    config.azure_kwargs.azure_deployment = None
+    config.azure_kwargs.azure_endpoint = None
+    config.azure_kwargs.api_version = None
+    config.azure_kwargs.default_headers = None
+    config.http_client = None
+
+    with patch("mem0.llms.azure_openai.AzureOpenAI") as mock_azure_openai:
+        llm = AzureOpenAILLM(config)
+        mock_azure_openai.assert_called_once_with(
+            azure_deployment="env-deployment",
+            azure_endpoint="https://env-endpoint",
+            azure_ad_token_provider=None,
+            api_version="2024-02-02",
+            api_key="env-key",
+            http_client=None,
+            default_headers=None,
+        )
+        # Should default to "gpt-4o" if model is None
+        assert llm.config.model == "gpt-4o"
+
+
+def test_init_with_default_azure_credential(monkeypatch):
+    # No API key in config or env, triggers DefaultAzureCredential
+    monkeypatch.delenv("LLM_AZURE_OPENAI_API_KEY", raising=False)
+    config = AzureOpenAIConfig(model=MODEL)
+    config.azure_kwargs.api_key = None
+    config.azure_kwargs.azure_deployment = "dep"
+    config.azure_kwargs.azure_endpoint = "https://endpoint"
+    config.azure_kwargs.api_version = "2024-03-03"
+    config.azure_kwargs.default_headers = None
+    config.http_client = None
+
+    with (
+        patch("mem0.llms.azure_openai.DefaultAzureCredential") as mock_cred,
+        patch("mem0.llms.azure_openai.get_bearer_token_provider") as mock_token_provider,
+        patch("mem0.llms.azure_openai.AzureOpenAI") as mock_azure_openai,
+    ):
+        mock_cred_instance = mock_cred.return_value
+        mock_token_provider.return_value = "token-provider"
+        AzureOpenAILLM(config)
+        mock_cred.assert_called_once()
+        mock_token_provider.assert_called_once_with(mock_cred_instance, "https://cognitiveservices.azure.com/.default")
+        mock_azure_openai.assert_called_once_with(
+            azure_deployment="dep",
+            azure_endpoint="https://endpoint",
+            azure_ad_token_provider="token-provider",
+            api_version="2024-03-03",
+            api_key=None,
+            http_client=None,
+            default_headers=None,
+        )
+
+
+def test_init_with_placeholder_api_key(monkeypatch):
+    # Placeholder API key should trigger DefaultAzureCredential
+    config = AzureOpenAIConfig(model=MODEL)
+    config.azure_kwargs.api_key = "your-api-key"
+    config.azure_kwargs.azure_deployment = "dep"
+    config.azure_kwargs.azure_endpoint = "https://endpoint"
+    config.azure_kwargs.api_version = "2024-04-04"
+    config.azure_kwargs.default_headers = None
+    config.http_client = None
+
+    with (
+        patch("mem0.llms.azure_openai.DefaultAzureCredential") as mock_cred,
+        patch("mem0.llms.azure_openai.get_bearer_token_provider") as mock_token_provider,
+        patch("mem0.llms.azure_openai.AzureOpenAI") as mock_azure_openai,
+    ):
+        mock_cred_instance = mock_cred.return_value
+        mock_token_provider.return_value = "token-provider"
+        AzureOpenAILLM(config)
+        mock_cred.assert_called_once()
+        mock_token_provider.assert_called_once_with(mock_cred_instance, "https://cognitiveservices.azure.com/.default")
+        mock_azure_openai.assert_called_once_with(
+            azure_deployment="dep",
+            azure_endpoint="https://endpoint",
+            azure_ad_token_provider="token-provider",
+            api_version="2024-04-04",
+            api_key=None,
+            http_client=None,
+            default_headers=None,
+        )
@@ -0,0 +1,100 @@
+from unittest import mock
+
+from mem0.llms.azure_openai_structured import SCOPE, AzureOpenAIStructuredLLM
+
+
+class DummyAzureKwargs:
+    def __init__(
+        self,
+        api_key=None,
+        azure_deployment="test-deployment",
+        azure_endpoint="https://test-endpoint.openai.azure.com",
+        api_version="2024-06-01-preview",
+        default_headers=None,
+    ):
+        self.api_key = api_key
+        self.azure_deployment = azure_deployment
+        self.azure_endpoint = azure_endpoint
+        self.api_version = api_version
+        self.default_headers = default_headers
+
+
+class DummyConfig:
+    def __init__(
+        self,
+        model=None,
+        azure_kwargs=None,
+        temperature=0.7,
+        max_tokens=256,
+        top_p=1.0,
+        http_client=None,
+    ):
+        self.model = model
+        self.azure_kwargs = azure_kwargs or DummyAzureKwargs()
+        self.temperature = temperature
+        self.max_tokens = max_tokens
+        self.top_p = top_p
+        self.http_client = http_client
+
+
+@mock.patch("mem0.llms.azure_openai_structured.AzureOpenAI")
+def test_init_with_api_key(mock_azure_openai):
+    config = DummyConfig(model="test-model", azure_kwargs=DummyAzureKwargs(api_key="real-key"))
+    llm = AzureOpenAIStructuredLLM(config)
+    assert llm.config.model == "test-model"
+    mock_azure_openai.assert_called_once()
+    args, kwargs = mock_azure_openai.call_args
+    assert kwargs["api_key"] == "real-key"
+    assert kwargs["azure_ad_token_provider"] is None
+
+
+@mock.patch("mem0.llms.azure_openai_structured.AzureOpenAI")
+@mock.patch("mem0.llms.azure_openai_structured.get_bearer_token_provider")
+@mock.patch("mem0.llms.azure_openai_structured.DefaultAzureCredential")
+def test_init_with_default_credential(mock_credential, mock_token_provider, mock_azure_openai):
+    config = DummyConfig(model=None, azure_kwargs=DummyAzureKwargs(api_key=None))
+    mock_token_provider.return_value = "token-provider"
+    llm = AzureOpenAIStructuredLLM(config)
+    # Should set default model if not provided
+    assert llm.config.model == "gpt-4o-2024-08-06"
+    mock_credential.assert_called_once()
+    mock_token_provider.assert_called_once_with(mock_credential.return_value, SCOPE)
+    mock_azure_openai.assert_called_once()
+    args, kwargs = mock_azure_openai.call_args
+    assert kwargs["api_key"] is None
+    assert kwargs["azure_ad_token_provider"] == "token-provider"
+
+
+def test_init_with_env_vars(monkeypatch, mocker):
+    mock_azure_openai = mocker.patch("mem0.llms.azure_openai_structured.AzureOpenAI")
+    monkeypatch.setenv("LLM_AZURE_DEPLOYMENT", "test-deployment")
+    monkeypatch.setenv("LLM_AZURE_ENDPOINT", "https://test-endpoint.openai.azure.com")
+    monkeypatch.setenv("LLM_AZURE_API_VERSION", "2024-06-01-preview")
+    config = DummyConfig(model="test-model", azure_kwargs=DummyAzureKwargs(api_key=None))
+    AzureOpenAIStructuredLLM(config)
+    mock_azure_openai.assert_called_once()
+    args, kwargs = mock_azure_openai.call_args
+    assert kwargs["api_key"] is None
+    assert kwargs["azure_deployment"] == "test-deployment"
+    assert kwargs["azure_endpoint"] == "https://test-endpoint.openai.azure.com"
+    assert kwargs["api_version"] == "2024-06-01-preview"
+
+
+@mock.patch("mem0.llms.azure_openai_structured.AzureOpenAI")
+def test_init_with_placeholder_api_key_uses_default_credential(
+    mock_azure_openai,
+):
+    with (
+        mock.patch("mem0.llms.azure_openai_structured.DefaultAzureCredential") as mock_credential,
+        mock.patch("mem0.llms.azure_openai_structured.get_bearer_token_provider") as mock_token_provider,
+    ):
+        config = DummyConfig(model=None, azure_kwargs=DummyAzureKwargs(api_key="your-api-key"))
+        mock_token_provider.return_value = "token-provider"
+        llm = AzureOpenAIStructuredLLM(config)
+        assert llm.config.model == "gpt-4o-2024-08-06"
+        mock_credential.assert_called_once()
+        mock_token_provider.assert_called_once_with(mock_credential.return_value, SCOPE)
+        mock_azure_openai.assert_called_once()
+        args, kwargs = mock_azure_openai.call_args
+        assert kwargs["api_key"] is None
+        assert kwargs["azure_ad_token_provider"] == "token-provider"