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 dataset tool callbacks and sessions (#43366)

Asuka Minato70ef9cbd5d3f
diff --git a/api/tests/unit_tests/core/tools/test_custom_tool_provider.py b/api/tests/unit_tests/core/tools/test_custom_tool_provider.py
index cd299047da3..ffb7a2a8bb9 100644
--- a/api/tests/unit_tests/core/tools/test_custom_tool_provider.py
+++ b/api/tests/unit_tests/core/tools/test_custom_tool_provider.py
@@ -4,7 +4,6 @@ from __future__ import annotations
import json
from dataclasses import dataclass
-from unittest.mock import MagicMock
from uuid import uuid4
import pytest
@@ -70,9 +69,9 @@ def _persist_provider(session: Session, *, tenant_id: str, name: str = "provider
return provider
-def test_api_tool_provider_from_db_and_parse_tool_bundle() -> None:
+def test_api_tool_provider_from_db_and_parse_tool_bundle(sqlite_session: Session) -> None:
controller = ApiToolProviderController.from_db(
- _db_provider(), ApiProviderAuthType.API_KEY_HEADER, session=MagicMock()
+ _db_provider(), ApiProviderAuthType.API_KEY_HEADER, session=sqlite_session
)
assert controller.provider_type == ToolProviderType.API
assert any(c.name == "api_key_value" for c in controller.entity.credentials_schema)
@@ -82,20 +81,22 @@ def test_api_tool_provider_from_db_and_parse_tool_bundle() -> None:
assert tool.entity.identity.provider == "provider-id"
-def test_api_tool_provider_from_db_query_auth_and_none_auth() -> None:
+def test_api_tool_provider_from_db_query_auth_and_none_auth(sqlite_session: Session) -> None:
query_controller = ApiToolProviderController.from_db(
- _db_provider(), ApiProviderAuthType.API_KEY_QUERY, session=MagicMock()
+ _db_provider(), ApiProviderAuthType.API_KEY_QUERY, session=sqlite_session
)
assert any(c.name == "api_key_query_param" for c in query_controller.entity.credentials_schema)
- none_controller = ApiToolProviderController.from_db(_db_provider(), ApiProviderAuthType.NONE, session=MagicMock())
+ none_controller = ApiToolProviderController.from_db(
+ _db_provider(), ApiProviderAuthType.NONE, session=sqlite_session
+ )
assert [c.name for c in none_controller.entity.credentials_schema] == ["auth_type"]
def test_api_tool_provider_load_get_tools_and_get_tool(
monkeypatch: pytest.MonkeyPatch, sqlite_session: Session
) -> None:
- controller = ApiToolProviderController.from_db(_db_provider(), ApiProviderAuthType.NONE, session=MagicMock())
+ controller = ApiToolProviderController.from_db(_db_provider(), ApiProviderAuthType.NONE, session=sqlite_session)
loaded = controller.load_bundled_tools(_db_provider().tools)
assert len(loaded) == 1
diff --git a/api/tests/unit_tests/core/tools/test_dataset_retriever_tool.py b/api/tests/unit_tests/core/tools/test_dataset_retriever_tool.py
index 71b17c96698..5af06f9c587 100644
--- a/api/tests/unit_tests/core/tools/test_dataset_retriever_tool.py
+++ b/api/tests/unit_tests/core/tools/test_dataset_retriever_tool.py
@@ -2,21 +2,53 @@
from __future__ import annotations
-from types import SimpleNamespace
-from unittest.mock import Mock, patch
+from unittest.mock import patch
import pytest
from sqlalchemy.orm import Session
from core.app.app_config.entities import DatasetRetrieveConfigEntity
+from core.app.apps.message_based_app_queue_manager import MessageBasedAppQueueManager
from core.app.entities.app_invoke_entities import InvokeFrom
+from core.callback_handler.index_tool_callback_handler import DatasetIndexToolCallbackHandler
+from core.rag.retrieval.dataset_retrieval import DatasetRetrieval
+from core.tools.utils.dataset_retriever.dataset_retriever_tool import DatasetRetrieverTool as RetrievalTool
from core.tools.utils.dataset_retriever_tool import DatasetRetrieverTool
+from models.model import AppMode
def _retrieve_config() -> DatasetRetrieveConfigEntity:
return DatasetRetrieveConfigEntity(retrieve_strategy=DatasetRetrieveConfigEntity.RetrieveStrategy.MULTIPLE)
+def _hit_callback() -> DatasetIndexToolCallbackHandler:
+ with patch("core.app.apps.base_app_queue_manager.redis_client.setex"):
+ queue_manager = MessageBasedAppQueueManager(
+ task_id="task",
+ user_id="u",
+ invoke_from=InvokeFrom.DEBUGGER,
+ conversation_id="conversation",
+ app_mode=AppMode.CHAT,
+ message_id="message",
+ )
+ return DatasetIndexToolCallbackHandler(
+ queue_manager=queue_manager, app_id="app", message_id="message", user_id="u", invoke_from=InvokeFrom.DEBUGGER
+ )
+
+
+def _retrieval_tool() -> RetrievalTool:
+ return RetrievalTool(
+ name="dataset_tool",
+ description="desc",
+ tenant_id="tenant",
+ dataset_id="d1",
+ retrieve_config=_retrieve_config(),
+ inputs={},
+ return_resource=False,
+ retriever_from="dev",
+ )
+
+
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)
def test_get_dataset_tools_returns_empty_for_empty_dataset_ids(sqlite_session: Session) -> None:
# Arrange
@@ -30,7 +62,7 @@ def test_get_dataset_tools_returns_empty_for_empty_dataset_ids(sqlite_session: S
retrieve_config=retrieve_config,
return_resource=False,
invoke_from=InvokeFrom.DEBUGGER,
- hit_callback=Mock(),
+ hit_callback=_hit_callback(),
user_id="u",
inputs={},
)
@@ -52,7 +84,7 @@ def test_get_dataset_tools_returns_empty_for_missing_retrieve_config(sqlite_sess
retrieve_config=None, # type: ignore[arg-type]
return_resource=False,
invoke_from=InvokeFrom.DEBUGGER,
- hit_callback=Mock(),
+ hit_callback=_hit_callback(),
user_id="u",
inputs={},
)
@@ -65,12 +97,10 @@ def test_get_dataset_tools_returns_empty_for_missing_retrieve_config(sqlite_sess
def test_get_dataset_tools_builds_tool_and_restores_strategy(sqlite_session: Session) -> None:
# Arrange
retrieve_config = _retrieve_config()
- retrieval_tool = SimpleNamespace(name="dataset_tool", description="desc", run=lambda query: f"result:{query}")
- feature = Mock()
- feature.to_dataset_retriever_tool.return_value = [retrieval_tool]
+ retrieval_tool = _retrieval_tool()
# Act
- with patch("core.tools.utils.dataset_retriever_tool.DatasetRetrieval", return_value=feature):
+ with patch.object(DatasetRetrieval, "to_dataset_retriever_tool", return_value=[retrieval_tool]):
tools = DatasetRetrieverTool.get_dataset_tools(
session=sqlite_session,
tenant_id="tenant",
@@ -78,7 +108,7 @@ def test_get_dataset_tools_builds_tool_and_restores_strategy(sqlite_session: Ses
retrieve_config=retrieve_config,
return_resource=True,
invoke_from=InvokeFrom.DEBUGGER,
- hit_callback=Mock(),
+ hit_callback=_hit_callback(),
user_id="u",
inputs={"x": 1},
)
@@ -89,15 +119,9 @@ def test_get_dataset_tools_builds_tool_and_restores_strategy(sqlite_session: Ses
assert retrieve_config.retrieve_strategy == DatasetRetrieveConfigEntity.RetrieveStrategy.MULTIPLE
-def _build_dataset_tool(sqlite_session: Session) -> tuple[DatasetRetrieverTool, SimpleNamespace]:
- retrieval_tool = SimpleNamespace(
- name="dataset_tool",
- description="desc",
- run=lambda session, query: f"result:{query}",
- )
- feature = Mock()
- feature.to_dataset_retriever_tool.return_value = [retrieval_tool]
- with patch("core.tools.utils.dataset_retriever_tool.DatasetRetrieval", return_value=feature):
+def _build_dataset_tool(sqlite_session: Session) -> tuple[DatasetRetrieverTool, RetrievalTool]:
+ retrieval_tool = _retrieval_tool()
+ with patch.object(DatasetRetrieval, "to_dataset_retriever_tool", return_value=[retrieval_tool]):
tools = DatasetRetrieverTool.get_dataset_tools(
session=sqlite_session,
tenant_id="tenant",
@@ -105,7 +129,7 @@ def _build_dataset_tool(sqlite_session: Session) -> tuple[DatasetRetrieverTool,
retrieve_config=_retrieve_config(),
return_resource=False,
invoke_from=InvokeFrom.DEBUGGER,
- hit_callback=Mock(),
+ hit_callback=_hit_callback(),
user_id="u",
inputs={},
)
@@ -144,11 +168,13 @@ def test_query_invocation_result(sqlite_session: Session) -> None:
tool, _ = _build_dataset_tool(sqlite_session)
# Act
- result = list(tool.invoke(session=sqlite_session, user_id="u", tool_parameters={"query": "hello"}))
+ with patch.object(RetrievalTool, "_run", return_value="result:hello") as retrieve:
+ result = list(tool.invoke(session=sqlite_session, user_id="u", tool_parameters={"query": "hello"}))
# Assert
assert len(result) == 1
assert result[0].message.text == "result:hello"
+ retrieve.assert_called_once_with(sqlite_session, "hello")
@pytest.mark.parametrize("sqlite_session", [()], indirect=True)