Files
MoviePilot/tests/test_plugin_database_hooks.py
Aqr-K d7c5955031 fix(plugin): 插件自有数据库释放与销毁全程容错,并修正建表去重与 schema 命名
release/destroy 统一经 _close_handle 先清线程局部会话再 dispose,两步失败都
只记日志:单个插件的连接池故障不再让 close_database 跳过宿主同步与异步引擎的
释放,release_all_databases 也逐插件隔离。按模型建表对 __table__ 去重,单表
继承的父子类一并声明时不再对同一张表建两次。

卸载编排先删插件数据、后停插件,停机钩子里的 get_database() 会把刚销毁的库
重新建出来:注册表记下已销毁的插件标识,其后的 release 改为再次销毁并清除
标记,ensure 则撤销标记,宿主编排代码不动。PostgreSQL schema 名在归一改写过
标识或超长时追加插件标识哈希并截到 63 字节,My-Plugin、My_Plugin 与
my_plugin 不再折叠到同一个 schema 而在卸载时互相 DROP。

start 的失败分支释放已经建立、却进不了运行态的句柄,整体停止把只登记在
_classes 里的插件一并释放。声明的迁移目录不存在时在建句柄之前抛
FileNotFoundError,不再留下空库;SQLite 迁移 URL 改由引擎渲染;
_get_sqlite_engine 的连接参数下沉到实际使用它的异步分支。
2026-09-02 02:14:19 -04:00

177 lines
5.9 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""_PluginBase 自有数据库钩子与插件 SDK 数据库入口。"""
from __future__ import annotations
from pathlib import Path
from typing import Any, Dict, List, Optional, Tuple
import pytest
from sqlalchemy import inspect as sa_inspect
from sqlalchemy.orm import Mapped, mapped_column
import app.db.plugin.locator as locator_module
import app.db.plugin.registry as registry_module
from app.db.decorators import db_query, db_update
from app.db.plugin.base import plugin_declarative_base
from app.plugins import _PluginBase
class _SamplePlugin(_PluginBase):
"""只实现最小生命周期合同的插件测试替身。"""
plugin_name = "示例插件"
def init_plugin(self, config: dict = None):
"""接受宿主初始化配置。"""
def get_state(self) -> bool:
"""保持插件为启用状态。"""
return True
def get_api(self) -> List[Dict[str, Any]]:
"""不注册任何 API。"""
return []
def get_form(self) -> Tuple[Optional[List[dict]], Dict[str, Any]]:
"""不提供配置页面。"""
return None, {}
def get_page(self) -> Optional[List[dict]]:
"""不提供详情页面。"""
return None
def stop_service(self):
"""无后台资源需要停止。"""
@pytest.fixture(autouse=True)
def _isolate_plugin_databases():
"""快照插件数据库句柄与销毁标记,用例结束后释放残留句柄并还原快照。"""
handles = dict(registry_module._handles)
destroyed = set(registry_module._destroyed)
registry_module._handles.clear()
registry_module._destroyed.clear()
yield
for plugin_id in list(registry_module._handles):
registry_module.release_database(plugin_id)
registry_module._handles.clear()
registry_module._handles.update(handles)
registry_module._destroyed.clear()
registry_module._destroyed.update(destroyed)
@pytest.fixture
def plugin_data_root(tmp_path, monkeypatch) -> Path:
"""把插件数据库文件隔离到进程私有的临时目录。"""
root = tmp_path / "plugins"
monkeypatch.setattr(
locator_module,
"get_runtime_setting",
lambda key, default=None: root if key == "PLUGIN_DATA_PATH" else default,
)
return root
def test_database_declaration_hooks_default_to_no_declaration():
"""未重写声明钩子的插件视为既未声明模型也未声明迁移目录。"""
plugin = _SamplePlugin()
assert plugin.get_database_models() is None
assert plugin.get_database_migrations() is None
def test_get_database_uses_the_plugin_class_name(plugin_data_root):
"""未显式传入插件ID时,句柄按插件类名解析,与 get_data_path() 目录约定一致。"""
plugin = _SamplePlugin()
handle = plugin.get_database()
assert handle.plugin_id == "_SamplePlugin"
assert handle.db_path == plugin_data_root / "_SamplePlugin" / "plugin.db"
def test_get_database_honours_an_explicit_plugin_id(plugin_data_root):
"""显式传入插件ID时按该ID解析句柄,不回退到类名。"""
plugin = _SamplePlugin()
handle = plugin.get_database(plugin_id="OtherPlugin")
assert handle.plugin_id == "OtherPlugin"
def test_clone_class_name_selects_its_own_database(plugin_data_root):
"""分身的类名即插件运行时标识,句柄与源插件互不相同。"""
clone_cls = type("_SamplePluginwork", (_SamplePlugin,), {})
clone = clone_cls()
source = _SamplePlugin()
clone_handle = clone.get_database()
source_handle = source.get_database()
assert clone_handle.plugin_id == "_SamplePluginwork"
assert clone_handle.db_path != source_handle.db_path
def test_declared_models_reach_the_framework_through_the_lifecycle_hook(plugin_data_root):
"""宿主一次性拉取 get_database_models() 的返回值建表,端到端验证拉取式链路。"""
base = plugin_declarative_base()
class Widget(base):
__tablename__ = "widgets"
id: Mapped[int] = mapped_column(primary_key=True)
class _ModelPlugin(_SamplePlugin):
"""声明一个模型的插件测试替身。"""
def get_database_models(self):
"""声明 Widget 模型。"""
return [Widget]
plugin = _ModelPlugin()
registry_module.ensure_database("_ModelPlugin", plugin.get_database_models())
handle = plugin.get_database()
tables = set(sa_inspect(handle.engine).get_table_names())
assert tables == {"widgets"}
def test_sdk_database_exports_the_plugin_database_contract():
"""SDK 门面复用 db 层的同一对象,不复制实现或制造第二套定义。"""
import app.db.plugin.base as base_module
import app.db.plugin.container as container_module
import app.sdk.database as sdk_database
assert sdk_database.plugin_declarative_base is base_module.plugin_declarative_base
assert sdk_database.PluginDatabaseHandle is container_module.PluginDatabaseHandle
assert "plugin_declarative_base" in sdk_database.__all__
assert "PluginDatabaseHandle" in sdk_database.__all__
def test_host_transaction_decorators_accept_a_plugin_owned_session(plugin_data_root):
"""db_update/db_query 的自动兜底不认识插件库,但显式传入的插件会话原样可用。"""
base = plugin_declarative_base()
class Widget(base):
__tablename__ = "widgets"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str] = mapped_column()
registry_module.ensure_database("demo", (Widget,))
handle = registry_module.get_database("demo")
@db_update
def _write(db, widget):
"""插入一条记录,提交由装饰器负责。"""
db.add(widget)
@db_query
def _count(db):
"""读取记录数。"""
return db.query(Widget).count()
session = handle.session()
try:
_write(session, Widget(id=1, name="a"))
assert _count(session) == 1
finally:
session.close()