Merge pull request #190 from microsoft/dev

fix: removed the container creation from code, added all the env variable in bicep for local setup

Author: Roopan-Microsoft

docs/DeploymentGuide.md

@@ -228,3 +228,8 @@ Additional Steps
 ## Running the application
 
 To help you get started, sample Informix queries have been included in the data/informix/functions and data/informix/simple directories. You can choose to upload these files to test the application.
+
+## Environment configuration for local development & debugging
+> Set APP_ENV in your .env file to control Azure authentication. Use dev to enable to use Azure CLI credential, Prod to enable Managed Identity (for production). **Ensure you're logged in via az login when using dev in local**.
+
+To configure your environment, navigate to the `src\backend` folder to create a `.env` file based on the `.env.sample`, fill it using deployment output or the Azure Portal under "Deployments" in your resource group, and ensure APP_ENV is set to "**dev**".

infra/main.bicep

@@ -647,3 +647,26 @@ module containerAppFrontend 'br/public:avm/res/app/container-app:0.17.0' = {
 @description('The resource group the resources were deployed into.')
 output resourceGroupName string = resourceGroup().name
 output WEB_APP_URL string = 'https://${containerAppFrontend.outputs.fqdn}'
+output COSMOSDB_ENDPOINT string = cosmosDb.outputs.endpoint
+output AZURE_BLOB_ACCOUNT_NAME string = storageAccount.outputs.name
+output AZURE_BLOB_ENDPOINT string = 'https://${storageAccount.outputs.name}.blob.core.windows.net/'
+output AZURE_OPENAI_ENDPOINT string = 'https://${aiServices.outputs.name}.openai.azure.com/'
+output AZURE_AI_AGENT_PROJECT_NAME string = aiServices.outputs.aiProjectInfo.name
+output AZURE_AI_AGENT_ENDPOINT string = aiServices.outputs.aiProjectInfo.apiEndpoint
+output AZURE_AI_AGENT_PROJECT_CONNECTION_STRING string = aiServices.outputs.aiProjectInfo.apiEndpoint
+output AZURE_AI_AGENT_RESOURCE_GROUP_NAME string = resourceGroup().name
+output AZURE_AI_AGENT_SUBSCRIPTION_ID string = subscription().subscriptionId
+output AI_PROJECT_ENDPOINT string = aiServices.outputs.aiProjectInfo.apiEndpoint
+output AZURE_CLIENT_ID string = appIdentity.outputs.clientId
+output AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME string = modelDeployment.name
+output AZURE_BLOB_CONTAINER_NAME string = appStorageContainerName
+output COSMOSDB_DATABASE string = cosmosDb.outputs.databaseName
+output COSMOSDB_BATCH_CONTAINER string = cosmosDb.outputs.containerNames.batch
+output COSMOSDB_FILE_CONTAINER string = cosmosDb.outputs.containerNames.file
+output COSMOSDB_LOG_CONTAINER string = cosmosDb.outputs.containerNames.log
+output APPLICATIONINSIGHTS_CONNECTION_STRING string = enableMonitoring ? applicationInsights.outputs.connectionString : ''
+output MIGRATOR_AGENT_MODEL_DEPLOY string = modelDeployment.name
+output PICKER_AGENT_MODEL_DEPLOY string = modelDeployment.name
+output FIXER_AGENT_MODEL_DEPLOY string = modelDeployment.name
+output SEMANTIC_VERIFIER_AGENT_MODEL_DEPLOY string = modelDeployment.name
+output SYNTAX_CHECKER_AGENT_MODEL_DEPLOY string = modelDeployment.name  

src/backend/common/database/cosmosdb.py

@@ -2,7 +2,6 @@
 from typing import Dict, List, Optional
 from uuid import UUID, uuid4
 
-from azure.cosmos import PartitionKey, exceptions
 from azure.cosmos.aio import CosmosClient
 from azure.cosmos.aio._database import DatabaseProxy
 from azure.cosmos.exceptions import (
@@ -49,32 +48,27 @@ async def initialize_cosmos(self):
         try:
             self.client = CosmosClient(url=self.endpoint, credential=self.credential)
             database = self.client.get_database_client(self.database_name)
-
-            self.batch_container = await self._get_or_create_container(
-                database, self.batch_container_name, "/batch_id"
+            self.batch_container = await self._get_container(
+                database, self.batch_container_name
             )
-            self.file_container = await self._get_or_create_container(
-                database, self.file_container_name, "/file_id"
+            self.file_container = await self._get_container(
+                database, self.file_container_name
             )
-            self.log_container = await self._get_or_create_container(
-                database, self.log_container_name, "/log_id"
+            self.log_container = await self._get_container(
+                database, self.log_container_name
             )
         except Exception as e:
             self.logger.error("Failed to initialize Cosmos DB", error=str(e))
             raise
 
-    async def _get_or_create_container(
-        self, database: DatabaseProxy, container_name, partition_key
+    async def _get_container(
+        self, database: DatabaseProxy, container_name
     ):
         try:
-            return await database.create_container(
-                id=container_name, partition_key=PartitionKey(path=partition_key)
-            )
-        except exceptions.CosmosResourceExistsError:
             return database.get_container_client(container_name)
 
         except Exception as e:
-            self.logger.error("Failed to Get/Create cosmosdb container", error=str(e))
+            self.logger.error("Failed to Get cosmosdb container", error=str(e))
             raise
 
     async def create_batch(self, user_id: str, batch_id: UUID) -> BatchRecord:

src/tests/backend/common/database/cosmosdb_test.py

@@ -59,8 +59,8 @@ async def test_initialize_cosmos(cosmos_db_client, mocker):
     mock_file_container = mock.MagicMock()
     mock_log_container = mock.MagicMock()
 
-    # Use AsyncMock to mock asynchronous container creation
-    mock_database.create_container = AsyncMock(side_effect=[
+    # Mock get_container_client method (since _get_container uses this)
+    mock_database.get_container_client = mock.MagicMock(side_effect=[
         mock_batch_container,
         mock_file_container,
         mock_log_container
@@ -69,10 +69,10 @@ async def test_initialize_cosmos(cosmos_db_client, mocker):
     # Call the initialize_cosmos method
     await cosmos_db_client.initialize_cosmos()
 
-    # Assert that the containers were created or fetched successfully
-    mock_database.create_container.assert_any_call(id=batch_container, partition_key=mock.ANY)
-    mock_database.create_container.assert_any_call(id=file_container, partition_key=mock.ANY)
-    mock_database.create_container.assert_any_call(id=log_container, partition_key=mock.ANY)
+    # Assert that the containers were fetched successfully
+    mock_database.get_container_client.assert_any_call(batch_container)
+    mock_database.get_container_client.assert_any_call(file_container)
+    mock_database.get_container_client.assert_any_call(log_container)
 
     # Check the client and containers were set
     assert cosmos_db_client.client is not None
@@ -87,15 +87,15 @@ async def test_initialize_cosmos_with_error(cosmos_db_client, mocker):
     mock_client = mocker.patch.object(CosmosClient, 'get_database_client', return_value=mock.MagicMock())
     mock_database = mock_client.return_value
 
-    # Simulate a general exception during container creation
-    mock_database.create_container = AsyncMock(side_effect=Exception("Failed to create container"))
+    # Simulate a general exception during container access
+    mock_database.get_container_client = mock.MagicMock(side_effect=Exception("Failed to get container"))
 
     # Call the initialize_cosmos method and expect it to raise an error
     with pytest.raises(Exception) as exc_info:
         await cosmos_db_client.initialize_cosmos()
 
     # Assert that the exception message matches the expected message
-    assert str(exc_info.value) == "Failed to create container"
+    assert str(exc_info.value) == "Failed to get container"
 
 
 @pytest.mark.asyncio
@@ -104,16 +104,13 @@ async def test_initialize_cosmos_container_exists_error(cosmos_db_client, mocker
     mock_client = mocker.patch.object(CosmosClient, 'get_database_client', return_value=mock.MagicMock())
     mock_database = mock_client.return_value
 
-    # Simulating CosmosResourceExistsError for container creation
-    mock_database.create_container = AsyncMock(side_effect=CosmosResourceExistsError)
-
     # Use AsyncMock for asynchronous methods
     mock_batch_container = mock.MagicMock()
     mock_file_container = mock.MagicMock()
     mock_log_container = mock.MagicMock()
 
-    # Use AsyncMock to mock asynchronous container creation
-    mock_database.create_container = AsyncMock(side_effect=[
+    # Mock get_container_client method to return existing containers
+    mock_database.get_container_client = mock.MagicMock(side_effect=[
         mock_batch_container,
         mock_file_container,
         mock_log_container
@@ -122,10 +119,10 @@ async def test_initialize_cosmos_container_exists_error(cosmos_db_client, mocker
     # Call the initialize_cosmos method
     await cosmos_db_client.initialize_cosmos()
 
-    # Assert that the container creation method was called with the correct arguments
-    mock_database.create_container.assert_any_call(id='batch_container', partition_key=mock.ANY)
-    mock_database.create_container.assert_any_call(id='file_container', partition_key=mock.ANY)
-    mock_database.create_container.assert_any_call(id='log_container', partition_key=mock.ANY)
+    # Assert that the container access method was called with the correct arguments
+    mock_database.get_container_client.assert_any_call('batch_container')
+    mock_database.get_container_client.assert_any_call('file_container')
+    mock_database.get_container_client.assert_any_call('log_container')
 
     # Check that existing containers are returned (mocked containers)
     assert cosmos_db_client.batch_container == mock_batch_container