Files
RuoYi-Vue3-FastAPI/ruoyi-fastapi-backend/tests/cli/root/test_contract_app_ops.py
T
insistence 4bd83bc7cd feat: 支持 v2 插件、独立前端和签名制品发布 (#130)
* feat: 支持 v2 插件、原生扩展与签名发布

* fix: 修复测试

* feat: 增强宿主 SDK、运行观测与制品维护能力

* feat: 增强文件传输、配置观测与本地开发能力

* feat: 支持 SSE 实时事件流并完善开发脚手架

* feat: 完善长连接鉴权复核与关闭回收

* feat: 增强生命周期与任务关闭可靠性

* feat: 收紧健康检查契约并补齐前端与真实网络验收

* feat: 增加SDK溯源与离线更新工具并验证跨版本兼容

* feat: 增加持久化业务示例与受控 Python 交付

* feat: 增加统一运行诊断与多worker状态观测

* feat: 增加固定目标发布等待与自动验收

* fix: 修复多环境插件部署前缀与代理配置不一致

* fix: 修复测试
2026-10-09 23:49:45 +08:00

611 lines
23 KiB
Python

import os
import subprocess
import sys
from collections.abc import Callable
from pathlib import Path
from textwrap import dedent
from cli.exit_codes import DEPENDENCY_ERROR, SUCCESS
from cli.runtime.plugin.scaffold import PluginFrontendVersionResolver
FRONTEND_ROOT = Path(__file__).resolve().parents[4] / 'ruoyi-fastapi-frontend'
def test_app_config_json_output_is_pure_json(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('app', 'config', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == 0
assert completed.stderr == ''
assert payload['ok'] is True
assert payload['env'] == 'dev'
assert isinstance(payload['config'], dict)
assert '\u001b[' not in completed.stdout
assert '✅' not in completed.stdout
assert '❌' not in completed.stdout
def test_app_config_text_output_has_stable_section_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('app', 'config', '--env=dev', '--output=text')
assert completed.returncode == SUCCESS
assert '\x1b[' not in completed.stdout
assert '✅' not in completed.stdout
assert completed.stdout.startswith('OK SUCCESS\n')
assert 'env: dev\n' in completed.stdout
assert 'application:\n' in completed.stdout
assert 'database:\n' in completed.stdout
assert 'redis:\n' in completed.stdout
assert 'logging:\n' in completed.stdout
assert 'transport_crypto:\n' in completed.stdout
def test_app_env_text_output_has_stable_section_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('app', 'env', '--env=dev', '--output=text')
assert completed.returncode == SUCCESS
assert completed.stdout.startswith('OK SUCCESS\n')
assert 'env: dev\n' in completed.stdout
assert 'runtime:\n' in completed.stdout
assert 'cli_env: dev\n' in completed.stdout
assert 'config_env:' in completed.stdout
assert 'app_env: dev\n' in completed.stdout
assert 'env_file: .env.dev\n' in completed.stdout
assert 'env_file_exists:' in completed.stdout
assert 'backend_dir:' in completed.stdout
assert 'python_executable:' in completed.stdout
def test_app_doctor_text_output_has_stable_check_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('app', 'doctor', '--env=dev', '--output=text')
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert '\x1b[' not in completed.stdout
assert '✅' not in completed.stdout
assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n'))
assert 'env: dev\n' in completed.stdout
assert 'checks:\n' in completed.stdout
assert 'database:' in completed.stdout
assert 'redis:' in completed.stdout
assert 'crypto:' in completed.stdout
assert 'oidc:' in completed.stdout
def test_app_doctor_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
assert_check_payload_contract: Callable[[dict, bool], None],
) -> None:
completed = run_cli_command('app', 'doctor', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert completed.stderr == ''
assert payload['env'] == 'dev'
assert isinstance(payload['ok'], bool)
assert set(payload) == {'env', 'database', 'redis', 'crypto', 'oidc', 'ok'}
assert_check_payload_contract(payload['database'], True)
assert_check_payload_contract(payload['redis'], True)
assert_check_payload_contract(payload['crypto'], False)
assert_check_payload_contract(payload['oidc'], False)
def test_app_env_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('app', 'env', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == SUCCESS
assert payload['ok'] is True
assert payload['env'] == 'dev'
assert set(payload) == {'ok', 'env', 'runtime'}
assert isinstance(payload['runtime'], dict)
assert set(payload['runtime']) == {
'cliEnv',
'configEnv',
'appEnv',
'envFile',
'envFilePath',
'envFileExists',
'backendDir',
'pythonExecutable',
}
assert payload['runtime']['cliEnv'] == 'dev'
assert payload['runtime']['appEnv'] == 'dev'
assert payload['runtime']['envFile'] == '.env.dev'
assert isinstance(payload['runtime']['envFileExists'], bool)
def test_app_routes_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('app', 'routes', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == 0
assert payload['ok'] is True
assert payload['env'] == 'dev'
assert isinstance(payload['count'], int)
assert payload['count'] > 0
assert payload['groupedRoutes'] is None
assert payload['filters'] == {
'pathPrefix': '',
'method': '',
'groupBy': 'none',
'includeHidden': False,
}
assert isinstance(payload['routes'], list)
assert payload['routes']
first_route = payload['routes'][0]
assert set(first_route) == {
'path',
'methods',
'name',
'summary',
'operationId',
'tags',
'includeInSchema',
}
assert isinstance(first_route['path'], str)
assert isinstance(first_route['methods'], list)
assert first_route['methods']
assert all(isinstance(method, str) for method in first_route['methods'])
assert isinstance(first_route['name'], str | None)
assert isinstance(first_route['summary'], str | None)
assert isinstance(first_route['operationId'], str | None)
assert isinstance(first_route['tags'], list)
assert all(isinstance(tag, str) for tag in first_route['tags'])
assert isinstance(first_route['includeInSchema'], bool)
def test_server_info_text_output_has_stable_section_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('ops', 'server-info', '--env=dev')
assert completed.returncode == 0
assert '\x1b[' not in completed.stdout
assert '✅' not in completed.stdout
assert completed.stdout.startswith('OK SUCCESS\n')
assert 'host:\n' in completed.stdout
assert 'cpu:\n' in completed.stdout
assert 'memory:\n' in completed.stdout
assert 'python:\n' in completed.stdout
assert 'disks:' in completed.stdout
def test_ops_health_text_output_has_stable_check_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('ops', 'health', '--env=dev', '--output=text')
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert '\x1b[' not in completed.stdout
assert '✅' not in completed.stdout
assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n'))
assert 'env: dev\n' in completed.stdout
assert 'checks:\n' in completed.stdout
assert 'database:' in completed.stdout
assert 'redis:' in completed.stdout
def test_ops_deps_text_output_has_stable_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('ops', 'deps', '--env=dev', '--output=text')
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert completed.stdout.startswith(('OK SUCCESS\n', 'FAIL FAILED\n'))
assert 'message:' in completed.stdout
assert 'include_dev: false\n' in completed.stdout
assert 'missing_required:' in completed.stdout
assert 'packages:\n' in completed.stdout
assert 'python:' in completed.stdout
assert 'fastapi:' in completed.stdout
assert 'typer:' in completed.stdout
def test_ops_health_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
assert_check_payload_contract: Callable[[dict, bool], None],
) -> None:
completed = run_cli_command('ops', 'health', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert completed.stderr == ''
assert payload['env'] == 'dev'
assert isinstance(payload['ok'], bool)
assert set(payload) == {'env', 'database', 'redis', 'ok'}
assert_check_payload_contract(payload['database'], True)
assert_check_payload_contract(payload['redis'], True)
def test_ops_deps_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('ops', 'deps', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert set(payload) == {'ok', 'message', 'missingRequired', 'includeDev', 'packages'}
assert isinstance(payload['ok'], bool)
assert isinstance(payload['message'], str)
assert isinstance(payload['missingRequired'], list)
assert payload['includeDev'] is False
assert isinstance(payload['packages'], dict)
assert 'python' in payload['packages']
assert 'fastapi' in payload['packages']
assert 'typer' in payload['packages']
for package_payload in payload['packages'].values():
assert isinstance(package_payload, dict)
assert isinstance(package_payload.get('installed'), bool)
assert isinstance(package_payload.get('version'), str)
assert isinstance(package_payload.get('required'), bool)
def test_ops_server_info_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('ops', 'server-info', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == 0
assert payload['ok'] is True
assert isinstance(payload['server'], dict)
server = payload['server']
assert set(server) == {'cpu', 'mem', 'sys', 'py', 'sysFiles'}
cpu = server['cpu']
assert set(cpu) == {'cpuNum', 'used', 'sys', 'free'}
assert isinstance(cpu['cpuNum'], int)
assert isinstance(cpu['used'], float | int | str)
assert isinstance(cpu['sys'], float | int | str)
assert isinstance(cpu['free'], float | int | str)
memory = server['mem']
assert set(memory) == {'total', 'used', 'free', 'usage'}
assert isinstance(memory['total'], str)
assert isinstance(memory['used'], str)
assert isinstance(memory['free'], str)
assert isinstance(memory['usage'], float | int)
sys_info = server['sys']
assert set(sys_info) == {'computerIp', 'computerName', 'osArch', 'osName', 'userDir'}
assert all(isinstance(value, str) for value in sys_info.values())
py_info = server['py']
assert set(py_info) == {
'name',
'version',
'startTime',
'runTime',
'home',
'total',
'used',
'free',
'usage',
}
assert isinstance(py_info['name'], str)
assert isinstance(py_info['version'], str)
assert isinstance(py_info['startTime'], str)
assert isinstance(py_info['runTime'], str)
assert isinstance(py_info['home'], str)
assert isinstance(py_info['total'], str)
assert isinstance(py_info['used'], str)
assert isinstance(py_info['free'], str)
assert isinstance(py_info['usage'], float | int)
assert isinstance(server['sysFiles'], list)
assert server['sysFiles']
first_disk = server['sysFiles'][0]
assert set(first_disk) == {'dirName', 'sysTypeName', 'typeName', 'total', 'used', 'free', 'usage'}
assert all(isinstance(value, str) for value in first_disk.values())
def test_plugin_list_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'list', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == SUCCESS
assert set(payload) == {'ok', 'count', 'plugins', 'databaseAvailable', 'databaseError'}
assert payload['ok'] is True
assert isinstance(payload['count'], int)
assert isinstance(payload['databaseAvailable'], bool)
assert isinstance(payload['plugins'], list)
if payload['plugins']:
assert isinstance(payload['plugins'][0]['runtimeEnabled'], bool)
assert 'enabled' not in payload['plugins'][0]
def test_plugin_check_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'check', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert set(payload) == {'ok', 'message', 'count', 'databaseAvailable', 'databaseError', 'checks'}
assert isinstance(payload['ok'], bool)
assert isinstance(payload['message'], str)
assert isinstance(payload['count'], int)
assert isinstance(payload['databaseAvailable'], bool)
assert isinstance(payload['checks'], list)
if payload['checks']:
check_payload = payload['checks'][0]
assert {
'pluginId',
'ok',
'dependencies',
'structure',
'missingDependencies',
'unsatisfiedDependencies',
'structureErrors',
'menuConflicts',
}.issubset(check_payload)
def test_plugin_check_deps_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'check-deps', 'ai', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert {
'ok',
'message',
'pluginId',
'dependencyOk',
'dependencies',
'missingDependencies',
'unsatisfiedDependencies',
}.issubset(payload)
assert payload['pluginId'] == 'ai'
assert isinstance(payload['dependencies'], list)
def test_plugin_install_deps_dry_run_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'install-deps', 'ai', '--dry-run', '--yes', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == SUCCESS
assert payload['ok'] is True
assert payload['pluginId'] == 'ai'
assert payload['dryRun'] is True
assert isinstance(payload['plan'], list)
assert isinstance(payload['planCount'], int)
def test_plugin_plan_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'plan', 'install', 'ai', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert payload['operation'] == 'install'
assert 'plan' in payload
assert isinstance(payload['plan']['orderedPluginIds'], list)
assert isinstance(payload['plan']['items'], list)
assert isinstance(payload['plan']['blockers'], list)
assert isinstance(payload['plan']['blockerCount'], int)
def test_plugin_plan_rejects_invalid_operation_at_cli_boundary(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_cli_command('plugin', 'plan', 'remove', 'ai', '--env=dev', '--output=json')
assert completed.returncode != SUCCESS
assert 'remove' in completed.stderr
def test_plugin_batch_dry_run_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'batch', 'install', 'ai', '--dry-run', '--yes', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode in {SUCCESS, DEPENDENCY_ERROR}
assert payload['operation'] == 'install'
assert payload['dryRun'] is True
assert payload['continueOnError'] is False
assert 'plan' in payload
assert isinstance(payload['executed'], list)
assert isinstance(payload['summary'], dict)
assert set(payload['summary']) == {'total', 'succeeded', 'failed', 'skipped'}
assert payload['failed'] is None
def test_plugin_list_text_output_has_stable_structure(
run_text_cli_command: Callable[..., subprocess.CompletedProcess[str]],
) -> None:
completed = run_text_cli_command('plugin', 'list', '--env=dev', '--output=text')
assert completed.returncode == SUCCESS
assert completed.stdout.startswith('OK SUCCESS\n')
assert 'count:' in completed.stdout
assert 'plugins:' in completed.stdout
def test_plugin_create_dry_run_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command('plugin', 'create', 'contract_demo', '--dry-run', '--env=dev', '--output=json')
payload = parse_json_stdout(completed)
assert completed.returncode == SUCCESS
assert payload['ok'] is True
assert payload['pluginId'] == 'contract_demo'
assert payload['dryRun'] is True
assert payload['backend'] is True
assert payload['frontend'] is True
assert payload['frontendVersion'] == PluginFrontendVersionResolver.resolve(FRONTEND_ROOT)
assert payload['migration'] is True
assert payload['seed'] is True
assert payload['job'] is True
assert payload['config'] is True
assert isinstance(payload['targetDirs'], list)
assert isinstance(payload['files'], list)
assert payload['conflicts'] == []
def test_plugin_create_optional_parts_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command(
'plugin',
'create',
'contract_minimal',
'--dry-run',
'--backend-only',
'--no-migration',
'--no-seed',
'--no-job',
'--no-config',
'--env=dev',
'--output=json',
)
payload = parse_json_stdout(completed)
assert completed.returncode == SUCCESS
assert payload['ok'] is True
assert payload['pluginId'] == 'contract_minimal'
assert payload['frontend'] is False
assert payload['migration'] is False
assert payload['seed'] is False
assert payload['job'] is False
assert payload['config'] is False
def test_plugin_create_frontend_version_override_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command(
'plugin',
'create',
'contract_vue2',
'--dry-run',
'--frontend-only',
'--frontend-version=vue2',
'--env=dev',
'--output=json',
)
payload = parse_json_stdout(completed)
view_payload = next(file for file in payload['files'] if str(file['path']).endswith('/views/index.vue'))
assert completed.returncode == SUCCESS
assert payload['ok'] is True
assert payload['frontendVersion'] == 'vue2'
assert 'slot="header"' in view_payload['content']
def test_plugin_install_dry_run_json_output_has_stable_contract(
run_cli_command: Callable[..., subprocess.CompletedProcess[str]],
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
completed = run_cli_command(
'plugin', 'install', 'missing_plugin', '--dry-run', '--yes', '--env=dev', '--output=json'
)
payload = parse_json_stdout(completed)
assert completed.returncode != SUCCESS
assert payload['ok'] is False
assert payload['pluginId'] == 'missing_plugin'
assert isinstance(payload['message'], str)
def test_plugin_upgrade_dry_run_json_output_has_stable_contract(
backend_dir: Path,
parse_json_stdout: Callable[[subprocess.CompletedProcess[str]], dict],
) -> None:
# 成功契约需要已确认的目录插件来源;CI 不应连接宿主数据库来决定测试结果。
script = dedent(
"""
import runpy
import sys
from types import SimpleNamespace
from unittest.mock import AsyncMock, Mock, patch
from plugins.core.management.service.gateway import PluginManagementRuntimeGateway
state = SimpleNamespace(plugin_id='ai', source='local', installed_version='0.0.1')
read_state = AsyncMock(return_value=state)
read_history = AsyncMock(return_value=None)
database = Mock(side_effect=AssertionError('Contract tests must not open database sessions'))
sys.argv[0] = 'ruoyi'
with (
patch.object(PluginManagementRuntimeGateway, 'get_plugin_state', read_state),
patch.object(PluginManagementRuntimeGateway, 'get_plugin_migration', read_history),
patch.object(PluginManagementRuntimeGateway, 'get_async_session_local', database),
):
try:
runpy.run_module('cli.main', run_name='__main__')
finally:
read_state.assert_any_await('ai')
database.assert_not_called()
"""
)
completed = subprocess.run(
[
sys.executable,
'-c',
script,
'plugin',
'upgrade',
'ai',
'--dry-run',
'--yes',
'--env=dev',
'--output=json',
],
cwd=backend_dir,
capture_output=True,
text=True,
encoding='utf-8',
env={**os.environ, 'PYTHONIOENCODING': 'utf-8', 'LOG_FILE_ENABLED': 'false'},
check=False,
timeout=60,
)
assert completed.returncode == SUCCESS, completed.stderr
payload = parse_json_stdout(completed)
assert payload['ok'] is True
assert payload['pluginId'] == 'ai'
assert payload['dryRun'] is True
assert payload['installedVersion'] == '0.0.1'
assert 'currentVersion' in payload
assert payload['needsUpgrade'] is True
assert payload['databaseAvailable'] is True
assert isinstance(payload['actions'], list)