microsoft--semantic-kernel/python/tests/unit/contents/test_function_result_content.py

# Copyright (c) Microsoft. All rights reserved.


from unittest.mock import Mock

import pytest
from pydantic import BaseModel, ConfigDict, Field

from semantic_kernel.contents.chat_message_content import ChatMessageContent
from semantic_kernel.contents.function_call_content import FunctionCallContent
from semantic_kernel.contents.function_result_content import FunctionResultContent
from semantic_kernel.contents.image_content import ImageContent
from semantic_kernel.contents.text_content import TextContent
from semantic_kernel.functions.function_result import FunctionResult
from semantic_kernel.functions.kernel_function_metadata import KernelFunctionMetadata
from semantic_kernel.kernel_pydantic import KernelBaseModel


class CustomResultClass:
    """Custom class for testing."""

    def __init__(self, result):
        self.result = result

    def __str__(self) -> str:
        return self.result


class CustomObjectWithList:
    """Custom class for testing."""

    def __init__(self, items):
        self.items = items

    def __str__(self):
        return f"CustomObjectWithList({self.items})"


class AccountBalanceFrozen(KernelBaseModel):
    # Make the model frozen so it's hashable
    balance: int = Field(default=..., alias="account_balance")
    model_config = ConfigDict(frozen=True)


class AccountBalanceNonFrozen(KernelBaseModel):
    # This model is not frozen and thus not hashable by default
    balance: int = Field(default=..., alias="account_balance")


def test_init():
    frc = FunctionResultContent(id="test", name="test-function", result="test-result", metadata={"test": "test"})
    assert frc.name == "test-function"
    assert frc.function_name == "function"
    assert frc.plugin_name == "test"
    assert frc.metadata == {"test": "test"}
    assert frc.result == "test-result"
    assert str(frc) == "test-result"
    assert frc.split_name() == ["test", "function"]
    assert frc.to_dict() == {
        "tool_call_id": "test",
        "content": "test-result",
    }


def test_init_from_names():
    frc = FunctionResultContent(id="test", function_name="Function", plugin_name="Test", result="test-result")
    assert frc.name == "Test-Function"
    assert frc.function_name == "Function"
    assert frc.plugin_name == "Test"
    assert frc.result == "test-result"
    assert str(frc) == "test-result"


@pytest.mark.parametrize(
    "result",
    [
        "Hello world!",
        123,
        {"test": "test"},
        FunctionResult(function=Mock(spec=KernelFunctionMetadata), value="Hello world!"),
        TextContent(text="Hello world!"),
        ChatMessageContent(role="user", content="Hello world!"),
        ChatMessageContent(role="user", items=[ImageContent(uri="https://example.com")]),
        ChatMessageContent(role="user", items=[FunctionResultContent(id="test", name="test", result="Hello world!")]),
        [1, 2, 3],
        [{"key": "value"}, {"another": "item"}],
        {"a", "b"},
        CustomResultClass("test"),
        CustomObjectWithList(["one", "two", "three"]),
    ],
    ids=[
        "str",
        "int",
        "dict",
        "FunctionResult",
        "TextContent",
        "ChatMessageContent",
        "ChatMessageContent-ImageContent",
        "ChatMessageContent-FunctionResultContent",
        "list",
        "list_of_dicts",
        "set",
        "CustomResultClass",
        "CustomObjectWithList",
    ],
)
def test_from_fcc_and_result(result: any):
    fcc = FunctionCallContent(
        id="test", name="test-function", arguments='{"input": "world"}', metadata={"test": "test"}
    )
    frc = FunctionResultContent.from_function_call_content_and_result(fcc, result, {"test2": "test2"})
    assert frc.name == "test-function"
    assert frc.function_name == "function"
    assert frc.plugin_name == "test"
    assert frc.result is not None
    assert frc.metadata == {"test": "test", "test2": "test2"}


def test_to_cmc():
    frc = FunctionResultContent(id="test", name="test-function", result="test-result")
    cmc = frc.to_chat_message_content()
    assert cmc.role.value == "tool"
    assert cmc.items[0].result == "test-result"


def test_serialize():
    class CustomResultClass:
        def __init__(self, result):
            self.result = result

        def __str__(self) -> str:
            return self.result

    custom_result = CustomResultClass(result="test")
    frc = FunctionResultContent(id="test", name="test-function", result=custom_result)
    assert (
        frc.model_dump_json(exclude_none=True)
        == """{"metadata":{},"content_type":"function_result","id":"test","result":"test","name":"test-function","function_name":"function","plugin_name":"test"}"""  # noqa: E501
    )


def test_hash_with_frozen_account_balance():
    balance = AccountBalanceFrozen(account_balance=100)
    content = FunctionResultContent(
        id="test_id",
        result=balance,
        function_name="TestFunction",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with frozen model should not raise errors."


def test_hash_with_dict_result():
    balance_dict = {"account_balance": 100}
    content = FunctionResultContent(
        id="test_id",
        result=balance_dict,
        function_name="TestFunction",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with dict result should not raise errors."


def test_hash_with_nested_dict_result():
    nested_dict = {"account_balance": 100, "details": {"currency": "USD", "last_updated": "2025-01-28"}}
    content = FunctionResultContent(
        id="test_id_nested",
        result=nested_dict,
        function_name="TestFunctionNested",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with nested dict result should not raise errors."


def test_hash_with_list_result():
    balance_list = [100, 200, 300]
    content = FunctionResultContent(
        id="test_id_list",
        result=balance_list,
        function_name="TestFunctionList",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with list result should not raise errors."


def test_hash_with_set_result():
    balance_set = {100, 200, 300}
    content = FunctionResultContent(
        id="test_id_set",
        result=balance_set,
        function_name="TestFunctionSet",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with set result should not raise errors."


def test_hash_with_custom_object_result():
    class CustomObject(BaseModel):
        field1: str
        field2: int

    custom_obj = CustomObject(field1="value1", field2=42)
    content = FunctionResultContent(
        id="test_id_custom",
        result=custom_obj,
        function_name="TestFunctionCustom",
    )
    _ = hash(content)
    assert True, "Hashing FunctionResultContent with custom object result should not raise errors."


def test_unhashable_non_frozen_model_raises_type_error():
    balance = AccountBalanceNonFrozen(account_balance=100)
    content = FunctionResultContent(
        id="test_id_unhashable",
        result=balance,
        function_name="TestFunctionUnhashable",
    )
    _ = hash(content)