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 core extension tests (#43887)

Eddy ZHANGf9e45591bdc4
diff --git a/api/tests/unit_tests/core/extension/test_extensible.py b/api/tests/unit_tests/core/extension/test_extensible.py
index 9bce0cd7c83..2f8c9aca3cd 100644
--- a/api/tests/unit_tests/core/extension/test_extensible.py
+++ b/api/tests/unit_tests/core/extension/test_extensible.py
@@ -8,7 +8,7 @@ from core.extension.extensible import Extensible
class TestExtensible:
- def test_init(self):
+ def test_init(self) -> None:
tenant_id = "tenant_123"
config = {"key": "value"}
ext = Extensible(tenant_id, config)
@@ -22,18 +22,16 @@ class TestExtensible:
@patch("core.extension.extensible.os.path.exists")
@patch("core.extension.extensible.Path.read_text")
@patch("core.extension.extensible.importlib.util.module_from_spec")
- @patch("core.extension.extensible.sort_to_dict_by_position_map")
def test_scan_extensions_success(
self,
- mock_sort,
- mock_module_from_spec,
- mock_read_text,
- mock_exists,
- mock_isdir,
- mock_listdir,
- mock_dirname,
- mock_find_spec,
- ):
+ mock_module_from_spec: MagicMock,
+ mock_read_text: MagicMock,
+ mock_exists: MagicMock,
+ mock_isdir: MagicMock,
+ mock_listdir: MagicMock,
+ mock_dirname: MagicMock,
+ mock_find_spec: MagicMock,
+ ) -> None:
# Setup
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
@@ -59,23 +57,21 @@ class TestExtensible:
class MockExtension(Extensible):
pass
- mock_mod.MockExtension = MockExtension
+ vars(mock_mod)["MockExtension"] = MockExtension
mock_module_from_spec.return_value = mock_mod
- mock_sort.side_effect = lambda position_map, data, name_func: data
-
# Execute
results = Extensible.scan_extensions()
# Assert
assert len(results) == 1
- assert results[0].name == "ext1"
- assert results[0].position == 10
- assert results[0].builtin is True
- assert results[0].extension_class == MockExtension
+ assert results["ext1"].name == "ext1"
+ assert results["ext1"].position == 10
+ assert results["ext1"].builtin is True
+ assert results["ext1"].extension_class == MockExtension
@patch("core.extension.extensible.importlib.util.find_spec")
- def test_scan_extensions_package_not_found(self, mock_find_spec):
+ def test_scan_extensions_package_not_found(self, mock_find_spec: MagicMock) -> None:
mock_find_spec.return_value = None
with pytest.raises(ImportError, match="Could not find package"):
Extensible.scan_extensions()
@@ -84,19 +80,20 @@ class TestExtensible:
@patch("core.extension.extensible.os.path.dirname")
@patch("core.extension.extensible.os.listdir")
@patch("core.extension.extensible.os.path.isdir")
- def test_scan_extensions_skip_subdirs(self, mock_isdir, mock_listdir, mock_dirname, mock_find_spec):
+ def test_scan_extensions_skip_subdirs(
+ self, mock_isdir: MagicMock, mock_listdir: MagicMock, mock_dirname: MagicMock, mock_find_spec: MagicMock
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
mock_find_spec.return_value = package_spec
mock_dirname.return_value = "/path/to/pkg"
- mock_listdir.side_effect = [["__pycache__", "not_a_dir", "missing_py_file"], []]
+ mock_listdir.side_effect = [["__pycache__", "not_a_dir", "missing_py_file"], list[str]()]
mock_isdir.side_effect = [False, True]
- with patch("core.extension.extensible.sort_to_dict_by_position_map", return_value=[]):
- results = Extensible.scan_extensions()
- assert len(results) == 0
+ results = Extensible.scan_extensions()
+ assert len(results) == 0
@patch("core.extension.extensible.importlib.util.find_spec")
@patch("core.extension.extensible.os.path.dirname")
@@ -105,8 +102,14 @@ class TestExtensible:
@patch("core.extension.extensible.os.path.exists")
@patch("core.extension.extensible.importlib.util.module_from_spec")
def test_scan_extensions_not_builtin_success(
- self, mock_module_from_spec, mock_exists, mock_isdir, mock_listdir, mock_dirname, mock_find_spec
- ):
+ self,
+ mock_module_from_spec: MagicMock,
+ mock_exists: MagicMock,
+ mock_isdir: MagicMock,
+ mock_listdir: MagicMock,
+ mock_dirname: MagicMock,
+ mock_find_spec: MagicMock,
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
@@ -127,24 +130,18 @@ class TestExtensible:
class MockExtension(Extensible):
pass
- mock_mod.MockExtension = MockExtension
+ vars(mock_mod)["MockExtension"] = MockExtension
mock_module_from_spec.return_value = mock_mod
schema_content = json.dumps({"label": {"en": "Test"}, "form_schema": [{"name": "field1"}]})
- with (
- patch("builtins.open", mock_open(read_data=schema_content)),
- patch(
- "core.extension.extensible.sort_to_dict_by_position_map",
- side_effect=lambda position_map, data, name_func: data,
- ),
- ):
+ with patch("builtins.open", mock_open(read_data=schema_content)):
results = Extensible.scan_extensions()
assert len(results) == 1
- assert results[0].name == "ext1"
- assert results[0].builtin is False
- assert results[0].label == {"en": "Test"}
+ assert results["ext1"].name == "ext1"
+ assert results["ext1"].builtin is False
+ assert results["ext1"].label == {"en": "Test"}
@patch("core.extension.extensible.importlib.util.find_spec")
@patch("core.extension.extensible.os.path.dirname")
@@ -153,8 +150,14 @@ class TestExtensible:
@patch("core.extension.extensible.os.path.exists")
@patch("core.extension.extensible.importlib.util.module_from_spec")
def test_scan_extensions_not_builtin_missing_schema(
- self, mock_module_from_spec, mock_exists, mock_isdir, mock_listdir, mock_dirname, mock_find_spec
- ):
+ self,
+ mock_module_from_spec: MagicMock,
+ mock_exists: MagicMock,
+ mock_isdir: MagicMock,
+ mock_listdir: MagicMock,
+ mock_dirname: MagicMock,
+ mock_find_spec: MagicMock,
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
@@ -175,11 +178,10 @@ class TestExtensible:
class MockExtension(Extensible):
pass
- mock_mod.MockExtension = MockExtension
+ vars(mock_mod)["MockExtension"] = MockExtension
mock_module_from_spec.return_value = mock_mod
- with patch("core.extension.extensible.sort_to_dict_by_position_map", return_value=[]):
- results = Extensible.scan_extensions()
+ results = Extensible.scan_extensions()
assert len(results) == 0
@@ -190,8 +192,14 @@ class TestExtensible:
@patch("core.extension.extensible.importlib.util.module_from_spec")
@patch("core.extension.extensible.os.path.exists")
def test_scan_extensions_no_extension_class(
- self, mock_exists, mock_module_from_spec, mock_isdir, mock_listdir, mock_dirname, mock_find_spec
- ):
+ self,
+ mock_exists: MagicMock,
+ mock_module_from_spec: MagicMock,
+ mock_isdir: MagicMock,
+ mock_listdir: MagicMock,
+ mock_dirname: MagicMock,
+ mock_find_spec: MagicMock,
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
module_spec = MagicMock()
@@ -207,13 +215,12 @@ class TestExtensible:
mock_exists.return_value = False
mock_mod = types.ModuleType("ext1")
- mock_mod.SomeOtherClass = type("SomeOtherClass", (), {})
+ vars(mock_mod)["SomeOtherClass"] = type("SomeOtherClass", (), {})
mock_module_from_spec.return_value = mock_mod
# We need to ensure we don't crash if checking schema (but we won't reach there because class not found)
- with patch("core.extension.extensible.sort_to_dict_by_position_map", return_value=[]):
- results = Extensible.scan_extensions()
+ results = Extensible.scan_extensions()
assert len(results) == 0
@@ -221,7 +228,9 @@ class TestExtensible:
@patch("core.extension.extensible.os.path.dirname")
@patch("core.extension.extensible.os.listdir")
@patch("core.extension.extensible.os.path.isdir")
- def test_scan_extensions_module_import_error(self, mock_isdir, mock_listdir, mock_dirname, mock_find_spec):
+ def test_scan_extensions_module_import_error(
+ self, mock_isdir: MagicMock, mock_listdir: MagicMock, mock_dirname: MagicMock, mock_find_spec: MagicMock
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
@@ -235,7 +244,7 @@ class TestExtensible:
Extensible.scan_extensions()
@patch("core.extension.extensible.importlib.util.find_spec")
- def test_scan_extensions_general_exception(self, mock_find_spec):
+ def test_scan_extensions_general_exception(self, mock_find_spec: MagicMock) -> None:
mock_find_spec.side_effect = Exception("Unexpected error")
with pytest.raises(Exception, match="Unexpected error"):
Extensible.scan_extensions()
@@ -248,8 +257,15 @@ class TestExtensible:
@patch("core.extension.extensible.Path.read_text")
@patch("core.extension.extensible.importlib.util.module_from_spec")
def test_scan_extensions_builtin_without_position_file(
- self, mock_module_from_spec, mock_read_text, mock_exists, mock_isdir, mock_listdir, mock_dirname, mock_find_spec
- ):
+ self,
+ mock_module_from_spec: MagicMock,
+ mock_read_text: MagicMock,
+ mock_exists: MagicMock,
+ mock_isdir: MagicMock,
+ mock_listdir: MagicMock,
+ mock_dirname: MagicMock,
+ mock_find_spec: MagicMock,
+ ) -> None:
package_spec = MagicMock()
package_spec.origin = "/path/to/pkg/__init__.py"
module_spec = MagicMock()
@@ -268,14 +284,10 @@ class TestExtensible:
class MockExtension(Extensible):
pass
- mock_mod.MockExtension = MockExtension
+ vars(mock_mod)["MockExtension"] = MockExtension
mock_module_from_spec.return_value = mock_mod
- with patch(
- "core.extension.extensible.sort_to_dict_by_position_map",
- side_effect=lambda position_map, data, name_func: data,
- ):
- results = Extensible.scan_extensions()
+ results = Extensible.scan_extensions()
assert len(results) == 1
- assert results[0].position == 0
+ assert results["ext1"].position == 0
diff --git a/api/tests/unit_tests/core/extension/test_extension.py b/api/tests/unit_tests/core/extension/test_extension.py
index 4ad32d38406..8933898468d 100644
--- a/api/tests/unit_tests/core/extension/test_extension.py
+++ b/api/tests/unit_tests/core/extension/test_extension.py
@@ -7,11 +7,11 @@ from core.extension.extension import Extension
class TestExtension:
- def setup_method(self):
+ def setup_method(self) -> None:
# Reset the private class attribute before each test
Extension._Extension__module_extensions = {}
- def test_init(self):
+ def test_init(self) -> None:
# Mock scan_extensions for Moderation and ExternalDataTool
mock_mod_extensions = {"mod1": ModuleExtension(name="mod1")}
mock_ext_extensions = {"ext1": ModuleExtension(name="ext1")}
@@ -25,12 +25,13 @@ class TestExtension:
):
extension.init()
- # Check if internal state is updated
- internal_state = Extension._Extension__module_extensions
- assert internal_state[ExtensionModule.MODERATION.value] == mock_mod_extensions
- assert internal_state[ExtensionModule.EXTERNAL_DATA_TOOL.value] == mock_ext_extensions
+ # Check the scanned extensions are exposed per module, keyed by extension name
+ moderation = extension.module_extensions(ExtensionModule.MODERATION.value)
+ external_data_tool = extension.module_extensions(ExtensionModule.EXTERNAL_DATA_TOOL.value)
+ assert {e.name: e for e in moderation} == mock_mod_extensions
+ assert {e.name: e for e in external_data_tool} == mock_ext_extensions
- def test_module_extensions_success(self):
+ def test_module_extensions_success(self) -> None:
# Setup data
mock_extensions = {"name1": ModuleExtension(name="name1"), "name2": ModuleExtension(name="name2")}
Extension._Extension__module_extensions = {ExtensionModule.MODERATION.value: mock_extensions}
@@ -42,12 +43,12 @@ class TestExtension:
assert any(e.name == "name1" for e in result)
assert any(e.name == "name2" for e in result)
- def test_module_extensions_not_found(self):
+ def test_module_extensions_not_found(self) -> None:
extension = Extension()
with pytest.raises(ValueError, match="Extension Module unknown not found"):
extension.module_extensions("unknown")
- def test_module_extension_success(self):
+ def test_module_extension_success(self) -> None:
mock_ext = ModuleExtension(name="test_ext")
Extension._Extension__module_extensions = {ExtensionModule.MODERATION.value: {"test_ext": mock_ext}}
@@ -55,13 +56,13 @@ class TestExtension:
result = extension.module_extension(ExtensionModule.MODERATION, "test_ext")
assert result == mock_ext
- def test_module_extension_module_not_found(self):
+ def test_module_extension_module_not_found(self) -> None:
extension = Extension()
# ExtensionModule.MODERATION is "moderation"
with pytest.raises(ValueError, match="Extension Module moderation not found"):
extension.module_extension(ExtensionModule.MODERATION, "any")
- def test_module_extension_extension_not_found(self):
+ def test_module_extension_extension_not_found(self) -> None:
# We need a non-empty dict because 'if not module_extensions' in extension.py
# returns True for an empty dict, which raises the module not found error instead.
Extension._Extension__module_extensions = {ExtensionModule.MODERATION.value: {"other": MagicMock()}}
@@ -70,7 +71,7 @@ class TestExtension:
with pytest.raises(ValueError, match="Extension unknown not found"):
extension.module_extension(ExtensionModule.MODERATION, "unknown")
- def test_extension_class_success(self):
+ def test_extension_class_success(self) -> None:
class MockClass:
pass
@@ -81,7 +82,7 @@ class TestExtension:
result = extension.extension_class(ExtensionModule.MODERATION, "test_ext")
assert result == MockClass
- def test_extension_class_none(self):
+ def test_extension_class_none(self) -> None:
mock_ext = ModuleExtension(name="test_ext", extension_class=None)
Extension._Extension__module_extensions = {ExtensionModule.MODERATION.value: {"test_ext": mock_ext}}
diff --git a/api/tests/unit_tests/pyrefly.toml b/api/tests/unit_tests/pyrefly.toml
index 56d90609a20..5096ab70bd0 100644
--- a/api/tests/unit_tests/pyrefly.toml
+++ b/api/tests/unit_tests/pyrefly.toml
@@ -325,8 +325,6 @@ project-excludes = [
"core/entities/test_entities_mcp_provider.py",
"core/entities/test_entities_provider_configuration.py",
"core/extension/test_api_based_extension_requestor.py",
- "core/extension/test_extensible.py",
- "core/extension/test_extension.py",
"core/external_data_tool/test_external_data_fetch.py",
"core/external_data_tool/test_factory.py",
"core/file/test_models.py",