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.

refactor(api): enable strict typing for agent strategy tests (#43915)

Eddy ZHANGd562cc0375e3
diff --git a/api/tests/unit_tests/core/agent/strategy/test_base.py b/api/tests/unit_tests/core/agent/strategy/test_base.py
index 83ff79e8a1e..6d3ac55d39b 100644
--- a/api/tests/unit_tests/core/agent/strategy/test_base.py
+++ b/api/tests/unit_tests/core/agent/strategy/test_base.py
@@ -1,9 +1,11 @@
-from collections.abc import Generator
+from collections.abc import Generator, Sequence
from unittest.mock import MagicMock
import pytest
+from core.agent.entities import AgentInvokeMessage
from core.agent.strategy.base import BaseAgentStrategy
+from core.plugin.entities.request import InvokeCredentials
class DummyStrategy(BaseAgentStrategy):
@@ -11,20 +13,22 @@ class DummyStrategy(BaseAgentStrategy):
Concrete implementation for testing BaseAgentStrategy
"""
- def __init__(self, return_values=None, raise_exception=None):
+ def __init__(
+ self, return_values: Sequence[AgentInvokeMessage] | None = None, raise_exception: Exception | None = None
+ ) -> None:
self.return_values = return_values or []
self.raise_exception = raise_exception
- self.received_args = None
+ self.received_args: tuple[object, ...] | None = None
def _invoke(
self,
- params,
- user_id,
- conversation_id=None,
- app_id=None,
- message_id=None,
- credentials=None,
- ) -> Generator:
+ params: dict[str, object],
+ user_id: str,
+ conversation_id: str | None = None,
+ app_id: str | None = None,
+ message_id: str | None = None,
+ credentials: InvokeCredentials | None = None,
+ ) -> Generator[AgentInvokeMessage]:
self.received_args = (
params,
user_id,
@@ -43,16 +47,16 @@ class DummyStrategy(BaseAgentStrategy):
class TestBaseAgentStrategyInstantiation:
def test_cannot_instantiate_abstract_class(self) -> None:
with pytest.raises(TypeError):
- BaseAgentStrategy()
+ BaseAgentStrategy() # pyrefly: ignore[bad-instantiation]
class TestBaseAgentStrategyInvoke:
@pytest.fixture
- def mock_message(self):
+ def mock_message(self) -> MagicMock:
return MagicMock(name="AgentInvokeMessage")
@pytest.fixture
- def mock_credentials(self):
+ def mock_credentials(self) -> MagicMock:
return MagicMock(name="InvokeCredentials")
@pytest.mark.parametrize(
@@ -66,13 +70,13 @@ class TestBaseAgentStrategyInvoke:
)
def test_invoke_success(
self,
- mock_message,
- mock_credentials,
- params,
- user_id,
- conversation_id,
- app_id,
- message_id,
+ mock_message: MagicMock,
+ mock_credentials: MagicMock,
+ params: dict[str, object],
+ user_id: str,
+ conversation_id: str | None,
+ app_id: str | None,
+ message_id: str | None,
) -> None:
# Arrange
strategy = DummyStrategy(return_values=[mock_message])
@@ -100,7 +104,7 @@ class TestBaseAgentStrategyInvoke:
mock_credentials,
)
- def test_invoke_multiple_yields(self, mock_message) -> None:
+ def test_invoke_multiple_yields(self, mock_message: MagicMock) -> None:
# Arrange
messages = [mock_message, MagicMock(), MagicMock()]
strategy = DummyStrategy(return_values=messages)
@@ -138,20 +142,20 @@ class TestBaseAgentStrategyInvoke:
[],
],
)
- def test_invoke_invalid_params_type_pass_through(self, invalid_params) -> None:
+ def test_invoke_invalid_params_type_pass_through(self, invalid_params: object) -> None:
"""
Base class does not validate types — ensure pass-through behavior
"""
strategy = DummyStrategy(return_values=[])
- result = list(strategy.invoke(params=invalid_params, user_id="user"))
+ result = list(strategy.invoke(params=invalid_params, user_id="user")) # pyrefly: ignore[bad-argument-type]
assert result == []
def test_invoke_none_user_id(self) -> None:
strategy = DummyStrategy(return_values=[])
- result = list(strategy.invoke(params={}, user_id=None))
+ result = list(strategy.invoke(params={}, user_id=None)) # pyrefly: ignore[bad-argument-type]
assert result == []
diff --git a/api/tests/unit_tests/core/agent/strategy/test_plugin.py b/api/tests/unit_tests/core/agent/strategy/test_plugin.py
index 55d4ffcb263..b08f81b4b06 100644
--- a/api/tests/unit_tests/core/agent/strategy/test_plugin.py
+++ b/api/tests/unit_tests/core/agent/strategy/test_plugin.py
@@ -1,5 +1,6 @@
# File: tests/unit_tests/core/agent/strategy/test_plugin.py
+from collections.abc import Callable
from unittest.mock import MagicMock
import pytest
@@ -15,8 +16,8 @@ from core.tools.entities.common_entities import I18nObject
@pytest.fixture
-def mock_parameter():
- def _factory(name="param", return_value="initialized"):
+def mock_parameter() -> Callable[..., MagicMock]:
+ def _factory(name: str = "param", return_value: object = "initialized") -> MagicMock:
param = MagicMock()
param.name = name
param.init_frontend_parameter = MagicMock(return_value=return_value)
@@ -26,7 +27,7 @@ def mock_parameter():
@pytest.fixture
-def mock_declaration(mock_parameter):
+def mock_declaration(mock_parameter: Callable[..., MagicMock]) -> MagicMock:
param1 = mock_parameter("param1", "init1")
param2 = mock_parameter("param2", "init2")
@@ -42,7 +43,7 @@ def mock_declaration(mock_parameter):
@pytest.fixture
-def strategy(mock_declaration):
+def strategy(mock_declaration: MagicMock) -> PluginAgentStrategy:
return PluginAgentStrategy(
tenant_id="tenant_123",
declaration=mock_declaration,
@@ -56,7 +57,7 @@ def strategy(mock_declaration):
class TestPluginAgentStrategyInitialization:
- def test_init_sets_attributes(self, mock_declaration) -> None:
+ def test_init_sets_attributes(self, mock_declaration: MagicMock) -> None:
strategy = PluginAgentStrategy(
tenant_id="tenant_test",
declaration=mock_declaration,
@@ -67,7 +68,7 @@ class TestPluginAgentStrategyInitialization:
assert strategy.declaration == mock_declaration
assert strategy.meta_version == "meta_v"
- def test_init_meta_version_none(self, mock_declaration) -> None:
+ def test_init_meta_version_none(self, mock_declaration: MagicMock) -> None:
strategy = PluginAgentStrategy(
tenant_id="tenant_test",
declaration=mock_declaration,
@@ -83,7 +84,9 @@ class TestPluginAgentStrategyInitialization:
class TestGetParameters:
- def test_get_parameters_returns_parameters(self, strategy: PluginAgentStrategy, mock_declaration) -> None:
+ def test_get_parameters_returns_parameters(
+ self, strategy: PluginAgentStrategy, mock_declaration: MagicMock
+ ) -> None:
result = strategy.get_parameters()
assert result == mock_declaration.parameters
@@ -94,7 +97,7 @@ class TestGetParameters:
class TestInitializeParameters:
- def test_initialize_parameters_success(self, strategy: PluginAgentStrategy, mock_declaration) -> None:
+ def test_initialize_parameters_success(self, strategy: PluginAgentStrategy, mock_declaration: MagicMock) -> None:
params = {"param1": "value1"}
result = strategy.initialize_parameters(params.copy())
@@ -127,7 +130,9 @@ class TestInitializeParameters:
{"param1": {}, "param2": "value"},
],
)
- def test_initialize_parameters_edge_cases(self, strategy: PluginAgentStrategy, input_params) -> None:
+ def test_initialize_parameters_edge_cases(
+ self, strategy: PluginAgentStrategy, input_params: dict[str, object]
+ ) -> None:
result = strategy.initialize_parameters(input_params.copy())
for param in strategy.declaration.parameters:
@@ -135,7 +140,7 @@ class TestInitializeParameters:
def test_initialize_parameters_invalid_input_type(self, strategy: PluginAgentStrategy) -> None:
with pytest.raises(AttributeError):
- strategy.initialize_parameters(None)
+ strategy.initialize_parameters(None) # pyrefly: ignore[bad-argument-type]
# ============================================================
@@ -228,7 +233,12 @@ class TestInvoke:
],
)
def test_invoke_optional_arguments(
- self, strategy, mocker: MockerFixture, conversation_id, app_id, message_id
+ self,
+ strategy: PluginAgentStrategy,
+ mocker: MockerFixture,
+ conversation_id: str | None,
+ app_id: str | None,
+ message_id: str | None,
) -> None:
mock_manager = MagicMock()
mock_manager.invoke = MagicMock(return_value=iter([]))
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 25dd6c4350b..9aad398ce5c 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -204,8 +204,6 @@ project-excludes = [
"controllers/web/test_wraps.py",
"core/agent/conftest.py",
"core/agent/output_parser/test_cot_output_parser.py",
- "core/agent/strategy/test_base.py",
- "core/agent/strategy/test_plugin.py",
"core/agent/test_base_agent_runner.py",
"core/agent/test_cot_agent_runner.py",
"core/agent/test_cot_chat_agent_runner.py",