fix(plugins): discover nested category plugins in 'plugins list' (issue #41066)
_discover_all_plugins() previously did a flat iterdir() scan, missing all category-namespaced plugins (web/*, image_gen/*, browser/*, video_gen/*). Now recurses up to 2 levels deep, matching PluginManager._scan_directory_level(). Also fixes _plugin_status() to check both manifest name AND path-derived key against enabled/disabled sets, so category plugins like 'web/tavily' show correct status when enabled via config.
This commit is contained in:
islam666
@@ -0,0 +1,355 @@
|
||||
"""Tests for the nested category plugin discovery fix (issue #41066).
|
||||
|
||||
Verifies that _discover_all_plugins() recurses into category directories
|
||||
(up to 2 levels deep) and that _plugin_status() checks both manifest name
|
||||
and path-derived key against the enabled/disabled sets.
|
||||
"""
|
||||
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _make_plugin_dir(parent: Path, name: str, manifest: dict) -> Path:
|
||||
"""Create a minimal plugin directory with a plugin.yaml."""
|
||||
d = parent / name
|
||||
d.mkdir(parents=True, exist_ok=True)
|
||||
import yaml
|
||||
(d / "plugin.yaml").write_text(yaml.dump(manifest), encoding="utf-8")
|
||||
(d / "__init__.py").write_text("def register(ctx): pass\n", encoding="utf-8")
|
||||
return d
|
||||
|
||||
|
||||
def _make_category_plugin(
|
||||
parent: Path, category: str, name: str, manifest: dict
|
||||
) -> Path:
|
||||
"""Create a category-namespaced plugin: <parent>/<category>/<name>/plugin.yaml."""
|
||||
return _make_plugin_dir(parent / category, name, manifest)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _read_manifest_info
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestReadManifestInfo:
|
||||
def test_flat_plugin(self, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _read_manifest_info
|
||||
|
||||
d = _make_plugin_dir(tmp_path, "my-plugin", {
|
||||
"name": "my-plugin", "version": "1.0.0", "description": "test"
|
||||
})
|
||||
result = _read_manifest_info(d, "")
|
||||
assert result is not None
|
||||
name, version, description, key = result
|
||||
assert name == "my-plugin"
|
||||
assert version == "1.0.0"
|
||||
assert description == "test"
|
||||
assert key == "my-plugin" # flat: key == name
|
||||
|
||||
def test_category_plugin(self, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _read_manifest_info
|
||||
|
||||
d = _make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "2.0.0", "description": "search"
|
||||
})
|
||||
result = _read_manifest_info(d, "web")
|
||||
assert result is not None
|
||||
name, version, description, key = result
|
||||
assert name == "web-tavily" # manifest name
|
||||
assert key == "web/tavily" # path-derived key
|
||||
|
||||
def test_no_manifest(self, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _read_manifest_info
|
||||
|
||||
d = tmp_path / "empty-dir"
|
||||
d.mkdir()
|
||||
assert _read_manifest_info(d, "") is None
|
||||
|
||||
def test_yml_extension(self, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _read_manifest_info
|
||||
|
||||
d = tmp_path / "my-plugin"
|
||||
d.mkdir()
|
||||
import yaml
|
||||
(d / "plugin.yml").write_text(yaml.dump({"name": "my-plugin"}), encoding="utf-8")
|
||||
result = _read_manifest_info(d, "")
|
||||
assert result is not None
|
||||
assert result[0] == "my-plugin"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _discover_all_plugins — recursive discovery
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestDiscoverAllPlugins:
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_flat_plugins_still_discovered(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
_make_plugin_dir(tmp_path, "disk-cleanup", {
|
||||
"name": "disk-cleanup", "version": "1.0.0"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
keys = [e[5] for e in entries]
|
||||
assert "disk-cleanup" in keys
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_category_plugins_discovered(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0"
|
||||
})
|
||||
_make_category_plugin(tmp_path, "image_gen", "openai", {
|
||||
"name": "image-gen-openai", "version": "2.0.0"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
keys = [e[5] for e in entries]
|
||||
assert "web/tavily" in keys
|
||||
assert "image_gen/openai" in keys
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_mixed_flat_and_category(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
_make_plugin_dir(tmp_path, "disk-cleanup", {
|
||||
"name": "disk-cleanup", "version": "1.0.0"
|
||||
})
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0"
|
||||
})
|
||||
_make_category_plugin(tmp_path, "web", "exa", {
|
||||
"name": "web-exa", "version": "1.0.0"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
keys = [e[5] for e in entries]
|
||||
assert "disk-cleanup" in keys
|
||||
assert "web/tavily" in keys
|
||||
assert "web/exa" in keys
|
||||
assert len(entries) == 3
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_depth_cap_at_two(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
"""Plugins nested 3 levels deep should NOT be discovered."""
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
# 2 levels: should be found
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0"
|
||||
})
|
||||
# 3 levels: should NOT be found
|
||||
deep = tmp_path / "a" / "b" / "c"
|
||||
deep.mkdir(parents=True)
|
||||
import yaml
|
||||
(deep / "plugin.yaml").write_text(
|
||||
yaml.dump({"name": "too-deep"}), encoding="utf-8"
|
||||
)
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
keys = [e[5] for e in entries]
|
||||
assert "web/tavily" in keys
|
||||
assert "a/b/c" not in keys
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_tuple_has_six_elements(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0", "description": "search"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
assert len(entries) == 1
|
||||
entry = entries[0]
|
||||
assert len(entry) == 6
|
||||
name, version, description, source, dir_path, key = entry
|
||||
assert name == "web-tavily"
|
||||
assert key == "web/tavily"
|
||||
assert source == "user"
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_user_overrides_bundled_on_key_collision(self, mock_user_dir, mock_bundled_dir, tmp_path):
|
||||
"""User plugin with same key as bundled should win."""
|
||||
from hermes_cli.plugins_cmd import _discover_all_plugins
|
||||
|
||||
# Simulate a bundled plugin
|
||||
bundled_dir = tmp_path / "bundled"
|
||||
bundled_dir.mkdir()
|
||||
_make_plugin_dir(bundled_dir, "my-plugin", {
|
||||
"name": "my-plugin", "version": "1.0.0"
|
||||
})
|
||||
# User plugin with same key
|
||||
_make_plugin_dir(tmp_path, "my-plugin", {
|
||||
"name": "my-plugin", "version": "2.0.0"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = bundled_dir
|
||||
|
||||
entries = _discover_all_plugins()
|
||||
keys = [e[5] for e in entries]
|
||||
assert keys.count("my-plugin") == 1
|
||||
# User version should win
|
||||
entry = [e for e in entries if e[5] == "my-plugin"][0]
|
||||
assert entry[1] == "2.0.0"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# _plugin_status — key-aware status
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestPluginStatus:
|
||||
def test_name_in_enabled(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("my-plugin", {"my-plugin"}, set()) == "enabled"
|
||||
|
||||
def test_key_in_enabled(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("web-tavily", {"web/tavily"}, set(), key="web/tavily") == "enabled"
|
||||
|
||||
def test_name_in_disabled(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("my-plugin", set(), {"my-plugin"}) == "disabled"
|
||||
|
||||
def test_key_in_disabled(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("web-tavily", set(), {"web/tavily"}, key="web/tavily") == "disabled"
|
||||
|
||||
def test_neither_name_nor_key(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("unknown", {"other"}, set(), key="cat/unknown") == "not enabled"
|
||||
|
||||
def test_disabled_takes_precedence_over_enabled(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("my-plugin", {"my-plugin"}, {"my-plugin"}) == "disabled"
|
||||
|
||||
def test_key_disabled_takes_precedence(self):
|
||||
from hermes_cli.plugins_cmd import _plugin_status
|
||||
assert _plugin_status("web-tavily", {"web/tavily"}, {"web/tavily"}, key="web/tavily") == "disabled"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Integration: _filter_plugin_entries with category plugins
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestFilterPluginEntries:
|
||||
def test_enabled_filter_uses_key(self):
|
||||
from hermes_cli.plugins_cmd import _filter_plugin_entries
|
||||
|
||||
entries = [
|
||||
("web-tavily", "1.0.0", "search", "user", Path("/tmp"), "web/tavily"),
|
||||
("disk-cleanup", "1.0.0", "cleanup", "bundled", Path("/tmp"), "disk-cleanup"),
|
||||
]
|
||||
args = MagicMock()
|
||||
args.no_bundled = False
|
||||
args.user = False
|
||||
args.enabled = True
|
||||
|
||||
result = _filter_plugin_entries(entries, args, {"web/tavily"}, set())
|
||||
assert len(result) == 1
|
||||
assert result[0][5] == "web/tavily"
|
||||
|
||||
def test_enabled_filter_by_name_still_works(self):
|
||||
from hermes_cli.plugins_cmd import _filter_plugin_entries
|
||||
|
||||
entries = [
|
||||
("disk-cleanup", "1.0.0", "cleanup", "bundled", Path("/tmp"), "disk-cleanup"),
|
||||
]
|
||||
args = MagicMock()
|
||||
args.no_bundled = False
|
||||
args.user = False
|
||||
args.enabled = True
|
||||
|
||||
result = _filter_plugin_entries(entries, args, {"disk-cleanup"}, set())
|
||||
assert len(result) == 1
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Integration: cmd_list JSON output includes category plugins
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestCmdListJson:
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_json_output_includes_category_plugins(self, mock_user_dir, mock_bundled_dir, tmp_path, capsys):
|
||||
from hermes_cli.plugins_cmd import cmd_list
|
||||
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0", "description": "search"
|
||||
})
|
||||
_make_plugin_dir(tmp_path, "disk-cleanup", {
|
||||
"name": "disk-cleanup", "version": "2.0.0", "description": "cleanup"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
args = MagicMock()
|
||||
args.json = True
|
||||
args.plain = False
|
||||
args.no_bundled = False
|
||||
args.user = False
|
||||
args.enabled = False
|
||||
|
||||
cmd_list(args)
|
||||
captured = capsys.readouterr()
|
||||
payload = json.loads(captured.out)
|
||||
names = [p["name"] for p in payload]
|
||||
assert "web-tavily" in names
|
||||
assert "disk-cleanup" in names
|
||||
|
||||
@patch("hermes_cli.plugins.get_bundled_plugins_dir")
|
||||
@patch("hermes_cli.plugins_cmd._plugins_dir")
|
||||
def test_json_status_uses_key(self, mock_user_dir, mock_bundled_dir, tmp_path, capsys):
|
||||
from hermes_cli.plugins_cmd import cmd_list
|
||||
|
||||
_make_category_plugin(tmp_path, "web", "tavily", {
|
||||
"name": "web-tavily", "version": "1.0.0"
|
||||
})
|
||||
mock_user_dir.return_value = tmp_path
|
||||
mock_bundled_dir.return_value = tmp_path / "nonexistent"
|
||||
|
||||
# Patch config to return web/tavily as enabled
|
||||
with patch("hermes_cli.plugins_cmd._get_enabled_set", return_value={"web/tavily"}):
|
||||
args = MagicMock()
|
||||
args.json = True
|
||||
args.plain = False
|
||||
args.no_bundled = False
|
||||
args.user = False
|
||||
args.enabled = False
|
||||
|
||||
cmd_list(args)
|
||||
captured = capsys.readouterr()
|
||||
payload = json.loads(captured.out)
|
||||
assert len(payload) == 1
|
||||
assert payload[0]["status"] == "enabled"
|
||||
Reference in New Issue
Block a user