test: added testcase related to azure credential utils

Author: Avijit-Microsoft

src/backend/helper/azure_credential_utils.py

@@ -14,7 +14,6 @@ async def get_azure_credential_async(client_id=None):
     Returns:
         Credential object: Either AioDefaultAzureCredential or AioManagedIdentityCredential.
     """
-    print(os.getenv("APP_ENV"))
     if os.getenv("APP_ENV", "prod").lower() == 'dev':
         return AioDefaultAzureCredential()  # CodeQL [SM05139] Okay use of DefaultAzureCredential as it is only used in development
     else:

src/tests/backend/helper/azure_credential_utils_test.py

@@ -0,0 +1,91 @@
+import os
+from unittest.mock import MagicMock, patch
+
+import helper.azure_credential_utils as azure_credential_utils
+
+import pytest
+
+
+@pytest.fixture
+def mock_env_vars():
+    return {
+        "APP_ENV": "dev"
+    }
+
+
+class TestAzureCredentialUtils:
+    @patch.dict(os.environ, {}, clear=True)
+    @patch("helper.azure_credential_utils.DefaultAzureCredential")
+    @patch("helper.azure_credential_utils.ManagedIdentityCredential")
+    def test_get_azure_credential_dev_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_env_vars):
+        """Test get_azure_credential in dev environment."""
+        # Arrange
+        os.environ.update(mock_env_vars)
+        mock_default_credential = MagicMock()
+        mock_default_azure_credential.return_value = mock_default_credential
+
+        # Act
+        credential = azure_credential_utils.get_azure_credential()
+
+        # Assert
+        mock_default_azure_credential.assert_called_once()
+        mock_managed_identity_credential.assert_not_called()
+        assert credential == mock_default_credential
+
+    @patch.dict(os.environ, {}, clear=True)
+    @patch("helper.azure_credential_utils.DefaultAzureCredential")
+    @patch("helper.azure_credential_utils.ManagedIdentityCredential")
+    def test_get_azure_credential_non_dev_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_env_vars):
+        """Test get_azure_credential in non-dev environment."""
+        # Arrange
+        mock_env_vars["APP_ENV"] = "prod"
+        os.environ.update(mock_env_vars)
+        mock_managed_credential = MagicMock()
+        mock_managed_identity_credential.return_value = mock_managed_credential
+
+        # Act
+        credential = azure_credential_utils.get_azure_credential(client_id="test-client-id")
+
+        # Assert
+        mock_managed_identity_credential.assert_called_once_with(client_id="test-client-id")
+        mock_default_azure_credential.assert_not_called()
+        assert credential == mock_managed_credential
+
+    @pytest.mark.asyncio
+    @patch.dict(os.environ, {}, clear=True)
+    @patch("helper.azure_credential_utils.AioDefaultAzureCredential")
+    @patch("helper.azure_credential_utils.AioManagedIdentityCredential")
+    async def test_get_azure_credential_async_dev_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_env_vars):
+        """Test get_azure_credential_async in dev environment."""
+        # Arrange
+        os.environ.update(mock_env_vars)
+        mock_aio_default_credential = MagicMock()
+        mock_aio_default_azure_credential.return_value = mock_aio_default_credential
+
+        # Act
+        credential = await azure_credential_utils.get_azure_credential_async()
+
+        # Assert
+        mock_aio_default_azure_credential.assert_called_once()
+        mock_aio_managed_identity_credential.assert_not_called()
+        assert credential == mock_aio_default_credential
+
+    @pytest.mark.asyncio
+    @patch.dict(os.environ, {}, clear=True)
+    @patch("helper.azure_credential_utils.AioDefaultAzureCredential")
+    @patch("helper.azure_credential_utils.AioManagedIdentityCredential")
+    async def test_get_azure_credential_async_non_dev_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_env_vars):
+        """Test get_azure_credential_async in non-dev environment."""
+        # Arrange
+        mock_env_vars["APP_ENV"] = "prod"
+        os.environ.update(mock_env_vars)
+        mock_aio_managed_credential = MagicMock()
+        mock_aio_managed_identity_credential.return_value = mock_aio_managed_credential
+
+        # Act
+        credential = await azure_credential_utils.get_azure_credential_async(client_id="test-client-id")
+
+        # Assert
+        mock_aio_managed_identity_credential.assert_called_once_with(client_id="test-client-id")
+        mock_aio_default_azure_credential.assert_not_called()
+        assert credential == mock_aio_managed_credential