feat: added unit test cases for config.py, database_base.py, database_factory.py and blob_azure.py file

Author: VishalS-Microsoft

src/backend/common/database/database_base.py

@@ -12,55 +12,55 @@ class DatabaseBase(ABC):
 
     @abstractmethod
     async def initialize_cosmos(self) -> None:
-        """Initialize the cosmosdb client and create container if needed."""
-        pass
+        """Initialize the cosmosdb client and create container if needed"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def create_batch(self, user_id: str, batch_id: uuid.UUID) -> BatchRecord:
-        """Create a new conversion batch."""
-        pass
+        """Create a new conversion batch"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_file_logs(self, file_id: str) -> Dict:
-        """Retrieve all logs for a file."""
-        pass
+        """Retrieve all logs for a file"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_batch_from_id(self, batch_id: str) -> Dict:
-        """Retrieve all logs for a file."""
-        pass
+        """Retrieve all logs for a file"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_batch_files(self, batch_id: str) -> List[Dict]:
-        """Retrieve all files for a batch."""
-        pass
+        """Retrieve all files for a batch"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def delete_file_logs(self, file_id: str) -> None:
-        """Delete all logs for a file."""
-        pass
+        """Delete all logs for a file"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_user_batches(self, user_id: str) -> Dict:
-        """Retrieve all batches for a user."""
-        pass
+        """Retrieve all batches for a user"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def add_file(
         self, batch_id: uuid.UUID, file_id: uuid.UUID, file_name: str, storage_path: str
     ) -> FileRecord:
-        """Add a file entry to the database."""
-        pass
+        """Add a file entry to the database"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_batch(self, user_id: str, batch_id: str) -> Optional[Dict]:
-        """Retrieve a batch and its associated files."""
-        pass
+        """Retrieve a batch and its associated files"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_file(self, file_id: str) -> Optional[Dict]:
-        """Retrieve a file entry along with its logs."""
-        pass
+        """Retrieve a file entry along with its logs"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def add_file_log(
@@ -72,39 +72,39 @@ async def add_file_log(
         agent_type: AgentType,
         author_role: AuthorRole,
     ) -> None:
-        """Log a file status update."""
-        pass
+        """Log a file status update"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def update_file(self, file_record: FileRecord) -> None:
-        """Update file record."""
-        pass
+        """update file record"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def update_batch(self, batch_record: BatchRecord) -> BatchRecord:
-        pass
+        pass # pragma: no cover
 
     @abstractmethod
     async def delete_all(self, user_id: str) -> None:
-        """Delete all batches, files, and logs for a user."""
-        pass
+        """Delete all batches, files, and logs for a user"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def delete_batch(self, user_id: str, batch_id: str) -> None:
-        """Delete a batch along with its files and logs."""
-        pass
+        """Delete a batch along with its files and logs"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def delete_file(self, user_id: str, batch_id: str, file_id: str) -> None:
-        """Delete a file and its logs, and update batch file count."""
-        pass
+        """Delete a file and its logs, and update batch file count"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def get_batch_history(self, user_id: str, batch_id: str) -> List[Dict]:
-        """Retrieve all logs for a batch."""
-        pass
+        """Retrieve all logs for a batch"""
+        pass # pragma: no cover
 
     @abstractmethod
     async def close(self) -> None:
-        """Close database connection."""
-        pass
+        """Close database connection"""
+        pass # pragma: no cover

src/backend/common/database/database_factory.py

@@ -1,3 +1,4 @@
+import asyncio
 from typing import Optional
 
 from common.config.config import Config
@@ -33,25 +34,20 @@ async def get_database():
 # Note that you have to assign yourself data plane access to Cosmos in script for this to work locally.  See
 # https://learn.microsoft.com/en-us/azure/cosmos-db/table/security/how-to-grant-data-plane-role-based-access?tabs=built-in-definition%2Ccsharp&pivots=azure-interface-cli
 # Note that your principal id is your entra object id for your user account.
-if __name__ == "__main__":
-    # Example usage
-    import asyncio
-
-    async def main():
-        database = await DatabaseFactory.get_database()
-        # Use the database instance...
-        await database.initialize_cosmos()
-        await database.create_batch("mark1", "123e4567-e89b-12d3-a456-426614174000")
-        await database.add_file(
-            "123e4567-e89b-12d3-a456-426614174000",
-            "123e4567-e89b-12d3-a456-426614174001",
-            "q1_informix.sql",
-            "https://cmsamarktaylstor.blob.core.windows.net/cmsablob",
-        )
-        tstbatch = await database.get_batch(
-            "mark1", "123e4567-e89b-12d3-a456-426614174000"
-        )
-        print(tstbatch)
-        await database.close()
+async def main():
+    database = await DatabaseFactory.get_database()
+    await database.initialize_cosmos()
+    await database.create_batch("mark1", "123e4567-e89b-12d3-a456-426614174000")
+    await database.add_file(
+        "123e4567-e89b-12d3-a456-426614174000",
+        "123e4567-e89b-12d3-a456-426614174001",
+        "q1_informix.sql",
+        "https://cmsamarktaylstor.blob.core.windows.net/cmsablob",
+    )
+    tstbatch = await database.get_batch("mark1", "123e4567-e89b-12d3-a456-426614174000")
+    print(tstbatch)
+    await database.close()
 
+
+if __name__ == "__main__":
     asyncio.run(main())

src/tests/backend/common/config/config_test.py

@@ -1,62 +1,70 @@
-import unittest
-from unittest.mock import patch
-
-# from config import Config
-from common.config.config import Config
-
-
-class TestConfigInitialization(unittest.TestCase):
-    @patch.dict(
-        "os.environ",
-        {
-            "AZURE_TENANT_ID": "test-tenant-id",
-            "AZURE_CLIENT_ID": "test-client-id",
-            "AZURE_CLIENT_SECRET": "test-client-secret",
-            "COSMOSDB_DATABASE": "test-database",
-            "COSMOSDB_BATCH_CONTAINER": "test-batch-container",
-            "COSMOSDB_FILE_CONTAINER": "test-file-container",
-            "COSMOSDB_LOG_CONTAINER": "test-log-container",
-            "AZURE_BLOB_CONTAINER_NAME": "test-blob-container-name",
-            "AZURE_BLOB_ACCOUNT_NAME": "test-blob-account-name",
-        },
-        clear=True,
-    )
-    def test_config_initialization(self):
-        """Test if all attributes are correctly assigned from environment variables."""
-        config = Config()
-
-        # Ensure every attribute is accessed
-        self.assertEqual(config.azure_tenant_id, "test-tenant-id")
-        self.assertEqual(config.azure_client_id, "test-client-id")
-        self.assertEqual(config.azure_client_secret, "test-client-secret")
-
-        self.assertEqual(config.cosmosdb_endpoint, "test-cosmosdb-endpoint")
-        self.assertEqual(config.cosmosdb_database, "test-database")
-        self.assertEqual(config.cosmosdb_batch_container, "test-batch-container")
-        self.assertEqual(config.cosmosdb_file_container, "test-file-container")
-        self.assertEqual(config.cosmosdb_log_container, "test-log-container")
-
-        self.assertEqual(config.azure_blob_container_name, "test-blob-container-name")
-        self.assertEqual(config.azure_blob_account_name, "test-blob-account-name")
-
-    @patch.dict(
-        "os.environ",
-        {
-            "COSMOSDB_ENDPOINT": "test-cosmosdb-endpoint",
-            "COSMOSDB_DATABASE": "test-database",
-            "COSMOSDB_BATCH_CONTAINER": "test-batch-container",
-            "COSMOSDB_FILE_CONTAINER": "test-file-container",
-            "COSMOSDB_LOG_CONTAINER": "test-log-container",
-        },
-    )
-    def test_cosmosdb_config_initialization(self):
-        config = Config()
-        self.assertEqual(config.cosmosdb_endpoint, "test-cosmosdb-endpoint")
-        self.assertEqual(config.cosmosdb_database, "test-database")
-        self.assertEqual(config.cosmosdb_batch_container, "test-batch-container")
-        self.assertEqual(config.cosmosdb_file_container, "test-file-container")
-        self.assertEqual(config.cosmosdb_log_container, "test-log-container")
-
-
-if __name__ == "__main__":
-    unittest.main()
+import os
+import sys
+import pytest
+ 
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../../../..', 'backend')))
+ 
+@pytest.fixture(autouse=True)
+def clear_env(monkeypatch):
+    # Clear environment variables that might affect tests.
+    keys = [
+        "AZURE_TENANT_ID",
+        "AZURE_CLIENT_ID",
+        "AZURE_CLIENT_SECRET",
+        "COSMOSDB_ENDPOINT",
+        "COSMOSDB_DATABASE",
+        "COSMOSDB_BATCH_CONTAINER",
+        "COSMOSDB_FILE_CONTAINER",
+        "COSMOSDB_LOG_CONTAINER",
+        "AZURE_BLOB_CONTAINER_NAME",
+        "AZURE_BLOB_ACCOUNT_NAME",
+    ]
+    for key in keys:
+        monkeypatch.delenv(key, raising=False)
+ 
+def test_config_initialization(monkeypatch):
+    # Set the full configuration environment variables.
+    monkeypatch.setenv("AZURE_TENANT_ID", "test-tenant-id")
+    monkeypatch.setenv("AZURE_CLIENT_ID", "test-client-id")
+    monkeypatch.setenv("AZURE_CLIENT_SECRET", "test-client-secret")
+    monkeypatch.setenv("COSMOSDB_ENDPOINT", "test-cosmosdb-endpoint")
+    monkeypatch.setenv("COSMOSDB_DATABASE", "test-database")
+    monkeypatch.setenv("COSMOSDB_BATCH_CONTAINER", "test-batch-container")
+    monkeypatch.setenv("COSMOSDB_FILE_CONTAINER", "test-file-container")
+    monkeypatch.setenv("COSMOSDB_LOG_CONTAINER", "test-log-container")
+    monkeypatch.setenv("AZURE_BLOB_CONTAINER_NAME", "test-blob-container-name")
+    monkeypatch.setenv("AZURE_BLOB_ACCOUNT_NAME", "test-blob-account-name")
+ 
+    # Local import to avoid triggering circular imports during module collection.
+    from common.config.config import Config
+    config = Config()
+ 
+    assert config.azure_tenant_id == "test-tenant-id"
+    assert config.azure_client_id == "test-client-id"
+    assert config.azure_client_secret == "test-client-secret"
+    assert config.cosmosdb_endpoint == "test-cosmosdb-endpoint"
+    assert config.cosmosdb_database == "test-database"
+    assert config.cosmosdb_batch_container == "test-batch-container"
+    assert config.cosmosdb_file_container == "test-file-container"
+    assert config.cosmosdb_log_container == "test-log-container"
+    assert config.azure_blob_container_name == "test-blob-container-name"
+    assert config.azure_blob_account_name == "test-blob-account-name"
+ 
+def test_cosmosdb_config_initialization(monkeypatch):
+    # Set only cosmosdb-related environment variables.
+    monkeypatch.setenv("COSMOSDB_ENDPOINT", "test-cosmosdb-endpoint")
+    monkeypatch.setenv("COSMOSDB_DATABASE", "test-database")
+    monkeypatch.setenv("COSMOSDB_BATCH_CONTAINER", "test-batch-container")
+    monkeypatch.setenv("COSMOSDB_FILE_CONTAINER", "test-file-container")
+    monkeypatch.setenv("COSMOSDB_LOG_CONTAINER", "test-log-container")
+ 
+    from common.config.config import Config
+    config = Config()
+ 
+    assert config.cosmosdb_endpoint == "test-cosmosdb-endpoint"
+    assert config.cosmosdb_database == "test-database"
+    assert config.cosmosdb_batch_container == "test-batch-container"
+    assert config.cosmosdb_file_container == "test-file-container"
+    assert config.cosmosdb_log_container == "test-log-container"
+ 
+