mirror of
https://github.com/insistence/RuoYi-Vue3-FastAPI.git
synced 2026-09-24 05:26:59 +00:00
insistence
2a055ba648
* feat: 初始化插件系统 * refactor: 收口插件系统运行时重构 * perf: 优化插件系统类型提示 * fix&perf: 修复和优化插件系统 * fix: 修复gitignore规则误忽略插件文件的问题 * fix: 修复运行时插件根路径算错的问题 * fix: 加强插件发现和路由注册的防护措施 * revert: 回滚定时任务白名单 * fix: 移除未使用的应用路由注册探测 * revert: 恢复部分代码 * perf: 优化插件系统 * docs: 新增插件开发文档 * perf: 优化插件管理模块 * perf: 提升插件系统核心能力 * refactor: 重构生命周期 step runner * fix: 修复lint错误 * test: 清理测试用例 * test: 调整测试目录名称 * fix: 修复前后端目录硬编码的问题 * fix: 修复插件系统安全性缺口 * refactor: 重新设计插件生命周期 Migration 事务与回滚 * perf: 优化插件系统边界问题 * refactor: 重构当前插件系统的依赖体系设计 * perf: 优化代码 * perf: 优化代码 * fix: 修复代码合并问题 * fix: 修复bug * perf: 优化代码 * perf&fix: 优化代码和修复bug * docs: 优化文档格式 * feat: 适配Vue2版本 * docs: 更新README文档 * fix: 修复ruff lint错误 * chore: 更新后端依赖文件
377 lines
17 KiB
Python
377 lines
17 KiB
Python
import json
|
|
from pathlib import Path
|
|
|
|
from cli.runtime.plugin.service import CliPluginRuntimeService
|
|
|
|
from .conftest import FakeRuntimeEnvironment, build_runtime
|
|
|
|
|
|
def write_frontend_package(frontend_root: Path, dependencies: dict[str, str]) -> None:
|
|
"""写入测试用前端 package.json。"""
|
|
frontend_root.mkdir(parents=True, exist_ok=True)
|
|
(frontend_root / 'package.json').write_text(
|
|
json.dumps({'dependencies': dependencies}),
|
|
encoding='utf-8',
|
|
)
|
|
|
|
|
|
class LazyPluginGateway:
|
|
"""
|
|
测试用 CLI 插件网关，验证开发者能力可懒解析运行时依赖。
|
|
"""
|
|
|
|
def __init__(self, backend_root: Path) -> None:
|
|
"""初始化测试用 CLI 插件网关。"""
|
|
self.backend_root = backend_root
|
|
self.runtime_environment_requested = False
|
|
|
|
def get_core_runtime_environment(self) -> FakeRuntimeEnvironment:
|
|
"""获取测试运行时环境。"""
|
|
self.runtime_environment_requested = True
|
|
return FakeRuntimeEnvironment(self.backend_root)
|
|
|
|
@staticmethod
|
|
def build_exception_payload(message: str, exc: Exception) -> dict[str, object]:
|
|
"""构建测试异常负载。"""
|
|
return {'ok': False, 'message': message, 'error': str(exc)}
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_lazily_resolves_runtime_environment(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会通过 CLI 网关懒解析运行时环境。"""
|
|
backend_root = tmp_path / 'backend'
|
|
backend_root.mkdir()
|
|
plugin_gateway = LazyPluginGateway(backend_root)
|
|
runtime = CliPluginRuntimeService(plugin_gateway=plugin_gateway)
|
|
|
|
payload = runtime.create_plugin('demo', dry_run=True)
|
|
|
|
assert payload['ok'] is True
|
|
assert plugin_gateway.runtime_environment_requested is True
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_dry_run_does_not_write_files(tmp_path: Path) -> None:
|
|
"""校验插件模板 dry-run 只返回写入计划，不写文件。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo', dry_run=True)
|
|
|
|
assert payload['ok'] is True
|
|
assert payload['dryRun'] is True
|
|
assert payload['template'] == 'full-stack'
|
|
assert payload['backend'] is True
|
|
assert payload['frontend'] is True
|
|
assert payload['frontendVersion'] == 'vue3'
|
|
assert payload['test'] is True
|
|
assert payload['backendTest'] is True
|
|
assert payload['frontendTest'] is True
|
|
assert str(backend_root / 'tests' / 'plugins' / 'demo') in payload['targetDirs']
|
|
assert str(project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo') in payload['targetDirs']
|
|
assert payload['files']
|
|
assert not (backend_root / 'plugins' / 'demo' / 'plugin.yaml').exists()
|
|
assert not (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').exists()
|
|
assert not (project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').exists()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_rejects_unsafe_plugin_id(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会拒绝不安全的插件ID。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('../../evil', dry_run=True)
|
|
|
|
assert payload['ok'] is False
|
|
assert '插件ID必须' in str(payload['error'])
|
|
assert not (project_root / 'evil').exists()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_uses_runtime_frontend_dir(tmp_path: Path) -> None:
|
|
"""校验插件模板创建使用运行时环境提供的前端目录。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'api-server'
|
|
frontend_root = project_root / 'web-client'
|
|
backend_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root, frontend_root=frontend_root).create_plugin('demo')
|
|
|
|
assert payload['ok'] is True
|
|
assert (backend_root / 'plugins' / 'demo' / 'plugin.yaml').is_file()
|
|
assert (frontend_root / 'plugins' / 'demo' / 'views' / 'index.vue').is_file()
|
|
assert (frontend_root / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').is_file()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_auto_detects_vue2_frontend(tmp_path: Path) -> None:
|
|
"""校验脚手架会从 package.json 自动识别 Vue 2 并生成对应语法。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'api-server'
|
|
frontend_root = project_root / 'web-client'
|
|
backend_root.mkdir(parents=True)
|
|
write_frontend_package(frontend_root, {'vue': '^2.7.16', 'element-ui': '^2.15.14'})
|
|
|
|
payload = build_runtime(backend_root, frontend_root=frontend_root).create_plugin('demo', template='crud-page')
|
|
|
|
view_content = (frontend_root / 'plugins' / 'demo' / 'views' / 'index.vue').read_text(encoding='utf-8')
|
|
test_content = (frontend_root / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').read_text(encoding='utf-8')
|
|
assert payload['ok'] is True
|
|
assert payload['frontendVersion'] == 'vue2'
|
|
assert '<script>' in view_content
|
|
assert 'export default {' in view_content
|
|
assert 'slot-scope="scope"' in view_content
|
|
assert '<script setup' not in view_content
|
|
assert "require('../../../src/utils/pluginViewResolver')" in test_content
|
|
assert "'./demo/views/index.vue'" in test_content
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_auto_detects_vue3_frontend(tmp_path: Path) -> None:
|
|
"""校验脚手架会从 package.json 自动识别 Vue 3 并生成对应语法。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'api-server'
|
|
frontend_root = project_root / 'web-client'
|
|
backend_root.mkdir(parents=True)
|
|
write_frontend_package(frontend_root, {'vue': '~3.5.26', 'element-plus': '^2.11.5'})
|
|
|
|
payload = build_runtime(backend_root, frontend_root=frontend_root).create_plugin('demo', template='crud-page')
|
|
|
|
view_content = (frontend_root / 'plugins' / 'demo' / 'views' / 'index.vue').read_text(encoding='utf-8')
|
|
test_content = (frontend_root / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').read_text(encoding='utf-8')
|
|
assert payload['ok'] is True
|
|
assert payload['frontendVersion'] == 'vue3'
|
|
assert '<script setup' in view_content
|
|
assert '<template #default="scope">' in view_content
|
|
assert 'export default {' not in view_content
|
|
assert "from '../../../src/utils/pluginViewResolver.js'" in test_content
|
|
assert "'../../../plugins/demo/views/index.vue'" in test_content
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_supports_frontend_version_override(tmp_path: Path) -> None:
|
|
"""校验显式 frontend_version 会覆盖 package.json 自动识别结果。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'api-server'
|
|
frontend_root = project_root / 'web-client'
|
|
backend_root.mkdir(parents=True)
|
|
write_frontend_package(frontend_root, {'vue': '^3.5.26'})
|
|
|
|
payload = build_runtime(backend_root, frontend_root=frontend_root).create_plugin(
|
|
'demo',
|
|
template='crud-page',
|
|
frontend_version='vue2',
|
|
dry_run=True,
|
|
)
|
|
|
|
view_payload = next(file for file in payload['files'] if str(file['path']).endswith('/views/index.vue'))
|
|
assert payload['ok'] is True
|
|
assert payload['frontendVersion'] == 'vue2'
|
|
assert 'export default {' in view_payload['content']
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_rejects_unknown_frontend_version(tmp_path: Path) -> None:
|
|
"""校验未知的 frontend_version 会返回清晰错误。"""
|
|
backend_root = tmp_path / 'project' / 'api-server'
|
|
backend_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo', frontend_version='vue4', dry_run=True)
|
|
|
|
assert payload['ok'] is False
|
|
assert 'frontend_version 仅支持 auto、vue2、vue3' in str(payload['error'])
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_writes_backend_and_frontend_files(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会写入后端和前端模板文件。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo')
|
|
|
|
assert payload['ok'] is True
|
|
assert (backend_root / 'plugins' / 'demo' / 'plugin.yaml').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'controller' / 'demo_controller.py').is_file()
|
|
assert not (backend_root / 'plugins' / 'demo' / '__init__.py').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'controller' / '__init__.py').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'service' / '__init__.py').exists()
|
|
assert (backend_root / 'plugins' / 'demo' / 'hooks.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'jobs.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'migrations' / '001_init.sql').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'seeds' / '001_seed.sql').is_file()
|
|
assert (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').is_file()
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo' / 'views' / 'index.vue').is_file()
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').is_file()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_generates_checkable_template(tmp_path: Path) -> None:
|
|
"""校验插件模板创建后可立即通过插件结构检查。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
runtime = build_runtime(backend_root)
|
|
|
|
create_payload = runtime.create_plugin('demo')
|
|
check_payload = runtime.core_runtime.check_plugin('demo')
|
|
|
|
assert create_payload['ok'] is True
|
|
assert check_payload['ok'] is True
|
|
assert check_payload['checks'][0]['structureErrors'] == []
|
|
assert check_payload['checks'][0]['manifestWarnings'] == []
|
|
assert (backend_root / 'plugins' / 'demo' / 'plugin.yaml').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'controller' / 'demo_controller.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'hooks.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'jobs.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'migrations' / '001_init.sql').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'seeds' / '001_seed.sql').is_file()
|
|
assert (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').is_file()
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo' / 'views' / 'index.vue').is_file()
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo' / 'pluginView.test.js').is_file()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_supports_optional_scaffold_parts(tmp_path: Path) -> None:
|
|
"""校验插件模板可以按参数跳过前端和可选后端示例。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
runtime = build_runtime(backend_root)
|
|
|
|
create_payload = runtime.create_plugin(
|
|
'demo',
|
|
frontend=False,
|
|
migration=False,
|
|
seed=False,
|
|
job=False,
|
|
config=False,
|
|
test=False,
|
|
)
|
|
check_payload = runtime.core_runtime.check_plugin('demo')
|
|
|
|
assert create_payload['ok'] is True
|
|
assert create_payload['frontend'] is False
|
|
assert create_payload['frontendVersion'] is None
|
|
assert create_payload['migration'] is False
|
|
assert create_payload['seed'] is False
|
|
assert create_payload['job'] is False
|
|
assert create_payload['config'] is False
|
|
assert create_payload['test'] is False
|
|
assert check_payload['ok'] is True
|
|
assert check_payload['checks'][0]['structureErrors'] == []
|
|
assert not (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'jobs.py').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'migrations' / '001_init.sql').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'seeds' / '001_seed.sql').exists()
|
|
assert not (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').exists()
|
|
assert not (project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo').exists()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_supports_minimal_template(tmp_path: Path) -> None:
|
|
"""校验 minimal 模板只生成后端最小插件和测试样例。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
runtime = build_runtime(backend_root)
|
|
|
|
create_payload = runtime.create_plugin('demo', template='minimal')
|
|
check_payload = runtime.core_runtime.check_plugin('demo')
|
|
|
|
assert create_payload['ok'] is True
|
|
assert create_payload['template'] == 'minimal'
|
|
assert create_payload['backend'] is True
|
|
assert create_payload['frontend'] is False
|
|
assert create_payload['frontendVersion'] is None
|
|
assert create_payload['migration'] is False
|
|
assert create_payload['seed'] is False
|
|
assert create_payload['job'] is False
|
|
assert create_payload['config'] is False
|
|
assert create_payload['test'] is True
|
|
assert check_payload['ok'] is True
|
|
assert not (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo').exists()
|
|
assert not (backend_root / 'plugins' / 'demo' / 'jobs.py').exists()
|
|
assert (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').is_file()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_supports_scheduled_job_template(tmp_path: Path) -> None:
|
|
"""校验 scheduled-job 模板生成后端任务插件。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
runtime = build_runtime(backend_root)
|
|
|
|
create_payload = runtime.create_plugin('demo', template='scheduled-job')
|
|
check_payload = runtime.core_runtime.check_plugin('demo')
|
|
|
|
assert create_payload['ok'] is True
|
|
assert create_payload['template'] == 'scheduled-job'
|
|
assert create_payload['backend'] is True
|
|
assert create_payload['frontend'] is False
|
|
assert create_payload['frontendVersion'] is None
|
|
assert create_payload['migration'] is False
|
|
assert create_payload['seed'] is False
|
|
assert create_payload['job'] is True
|
|
assert create_payload['config'] is False
|
|
assert check_payload['ok'] is True
|
|
assert (backend_root / 'plugins' / 'demo' / 'jobs.py').is_file()
|
|
assert not (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo').exists()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_supports_crud_page_template(tmp_path: Path) -> None:
|
|
"""校验 crud-page 模板生成后端接口、前端页面和测试样例。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
backend_root.mkdir(parents=True)
|
|
runtime = build_runtime(backend_root)
|
|
|
|
create_payload = runtime.create_plugin('demo', template='crud-page')
|
|
check_payload = runtime.core_runtime.check_plugin('demo')
|
|
|
|
assert create_payload['ok'] is True
|
|
assert create_payload['template'] == 'crud-page'
|
|
assert create_payload['backend'] is True
|
|
assert create_payload['frontend'] is True
|
|
assert create_payload['crud'] is True
|
|
assert create_payload['job'] is False
|
|
assert check_payload['ok'] is True
|
|
assert check_payload['checks'][0]['manifestWarnings'] == []
|
|
assert (backend_root / 'plugins' / 'demo' / 'controller' / 'demo_controller.py').is_file()
|
|
assert (backend_root / 'plugins' / 'demo' / 'service' / 'demo_service.py').is_file()
|
|
assert (backend_root / 'tests' / 'plugins' / 'demo' / 'test_ping.py').read_text(encoding='utf-8').find(
|
|
'service_crud_flow'
|
|
) > -1
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo' / 'api' / 'demo.js').is_file()
|
|
assert (project_root / 'ruoyi-fastapi-frontend' / 'plugins' / 'demo' / 'views' / 'index.vue').is_file()
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_rejects_existing_target_dir(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会拒绝覆盖已存在目录。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
(backend_root / 'plugins' / 'demo').mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo')
|
|
|
|
assert payload['ok'] is False
|
|
assert payload['conflicts'] == [str(backend_root / 'plugins' / 'demo')]
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_rejects_existing_test_dir(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会拒绝覆盖已存在后端测试目录。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
(backend_root / 'tests' / 'plugins' / 'demo').mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo')
|
|
|
|
assert payload['ok'] is False
|
|
assert payload['conflicts'] == [str(backend_root / 'tests' / 'plugins' / 'demo')]
|
|
|
|
|
|
def test_plugin_runtime_create_plugin_rejects_existing_frontend_test_dir(tmp_path: Path) -> None:
|
|
"""校验插件模板创建会拒绝覆盖已存在前端测试目录。"""
|
|
project_root = tmp_path / 'project'
|
|
backend_root = project_root / 'ruoyi-fastapi-backend'
|
|
frontend_test_root = project_root / 'ruoyi-fastapi-frontend' / 'tests' / 'plugins' / 'demo'
|
|
backend_root.mkdir(parents=True)
|
|
frontend_test_root.mkdir(parents=True)
|
|
|
|
payload = build_runtime(backend_root).create_plugin('demo')
|
|
|
|
assert payload['ok'] is False
|
|
assert payload['conflicts'] == [str(frontend_test_root)]
|