Files
MoviePilot/tests/test_plugin_virtual_instances.py
Aqr-K 4dbb8b8204 feat(plugin): 插件配置与实例描述符迁入独立表
插件配置此前寄存在 systemconfig 的 plugin.<实例ID> 单键下,实例描述符则整份挤在
PluginInstances 这一个 JSON 键里,两者都不成立:

- plugin.<ID> 是裸字符串 key,而仓库规则本身禁止用裸字符串做 SystemConfig key,
  只允许先定义 SystemConfigKey 枚举项;插件 ID 由用户安装决定,永远枚举不出常量。
  条目数随安装量增长,混在系统设置表里会把主程序自己的设置项淹掉。
- 那个键存的其实是实例 ID,表里没有任何一列说得出它属于哪个插件,想列出某个插件
  的全部实例配置只能靠字符串前缀去猜。
- 实例描述符整份读出再整份写回,改一个分身要重写全部分身。

改为 plugininstance 一实例一行:instance_id 与 source_plugin_id 构成身份,本体与
分身由两者是否相等派生而不设模式列——模式列会是这个等式的冗余副本,两者一旦失步
同一行就会在不同读取口被判成不同角色。展示信息与业务参数同存一行,属于同一个
生命周期,分表只会让建分身、删分身退化成两张表之间的协调问题。

读写路由落在 SystemConfigOper.get/set/delete,而不是在各个调用方各改一处:第三方
插件可能直接用 self.systemconfig.get("plugin.xxx") 读写自己的配置,只改
PluginConfigStore 与 _PluginBase.get_config/update_config 必然漏掉它们。路由只做
前缀识别,插入、更新与空本体行回收都委托 PluginInstanceOper,不在配置层重抄一遍。

PluginInstances 旧键迁移后不删,留作回滚依据,并以
SystemConfigKey.PluginInstancesImported 标志防止重复导入;判据不能是「表当前为空」,
否则用户把分身全部删光后,下次启动会把它们整批导回来。

迁移链:b2d4f6a8c1e3 -> 281965691a20(3.0.34 建表并搬描述符)
-> c4e1a7b9d2f6(3.0.35 加 config_data 并搬 plugin.* 配置)。

依赖基线与启动模块数随两个新模块重算,架构文档与数据库技能表目录同步登记新表。
2026-09-12 17:39:36 -04:00

341 lines
12 KiB
Python

"""虚拟插件实例的持久化、加载和创建行为测试。"""
import sys
from types import ModuleType, SimpleNamespace
import pytest
from app.runtime.extensions.plugin.clone import PluginCloneService
from app.runtime.extensions.plugin.loader import PluginLoader
from app.runtime.extensions.plugin.storage import (
PluginInstanceDirectory,
PluginInstanceStore,
PluginStorage,
)
from app.schemas.plugin import PluginInstance, PluginRuntimeStatus
from app.schemas.types import SystemConfigKey
def _make_directory() -> tuple[PluginInstanceDirectory, dict[str, PluginInstance]]:
"""构造进程内插件实例表,供分身持久化测试使用。
返回背后的字典,用例据此断言写入落在哪一行上,而不是只看端口回报的结果。
"""
records: dict[str, PluginInstance] = {}
directory = PluginInstanceDirectory(
get=records.get,
list_all=lambda: list(records.values()),
list_by_source=lambda source_plugin_id: [
record
for record in records.values()
if record.source_plugin_id == source_plugin_id
],
save=lambda instance: records.__setitem__(instance.instance_id, instance),
delete=lambda instance_id: records.pop(instance_id, None) is not None,
)
return directory, records
def _logger() -> SimpleNamespace:
"""提供加载器测试所需的最小日志对象。"""
return SimpleNamespace(
debug=lambda *_args: None,
info=lambda *_args: None,
warning=lambda *_args: None,
error=lambda *_args: None,
)
def test_instance_store_keeps_virtual_instances_out_of_installed_list():
"""虚拟实例使用独立配置键,不改写存量物理插件安装清单。"""
values = {SystemConfigKey.UserInstalledPlugins: ["DemoPlugin"]}
storage = PluginStorage(
read=values.get,
write=lambda key, value: values.__setitem__(key, value),
)
directory, _records = _make_directory()
store = PluginInstanceStore(storage=lambda: storage, directory=lambda: directory)
instance = PluginInstance(
instance_id="DemoPluginWork",
source_plugin_id="DemoPlugin",
plugin_name="工作实例",
)
store.save(instance)
assert store.get("DemoPluginWork") == instance
assert store.for_source("DemoPlugin") == [instance]
assert values[SystemConfigKey.UserInstalledPlugins] == ["DemoPlugin"]
assert store.delete("DemoPluginWork") is True
assert store.all() == {}
def test_host_rows_do_not_leak_into_the_clone_listing():
"""本体自身那一行与分身共用一张表,但不得出现在分身清单里。
本体行承载的是插件自己的业务参数,混进分身清单会让「我的插件」里多出一张
指向插件自身的分身卡片。
"""
values = {SystemConfigKey.UserInstalledPlugins: ["DemoPlugin"]}
storage = PluginStorage(
read=values.get,
write=lambda key, value: values.__setitem__(key, value),
)
directory, records = _make_directory()
store = PluginInstanceStore(storage=lambda: storage, directory=lambda: directory)
clone = PluginInstance(instance_id="DemoPluginWork", source_plugin_id="DemoPlugin")
store.save(clone)
records["DemoPlugin"] = PluginInstance(
instance_id="DemoPlugin",
source_plugin_id="DemoPlugin",
)
assert store.all() == {"DemoPluginWork": clone}
assert store.for_source("DemoPlugin") == [clone]
assert store.get("DemoPlugin") is None
assert store.delete("DemoPlugin") is False
assert "DemoPlugin" in records
def test_saving_a_clone_whose_id_equals_its_source_is_rejected():
"""两者相等的那一行表示本体自身,按分身写入会把本体承载的配置顶掉。"""
values: dict = {}
storage = PluginStorage(
read=values.get,
write=lambda key, value: values.__setitem__(key, value),
)
directory, records = _make_directory()
store = PluginInstanceStore(storage=lambda: storage, directory=lambda: directory)
with pytest.raises(ValueError):
store.save(
PluginInstance(instance_id="DemoPlugin", source_plugin_id="DemoPlugin")
)
assert records == {}
def test_legacy_instances_are_not_reimported_after_being_deleted():
"""删光分身后重启不得从旧 systemconfig 键把它们导回来。
旧键刻意保留作回滚依据、从不清理,若以「表为空」作为兜底导入的判据,
用户每删光一次分身、下次启动就会复活一次。
"""
values = {
SystemConfigKey.UserInstalledPlugins: ["DemoPlugin"],
SystemConfigKey.PluginInstances: {
"DemoPluginWork": {
"instance_id": "DemoPluginWork",
"source_plugin_id": "DemoPlugin",
}
},
}
storage = PluginStorage(
read=values.get,
write=lambda key, value: values.__setitem__(key, value),
)
directory, _records = _make_directory()
# 首次访问:旧键内容被导入独立表
first = PluginInstanceStore(storage=lambda: storage, directory=lambda: directory)
assert set(first.all()) == {"DemoPluginWork"}
# 用户删光全部分身,表重新变空
assert first.delete("DemoPluginWork") is True
assert first.all() == {}
# 进程重启:新建 store 重新走一次兜底导入判定
second = PluginInstanceStore(storage=lambda: storage, directory=lambda: directory)
assert second.all() == {}
assert values[SystemConfigKey.PluginInstances] is not None
def test_loader_executes_each_instance_in_an_isolated_module_namespace(
tmp_path,
monkeypatch,
):
"""两个实例共享磁盘源码,但模块全局状态、类身份和相对导入互相隔离。"""
source_dir = tmp_path / "demoplugin"
source_dir.mkdir()
(source_dir / "state.py").write_text("state = []\n", encoding="utf-8")
(source_dir / "__init__.py").write_text(
"from app.plugins.demoplugin.state import state\n"
"class DemoPlugin:\n"
" plugin_name = 'Demo'\n"
" plugin_desc = 'Source'\n"
" plugin_icon = 'source.svg'\n"
" plugin_config_prefix = 'demo_'\n"
" def init_plugin(self, _config):\n"
" state.append(self.__class__.__name__)\n",
encoding="utf-8",
)
loader = PluginLoader(
plugins_root=tmp_path,
import_preparer=lambda **_kwargs: None,
import_scanner=lambda **_kwargs: None,
log=_logger(),
)
validator = lambda candidate: hasattr(candidate, "init_plugin")
import app.plugins as plugin_package
source_module = ModuleType("app.plugins.demoplugin")
source_module.__path__ = [str(source_dir)]
monkeypatch.setitem(sys.modules, "app.plugins.demoplugin", source_module)
monkeypatch.setattr(plugin_package, "demoplugin", source_module, raising=False)
work_class = loader.load_instance(
PluginInstance(
instance_id="DemoPluginWork",
source_plugin_id="DemoPlugin",
plugin_name="工作实例",
),
validator,
)[0]
home_class = loader.load_instance(
PluginInstance(
instance_id="DemoPluginHome",
source_plugin_id="DemoPlugin",
plugin_desc="家庭实例",
),
validator,
)[0]
work_class().init_plugin({})
home_class().init_plugin({})
assert work_class.__name__ == "DemoPluginWork"
assert home_class.__name__ == "DemoPluginHome"
assert work_class.__qualname__ == "DemoPlugin"
assert work_class.__module__ == "app.plugins.demopluginwork"
assert home_class.__module__ == "app.plugins.demopluginhome"
assert work_class.plugin_source_id == "DemoPlugin"
assert work_class.plugin_name == "工作实例"
assert work_class.plugin_config_prefix == "demopluginwork_"
assert work_class.__dict__["init_plugin"].__globals__["state"] == [
"DemoPluginWork"
]
assert home_class.__dict__["init_plugin"].__globals__["state"] == [
"DemoPluginHome"
]
assert sys.modules["app.plugins.demoplugin"] is source_module
assert plugin_package.demoplugin is source_module
def test_loader_runtime_gate_only_rejects_explicit_incompatible_declarations(
tmp_path,
monkeypatch,
):
"""运行目录缺少声明或 runtime 为空时保持历史插件可加载。"""
from app.runtime.extensions.plugin import loader as loader_module
monkeypatch.setattr(
loader_module,
"get_runtime_setting",
lambda key: "v3" if key == "VERSION_FLAG" else None,
)
monkeypatch.setattr(loader_module, "is_free_threaded_runtime", lambda: True)
missing = tmp_path / "missing"
missing.mkdir()
assert PluginLoader._is_runtime_compatible(missing)
empty = tmp_path / "empty"
empty.mkdir()
(empty / "package.json").write_text('{"runtime": {}}', encoding="utf-8")
assert PluginLoader._is_runtime_compatible(empty)
rejected = tmp_path / "rejected"
rejected.mkdir()
(rejected / "package.json").write_text('{"v3t": false}', encoding="utf-8")
assert not PluginLoader._is_runtime_compatible(rejected)
def test_clone_service_persists_descriptor_without_copying_source_package():
"""创建分身只写实例描述和隔离配置,并始终跟随源插件版本。"""
instances: dict[str, PluginInstance] = {}
configs = {"DemoPlugin": {"enable": True, "token": "secret"}}
reloaded: list[str] = []
removed: list[str] = []
class DemoPlugin:
"""提供创建用例需要的最小源插件类。"""
service = PluginCloneService(
plugin_class=lambda plugin_id: DemoPlugin if plugin_id == "DemoPlugin" else None,
plugin_exists=lambda plugin_id: plugin_id in instances,
source_plugin_id=lambda plugin_id: plugin_id,
save_instance=lambda instance: instances.__setitem__(
instance.instance_id,
instance,
),
delete_instance=lambda plugin_id: instances.pop(plugin_id, None) is not None,
read_config=lambda plugin_id: configs.get(plugin_id, {}),
save_config=lambda plugin_id, config: not configs.__setitem__(plugin_id, config),
delete_config=lambda plugin_id: configs.pop(plugin_id, None) is not None,
reload_plugin=lambda plugin_id: (
reloaded.append(plugin_id) or PluginRuntimeStatus.ACTIVE
),
remove_plugin=removed.append,
log=_logger(),
)
success, clone_id = service.clone(
plugin_id="DemoPlugin",
suffix="Work",
name="工作实例",
description="独立配置",
version="9.9.9",
)
assert success is True
assert clone_id == "DemoPluginwork"
assert instances[clone_id].source_plugin_id == "DemoPlugin"
assert configs[clone_id] == {
"enable": False,
"enabled": False,
"token": "secret",
}
assert reloaded == [clone_id]
assert removed == []
def test_clone_service_rolls_back_descriptor_and_config_after_load_failure():
"""实例首次加载失败时不留下不可见描述或孤立配置。"""
instances: dict[str, PluginInstance] = {}
configs = {"DemoPlugin": {"enabled": True}}
removed: list[str] = []
class DemoPlugin:
"""提供失败回滚用例需要的最小源插件类。"""
service = PluginCloneService(
plugin_class=lambda _plugin_id: DemoPlugin,
plugin_exists=lambda plugin_id: plugin_id in instances,
source_plugin_id=lambda plugin_id: plugin_id,
save_instance=lambda instance: instances.__setitem__(
instance.instance_id,
instance,
),
delete_instance=lambda plugin_id: instances.pop(plugin_id, None) is not None,
read_config=lambda plugin_id: configs.get(plugin_id, {}),
save_config=lambda plugin_id, config: not configs.__setitem__(plugin_id, config),
delete_config=lambda plugin_id: configs.pop(plugin_id, None) is not None,
reload_plugin=lambda _plugin_id: PluginRuntimeStatus.LOAD_FAILED,
remove_plugin=removed.append,
log=_logger(),
)
success, message = service.clone(
plugin_id="DemoPlugin",
suffix="Broken",
name="失败实例",
description="",
)
assert success is False
assert "加载失败" in message
assert instances == {}
assert configs == {"DemoPlugin": {"enabled": True}}
assert removed == ["DemoPluginbroken"]