core/tests/components/todo/test_llm.py

"""Tests for the todo LLM tools platform."""

import pytest

from homeassistant.components import llm as llm_component, todo
from homeassistant.components.homeassistant.exposed_entities import async_expose_entity
from homeassistant.components.todo import llm as todo_llm
from homeassistant.core import Context, HomeAssistant
from homeassistant.helpers import config_validation as cv, llm
from homeassistant.setup import async_setup_component

from tests.common import async_mock_service

ENTITY_ID = "todo.test_list"


@pytest.fixture(autouse=True)
async def setup_integrations(hass: HomeAssistant) -> None:
    """Set up the integrations and expose a to-do list."""
    assert await async_setup_component(hass, "homeassistant", {})
    assert await async_setup_component(hass, "intent", {})
    assert await async_setup_component(hass, "todo", {})
    assert await async_setup_component(hass, "llm", {})
    hass.states.async_set(ENTITY_ID, "0", {"friendly_name": "Mock Todo List Name"})
    async_expose_entity(hass, "conversation", ENTITY_ID, True)
    await hass.async_block_till_done()


def _llm_context() -> llm.LLMContext:
    """Return an LLM context for the conversation assistant."""
    return llm.LLMContext(
        platform="test_platform",
        context=Context(),
        language="*",
        assistant="conversation",
        device_id=None,
    )


async def test_get_tools_no_exposed_todo(hass: HomeAssistant) -> None:
    """Test no todo tool is offered when no to-do list is exposed."""
    async_expose_entity(hass, "conversation", ENTITY_ID, False)
    result = await llm_component.async_get_tools(hass, _llm_context(), "assist")
    assert "todo_get_items" not in [tool.name for tool in result.tools]
    assert todo_llm.async_get_tools(hass, _llm_context(), "assist") is None


async def test_no_tools_for_other_api(hass: HomeAssistant) -> None:
    """Test the platform returns None for an unsupported API."""
    assert todo_llm.async_get_tools(hass, _llm_context(), "other") is None


async def test_todo_get_items_tool(hass: HomeAssistant) -> None:
    """Test the todo get items tool is exposed and works via the platform."""
    llm_context = _llm_context()
    result = await llm_component.async_get_tools(hass, llm_context, "assist")
    tool = next((tool for tool in result.tools if tool.name == "todo_get_items"), None)
    assert tool is not None
    assert tool.parameters.schema["todo_list"].container == ["Mock Todo List Name"]

    calls = async_mock_service(
        hass,
        domain=todo.DOMAIN,
        service=todo.TodoServices.GET_ITEMS,
        schema=cv.make_entity_service_schema(todo.TODO_SERVICE_GET_ITEMS_SCHEMA),
        response={
            ENTITY_ID: {
                "items": [
                    {"uid": "1234", "summary": "Buy milk", "status": "needs_action"},
                ]
            }
        },
    )

    result = await tool.async_call(
        hass,
        llm.ToolInput("todo_get_items", {"todo_list": "Mock Todo List Name"}),
        llm_context,
    )

    assert len(calls) == 1
    assert calls[0].data == {"entity_id": [ENTITY_ID], "status": ["needs_action"]}
    assert result == {
        "success": True,
        "result": [{"uid": "1234", "status": "needs_action", "summary": "Buy milk"}],
    }


@pytest.mark.parametrize(
    ("status", "expected"),
    [
        ("all", ["needs_action", "completed"]),
        ("completed", ["completed"]),
    ],
)
async def test_todo_get_items_status_filter(
    hass: HomeAssistant, status: str, expected: list[str]
) -> None:
    """Test the status filter is translated into the service call."""
    llm_context = _llm_context()
    result = await llm_component.async_get_tools(hass, llm_context, "assist")
    tool = next(tool for tool in result.tools if tool.name == "todo_get_items")

    calls = async_mock_service(
        hass,
        domain=todo.DOMAIN,
        service=todo.TodoServices.GET_ITEMS,
        schema=cv.make_entity_service_schema(todo.TODO_SERVICE_GET_ITEMS_SCHEMA),
        response={ENTITY_ID: {"items": []}},
    )
    await tool.async_call(
        hass,
        llm.ToolInput(
            "todo_get_items", {"todo_list": "Mock Todo List Name", "status": status}
        ),
        llm_context,
    )
    assert calls[0].data == {"entity_id": [ENTITY_ID], "status": expected}


async def test_todo_list_intents_exposed(hass: HomeAssistant) -> None:
    """Test the todo list intents are exposed as tools when a list is exposed."""
    result = await llm_component.async_get_tools(hass, _llm_context(), "assist")
    names = {tool.name for tool in result.tools}
    assert "HassListAddItem" in names
    assert "HassListCompleteItem" in names
    assert "HassListRemoveItem" in names