feat: implement dedicated API registry and enhance API handling capabilities
- Added APIEntry and APIRegistry classes for managing plugin APIs. - Updated PluginRunnerSupervisor to include API registry and methods for invoking APIs. - Enhanced PluginRuntimeManager to support API registration and invocation. - Created tests for API registration, invocation, and visibility between plugins. - Refactored component handling to distinguish between runtime components and APIs.
This commit is contained in:
DrSmoothl
294
pytests/test_plugin_runtime_api.py
Normal file
294
pytests/test_plugin_runtime_api.py
Normal file
@@ -0,0 +1,294 @@
|
||||
"""插件 API 注册与调用测试。"""
|
||||
|
||||
from types import SimpleNamespace
|
||||
from typing import Any, Dict, List
|
||||
|
||||
import pytest
|
||||
|
||||
from src.plugin_runtime.integration import PluginRuntimeManager
|
||||
from src.plugin_runtime.host.supervisor import PluginSupervisor
|
||||
from src.plugin_runtime.protocol.envelope import (
|
||||
ComponentDeclaration,
|
||||
Envelope,
|
||||
MessageType,
|
||||
RegisterPluginPayload,
|
||||
UnregisterPluginPayload,
|
||||
)
|
||||
|
||||
|
||||
def _build_manager(*supervisors: PluginSupervisor) -> PluginRuntimeManager:
|
||||
"""构造一个最小可用的插件运行时管理器。
|
||||
|
||||
Args:
|
||||
*supervisors: 需要挂载的监督器列表。
|
||||
|
||||
Returns:
|
||||
PluginRuntimeManager: 已注入监督器的运行时管理器。
|
||||
"""
|
||||
|
||||
manager = PluginRuntimeManager()
|
||||
if supervisors:
|
||||
manager._builtin_supervisor = supervisors[0]
|
||||
if len(supervisors) > 1:
|
||||
manager._third_party_supervisor = supervisors[1]
|
||||
return manager
|
||||
|
||||
|
||||
async def _register_plugin(
|
||||
supervisor: PluginSupervisor,
|
||||
plugin_id: str,
|
||||
components: List[Dict[str, Any]],
|
||||
) -> Envelope:
|
||||
"""通过 Supervisor 注册测试插件。
|
||||
|
||||
Args:
|
||||
supervisor: 目标监督器。
|
||||
plugin_id: 测试插件 ID。
|
||||
components: 组件声明列表。
|
||||
|
||||
Returns:
|
||||
Envelope: 注册响应信封。
|
||||
"""
|
||||
|
||||
payload = RegisterPluginPayload(
|
||||
plugin_id=plugin_id,
|
||||
plugin_version="1.0.0",
|
||||
components=[
|
||||
ComponentDeclaration(
|
||||
name=str(component.get("name", "") or ""),
|
||||
component_type=str(component.get("component_type", "") or ""),
|
||||
plugin_id=plugin_id,
|
||||
metadata=component.get("metadata", {}) if isinstance(component.get("metadata"), dict) else {},
|
||||
)
|
||||
for component in components
|
||||
],
|
||||
)
|
||||
return await supervisor._handle_register_plugin(
|
||||
Envelope(
|
||||
request_id=1,
|
||||
message_type=MessageType.REQUEST,
|
||||
method="plugin.register_components",
|
||||
plugin_id=plugin_id,
|
||||
payload=payload.model_dump(),
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
async def _unregister_plugin(supervisor: PluginSupervisor, plugin_id: str) -> Envelope:
|
||||
"""通过 Supervisor 注销测试插件。
|
||||
|
||||
Args:
|
||||
supervisor: 目标监督器。
|
||||
plugin_id: 测试插件 ID。
|
||||
|
||||
Returns:
|
||||
Envelope: 注销响应信封。
|
||||
"""
|
||||
|
||||
payload = UnregisterPluginPayload(plugin_id=plugin_id, reason="test")
|
||||
return await supervisor._handle_unregister_plugin(
|
||||
Envelope(
|
||||
request_id=2,
|
||||
message_type=MessageType.REQUEST,
|
||||
method="plugin.unregister",
|
||||
plugin_id=plugin_id,
|
||||
payload=payload.model_dump(),
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_register_plugin_syncs_dedicated_api_registry() -> None:
|
||||
"""插件注册时应将 API 同步到独立注册表，而不是通用组件表。"""
|
||||
|
||||
supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
response = await _register_plugin(
|
||||
supervisor,
|
||||
"provider",
|
||||
[
|
||||
{
|
||||
"name": "render_html",
|
||||
"component_type": "API",
|
||||
"metadata": {
|
||||
"description": "渲染 HTML",
|
||||
"version": "1",
|
||||
"public": True,
|
||||
},
|
||||
}
|
||||
],
|
||||
)
|
||||
|
||||
assert response.payload["accepted"] is True
|
||||
assert response.payload["registered_components"] == 0
|
||||
assert response.payload["registered_apis"] == 1
|
||||
assert supervisor.api_registry.get_api("provider", "render_html") is not None
|
||||
assert supervisor.component_registry.get_component("provider.render_html") is None
|
||||
|
||||
unregister_response = await _unregister_plugin(supervisor, "provider")
|
||||
assert unregister_response.payload["removed_apis"] == 1
|
||||
assert supervisor.api_registry.get_api("provider", "render_html") is None
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_api_call_allows_public_api_between_plugins(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""公开 API 应允许其他插件通过 Host 转发调用。"""
|
||||
|
||||
provider_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
consumer_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
await _register_plugin(
|
||||
provider_supervisor,
|
||||
"provider",
|
||||
[
|
||||
{
|
||||
"name": "render_html",
|
||||
"component_type": "API",
|
||||
"metadata": {
|
||||
"description": "渲染 HTML",
|
||||
"version": "1",
|
||||
"public": True,
|
||||
},
|
||||
}
|
||||
],
|
||||
)
|
||||
await _register_plugin(consumer_supervisor, "consumer", [])
|
||||
|
||||
captured: Dict[str, Any] = {}
|
||||
|
||||
async def fake_invoke_api(
|
||||
plugin_id: str,
|
||||
component_name: str,
|
||||
args: Dict[str, Any] | None = None,
|
||||
timeout_ms: int = 30000,
|
||||
) -> Any:
|
||||
"""模拟 API RPC 调用。"""
|
||||
|
||||
captured["plugin_id"] = plugin_id
|
||||
captured["component_name"] = component_name
|
||||
captured["args"] = args or {}
|
||||
captured["timeout_ms"] = timeout_ms
|
||||
return SimpleNamespace(error=None, payload={"success": True, "result": {"image": "ok"}})
|
||||
|
||||
monkeypatch.setattr(provider_supervisor, "invoke_api", fake_invoke_api)
|
||||
|
||||
manager = _build_manager(provider_supervisor, consumer_supervisor)
|
||||
result = await manager._cap_api_call(
|
||||
"consumer",
|
||||
"api.call",
|
||||
{
|
||||
"api_name": "provider.render_html",
|
||||
"version": "1",
|
||||
"args": {"html": "<div>Hello</div>"},
|
||||
},
|
||||
)
|
||||
|
||||
assert result == {"success": True, "result": {"image": "ok"}}
|
||||
assert captured["plugin_id"] == "provider"
|
||||
assert captured["component_name"] == "render_html"
|
||||
assert captured["args"] == {"html": "<div>Hello</div>"}
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_api_call_rejects_private_api_between_plugins() -> None:
|
||||
"""未公开的 API 默认不允许跨插件调用。"""
|
||||
|
||||
provider_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
consumer_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
await _register_plugin(
|
||||
provider_supervisor,
|
||||
"provider",
|
||||
[
|
||||
{
|
||||
"name": "secret_api",
|
||||
"component_type": "API",
|
||||
"metadata": {
|
||||
"description": "私有 API",
|
||||
"version": "1",
|
||||
"public": False,
|
||||
},
|
||||
}
|
||||
],
|
||||
)
|
||||
await _register_plugin(consumer_supervisor, "consumer", [])
|
||||
|
||||
manager = _build_manager(provider_supervisor, consumer_supervisor)
|
||||
result = await manager._cap_api_call(
|
||||
"consumer",
|
||||
"api.call",
|
||||
{
|
||||
"api_name": "provider.secret_api",
|
||||
"args": {},
|
||||
},
|
||||
)
|
||||
|
||||
assert result["success"] is False
|
||||
assert "未公开" in str(result["error"])
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_api_list_and_component_toggle_use_dedicated_registry() -> None:
|
||||
"""API 列表与组件启停应直接作用于独立 API 注册表。"""
|
||||
|
||||
provider_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
consumer_supervisor = PluginSupervisor(plugin_dirs=[])
|
||||
await _register_plugin(
|
||||
provider_supervisor,
|
||||
"provider",
|
||||
[
|
||||
{
|
||||
"name": "public_api",
|
||||
"component_type": "API",
|
||||
"metadata": {"version": "1", "public": True},
|
||||
},
|
||||
{
|
||||
"name": "private_api",
|
||||
"component_type": "API",
|
||||
"metadata": {"version": "1", "public": False},
|
||||
},
|
||||
],
|
||||
)
|
||||
await _register_plugin(
|
||||
consumer_supervisor,
|
||||
"consumer",
|
||||
[
|
||||
{
|
||||
"name": "self_private_api",
|
||||
"component_type": "API",
|
||||
"metadata": {"version": "1", "public": False},
|
||||
}
|
||||
],
|
||||
)
|
||||
|
||||
manager = _build_manager(provider_supervisor, consumer_supervisor)
|
||||
list_result = await manager._cap_api_list("consumer", "api.list", {})
|
||||
|
||||
assert list_result["success"] is True
|
||||
api_names = {(item["plugin_id"], item["name"]) for item in list_result["apis"]}
|
||||
assert ("provider", "public_api") in api_names
|
||||
assert ("provider", "private_api") not in api_names
|
||||
assert ("consumer", "self_private_api") in api_names
|
||||
|
||||
disable_result = await manager._cap_component_disable(
|
||||
"consumer",
|
||||
"component.disable",
|
||||
{
|
||||
"name": "provider.public_api",
|
||||
"component_type": "API",
|
||||
"scope": "global",
|
||||
"stream_id": "",
|
||||
},
|
||||
)
|
||||
assert disable_result["success"] is True
|
||||
assert provider_supervisor.api_registry.get_api("provider", "public_api", enabled_only=True) is None
|
||||
|
||||
enable_result = await manager._cap_component_enable(
|
||||
"consumer",
|
||||
"component.enable",
|
||||
{
|
||||
"name": "provider.public_api",
|
||||
"component_type": "API",
|
||||
"scope": "global",
|
||||
"stream_id": "",
|
||||
},
|
||||
)
|
||||
assert enable_result["success"] is True
|
||||
assert provider_supervisor.api_registry.get_api("provider", "public_api", enabled_only=True) is not None
|
||||
Reference in New Issue
Block a user