Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

5.3 KB
Raw Blame
from uuid import uuid4

from posthog.test.base import ClickhouseTestMixin, NonAtomicBaseTest
from unittest.mock import AsyncMock, MagicMock, patch

from ee.hogai.context.context import AssistantContextManager
from ee.hogai.tools.list_data import ListDataTool
from ee.hogai.utils.types import AssistantState
from ee.hogai.utils.types.base import NodePath


class TestListDataTool(ClickhouseTestMixin, NonAtomicBaseTest):
    CLASS_DATA_LEVEL_SETUP = False

    def setUp(self):
        super().setUp()
        self.tool_call_id = "test_tool_call_id"
        self.state = AssistantState(messages=[], root_tool_call_id=str(uuid4()))
        self.context_manager = AssistantContextManager(self.team, self.user, {})
        self.tool = ListDataTool(
            team=self.team,
            user=self.user,
            state=self.state,
            context_manager=self.context_manager,
            node_path=(NodePath(name="test_node", tool_call_id=self.tool_call_id, message_id="test"),),
        )

    async def test_list_entities_returns_formatted_data(self):
        """Test that list entities returns formatted entity data."""
        entities_data = [
            {
                "type": "insight",
                "result_id": "insight-123",
                "extra_fields": {"name": "Test Insight", "description": "A test insight"},
            }
        ]
        formatted_str = "Entity type: Insight\nID|Name|Description|URL\ninsight-123|Test Insight|A test insight|-"

        with patch("ee.hogai.tools.list_data.EntitySearchContext") as MockEntitySearchContext:
            mock_instance = MagicMock()
            mock_instance.list_entities = AsyncMock(return_value=(entities_data, 1))
            mock_instance.format_entities = MagicMock(return_value=formatted_str)
            MockEntitySearchContext.return_value = mock_instance

            result, _ = await self.tool._arun_impl(kind="insights", limit=100, offset=0)

            MockEntitySearchContext.assert_called_once_with(
                team=self.team, user=self.user, context_manager=self.context_manager
            )
            mock_instance.list_entities.assert_called_once_with("insight", 100, 0)
            mock_instance.format_entities.assert_called_once_with(entities_data)

            self.assertIn("Offset 0, limit 100", result)
            self.assertIn("Test Insight", result)
            self.assertIn("insight-123", result)
            self.assertIn("You reached the end of results", result)

    async def test_list_entities_with_pagination(self):
        """Test list entities pagination."""
        entities_data = [
            {"type": "dashboard", "result_id": "dash-1", "extra_fields": {"name": "Dashboard 1"}},
            {"type": "dashboard", "result_id": "dash-2", "extra_fields": {"name": "Dashboard 2"}},
        ]
        formatted_str = "Entity type: Dashboard\nID|Name|URL\ndash-1|Dashboard 1|-\ndash-2|Dashboard 2|-"

        with patch("ee.hogai.tools.list_data.EntitySearchContext") as MockEntitySearchContext:
            mock_instance = MagicMock()
            mock_instance.list_entities = AsyncMock(return_value=(entities_data, 5))
            mock_instance.format_entities = MagicMock(return_value=formatted_str)
            MockEntitySearchContext.return_value = mock_instance

            result, _ = await self.tool._arun_impl(kind="dashboards", limit=2, offset=0)

            self.assertIn("Offset 0, limit 2", result)
            self.assertIn("To see more results, use offset=2", result)
            self.assertIn("Dashboard 1", result)
            self.assertIn("Dashboard 2", result)

    async def test_list_entities_rejects_invalid_kind(self):
        """Test that list entities rejects invalid entity kinds."""
        with self.assertRaises(ValueError):
            await self.tool._arun_impl(kind="invalid_kind", limit=100, offset=0)

    async def test_list_entities_accounts_routes_to_account(self):
        """The accounts kind maps to the account database entity type."""
        with patch("ee.hogai.tools.list_data.EntitySearchContext") as MockEntitySearchContext:
            mock_instance = MagicMock()
            mock_instance.list_entities = AsyncMock(return_value=([], 0))
            mock_instance.format_entities = MagicMock(return_value="")
            MockEntitySearchContext.return_value = mock_instance

            await self.tool._arun_impl(kind="accounts", limit=100, offset=0)

            mock_instance.list_entities.assert_called_once_with("account", 100, 0)

    async def test_list_entities_default_pagination(self):
        """Test that list entities uses default pagination values."""
        entities_data = [
            {"type": "insight", "result_id": "insight-1", "extra_fields": {"name": "Insight 1"}},
        ]
        formatted_str = "Entity type: Insight\nID|Name|URL\ninsight-1|Insight 1|-"

        with patch("ee.hogai.tools.list_data.EntitySearchContext") as MockEntitySearchContext:
            mock_instance = MagicMock()
            mock_instance.list_entities = AsyncMock(return_value=(entities_data, 1))
            mock_instance.format_entities = MagicMock(return_value=formatted_str)
            MockEntitySearchContext.return_value = mock_instance

            result, _ = await self.tool._arun_impl(kind="insights", limit=100, offset=0)

            mock_instance.list_entities.assert_called_once_with("insight", 100, 0)
            self.assertIn("Offset 0, limit 100", result)