エイカク
6da59cfb07
* fix: install plugin requirements before first load * fix: handle pip option arguments correctly * fix: harden pip install input parsing * refactor: simplify pip install input parsing * fix: align plugin dependency install handling * fix: respect configured pip index overrides * test: parameterize plugin dependency install flows * refactor: simplify multiline pip input parsing * fix: install plugin dependencies before loading * fix: protect core dependencies from downgrades and simplify package input splitting * fix: enhance dependency conflict reporting and improve user-facing warnings * refactor: preserve pip log indentation and fix CodeQL URL sanitization alert * fix: explicit re-export for DependencyConflictError to satisfy ruff F401 * test: enhance index override verification in pip installer tests * fix: correctly map pip ERROR and WARNING outputs to proper log levels * refactor: show specific version conflicts in DependencyConflictError and revert log level mapping * refactor: simplify install() by decoupling pip logging, failure classification and constraint file management * refactor: further simplify pip installer and requirement parsing logic * refactor: simplify dependency installation logic and improve circular requirement reporting * style: organize imports in astrbot/core/__init__.py * refactor: optimize requirement parsing efficiency and flatten pip installer API * style: fix import sorting in astrbot/core/__init__.py * refactor: consolidate requirement parsing, optimize core protection, and improve exception propagation * fix: preserve valid pip requirement parsing * fix: skip empty pip installs and preserve blank output * chore: normalize gitignore entry style * fix: tighten pip trust and requirement parsing * refactor: centralize pip install parsing and failure handling * fix: redact pip argv credentials in logs * fix: surface plugin dependency install errors * fix: cache core constraints and clarify requirement installs * fix: harden pip requirement parsing for plugin installs * fix: simplify pip installer parsing internals * fix: tighten pip installer parsing and redaction * refactor: simplify plugin dependency install flow * fix: preserve core constraint conflict errors * fix: harden pip installer fallback resolution * refactor: split pip requirement and constraint helpers * refactor: simplify pip installer helper flow * refactor: streamline requirement precheck helpers * refactor: clarify core constraint resolution * fix: surface pip install failures explicitly * refactor: separate pip conflict context parsing * fix: harden core constraint resolution * test: cover pip installer failure call sites * refactor: remove dead requirements fallback helper * refactor: narrow core constraint error handling * refactor: unify requirement iteration * refactor: share requirement name parsing * test: align pip helper coverage * fix: bind pip output limit at runtime * refactor: reuse core requirement parser for tokens
473 lines
16 KiB
Python
473 lines
16 KiB
Python
import asyncio
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
import yaml
|
|
|
|
from astrbot.core.star.star_manager import PluginDependencyInstallError, PluginManager
|
|
from astrbot.core.utils.pip_installer import PipInstallError
|
|
|
|
# --- Test Data & Helpers ---
|
|
|
|
TEST_PLUGIN_NAME = "helloworld"
|
|
TEST_PLUGIN_REPO = "https://github.com/AstrBotDevs/astrbot_plugin_helloworld"
|
|
TEST_PLUGIN_DIR = "helloworld"
|
|
|
|
|
|
class MockStar:
|
|
def __init__(self):
|
|
self.root_dir_name = TEST_PLUGIN_DIR
|
|
self.name = TEST_PLUGIN_NAME
|
|
self.repo = TEST_PLUGIN_REPO
|
|
self.reserved = False
|
|
self.info = {"repo": TEST_PLUGIN_REPO, "readme": ""}
|
|
|
|
|
|
def _write_local_test_plugin(plugin_path: Path, repo_url: str):
|
|
"""Creates a minimal valid plugin structure."""
|
|
plugin_path.mkdir(parents=True, exist_ok=True)
|
|
metadata = {
|
|
"name": TEST_PLUGIN_NAME,
|
|
"repo": repo_url,
|
|
"version": "1.0.0",
|
|
"author": "AstrBot Team",
|
|
"desc": "Local test plugin",
|
|
}
|
|
with open(plugin_path / "info.yaml", "w", encoding="utf-8") as f:
|
|
yaml.dump(metadata, f)
|
|
with open(plugin_path / "main.py", "w", encoding="utf-8") as f:
|
|
f.write("from astrbot.api.star import Star, Context, StarManager\n")
|
|
f.write("@StarManager.register\n")
|
|
f.write("class HelloWorld(Star):\n")
|
|
f.write(" def __init__(self, context: Context): ...\n")
|
|
|
|
|
|
def _write_requirements(plugin_path: Path):
|
|
"""Creates a requirements.txt file."""
|
|
with open(plugin_path / "requirements.txt", "w", encoding="utf-8") as f:
|
|
f.write("networkx\n")
|
|
|
|
|
|
def _clear_module_cache():
|
|
"""Clear test-specific modules from sys.modules to allow reloading."""
|
|
import sys
|
|
|
|
to_del = [m for m in sys.modules if m.startswith("data.plugins.helloworld")]
|
|
for m in to_del:
|
|
del sys.modules[m]
|
|
|
|
|
|
def _build_load_mock(events):
|
|
async def mock_load(specified_dir_name=None, ignore_version_check=False):
|
|
del ignore_version_check
|
|
events.append(("load", specified_dir_name or TEST_PLUGIN_DIR))
|
|
return True, ""
|
|
|
|
return mock_load
|
|
|
|
|
|
def _build_reload_mock(events):
|
|
async def mock_reload(specified_dir_name=None):
|
|
events.append(("reload", specified_dir_name or TEST_PLUGIN_DIR))
|
|
return True, ""
|
|
|
|
return mock_reload
|
|
|
|
|
|
def _build_dependency_install_mock(events, fail: bool):
|
|
async def mock_install_requirements(
|
|
*, requirements_path: str = None, package_name: str = None, **kwargs
|
|
):
|
|
del kwargs
|
|
if requirements_path:
|
|
events.append(("deps", str(requirements_path)))
|
|
if package_name:
|
|
events.append(("deps_pkg", package_name))
|
|
if fail:
|
|
raise Exception("pip failed")
|
|
|
|
return mock_install_requirements
|
|
|
|
|
|
def _mock_missing_requirements(monkeypatch, missing: set[str]):
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.find_missing_requirements_or_raise",
|
|
lambda requirements_path: missing,
|
|
)
|
|
|
|
|
|
def _mock_precheck_fails(monkeypatch):
|
|
from astrbot.core import RequirementsPrecheckFailed
|
|
|
|
def mock_fail(requirements_path):
|
|
raise RequirementsPrecheckFailed("mock precheck failure")
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.find_missing_requirements_or_raise",
|
|
mock_fail,
|
|
)
|
|
|
|
|
|
# --- Fixtures ---
|
|
|
|
|
|
@pytest.fixture
|
|
def plugin_manager_pm(tmp_path, monkeypatch):
|
|
"""Provides a fully isolated PluginManager instance for testing."""
|
|
# Clear module cache before setup to ensure isolation
|
|
_clear_module_cache()
|
|
|
|
plugin_dir = tmp_path / "astrbot_root" / "data" / "plugins"
|
|
plugin_dir.mkdir(parents=True, exist_ok=True)
|
|
|
|
class MockContext:
|
|
def __init__(self):
|
|
self.stars = []
|
|
|
|
def get_all_stars(self):
|
|
return self.stars
|
|
|
|
def get_registered_star(self, name):
|
|
for s in self.stars:
|
|
if s.root_dir_name == name or s.name == name:
|
|
return s
|
|
return None
|
|
|
|
mock_context = MockContext()
|
|
mock_config = {}
|
|
pm = PluginManager(mock_context, mock_config)
|
|
|
|
# Patch paths to use tmp_path
|
|
monkeypatch.setattr(pm, "plugin_store_path", str(plugin_dir))
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.get_astrbot_plugin_path",
|
|
lambda: str(plugin_dir),
|
|
)
|
|
|
|
return pm
|
|
|
|
|
|
@pytest.fixture
|
|
def local_updator(plugin_manager_pm):
|
|
"""Helper to setup a local plugin directory simulating a download."""
|
|
path = Path(plugin_manager_pm.plugin_store_path) / TEST_PLUGIN_DIR
|
|
_write_local_test_plugin(path, TEST_PLUGIN_REPO)
|
|
return path
|
|
|
|
|
|
# --- Tests ---
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("dependency_install_fails", [False, True])
|
|
async def test_install_plugin_dependency_install_flow(
|
|
plugin_manager_pm: PluginManager, monkeypatch, dependency_install_fails: bool
|
|
):
|
|
plugin_path = Path(plugin_manager_pm.plugin_store_path) / TEST_PLUGIN_DIR
|
|
events = []
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
async def mock_install(repo_url: str, proxy=""):
|
|
assert repo_url == TEST_PLUGIN_REPO
|
|
_write_local_test_plugin(plugin_path, repo_url)
|
|
_write_requirements(plugin_path)
|
|
return str(plugin_path)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm.updator, "install", mock_install)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, dependency_install_fails),
|
|
)
|
|
|
|
def mock_load_and_register(*args, **kwargs):
|
|
plugin_manager_pm.context.stars.append(MockStar())
|
|
return _build_load_mock(events)(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm, "load", mock_load_and_register)
|
|
|
|
if dependency_install_fails:
|
|
with pytest.raises(PluginDependencyInstallError, match="pip failed"):
|
|
await plugin_manager_pm.install_plugin(TEST_PLUGIN_REPO)
|
|
assert events == [("deps", str(plugin_path / "requirements.txt"))]
|
|
else:
|
|
await plugin_manager_pm.install_plugin(TEST_PLUGIN_REPO)
|
|
assert events == [
|
|
("deps", str(plugin_path / "requirements.txt")),
|
|
("load", TEST_PLUGIN_DIR),
|
|
]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("dependency_install_fails", [False, True])
|
|
async def test_install_plugin_from_file_dependency_install_flow(
|
|
plugin_manager_pm: PluginManager,
|
|
monkeypatch,
|
|
tmp_path,
|
|
dependency_install_fails: bool,
|
|
):
|
|
zip_file_path = tmp_path / f"{TEST_PLUGIN_DIR}.zip"
|
|
zip_file_path.write_text("placeholder", encoding="utf-8")
|
|
events = []
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
def mock_unzip_file(zip_path: str, target_dir: str) -> None:
|
|
assert zip_path == str(zip_file_path)
|
|
plugin_path = Path(target_dir)
|
|
_write_local_test_plugin(plugin_path, TEST_PLUGIN_REPO)
|
|
_write_requirements(plugin_path)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm.updator, "unzip_file", mock_unzip_file)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, dependency_install_fails),
|
|
)
|
|
|
|
def mock_load_and_register(*args, **kwargs):
|
|
plugin_manager_pm.context.stars.append(MockStar())
|
|
return _build_load_mock(events)(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm, "load", mock_load_and_register)
|
|
|
|
if dependency_install_fails:
|
|
with pytest.raises(PluginDependencyInstallError, match="pip failed"):
|
|
await plugin_manager_pm.install_plugin_from_file(str(zip_file_path))
|
|
assert any(e[0] == "deps" for e in events)
|
|
else:
|
|
await plugin_manager_pm.install_plugin_from_file(str(zip_file_path))
|
|
assert any(e[0] == "deps" for e in events)
|
|
assert ("load", TEST_PLUGIN_DIR) in events
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("dependency_install_fails", [False, True])
|
|
async def test_reload_failed_plugin_dependency_install_flow(
|
|
plugin_manager_pm: PluginManager,
|
|
local_updator: Path,
|
|
monkeypatch,
|
|
dependency_install_fails: bool,
|
|
):
|
|
_write_requirements(local_updator)
|
|
plugin_manager_pm.failed_plugin_dict[TEST_PLUGIN_DIR] = {"error": "init fail"}
|
|
events = []
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, dependency_install_fails),
|
|
)
|
|
|
|
def mock_load_and_register(*args, **kwargs):
|
|
plugin_manager_pm.context.stars.append(MockStar())
|
|
return _build_load_mock(events)(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm, "load", mock_load_and_register)
|
|
|
|
if dependency_install_fails:
|
|
with pytest.raises(PluginDependencyInstallError, match="pip failed"):
|
|
await plugin_manager_pm.reload_failed_plugin(TEST_PLUGIN_DIR)
|
|
assert events == [("deps", str(local_updator / "requirements.txt"))]
|
|
else:
|
|
await plugin_manager_pm.reload_failed_plugin(TEST_PLUGIN_DIR)
|
|
assert events == [
|
|
("deps", str(local_updator / "requirements.txt")),
|
|
("load", TEST_PLUGIN_DIR),
|
|
]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ensure_plugin_requirements_reraises_cancelled_error(
|
|
plugin_manager_pm: PluginManager, local_updator: Path, monkeypatch
|
|
):
|
|
_write_requirements(local_updator)
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
async def mock_install_requirements(*args, **kwargs):
|
|
raise asyncio.CancelledError()
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
mock_install_requirements,
|
|
)
|
|
|
|
with pytest.raises(asyncio.CancelledError):
|
|
await plugin_manager_pm._ensure_plugin_requirements(
|
|
str(local_updator),
|
|
TEST_PLUGIN_DIR,
|
|
)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ensure_plugin_requirements_wraps_generic_dependency_install_failure(
|
|
plugin_manager_pm: PluginManager, local_updator: Path, monkeypatch
|
|
):
|
|
_write_requirements(local_updator)
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
async def mock_install_requirements(*args, **kwargs):
|
|
raise RuntimeError("pip failed")
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
mock_install_requirements,
|
|
)
|
|
|
|
with pytest.raises(PluginDependencyInstallError, match="pip failed") as exc_info:
|
|
await plugin_manager_pm._ensure_plugin_requirements(
|
|
str(local_updator),
|
|
TEST_PLUGIN_DIR,
|
|
)
|
|
|
|
assert exc_info.value.plugin_label == TEST_PLUGIN_DIR
|
|
assert exc_info.value.requirements_path == str(local_updator / "requirements.txt")
|
|
assert isinstance(exc_info.value.__cause__, RuntimeError)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ensure_plugin_requirements_wraps_pip_install_error(
|
|
plugin_manager_pm: PluginManager, local_updator: Path, monkeypatch
|
|
):
|
|
_write_requirements(local_updator)
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
async def mock_install_requirements(*args, **kwargs):
|
|
raise PipInstallError("install failed", code=2)
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
mock_install_requirements,
|
|
)
|
|
|
|
with pytest.raises(PluginDependencyInstallError, match="install failed") as exc_info:
|
|
await plugin_manager_pm._ensure_plugin_requirements(
|
|
str(local_updator),
|
|
TEST_PLUGIN_DIR,
|
|
)
|
|
|
|
assert isinstance(exc_info.value.__cause__, PipInstallError)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_ensure_plugin_requirements_logs_requirements_file_install_for_missing_dependencies(
|
|
plugin_manager_pm: PluginManager, local_updator: Path, monkeypatch
|
|
):
|
|
_write_requirements(local_updator)
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
logged_lines = []
|
|
|
|
async def mock_install_requirements(*args, **kwargs):
|
|
return None
|
|
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
mock_install_requirements,
|
|
)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.logger.info",
|
|
lambda line, *args: logged_lines.append(line % args if args else line),
|
|
)
|
|
|
|
await plugin_manager_pm._ensure_plugin_requirements(
|
|
str(local_updator),
|
|
TEST_PLUGIN_DIR,
|
|
)
|
|
|
|
assert any("按 requirements.txt 安装" in line for line in logged_lines)
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("dependency_install_fails", [False, True])
|
|
async def test_update_plugin_dependency_install_flow(
|
|
plugin_manager_pm: PluginManager,
|
|
local_updator: Path,
|
|
monkeypatch,
|
|
dependency_install_fails: bool,
|
|
):
|
|
mock_star = MockStar()
|
|
plugin_manager_pm.context.stars.append(mock_star)
|
|
|
|
_write_requirements(local_updator)
|
|
events = []
|
|
_mock_missing_requirements(monkeypatch, {"networkx"})
|
|
|
|
async def mock_update(plugin, proxy=""):
|
|
del proxy
|
|
events.append(("update", plugin.name))
|
|
|
|
monkeypatch.setattr(plugin_manager_pm.updator, "update", mock_update)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, dependency_install_fails),
|
|
)
|
|
monkeypatch.setattr(plugin_manager_pm, "reload", _build_reload_mock(events))
|
|
|
|
if dependency_install_fails:
|
|
with pytest.raises(PluginDependencyInstallError, match="pip failed"):
|
|
await plugin_manager_pm.update_plugin(TEST_PLUGIN_NAME)
|
|
assert ("deps", str(local_updator / "requirements.txt")) in events
|
|
else:
|
|
await plugin_manager_pm.update_plugin(TEST_PLUGIN_NAME)
|
|
assert ("deps", str(local_updator / "requirements.txt")) in events
|
|
assert ("reload", TEST_PLUGIN_DIR) in events
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_install_plugin_skips_dependency_install_when_no_requirements_missing(
|
|
plugin_manager_pm: PluginManager, monkeypatch
|
|
):
|
|
plugin_path = Path(plugin_manager_pm.plugin_store_path) / TEST_PLUGIN_DIR
|
|
events = []
|
|
_mock_missing_requirements(monkeypatch, set())
|
|
|
|
async def mock_install(repo_url: str, proxy=""):
|
|
_write_local_test_plugin(plugin_path, repo_url)
|
|
_write_requirements(plugin_path)
|
|
return str(plugin_path)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm.updator, "install", mock_install)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, False),
|
|
)
|
|
|
|
def mock_load_and_register(*args, **kwargs):
|
|
plugin_manager_pm.context.stars.append(MockStar())
|
|
return _build_load_mock(events)(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm, "load", mock_load_and_register)
|
|
|
|
await plugin_manager_pm.install_plugin(TEST_PLUGIN_REPO)
|
|
|
|
assert "deps" not in [e[0] for e in events]
|
|
assert ("load", TEST_PLUGIN_DIR) in events
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_install_plugin_runs_dependency_install_when_precheck_fails(
|
|
plugin_manager_pm: PluginManager, monkeypatch
|
|
):
|
|
plugin_path = Path(plugin_manager_pm.plugin_store_path) / TEST_PLUGIN_DIR
|
|
events = []
|
|
|
|
async def mock_install(repo_url: str, proxy=""):
|
|
_write_local_test_plugin(plugin_path, repo_url)
|
|
_write_requirements(plugin_path)
|
|
return str(plugin_path)
|
|
|
|
_mock_precheck_fails(monkeypatch)
|
|
monkeypatch.setattr(plugin_manager_pm.updator, "install", mock_install)
|
|
monkeypatch.setattr(
|
|
"astrbot.core.star.star_manager.pip_installer.install",
|
|
_build_dependency_install_mock(events, False),
|
|
)
|
|
|
|
def mock_load_and_register(*args, **kwargs):
|
|
plugin_manager_pm.context.stars.append(MockStar())
|
|
return _build_load_mock(events)(*args, **kwargs)
|
|
|
|
monkeypatch.setattr(plugin_manager_pm, "load", mock_load_and_register)
|
|
|
|
await plugin_manager_pm.install_plugin(TEST_PLUGIN_REPO)
|
|
|
|
assert ("deps", str(plugin_path / "requirements.txt")) in events
|
|
assert ("load", TEST_PLUGIN_DIR) in events
|