add tests

Author: nikhilc-microsoft

tests/observability/hosting/__init__.py

@@ -0,0 +1,2 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.

tests/observability/hosting/test_populate_baggage.py

@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+from unittest.mock import MagicMock
+
+from microsoft_agents_a365.observability.core.constants import GEN_AI_CALLER_ID_KEY
+from microsoft_agents_a365.observability.core.middleware.baggage_builder import BaggageBuilder
+from microsoft_agents_a365.observability.hosting.scope_helpers.populate_baggage import populate
+
+
+def test_populate():
+    """Test populate populates BaggageBuilder from turn context."""
+    # Create a mock turn context with activity
+    turn_context = MagicMock()
+    activity = MagicMock()
+    activity.from_property = MagicMock(
+        aad_object_id="caller-id",
+        name="Caller",
+        agentic_user_id="caller-upn",
+        tenant_id="tenant-id",
+    )
+    activity.recipient = MagicMock(tenant_id="tenant-id", role="user")
+    activity.conversation = MagicMock(id="conv-id")
+    activity.service_url = "https://example.com"
+    activity.channel_id = "test-channel"
+    turn_context.activity = activity
+
+    builder = BaggageBuilder()
+
+    result = populate(builder, turn_context)
+
+    assert result == builder
+    # Verify builder was populated by checking its internal _pairs dict
+    assert len(builder._pairs) > 0
+    # Verify specific expected baggage keys were set
+    assert GEN_AI_CALLER_ID_KEY in builder._pairs
+    assert builder._pairs[GEN_AI_CALLER_ID_KEY] == "caller-id"

tests/observability/hosting/test_populate_invoke_agent_scope.py

@@ -0,0 +1,223 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+import os
+from unittest.mock import MagicMock
+
+import pytest
+from microsoft_agents_a365.observability.core.agent_details import AgentDetails
+from microsoft_agents_a365.observability.core.constants import (
+    GEN_AI_AGENT_ID_KEY,
+    GEN_AI_CALLER_ID_KEY,
+    GEN_AI_CONVERSATION_ID_KEY,
+    GEN_AI_EXECUTION_SOURCE_NAME_KEY,
+    GEN_AI_EXECUTION_TYPE_KEY,
+    GEN_AI_INPUT_MESSAGES_KEY,
+    TENANT_ID_KEY,
+)
+from microsoft_agents_a365.observability.core.invoke_agent_details import InvokeAgentDetails
+from microsoft_agents_a365.observability.core.invoke_agent_scope import InvokeAgentScope
+from microsoft_agents_a365.observability.core.tenant_details import TenantDetails
+from microsoft_agents_a365.observability.hosting.scope_helpers.populate_invoke_agent_scope import (
+    populate,
+    set_caller_tags,
+    set_conversation_id_tags,
+    set_execution_type_tags,
+    set_input_message_tags,
+    set_source_metadata_tags,
+    set_target_agent_tags,
+    set_tenant_id_tags,
+)
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+
+
+@pytest.fixture(autouse=True)
+def enable_telemetry():
+    """Enable telemetry and set up tracer provider for all tests in this module."""
+    # Set environment variable to enable telemetry
+    os.environ["ENABLE_OBSERVABILITY"] = "true"
+
+    # Set up a proper tracer provider
+    provider = TracerProvider()
+    trace.set_tracer_provider(provider)
+
+    yield
+
+    # Clean up
+    os.environ.pop("ENABLE_OBSERVABILITY", None)
+
+
+def test_populate():
+    """Test populate populates scope from turn context."""
+    # Create real InvokeAgentScope with minimal required parameters
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    # Use mock for TurnContext to avoid dependency on microsoft_agents package
+    turn_context = MagicMock()
+    activity = MagicMock()
+    activity.from_property = MagicMock()
+    activity.recipient = MagicMock()
+    activity.conversation = MagicMock()
+    activity.text = "Test message"
+    turn_context.activity = activity
+
+    result = populate(scope, turn_context)
+
+    # Verify function completes without error and returns the scope
+    assert result == scope
+
+
+def test_set_caller_tags():
+    """Test set_caller_tags sets caller attributes on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.from_property = MagicMock(
+        aad_object_id="caller-id", name="Caller", agentic_user_id="upn", tenant_id="tenant"
+    )
+
+    # Verify function completes without error
+    set_caller_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_CALLER_ID_KEY in scope._span._attributes
+        assert scope._span._attributes[GEN_AI_CALLER_ID_KEY] == "caller-id"
+
+
+def test_set_execution_type_tags():
+    """Test set_execution_type_tags sets execution type on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.from_property = MagicMock(role="user")
+    activity.recipient = MagicMock(role="agenticUser")
+
+    # Verify function completes without error
+    set_execution_type_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_EXECUTION_TYPE_KEY in scope._span._attributes
+
+
+def test_set_target_agent_tags():
+    """Test set_target_agent_tags sets target agent attributes on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.recipient = MagicMock(
+        agentic_app_id="agent-id", name="Agent", aad_object_id="auid", agentic_user_id="upn"
+    )
+
+    # Verify function completes without error
+    set_target_agent_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_AGENT_ID_KEY in scope._span._attributes
+        assert scope._span._attributes[GEN_AI_AGENT_ID_KEY] == "agent-id"
+
+
+def test_set_tenant_id_tags():
+    """Test set_tenant_id_tags sets tenant ID on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.recipient = MagicMock(tenant_id="tenant-123")
+
+    # Verify function completes without error
+    set_tenant_id_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert TENANT_ID_KEY in scope._span._attributes
+        assert scope._span._attributes[TENANT_ID_KEY] == "tenant-123"
+
+
+def test_set_source_metadata_tags():
+    """Test set_source_metadata_tags sets source metadata on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.channel_id = "test-channel"
+
+    # Verify function completes without error
+    set_source_metadata_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_EXECUTION_SOURCE_NAME_KEY in scope._span._attributes
+        assert scope._span._attributes[GEN_AI_EXECUTION_SOURCE_NAME_KEY] == "test-channel"
+
+
+def test_set_conversation_id_tags():
+    """Test set_conversation_id_tags sets conversation attributes on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.conversation = MagicMock(id="conv-123")
+    activity.service_url = "https://example.com"
+
+    # Verify function completes without error
+    set_conversation_id_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_CONVERSATION_ID_KEY in scope._span._attributes
+        assert scope._span._attributes[GEN_AI_CONVERSATION_ID_KEY] == "conv-123"
+
+
+def test_set_input_message_tags():
+    """Test set_input_message_tags sets input message on scope."""
+    # Create real InvokeAgentScope
+    invoke_agent_details = InvokeAgentDetails(
+        details=AgentDetails(agent_id="test-agent", agent_name="Test Agent")
+    )
+    tenant_details = TenantDetails(tenant_id="test-tenant")
+    scope = InvokeAgentScope(invoke_agent_details, tenant_details)
+
+    activity = MagicMock()
+    activity.text = "Test input message"
+
+    # Verify function completes without error
+    set_input_message_tags(scope, activity)
+
+    # Verify attributes were set on the span (if telemetry is enabled)
+    if scope._span and hasattr(scope._span, "_attributes"):
+        assert GEN_AI_INPUT_MESSAGES_KEY in scope._span._attributes

tests/observability/hosting/test_utils.py

@@ -0,0 +1,112 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+from microsoft_agents.activity import Activity, ChannelAccount, ConversationAccount
+from microsoft_agents_a365.observability.core.constants import (
+    GEN_AI_AGENT_AUID_KEY,
+    GEN_AI_AGENT_DESCRIPTION_KEY,
+    GEN_AI_AGENT_ID_KEY,
+    GEN_AI_AGENT_NAME_KEY,
+    GEN_AI_AGENT_UPN_KEY,
+    GEN_AI_CALLER_ID_KEY,
+    GEN_AI_CALLER_NAME_KEY,
+    GEN_AI_CALLER_TENANT_ID_KEY,
+    GEN_AI_CALLER_UPN_KEY,
+    GEN_AI_CONVERSATION_ID_KEY,
+    GEN_AI_CONVERSATION_ITEM_LINK_KEY,
+    GEN_AI_EXECUTION_SOURCE_DESCRIPTION_KEY,
+    GEN_AI_EXECUTION_SOURCE_NAME_KEY,
+    GEN_AI_EXECUTION_TYPE_KEY,
+    TENANT_ID_KEY,
+)
+from microsoft_agents_a365.observability.core.execution_type import ExecutionType
+from microsoft_agents_a365.observability.hosting.scope_helpers.utils import (
+    get_caller_pairs,
+    get_conversation_pairs,
+    get_execution_type_pair,
+    get_source_metadata_pairs,
+    get_target_agent_pairs,
+    get_tenant_id_pair,
+)
+
+
+def test_get_caller_pairs():
+    """Test get_caller_pairs extracts caller information from activity."""
+    from_account = ChannelAccount(
+        aad_object_id="caller-aad-id",
+        name="Test Caller",
+        agentic_user_id="caller-upn",
+        tenant_id="caller-tenant-id",
+    )
+    activity = Activity(type="message", from_property=from_account)
+
+    result = list(get_caller_pairs(activity))
+
+    assert (GEN_AI_CALLER_ID_KEY, "caller-aad-id") in result
+    assert (GEN_AI_CALLER_NAME_KEY, "Test Caller") in result
+    assert (GEN_AI_CALLER_UPN_KEY, "caller-upn") in result
+    assert (GEN_AI_CALLER_TENANT_ID_KEY, "caller-tenant-id") in result
+
+
+def test_get_execution_type_pair():
+    """Test get_execution_type_pair determines execution type correctly."""
+    from_account = ChannelAccount(role="agenticUser")
+    recipient = ChannelAccount(role="agenticUser")
+    activity = Activity(type="message", from_property=from_account, recipient=recipient)
+
+    result = list(get_execution_type_pair(activity))
+
+    assert (GEN_AI_EXECUTION_TYPE_KEY, ExecutionType.AGENT_TO_AGENT.value) in result
+
+
+def test_get_target_agent_pairs():
+    """Test get_target_agent_pairs extracts target agent information."""
+    recipient = ChannelAccount(
+        agentic_app_id="agent-app-id",
+        name="Test Agent",
+        aad_object_id="agent-auid",
+        agentic_user_id="agent-upn",
+        role="Assistant",
+    )
+    activity = Activity(type="message", recipient=recipient)
+
+    result = list(get_target_agent_pairs(activity))
+
+    assert (GEN_AI_AGENT_ID_KEY, "agent-app-id") in result
+    assert (GEN_AI_AGENT_NAME_KEY, "Test Agent") in result
+    assert (GEN_AI_AGENT_AUID_KEY, "agent-auid") in result
+    assert (GEN_AI_AGENT_UPN_KEY, "agent-upn") in result
+    assert (GEN_AI_AGENT_DESCRIPTION_KEY, "Assistant") in result
+
+
+def test_get_tenant_id_pair():
+    """Test get_tenant_id_pair extracts tenant ID from recipient."""
+    recipient = ChannelAccount(tenant_id="test-tenant-id")
+    activity = Activity(type="message", recipient=recipient)
+
+    result = list(get_tenant_id_pair(activity))
+
+    assert (TENANT_ID_KEY, "test-tenant-id") in result
+
+
+def test_get_source_metadata_pairs():
+    """Test get_source_metadata_pairs extracts channel metadata."""
+    activity = Activity(type="message", channel_id="test-channel")
+
+    result = list(get_source_metadata_pairs(activity))
+
+    assert (GEN_AI_EXECUTION_SOURCE_NAME_KEY, "test-channel") in result
+    assert (GEN_AI_EXECUTION_SOURCE_DESCRIPTION_KEY, None) in result
+
+
+def test_get_conversation_pairs():
+    """Test get_conversation_pairs extracts conversation information."""
+    conversation = ConversationAccount(id="conversation-123")
+    activity = Activity(
+        type="message", conversation=conversation, service_url="https://example.com"
+    )
+
+    result = list(get_conversation_pairs(activity))
+
+    assert (GEN_AI_CONVERSATION_ID_KEY, "conversation-123") in result
+    assert (GEN_AI_CONVERSATION_ITEM_LINK_KEY, "https://example.com") in result