rename env name from local to dev

Author: Pavan-Microsoft

infra/scripts/index_scripts/azure_credential_utils.py

@@ -1,6 +1,6 @@
 from azure.identity import ManagedIdentityCredential, DefaultAzureCredential
 
-APP_ENV = 'prod'  # Change to 'local' for local development
+APP_ENV = 'prod'  # Change to 'dev' for local development
 
 def get_azure_credential(client_id=None):
     """
@@ -16,7 +16,7 @@ def get_azure_credential(client_id=None):
         azure.identity.DefaultAzureCredential or azure.identity.ManagedIdentityCredential: 
         The Azure credential object.
     """
-    if APP_ENV == 'local':
+    if APP_ENV == 'dev':
         return DefaultAzureCredential() # CodeQL [SM05139] Okay use of DefaultAzureCredential as it is only used in development
     else:
         return ManagedIdentityCredential(client_id=client_id)

src/api/.env.sample

@@ -23,4 +23,4 @@ SQLDB_USER_MID=
 SQLDB_USERNAME=
 USE_AI_PROJECT_CLIENT="False"
 USE_CHAT_HISTORY_ENABLED="True"
-APP_ENV="local"
+APP_ENV="dev"

src/api/helpers/azure_credential_utils.py

@@ -7,7 +7,7 @@ async def get_azure_credential_async(client_id=None):
     """
     Returns an Azure credential asynchronously based on the application environment.
 
-    If the environment is 'local', it uses AioDefaultAzureCredential.
+    If the environment is 'dev', it uses AioDefaultAzureCredential.
     Otherwise, it uses AioManagedIdentityCredential.
 
     Args:
@@ -17,7 +17,7 @@ async def get_azure_credential_async(client_id=None):
         Credential object: Either AioDefaultAzureCredential or AioManagedIdentityCredential.
     """
     config = Config()
-    if config.app_env == 'local':
+    if config.app_env == 'dev':
         return AioDefaultAzureCredential()  # CodeQL [SM05139] Okay use of DefaultAzureCredential as it is only used in development
     else:
         return AioManagedIdentityCredential(client_id=client_id)
@@ -27,7 +27,7 @@ def get_azure_credential(client_id=None):
     """
     Returns an Azure credential based on the application environment.
 
-    If the environment is 'local', it uses DefaultAzureCredential.
+    If the environment is 'dev', it uses DefaultAzureCredential.
     Otherwise, it uses ManagedIdentityCredential.
 
     Args:
@@ -37,7 +37,7 @@ def get_azure_credential(client_id=None):
         Credential object: Either DefaultAzureCredential or ManagedIdentityCredential.
     """
     config = Config()
-    if config.app_env == 'local':
+    if config.app_env == 'dev':
         return DefaultAzureCredential()  # CodeQL [SM05139] Okay use of DefaultAzureCredential as it is only used in development
     else:
         return ManagedIdentityCredential(client_id=client_id)

src/tests/api/helpers/test_azure_credential_utils.py

@@ -11,11 +11,11 @@ class TestAzureCredentialUtils:
     @patch("helpers.azure_credential_utils.Config")
     @patch("helpers.azure_credential_utils.DefaultAzureCredential")
     @patch("helpers.azure_credential_utils.ManagedIdentityCredential")
-    def test_get_azure_credential_local_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_config):
-        """Test get_azure_credential in local environment."""
+    def test_get_azure_credential_dev_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_config):
+        """Test get_azure_credential in dev environment."""
         # Arrange
         mock_config_instance = MagicMock()
-        mock_config_instance.app_env = "local"
+        mock_config_instance.app_env = "dev"
         mock_config.return_value = mock_config_instance
 
         mock_default_credential = MagicMock()
@@ -33,8 +33,8 @@ def test_get_azure_credential_local_env(self, mock_managed_identity_credential,
     @patch("helpers.azure_credential_utils.Config")
     @patch("helpers.azure_credential_utils.DefaultAzureCredential")
     @patch("helpers.azure_credential_utils.ManagedIdentityCredential")
-    def test_get_azure_credential_non_local_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_config):
-        """Test get_azure_credential in non-local environment."""
+    def test_get_azure_credential_non_dev_env(self, mock_managed_identity_credential, mock_default_azure_credential, mock_config):
+        """Test get_azure_credential in non-dev environment."""
         # Arrange
         mock_config_instance = MagicMock()
         mock_config_instance.app_env = "Prod"
@@ -56,11 +56,11 @@ def test_get_azure_credential_non_local_env(self, mock_managed_identity_credenti
     @patch("helpers.azure_credential_utils.Config")
     @patch("helpers.azure_credential_utils.AioDefaultAzureCredential")
     @patch("helpers.azure_credential_utils.AioManagedIdentityCredential")
-    async def test_get_azure_credential_async_local_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_config):
-        """Test get_azure_credential_async in local environment."""
+    async def test_get_azure_credential_async_dev_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_config):
+        """Test get_azure_credential_async in dev environment."""
         # Arrange
         mock_config_instance = MagicMock()
-        mock_config_instance.app_env = "local"
+        mock_config_instance.app_env = "dev"
         mock_config.return_value = mock_config_instance
 
         mock_aio_default_credential = MagicMock()
@@ -79,8 +79,8 @@ async def test_get_azure_credential_async_local_env(self, mock_aio_managed_ident
     @patch("helpers.azure_credential_utils.Config")
     @patch("helpers.azure_credential_utils.AioDefaultAzureCredential")
     @patch("helpers.azure_credential_utils.AioManagedIdentityCredential")
-    async def test_get_azure_credential_async_non_local_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_config):
-        """Test get_azure_credential_async in non-local environment."""
+    async def test_get_azure_credential_async_non_dev_env(self, mock_aio_managed_identity_credential, mock_aio_default_azure_credential, mock_config):
+        """Test get_azure_credential_async in non-dev environment."""
         # Arrange
         mock_config_instance = MagicMock()
         mock_config_instance.app_env = "Prod"