agent-framework/python/packages/durabletask/tests/test_client.py

# Copyright (c) Microsoft. All rights reserved.

"""Unit tests for DurableAIAgentClient.

Focuses on critical client workflows: agent retrieval, protocol compliance, and integration.
Run with: pytest tests/test_client.py -v
"""

from unittest.mock import Mock

import pytest
from agent_framework import SupportsAgentRun

from agent_framework_durabletask import DurableAgentSession, DurableAIAgentClient
from agent_framework_durabletask._constants import DEFAULT_MAX_POLL_RETRIES, DEFAULT_POLL_INTERVAL_SECONDS
from agent_framework_durabletask._shim import DurableAIAgent


@pytest.fixture
def mock_grpc_client() -> Mock:
    """Create a mock TaskHubGrpcClient for testing."""
    return Mock()


@pytest.fixture
def agent_client(mock_grpc_client: Mock) -> DurableAIAgentClient:
    """Create a DurableAIAgentClient with mock gRPC client."""
    return DurableAIAgentClient(mock_grpc_client)


@pytest.fixture
def agent_client_with_custom_polling(mock_grpc_client: Mock) -> DurableAIAgentClient:
    """Create a DurableAIAgentClient with custom polling parameters."""
    return DurableAIAgentClient(
        mock_grpc_client,
        max_poll_retries=15,
        poll_interval_seconds=0.5,
    )


class TestDurableAIAgentClientGetAgent:
    """Test core workflow: retrieving agents from the client."""

    def test_get_agent_returns_durable_agent_shim(self, agent_client: DurableAIAgentClient) -> None:
        """Verify get_agent returns a DurableAIAgent instance."""
        agent = agent_client.get_agent("assistant")

        assert isinstance(agent, DurableAIAgent)
        assert isinstance(agent, SupportsAgentRun)

    def test_get_agent_shim_has_correct_name(self, agent_client: DurableAIAgentClient) -> None:
        """Verify retrieved agent has the correct name."""
        agent = agent_client.get_agent("my_agent")

        assert agent.name == "my_agent"

    def test_get_agent_multiple_times_returns_new_instances(self, agent_client: DurableAIAgentClient) -> None:
        """Verify multiple get_agent calls return independent instances."""
        agent1 = agent_client.get_agent("assistant")
        agent2 = agent_client.get_agent("assistant")

        assert agent1 is not agent2  # Different object instances

    def test_get_agent_different_agents(self, agent_client: DurableAIAgentClient) -> None:
        """Verify client can retrieve multiple different agents."""
        agent1 = agent_client.get_agent("agent1")
        agent2 = agent_client.get_agent("agent2")

        assert agent1.name == "agent1"
        assert agent2.name == "agent2"


class TestDurableAIAgentClientIntegration:
    """Test integration scenarios between client and agent shim."""

    def test_client_agent_has_working_run_method(self, agent_client: DurableAIAgentClient) -> None:
        """Verify agent from client has callable run method (even if not yet implemented)."""
        agent = agent_client.get_agent("assistant")

        assert hasattr(agent, "run")
        assert callable(agent.run)

    def test_client_agent_can_create_sessions(self, agent_client: DurableAIAgentClient) -> None:
        """Verify agent from client can create DurableAgentSession instances."""
        agent = agent_client.get_agent("assistant")

        session = agent.create_session()

        assert isinstance(session, DurableAgentSession)

    def test_client_agent_session_with_parameters(self, agent_client: DurableAIAgentClient) -> None:
        """Verify agent can create sessions with custom parameters."""
        agent = agent_client.get_agent("assistant")

        session = agent.create_session(service_session_id="client-session-123")

        assert isinstance(session, DurableAgentSession)
        assert session.service_session_id == "client-session-123"


class TestDurableAIAgentClientPollingConfiguration:
    """Test polling configuration parameters for DurableAIAgentClient."""

    def test_client_uses_default_polling_parameters(self, agent_client: DurableAIAgentClient) -> None:
        """Verify client initializes with default polling parameters."""
        assert agent_client.max_poll_retries == DEFAULT_MAX_POLL_RETRIES
        assert agent_client.poll_interval_seconds == DEFAULT_POLL_INTERVAL_SECONDS

    def test_client_accepts_custom_polling_parameters(
        self, agent_client_with_custom_polling: DurableAIAgentClient
    ) -> None:
        """Verify client accepts and stores custom polling parameters."""
        assert agent_client_with_custom_polling.max_poll_retries == 15
        assert agent_client_with_custom_polling.poll_interval_seconds == 0.5

    def test_client_validates_max_poll_retries(self, mock_grpc_client: Mock) -> None:
        """Verify client validates and normalizes max_poll_retries."""
        # Test with zero - should enforce minimum of 1
        client = DurableAIAgentClient(mock_grpc_client, max_poll_retries=0)
        assert client.max_poll_retries == 1

        # Test with negative - should enforce minimum of 1
        client = DurableAIAgentClient(mock_grpc_client, max_poll_retries=-5)
        assert client.max_poll_retries == 1

    def test_client_validates_poll_interval_seconds(self, mock_grpc_client: Mock) -> None:
        """Verify client validates and normalizes poll_interval_seconds."""
        # Test with zero - should use default
        client = DurableAIAgentClient(mock_grpc_client, poll_interval_seconds=0)
        assert client.poll_interval_seconds == DEFAULT_POLL_INTERVAL_SECONDS

        # Test with negative - should use default
        client = DurableAIAgentClient(mock_grpc_client, poll_interval_seconds=-0.5)
        assert client.poll_interval_seconds == DEFAULT_POLL_INTERVAL_SECONDS

        # Test with valid float
        client = DurableAIAgentClient(mock_grpc_client, poll_interval_seconds=2.5)
        assert client.poll_interval_seconds == 2.5


if __name__ == "__main__":
    pytest.main([__file__, "-v", "--tb=short"])