feat: added test cases for auth_utils and utils file

Author: Prashant-Microsoft

src/tests/backend/api/auth/__init__.py

@@ -0,0 +1,83 @@
+import base64
+import json
+from unittest.mock import MagicMock
+
+from api.auth.auth_utils import UserDetails, get_authenticated_user, get_tenant_id
+
+from fastapi import HTTPException, Request
+
+import pytest
+
+
+def test_get_tenant_id_valid():
+    payload = {"tid": "tenant123"}
+    encoded = base64.b64encode(json.dumps(payload).encode("utf-8")).decode("utf-8")
+
+    result = get_tenant_id(encoded)
+    assert result == "tenant123"
+
+
+def test_get_tenant_id_invalid():
+    invalid_b64 = "invalid_base64_string"
+    result = get_tenant_id(invalid_b64)
+    assert result == ""
+
+
+def test_user_details_initialization_with_tenant():
+    payload = {"tid": "tenant456"}
+    encoded = base64.b64encode(json.dumps(payload).encode("utf-8")).decode("utf-8")
+
+    user_data = {
+        "user_principal_id": "user1",
+        "user_name": "John Doe",
+        "auth_provider": "aad",
+        "auth_token": "fake_token",
+        "client_principal_b64": encoded,
+    }
+
+    user = UserDetails(user_data)
+    assert user.user_principal_id == "user1"
+    assert user.user_name == "John Doe"
+    assert user.tenant_id == "tenant456"
+
+
+def test_user_details_initialization_without_tenant():
+    user_data = {
+        "user_principal_id": "user2",
+        "user_name": "Jane Doe",
+        "auth_provider": "aad",
+        "auth_token": "fake_token",
+        "client_principal_b64": "your_base_64_encoded_token",
+    }
+
+    user = UserDetails(user_data)
+    assert user.tenant_id is None
+
+
+def test_get_authenticated_user_valid():
+    headers = {
+        "x-ms-client-principal-id": "user3",
+    }
+
+    mock_request = MagicMock(spec=Request)
+    mock_request.headers = headers
+
+    user = get_authenticated_user(mock_request)
+    assert isinstance(user, UserDetails)
+    assert user.user_principal_id == "user3"
+
+
+def test_get_authenticated_user_raises_http_exception(monkeypatch):
+    # Mocking a development environment with no user principal in sample_user
+    sample_user_mock = {"some-header": "some-value"}
+
+    monkeypatch.setattr("api.auth.auth_utils.sample_user", sample_user_mock)
+
+    mock_request = MagicMock(spec=Request)
+    mock_request.headers = {}
+
+    with pytest.raises(HTTPException) as exc_info:
+        get_authenticated_user(mock_request)
+
+    assert exc_info.value.status_code == 401
+    assert exc_info.value.detail == "User not authenticated"

src/tests/backend/api/auth/auth_utils_test.py

@@ -1,31 +1,24 @@
-import os
-import sys
-# Add backend directory to sys.path
-sys.path.insert(
-    0,
-    os.path.abspath(os.path.join(os.path.dirname(__file__), "../../../..", "backend")),
-)
-from datetime import datetime, timezone  # noqa: E402
-from unittest import mock  # noqa: E402
-from unittest.mock import AsyncMock  # noqa: E402
-from uuid import uuid4  # noqa: E402
+from datetime import datetime, timezone
+from unittest import mock
+from unittest.mock import AsyncMock
+from uuid import uuid4
 
-from azure.cosmos.aio import CosmosClient  # noqa: E402
-from azure.cosmos.exceptions import CosmosResourceExistsError  # noqa: E402
+from azure.cosmos.aio import CosmosClient
+from azure.cosmos.exceptions import CosmosResourceExistsError
 
-from common.database.cosmosdb import (  # noqa: E402
+from common.database.cosmosdb import (
     CosmosDBClient,
 )
-from common.models.api import (  # noqa: E402
+from common.models.api import (
     AgentType,
     AuthorRole,
     BatchRecord,
     FileRecord,
     LogType,
-    ProcessStatus,
-)  # noqa: E402
+    ProcessStatus
+)
 
-import pytest  # noqa: E402
+import pytest
 
 # Mocked data for the test
 endpoint = "https://fake.cosmosdb.azure.com"

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

@@ -0,0 +1,45 @@
+from unittest import mock
+
+import pytest
+
+from sql_agents.helpers.utils import get_prompt, is_text
+
+
+def test_get_prompt_valid_agent_type():
+    agent_type = "agent1"
+
+    # Mock the file reading
+    with mock.patch("builtins.open", mock.mock_open(read_data="This is the prompt")):
+        prompt = get_prompt(agent_type)
+
+    # Assert the prompt returned is correct
+    assert prompt == "This is the prompt"
+
+
+def test_get_prompt_invalid_agent_type():
+    agent_type = "invalid-agent!"  # Invalid agent type with a non-alphanumeric character
+
+    # Expect a ValueError to be raised for an invalid agent type
+    with pytest.raises(ValueError):
+        get_prompt(agent_type)
+
+
+def test_get_prompt_file_not_found():
+    agent_type = "agent1"
+
+    # Mock os.path.join and the file not being found
+    with mock.patch("builtins.open", mock.mock_open()) as mock_file:
+        mock_file.side_effect = FileNotFoundError
+        with pytest.raises(FileNotFoundError):
+            get_prompt(agent_type)
+
+
+# Test for the is_text function
+def test_is_text_empty_string():
+    """Test when the content is an empty string."""
+    assert not is_text("")
+
+
+def test_is_text_non_empty_string():
+    """Test when the content is a non-empty string."""
+    assert is_text("Hello, world!")