Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

test: use real tool runtime callbacks (#43367)

Asuka Minato7d13952e245e
diff --git a/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py b/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
index f3c41821046..301922222e2 100644
--- a/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
+++ b/api/tests/unit_tests/core/tools/test_mcp_tool_provider.py
@@ -1,14 +1,18 @@
from __future__ import annotations
+import json
from datetime import datetime
-from unittest.mock import Mock, patch
+from unittest.mock import patch
+from uuid import uuid4
import pytest
+from sqlalchemy.orm import Session
from core.entities.mcp_provider import MCPProviderEntity
from core.tools.entities.tool_entities import ToolProviderType
from core.tools.mcp_tool.provider import MCPToolProviderController
from core.tools.mcp_tool.tool import MCPTool
+from models.tools import MCPToolProvider
def _build_mcp_entity(*, icon: str = "icon.svg") -> MCPProviderEntity:
@@ -66,13 +70,31 @@ def test_mcp_tool_provider_controller_from_entity_requires_icon():
MCPToolProviderController.from_entity(entity)
-def test_mcp_tool_provider_controller_from_db_delegates_to_entity():
+def test_mcp_tool_provider_controller_from_db_delegates_to_entity(sqlite_session: Session):
entity = _build_mcp_entity()
- db_provider = Mock()
- db_provider.to_entity.return_value = entity
+ db_provider = MCPToolProvider(
+ name=entity.name,
+ server_identifier=entity.server_identifier,
+ server_url=entity.server_url,
+ server_url_hash="server-url-hash",
+ icon=str(entity.icon),
+ tenant_id=str(uuid4()),
+ user_id=str(uuid4()),
+ encrypted_credentials=json.dumps(entity.credentials),
+ authed=entity.authed,
+ tools=json.dumps(entity.tools),
+ timeout=entity.timeout,
+ sse_read_timeout=entity.sse_read_timeout,
+ encrypted_headers=json.dumps(entity.headers),
+ identity_mode=entity.identity_mode,
+ )
+ sqlite_session.add(db_provider)
+ sqlite_session.commit()
with patch("core.tools.mcp_tool.provider.ToolTransformService.convert_mcp_schema_to_parameter", return_value=[]):
controller = MCPToolProviderController.from_db(db_provider)
assert isinstance(controller, MCPToolProviderController)
+ assert controller.server_identifier == entity.server_identifier
+ assert controller.entity.tools[0].identity.name == "remote-tool"
def _build_mcp_entity_with_tools(tools: list[dict]) -> MCPProviderEntity:
diff --git a/api/tests/unit_tests/core/tools/test_plugin_tool.py b/api/tests/unit_tests/core/tools/test_plugin_tool.py
index 2ab3e57a8ad..0806f71ea4d 100644
--- a/api/tests/unit_tests/core/tools/test_plugin_tool.py
+++ b/api/tests/unit_tests/core/tools/test_plugin_tool.py
@@ -1,10 +1,13 @@
from __future__ import annotations
-from unittest.mock import Mock, patch
+import json
+from unittest.mock import patch
+import httpx
import pytest
from sqlalchemy.orm import Session
+import core.plugin.impl.base as plugin_client_module
from core.app.entities.app_invoke_entities import InvokeFrom
from core.tools.__base.tool_runtime import ToolRuntime
from core.tools.entities.common_entities import I18nObject
@@ -43,19 +46,29 @@ def _build_plugin_tool(*, has_runtime_parameters: bool) -> PluginTool:
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_plugin_tool_invoke_and_fork_runtime(sqlite_session: Session):
tool = _build_plugin_tool(has_runtime_parameters=False)
- manager = Mock()
- manager.invoke.return_value = iter([tool.create_text_message("ok")])
+ requests: list[httpx.Request] = []
- with patch("core.tools.plugin_tool.tool.PluginToolManager", return_value=manager):
- with patch(
- "core.tools.plugin_tool.tool.convert_parameters_to_plugin_format",
- return_value={"converted": 1},
+ def handle_request(request: httpx.Request) -> httpx.Response:
+ requests.append(request)
+ return httpx.Response(
+ 200,
+ text='data: {"code": 0, "message": "", "data": {"type": "text", "message": {"text": "ok"}}}\n\n',
+ )
+
+ with httpx.Client(transport=httpx.MockTransport(handle_request)) as client:
+ with (
+ patch.object(plugin_client_module, "_httpx_client", client),
+ patch(
+ "core.tools.plugin_tool.tool.convert_parameters_to_plugin_format",
+ return_value={"converted": 1},
+ ),
):
messages = list(tool.invoke(session=sqlite_session, user_id="user-1", tool_parameters={"raw": 1}))
assert [m.message.text for m in messages] == ["ok"]
- manager.invoke.assert_called_once()
- assert manager.invoke.call_args.kwargs["tool_parameters"] == {"converted": 1}
+ assert len(requests) == 1
+ request_data = json.loads(requests[0].content)
+ assert request_data["data"]["tool_parameters"] == {"converted": 1}
forked = tool.fork_tool_runtime(ToolRuntime(tenant_id="tenant-2"))
assert isinstance(forked, PluginTool)
@@ -80,7 +93,6 @@ def test_plugin_tool_get_runtime_parameters_branches():
assert tool.get_runtime_parameters() == cached
tool.runtime_parameters = None
- manager = Mock()
returned = [
ToolParameter.get_simple_instance(
name="dyn",
@@ -89,7 +101,19 @@ def test_plugin_tool_get_runtime_parameters_branches():
required=False,
)
]
- manager.get_runtime_parameters.return_value = returned
- with patch("core.tools.plugin_tool.tool.PluginToolManager", return_value=manager):
- assert tool.get_runtime_parameters(conversation_id="c1", app_id="a1", message_id="m1") == returned
+ requests: list[httpx.Request] = []
+
+ def handle_request(request: httpx.Request) -> httpx.Response:
+ requests.append(request)
+ payload = {"code": 0, "message": "", "data": {"parameters": [returned[0].model_dump(mode="json")]}}
+ return httpx.Response(200, text=f"data: {json.dumps(payload)}\n\n")
+
+ with httpx.Client(transport=httpx.MockTransport(handle_request)) as client:
+ with patch.object(plugin_client_module, "_httpx_client", client):
+ assert tool.get_runtime_parameters(conversation_id="c1", app_id="a1", message_id="m1") == returned
assert tool.runtime_parameters == returned
+ assert len(requests) == 1
+ request_data = json.loads(requests[0].content)
+ assert request_data["conversation_id"] == "c1"
+ assert request_data["app_id"] == "a1"
+ assert request_data["message_id"] == "m1"
diff --git a/api/tests/unit_tests/core/tools/test_tool_engine.py b/api/tests/unit_tests/core/tools/test_tool_engine.py
index 941dbb22a7d..90195751a1d 100644
--- a/api/tests/unit_tests/core/tools/test_tool_engine.py
+++ b/api/tests/unit_tests/core/tools/test_tool_engine.py
@@ -2,7 +2,7 @@ from __future__ import annotations
from collections.abc import Generator
from typing import Any
-from unittest.mock import Mock, patch
+from unittest.mock import patch
from uuid import uuid4
import pytest
@@ -11,6 +11,8 @@ from sqlalchemy.engine import Engine
from sqlalchemy.orm import Session
from core.app.entities.app_invoke_entities import InvokeFrom
+from core.callback_handler.agent_tool_callback_handler import DifyAgentCallbackHandler
+from core.callback_handler.workflow_tool_callback_handler import DifyWorkflowCallbackHandler
from core.tools.__base.tool import Tool
from core.tools.__base.tool_runtime import ToolRuntime
from core.tools.entities.common_entities import I18nObject
@@ -276,8 +278,7 @@ def test_create_message_files_and_invoke_generator(sqlite_engine: Engine, sqlite
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_generic_invoke_success_and_error_paths(sqlite_session: Session):
tool = _build_tool()
- callback = Mock()
- callback.on_tool_execution.side_effect = lambda **kwargs: kwargs["tool_outputs"]
+ callback = DifyWorkflowCallbackHandler()
response = list(
ToolEngine.generic_invoke(
session=sqlite_session,
@@ -292,12 +293,9 @@ def test_generic_invoke_success_and_error_paths(sqlite_session: Session):
)
)
assert response[0].message.text == "ok"
- callback.on_tool_start.assert_called_once()
- callback.on_tool_execution.assert_called_once()
tool.raise_error = RuntimeError("boom")
- error_callback = Mock()
- error_callback.on_tool_execution.side_effect = lambda **kwargs: list(kwargs["tool_outputs"])
+ error_callback = DifyWorkflowCallbackHandler()
with pytest.raises(RuntimeError, match="boom"):
list(
ToolEngine.generic_invoke(
@@ -309,13 +307,12 @@ def test_generic_invoke_success_and_error_paths(sqlite_session: Session):
workflow_call_depth=0,
)
)
- error_callback.on_tool_error.assert_called_once()
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_agent_invoke_success(sqlite_session: Session):
tool = _build_tool(with_llm_parameter=True)
- callback = Mock()
+ callback = DifyAgentCallbackHandler()
message = _message()
meta = ToolInvokeMeta.empty()
@@ -340,14 +337,12 @@ def test_agent_invoke_success(sqlite_session: Session):
assert result_text == "ok"
assert message_files == []
assert result_meta.error is None
- callback.on_tool_start.assert_called_once()
- callback.on_tool_end.assert_called_once()
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_agent_invoke_param_validation_error(sqlite_session: Session):
tool = _build_tool(with_llm_parameter=True)
- callback = Mock()
+ callback = DifyAgentCallbackHandler()
message = _message()
with patch.object(ToolEngine, "_invoke", side_effect=ToolParameterValidationError("bad-param")):
@@ -370,7 +365,7 @@ def test_agent_invoke_param_validation_error(sqlite_session: Session):
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_agent_invoke_engine_meta_error(sqlite_session: Session):
tool = _build_tool(with_llm_parameter=True)
- callback = Mock()
+ callback = DifyAgentCallbackHandler()
message = _message()
engine_error = ToolEngineInvokeError(ToolInvokeMeta.error_instance("meta failure"))
@@ -416,7 +411,7 @@ def test_convert_tool_response_excludes_variable_messages():
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_agent_invoke_tool_invoke_error(sqlite_session: Session):
tool = _build_tool(with_llm_parameter=True)
- callback = Mock()
+ callback = DifyAgentCallbackHandler()
message = _message()
with patch.object(ToolEngine, "_invoke", side_effect=ToolInvokeError("invoke boom")):