mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-08-28 05:25:04 +00:00
efcc2b34d1
Some checks are pending
CI / Documentation / Test and build documentation (push) Waiting to run
CI / Python quality / Pre-commit (push) Waiting to run
CI / Python tests / Unit Tests - py3.11 (push) Waiting to run
CI / Python tests / Unit Tests - py3.12 (push) Waiting to run
CI / Python tests / Unit Tests - py3.13 (push) Waiting to run
CI / Windows / CLI smoke - py3.11 (push) Waiting to run
Deploy / Documentation / Build documentation (push) Waiting to run
Deploy / Documentation / deploy (push) Blocked by required conditions
Security / CodeQL / Analyze javascript-typescript (push) Waiting to run
Security / CodeQL / Analyze python (push) Waiting to run
* feat: simplify plugin setup and add management CLI * fix: isolate plugin CLI import side effects * refactor: streamline plugin validation * fix: route plugin CLI arguments independently * fix: support standard plugin source layouts
297 lines
10 KiB
Python
297 lines
10 KiB
Python
"""Tests for local plugin package management commands."""
|
|
|
|
# pylint: disable=missing-class-docstring,missing-function-docstring,protected-access
|
|
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
|
|
from reme import plugin_cli as plugin_cli_module
|
|
from reme import reme as reme_module
|
|
from reme.components import R
|
|
from reme.enumeration import ComponentEnum
|
|
|
|
|
|
class _FakeDistribution:
|
|
def __init__(self, root: Path, name: str = "reme-auto-fin", version: str = "0.1.0") -> None:
|
|
self.root = root
|
|
self.metadata = {"Name": name}
|
|
self.version = version
|
|
|
|
def locate_file(self, relative: Path) -> Path:
|
|
return self.root / relative
|
|
|
|
|
|
class _FakeEntryPoint:
|
|
def __init__(self, name: str, value: str, distribution: _FakeDistribution) -> None:
|
|
self.name = name
|
|
self.value = value
|
|
self.dist = distribution
|
|
|
|
|
|
class _FakeEntryPoints(list):
|
|
def select(self, *, group):
|
|
assert group == "reme.plugins"
|
|
return self
|
|
|
|
|
|
def _install_manifest(tmp_path: Path) -> _FakeEntryPoint:
|
|
package = tmp_path / "reme_auto_fin"
|
|
package.mkdir()
|
|
(package / "plugin.yaml").write_text(
|
|
"backends:\n"
|
|
" auto_fin_step: reme_auto_fin.step:AutoFinStep\n"
|
|
"application_defaults:\n"
|
|
" jobs:\n"
|
|
" auto_fin:\n"
|
|
" backend: base\n",
|
|
encoding="utf-8",
|
|
)
|
|
return _FakeEntryPoint("auto-fin", "reme_auto_fin", _FakeDistribution(tmp_path))
|
|
|
|
|
|
def test_list_plugins_does_not_load_plugin_code(monkeypatch, tmp_path, capsys):
|
|
entry = _install_manifest(tmp_path)
|
|
monkeypatch.setattr(
|
|
plugin_cli_module.metadata,
|
|
"entry_points",
|
|
lambda: _FakeEntryPoints([entry]),
|
|
)
|
|
|
|
assert plugin_cli_module.plugin_cli(["list"]) == 0
|
|
|
|
output = capsys.readouterr().out
|
|
assert "auto-fin" in output
|
|
assert "reme-auto-fin" in output
|
|
assert "manifest" in output
|
|
|
|
|
|
def test_list_plugins_marks_configured_plugins(monkeypatch, tmp_path, capsys):
|
|
entry = _install_manifest(tmp_path)
|
|
monkeypatch.setattr(
|
|
plugin_cli_module.metadata,
|
|
"entry_points",
|
|
lambda: _FakeEntryPoints([entry]),
|
|
)
|
|
monkeypatch.setattr(plugin_cli_module, "_enabled_plugins", lambda _config: {"auto-fin"})
|
|
|
|
assert plugin_cli_module.plugin_cli(["list", "--config", "daily_cookbook"]) == 0
|
|
|
|
output = capsys.readouterr().out
|
|
assert "ENABLED" in output
|
|
assert "yes" in output
|
|
|
|
|
|
def test_show_plugin_reads_manifest_without_importing_backends(monkeypatch, tmp_path, capsys):
|
|
entry = _install_manifest(tmp_path)
|
|
monkeypatch.setattr(
|
|
plugin_cli_module.metadata,
|
|
"entry_points",
|
|
lambda: _FakeEntryPoints([entry]),
|
|
)
|
|
|
|
assert plugin_cli_module.plugin_cli(["show", "auto-fin"]) == 0
|
|
|
|
output = capsys.readouterr().out
|
|
assert "auto_fin_step" in output
|
|
assert "auto_fin" in output
|
|
|
|
|
|
def test_show_plugin_preserves_registry_when_editable_fallback_imports_package(monkeypatch, tmp_path, capsys):
|
|
package = tmp_path / "fallback_plugin"
|
|
package.mkdir()
|
|
(package / "__init__.py").write_text("from .backend import FallbackStep\n", encoding="utf-8")
|
|
(package / "backend.py").write_text(
|
|
"from reme.components import ComponentMixin, R\n"
|
|
"from reme.enumeration import ComponentEnum\n"
|
|
"@R.register('fallback_import_side_effect')\n"
|
|
"class FallbackStep(ComponentMixin):\n"
|
|
" component_type = ComponentEnum.STEP\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "plugin.yaml").write_text(
|
|
"""backends:
|
|
fallback_step: fallback_plugin.backend:FallbackStep
|
|
""",
|
|
encoding="utf-8",
|
|
)
|
|
entry = _FakeEntryPoint("fallback", "fallback_plugin", _FakeDistribution(tmp_path / "missing"))
|
|
monkeypatch.syspath_prepend(str(tmp_path))
|
|
monkeypatch.setattr(plugin_cli_module.metadata, "entry_points", lambda: _FakeEntryPoints([entry]))
|
|
|
|
assert plugin_cli_module.plugin_cli(["show", "fallback"]) == 0
|
|
|
|
assert "fallback_step" in capsys.readouterr().out
|
|
assert R.get(ComponentEnum.STEP, "fallback_import_side_effect") is None
|
|
|
|
|
|
def test_install_uses_current_python_pip(monkeypatch, capsys):
|
|
commands = []
|
|
monkeypatch.setattr(plugin_cli_module, "_run_pip", lambda command: commands.append(command) or 0)
|
|
|
|
assert plugin_cli_module.plugin_cli(["install", ".", "--editable", "--upgrade"]) == 0
|
|
|
|
assert commands == [["install", "--editable", "--upgrade", "."]]
|
|
assert "plugins list" in capsys.readouterr().out
|
|
|
|
|
|
def test_pip_uses_current_python_interpreter(monkeypatch):
|
|
calls = []
|
|
monkeypatch.setattr(
|
|
plugin_cli_module.subprocess,
|
|
"run",
|
|
lambda command, **kwargs: calls.append((command, kwargs)) or SimpleNamespace(returncode=7),
|
|
)
|
|
|
|
assert plugin_cli_module._run_pip(["install", "example"]) == 7
|
|
|
|
assert calls == [
|
|
(
|
|
[plugin_cli_module.sys.executable, "-m", "pip", "install", "example"],
|
|
{"check": False},
|
|
),
|
|
]
|
|
|
|
|
|
def test_uninstall_resolves_plugin_to_distribution(monkeypatch, tmp_path, capsys):
|
|
entry = _install_manifest(tmp_path)
|
|
commands = []
|
|
monkeypatch.setattr(
|
|
plugin_cli_module.metadata,
|
|
"entry_points",
|
|
lambda: _FakeEntryPoints([entry]),
|
|
)
|
|
monkeypatch.setattr(plugin_cli_module, "_run_pip", lambda command: commands.append(command) or 0)
|
|
|
|
assert plugin_cli_module.plugin_cli(["uninstall", "auto-fin", "--yes"]) == 0
|
|
|
|
assert commands == [["uninstall", "--yes", "reme-auto-fin"]]
|
|
assert "Remove 'auto-fin'" in capsys.readouterr().out
|
|
|
|
|
|
def test_validate_local_auto_fin_project():
|
|
repository = Path(__file__).resolve().parents[2]
|
|
|
|
names = plugin_cli_module._validate_local(repository / "plugins" / "auto-fin")
|
|
|
|
assert names == ["auto-fin"]
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"build_system",
|
|
[
|
|
"requires = ['hatchling']\nbuild-backend = 'hatchling.build'\n",
|
|
"requires = ['poetry-core']\nbuild-backend = 'poetry.core.masonry.api'\n",
|
|
"requires = ['flit-core']\nbuild-backend = 'flit_core.buildapi'\n",
|
|
],
|
|
)
|
|
def test_validate_local_supports_backend_independent_src_layout(tmp_path, build_system):
|
|
package = tmp_path / "src" / "src_layout_plugin"
|
|
package.mkdir(parents=True)
|
|
(tmp_path / "pyproject.toml").write_text(
|
|
"[project]\n"
|
|
"name = 'example-plugin'\n"
|
|
"version = '0.1.0'\n"
|
|
"[project.entry-points.'reme.plugins']\n"
|
|
"example = 'src_layout_plugin'\n"
|
|
"[build-system]\n"
|
|
f"{build_system}",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "__init__.py").write_text("", encoding="utf-8")
|
|
(package / "backend.py").write_text(
|
|
"from reme.components import ComponentMixin\n"
|
|
"from reme.enumeration import ComponentEnum\n"
|
|
"class ExampleStep(ComponentMixin):\n"
|
|
" component_type = ComponentEnum.STEP\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "plugin.yaml").write_text(
|
|
"backends:\n example_step: src_layout_plugin.backend:ExampleStep\n",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
assert plugin_cli_module._validate_local(tmp_path) == ["example"]
|
|
|
|
|
|
def test_validate_local_supports_setuptools_find_source_root(tmp_path):
|
|
package = tmp_path / "python" / "find_layout_plugin"
|
|
package.mkdir(parents=True)
|
|
(tmp_path / "pyproject.toml").write_text(
|
|
"[project]\n"
|
|
"name = 'example-plugin'\n"
|
|
"version = '0.1.0'\n"
|
|
"[project.entry-points.'reme.plugins']\n"
|
|
"example = 'find_layout_plugin'\n"
|
|
"[tool.setuptools.packages.find]\n"
|
|
"where = ['python']\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "__init__.py").write_text("", encoding="utf-8")
|
|
(package / "backend.py").write_text(
|
|
"from reme.components import ComponentMixin\n"
|
|
"from reme.enumeration import ComponentEnum\n"
|
|
"class ExampleStep(ComponentMixin):\n"
|
|
" component_type = ComponentEnum.STEP\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "plugin.yaml").write_text(
|
|
"backends:\n example_step: find_layout_plugin.backend:ExampleStep\n",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
assert plugin_cli_module._validate_local(tmp_path) == ["example"]
|
|
|
|
|
|
def test_validate_local_preserves_registry_during_backend_imports(tmp_path):
|
|
package = tmp_path / "src" / "decorated_plugin"
|
|
package.mkdir(parents=True)
|
|
(tmp_path / "pyproject.toml").write_text(
|
|
"[project]\n"
|
|
"name = 'decorated-plugin'\n"
|
|
"version = '0.1.0'\n"
|
|
"[project.entry-points.'reme.plugins']\n"
|
|
"decorated = 'decorated_plugin'\n"
|
|
"[tool.setuptools.package-dir]\n"
|
|
"'' = 'src'\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "__init__.py").write_text("", encoding="utf-8")
|
|
(package / "backend.py").write_text(
|
|
"from reme.components import ComponentMixin, R\n"
|
|
"from reme.enumeration import ComponentEnum\n"
|
|
"@R.register('local_import_side_effect')\n"
|
|
"class DecoratedStep(ComponentMixin):\n"
|
|
" component_type = ComponentEnum.STEP\n",
|
|
encoding="utf-8",
|
|
)
|
|
(package / "plugin.yaml").write_text(
|
|
"""backends:
|
|
decorated_step: decorated_plugin.backend:DecoratedStep
|
|
""",
|
|
encoding="utf-8",
|
|
)
|
|
|
|
assert plugin_cli_module._validate_local(tmp_path) == ["decorated"]
|
|
assert R.get(ComponentEnum.STEP, "local_import_side_effect") is None
|
|
|
|
|
|
def test_plugin_command_errors_are_clean(monkeypatch, capsys):
|
|
monkeypatch.setattr(plugin_cli_module.metadata, "entry_points", _FakeEntryPoints)
|
|
|
|
assert plugin_cli_module.plugin_cli(["show", "missing"]) == 1
|
|
|
|
assert "Plugin 'missing' is not installed" in capsys.readouterr().err
|
|
|
|
|
|
@pytest.mark.parametrize("action", ["plugins", "-plugins", "--plugins"])
|
|
def test_main_routes_plugins_before_loading_environment(monkeypatch, action):
|
|
events = []
|
|
monkeypatch.setattr("sys.argv", ["reme", action, "list"])
|
|
monkeypatch.setattr(reme_module, "load_env", lambda: events.append("load_env"))
|
|
monkeypatch.setattr(plugin_cli_module, "plugin_cli", lambda argv: events.append(list(argv)) or 0)
|
|
|
|
reme_module.main()
|
|
|
|
assert events == [["list"]]
|