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 external data tool tests (#43634)

Eddy ZHANGaf0e3d3cd961
diff --git a/api/tests/unit_tests/core/external_data_tool/api/test_api.py b/api/tests/unit_tests/core/external_data_tool/api/test_api.py
index c2c4dec519a..33a5c28b23d 100644
--- a/api/tests/unit_tests/core/external_data_tool/api/test_api.py
+++ b/api/tests/unit_tests/core/external_data_tool/api/test_api.py
@@ -1,4 +1,4 @@
-from unittest.mock import patch
+from unittest.mock import MagicMock, patch
import pytest
from sqlalchemy.orm import Session
@@ -41,27 +41,27 @@ def api_extension(sqlite_session: Session) -> APIBasedExtension:
return extension
-def test_api_external_data_tool_name():
+def test_api_external_data_tool_name() -> None:
assert ApiExternalDataTool.name == "api"
-def test_validate_config_success(api_extension: APIBasedExtension):
+def test_validate_config_success(api_extension: APIBasedExtension) -> None:
# Should not raise exception
ApiExternalDataTool.validate_config("tenant_id", {"api_based_extension_id": "ext_id"})
-def test_validate_config_missing_id():
+def test_validate_config_missing_id() -> None:
with pytest.raises(ValueError, match="api_based_extension_id is required"):
ApiExternalDataTool.validate_config("tenant_id", {})
-def test_validate_config_invalid_id():
+def test_validate_config_invalid_id() -> None:
with pytest.raises(ValueError, match="api_based_extension_id is invalid"):
ApiExternalDataTool.validate_config("tenant_id", {"api_based_extension_id": "ext_id"})
@pytest.fixture
-def api_tool():
+def api_tool() -> ApiExternalDataTool:
# Use standard kwargs as it inherits from ExternalDataTool which is typically a Pydantic BaseModel
return ApiExternalDataTool(
tenant_id="tenant_id", app_id="app_id", variable="var1", config={"api_based_extension_id": "ext_id"}
@@ -70,7 +70,12 @@ def api_tool():
@patch("core.external_data_tool.api.api.encrypter")
@patch("core.external_data_tool.api.api.APIBasedExtensionRequestor")
-def test_query_success(mock_requestor_class, mock_encrypter, api_tool, api_extension: APIBasedExtension):
+def test_query_success(
+ mock_requestor_class: MagicMock,
+ mock_encrypter: MagicMock,
+ api_tool: ApiExternalDataTool,
+ api_extension: APIBasedExtension,
+) -> None:
mock_encrypter.decrypt_token.return_value = "decrypted_key"
mock_requestor = mock_requestor_class.return_value
@@ -87,27 +92,32 @@ def test_query_success(mock_requestor_class, mock_encrypter, api_tool, api_exten
)
-def test_query_missing_config():
+def test_query_missing_config() -> None:
api_tool = ApiExternalDataTool(tenant_id="tenant_id", app_id="app_id", variable="var1")
api_tool.config = None # Force None
with pytest.raises(ValueError, match="config is required"):
api_tool.query({}, "")
-def test_query_missing_extension_id():
+def test_query_missing_extension_id() -> None:
api_tool = ApiExternalDataTool(tenant_id="tenant_id", app_id="app_id", variable="var1", config={"dummy": "value"})
with pytest.raises(AssertionError, match="api_based_extension_id is required"):
api_tool.query({}, "")
-def test_query_invalid_extension(api_tool):
+def test_query_invalid_extension(api_tool: ApiExternalDataTool) -> None:
with pytest.raises(ValueError, match=".*error: api_based_extension_id is invalid"):
api_tool.query({}, "")
@patch("core.external_data_tool.api.api.encrypter")
@patch("core.external_data_tool.api.api.APIBasedExtensionRequestor")
-def test_query_requestor_init_error(mock_requestor_class, mock_encrypter, api_tool, api_extension: APIBasedExtension):
+def test_query_requestor_init_error(
+ mock_requestor_class: MagicMock,
+ mock_encrypter: MagicMock,
+ api_tool: ApiExternalDataTool,
+ api_extension: APIBasedExtension,
+) -> None:
mock_encrypter.decrypt_token.return_value = "decrypted_key"
mock_requestor_class.side_effect = Exception("init error")
@@ -118,7 +128,12 @@ def test_query_requestor_init_error(mock_requestor_class, mock_encrypter, api_to
@patch("core.external_data_tool.api.api.encrypter")
@patch("core.external_data_tool.api.api.APIBasedExtensionRequestor")
-def test_query_no_result_in_response(mock_requestor_class, mock_encrypter, api_tool, api_extension: APIBasedExtension):
+def test_query_no_result_in_response(
+ mock_requestor_class: MagicMock,
+ mock_encrypter: MagicMock,
+ api_tool: ApiExternalDataTool,
+ api_extension: APIBasedExtension,
+) -> None:
mock_encrypter.decrypt_token.return_value = "decrypted_key"
mock_requestor = mock_requestor_class.return_value
@@ -130,7 +145,12 @@ def test_query_no_result_in_response(mock_requestor_class, mock_encrypter, api_t
@patch("core.external_data_tool.api.api.encrypter")
@patch("core.external_data_tool.api.api.APIBasedExtensionRequestor")
-def test_query_result_not_string(mock_requestor_class, mock_encrypter, api_tool, api_extension: APIBasedExtension):
+def test_query_result_not_string(
+ mock_requestor_class: MagicMock,
+ mock_encrypter: MagicMock,
+ api_tool: ApiExternalDataTool,
+ api_extension: APIBasedExtension,
+) -> None:
mock_encrypter.decrypt_token.return_value = "decrypted_key"
mock_requestor = mock_requestor_class.return_value
diff --git a/api/tests/unit_tests/core/external_data_tool/test_base.py b/api/tests/unit_tests/core/external_data_tool/test_base.py
index 5c932639b95..10f2995edd2 100644
--- a/api/tests/unit_tests/core/external_data_tool/test_base.py
+++ b/api/tests/unit_tests/core/external_data_tool/test_base.py
@@ -8,19 +8,19 @@ from core.external_data_tool.base import ExternalDataTool
class TestExternalDataTool:
- def test_module_attribute(self):
+ def test_module_attribute(self) -> None:
assert ExternalDataTool.module == ExtensionModule.EXTERNAL_DATA_TOOL
- def test_init(self):
+ def test_init(self) -> None:
# Create a concrete subclass to test init
class ConcreteTool(ExternalDataTool):
@classmethod
@override
- def validate_config(cls, tenant_id: str, config: dict[str, Any]):
+ def validate_config(cls, tenant_id: str, config: dict[str, Any]) -> None:
return super().validate_config(tenant_id, config)
@override
- def query(self, inputs: Mapping[str, Any], query: str | None = None):
+ def query(self, inputs: Mapping[str, Any], query: str | None = None) -> str:
return super().query(inputs, query)
tool = ConcreteTool(tenant_id="tenant_1", app_id="app_1", variable="var_1", config={"key": "value"})
@@ -29,12 +29,12 @@ class TestExternalDataTool:
assert tool.variable == "var_1"
assert tool.config == {"key": "value"}
- def test_init_without_config(self):
+ def test_init_without_config(self) -> None:
# Create a concrete subclass to test init
class ConcreteTool(ExternalDataTool):
@classmethod
@override
- def validate_config(cls, tenant_id: str, config: dict[str, Any]):
+ def validate_config(cls, tenant_id: str, config: dict[str, Any]) -> None:
pass
@override
@@ -47,11 +47,11 @@ class TestExternalDataTool:
assert tool.variable == "var_1"
assert tool.config is None
- def test_validate_config_raises_not_implemented(self):
+ def test_validate_config_raises_not_implemented(self) -> None:
class ConcreteTool(ExternalDataTool):
@classmethod
@override
- def validate_config(cls, tenant_id: str, config: dict[str, Any]):
+ def validate_config(cls, tenant_id: str, config: dict[str, Any]) -> None:
return super().validate_config(tenant_id, config)
@override
@@ -61,11 +61,11 @@ class TestExternalDataTool:
with pytest.raises(NotImplementedError):
ConcreteTool.validate_config("tenant_1", {})
- def test_query_raises_not_implemented(self):
+ def test_query_raises_not_implemented(self) -> None:
class ConcreteTool(ExternalDataTool):
@classmethod
@override
- def validate_config(cls, tenant_id: str, config: dict[str, Any]):
+ def validate_config(cls, tenant_id: str, config: dict[str, Any]) -> None:
pass
@override
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 6c07a7561ea..52d9b303870 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -354,8 +354,6 @@ project-excludes = [
"core/extension/test_api_based_extension_requestor.py",
"core/extension/test_extensible.py",
"core/extension/test_extension.py",
- "core/external_data_tool/api/test_api.py",
- "core/external_data_tool/test_base.py",
"core/external_data_tool/test_external_data_fetch.py",
"core/external_data_tool/test_factory.py",
"core/file/test_models.py",