File size: 40,672 Bytes
8ede856 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 | import asyncio
import threading
from unittest.mock import AsyncMock
import pytest
from astrbot.core.utils import core_constraints as core_constraints_module
from astrbot.core.utils import pip_installer as pip_installer_module
from astrbot.core.utils import requirements_utils
from astrbot.core.utils.pip_installer import PipInstaller
def _make_run_pip_mock(
code: int = 0,
output_lines: list[str] | None = None,
conflict=None,
):
del output_lines, conflict
async def run_pip(*args, **kwargs):
del args, kwargs
return code
return AsyncMock(side_effect=run_pip)
@pytest.mark.asyncio
async def test_install_targets_site_packages_for_desktop_client(monkeypatch, tmp_path):
monkeypatch.setenv("ASTRBOT_DESKTOP_CLIENT", "1")
monkeypatch.delattr("sys.frozen", raising=False)
site_packages_path = tmp_path / "site-packages"
run_pip = _make_run_pip_mock()
prepend_sys_path_calls = []
ensure_preferred_calls = []
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.get_astrbot_site_packages_path",
lambda: str(site_packages_path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._prepend_sys_path",
lambda path: prepend_sys_path_calls.append(path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._ensure_plugin_dependencies_preferred",
lambda path, requirements: ensure_preferred_calls.append((path, requirements)),
)
installer = PipInstaller("")
await installer.install(package_name="demo-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert "--target" in recorded_args
assert str(site_packages_path) in recorded_args
assert prepend_sys_path_calls == [str(site_packages_path), str(site_packages_path)]
assert ensure_preferred_calls == [(str(site_packages_path), {"demo-package"})]
@pytest.mark.asyncio
async def test_run_pip_in_process_streams_output_lines(monkeypatch):
logged_lines = []
first_line_seen = asyncio.Event()
unblock_pip = threading.Event()
def fake_pip_main(args):
del args
print("Collecting demo-package")
unblock_pip.wait(timeout=1)
print("Downloading demo-package.whl")
return 0
loop = asyncio.get_running_loop()
def record_log(line, *args):
message = line % args if args else line
logged_lines.append(message)
if message == "Collecting demo-package":
loop.call_soon_threadsafe(first_line_seen.set)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
record_log,
)
installer = PipInstaller("")
task = asyncio.create_task(
installer._run_pip_in_process(["install", "demo-package"])
)
await asyncio.wait_for(first_line_seen.wait(), timeout=1)
unblock_pip.set()
result = await task
assert result == 0
assert logged_lines[-2:] == [
"Collecting demo-package",
"Downloading demo-package.whl",
]
@pytest.mark.asyncio
async def test_run_pip_in_process_preserves_shared_stream_order(monkeypatch):
logged_lines = []
def fake_pip_main(args):
del args
import sys
sys.stdout.write("out")
sys.stderr.write("err\n")
sys.stdout.write(" line\n")
return 0
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
lambda line, *args: logged_lines.append(line % args if args else line),
)
installer = PipInstaller("")
result = await installer._run_pip_in_process(["install", "demo-package"])
assert result == 0
assert logged_lines[-2:] == ["outerr", " line"]
@pytest.mark.asyncio
async def test_run_pip_in_process_preserves_blank_lines(monkeypatch):
logged_lines = []
def fake_pip_main(args):
del args
print("Collecting demo-package")
print()
print("Installing collected packages")
return 0
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
lambda line, *args: logged_lines.append(line % args if args else line),
)
installer = PipInstaller("")
result = await installer._run_pip_in_process(["install", "demo-package"])
assert result == 0
assert logged_lines[-3:] == [
"Collecting demo-package",
"",
"Installing collected packages",
]
@pytest.mark.asyncio
async def test_run_pip_in_process_preserves_trailing_blank_line_on_flush(monkeypatch):
logged_lines = []
def fake_pip_main(args):
del args
import sys
sys.stdout.write("Collecting demo-package\n\n")
return 0
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
lambda line, *args: logged_lines.append(line % args if args else line),
)
installer = PipInstaller("")
result = await installer._run_pip_in_process(["install", "demo-package"])
assert result == 0
assert logged_lines[-2:] == ["Collecting demo-package", ""]
@pytest.mark.asyncio
async def test_run_pip_in_process_normalizes_crlf_without_extra_blank_lines(
monkeypatch,
):
logged_lines = []
def fake_pip_main(args):
del args
import sys
sys.stdout.write("Collecting demo-package\r\n")
sys.stdout.write("Installing collected packages\r\n")
return 0
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
lambda line, *args: logged_lines.append(line % args if args else line),
)
installer = PipInstaller("")
result = await installer._run_pip_in_process(["install", "demo-package"])
assert result == 0
assert logged_lines[-2:] == [
"Collecting demo-package",
"Installing collected packages",
]
@pytest.mark.asyncio
async def test_run_pip_in_process_classifies_nonstandard_conflict_output(monkeypatch):
def fake_pip_main(args):
del args
print(
"Cannot install demo-package and astrbot-core because these package "
"versions have conflicting dependencies."
)
print("The conflict is caused by:")
print(" demo-package depends on shared-lib>=3.0")
print(" AstrBot (constraint) depends on shared-lib==2.0")
return 1
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
installer = PipInstaller("")
with pytest.raises(pip_installer_module.DependencyConflictError) as exc_info:
await installer._run_pip_in_process(["install", "demo-package"])
assert exc_info.value.is_core_conflict is True
assert "demo-package" in str(exc_info.value)
assert "demo-package depends on shared-lib>=3.0" in str(exc_info.value)
assert "AstrBot (constraint) depends on shared-lib==2.0" in str(exc_info.value)
assert "The conflict is caused by:" in exc_info.value.errors
@pytest.mark.asyncio
async def test_install_raises_dedicated_pip_install_error_on_non_conflict_failure(
monkeypatch,
):
async def failing_run_pip(self, args):
del self, args
return 2
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", failing_run_pip)
installer = PipInstaller("")
with pytest.raises(pip_installer_module.PipInstallError, match="错误码:2"):
await installer.install(package_name="demo-package")
@pytest.mark.asyncio
async def test_run_pip_with_classification_raises_install_error_on_non_conflict_failure(
monkeypatch,
):
async def failing_run_pip(self, args):
del self, args
return 3
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", failing_run_pip)
installer = PipInstaller("")
with pytest.raises(pip_installer_module.PipInstallError, match="错误码:3"):
await installer._run_pip_with_classification(["install", "demo-package"])
@pytest.mark.asyncio
async def test_run_pip_in_process_bounds_retained_conflict_lines(monkeypatch):
def fake_pip_main(args):
del args
for index in range(10):
print(f"noise-{index}")
print(
"Cannot install demo-package and astrbot-core because these package "
"versions have conflicting dependencies."
)
print("The conflict is caused by:")
print(" demo-package depends on shared-lib>=3.0")
print(" AstrBot (constraint) depends on shared-lib==2.0")
return 1
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._get_pip_main",
lambda: fake_pip_main,
)
monkeypatch.setattr("astrbot.core.utils.pip_installer._MAX_PIP_OUTPUT_LINES", 4)
installer = PipInstaller("")
with pytest.raises(pip_installer_module.DependencyConflictError) as exc_info:
await installer._run_pip_in_process(["install", "demo-package"])
assert len(exc_info.value.errors) == 4
assert exc_info.value.errors[0].startswith("Cannot install demo-package")
assert (
exc_info.value.errors[-1]
== " AstrBot (constraint) depends on shared-lib==2.0"
)
def test_build_pip_args_rejects_package_name_and_requirements_path_together(tmp_path):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("demo-package\n", encoding="utf-8")
installer = PipInstaller("")
with pytest.raises(ValueError, match="package_name and requirements_path"):
installer._build_pip_args("requests", str(requirements_path), None)
def _make_fake_distribution(name: str, version: str):
class FakeDistribution:
metadata = {"Name": name}
def __init__(self, version: str):
self.version = version
return FakeDistribution(version)
def test_find_missing_requirements_honors_version_specifiers(monkeypatch, tmp_path):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("demo-package>=2.0\n", encoding="utf-8")
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [_make_fake_distribution("demo-package", "1.0")],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == {"demo-package"}
def test_find_missing_requirements_skips_unmatched_markers(monkeypatch, tmp_path):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text(
'demo-package; sys_platform == "win32"\n',
encoding="utf-8",
)
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == set()
def test_find_missing_requirements_follows_nested_requirement_files(
monkeypatch, tmp_path
):
base_requirements = tmp_path / "base.txt"
base_requirements.write_text("demo-package==1.0\n", encoding="utf-8")
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("-r base.txt\n", encoding="utf-8")
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == {"demo-package"}
def test_find_missing_requirements_follows_equals_form_nested_requirements(
monkeypatch, tmp_path
):
base_requirements = tmp_path / "base.txt"
base_requirements.write_text("demo-package==1.0\n", encoding="utf-8")
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("--requirement=base.txt\n", encoding="utf-8")
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == {"demo-package"}
def test_find_missing_requirements_returns_none_when_nested_file_missing(tmp_path):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("-r base.txt\n", encoding="utf-8")
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing is None
def test_find_missing_requirements_extracts_editable_vcs_requirement(
monkeypatch, tmp_path
):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text(
"-e git+https://example.com/demo.git#egg=demo-package\n",
encoding="utf-8",
)
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == {"demo-package"}
def test_find_missing_requirements_prefers_first_search_path_version(
monkeypatch, tmp_path
):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("demo-package>=2.0\n", encoding="utf-8")
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
lambda path: [
_make_fake_distribution("demo-package", "1.0"),
_make_fake_distribution("demo-package", "3.0"),
],
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing == {"demo-package"}
def test_find_missing_requirements_returns_none_when_distribution_scan_fails(
monkeypatch, tmp_path
):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("demo-package>=2.0\n", encoding="utf-8")
def failing_distributions(path):
del path
yield _make_fake_distribution("demo-package", "3.0")
raise RuntimeError("scan failed")
monkeypatch.setattr(
pip_installer_module.importlib_metadata,
"distributions",
failing_distributions,
)
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing is None
def test_get_core_constraints_caches_fallback_resolution(monkeypatch):
distribution_calls = []
distributions_calls = []
class FakeFallbackDistribution:
metadata = {"Name": "AstrBot-App"}
requires = ["shared-lib>=1.0"]
def read_text(self, name):
if name == "top_level.txt":
return "astrbot\n"
return ""
fake_distribution = FakeFallbackDistribution()
def mock_distribution(name):
distribution_calls.append(name)
if name == "AstrBot":
raise pip_installer_module.importlib_metadata.PackageNotFoundError
if name == "AstrBot-App":
return fake_distribution
raise pip_installer_module.importlib_metadata.PackageNotFoundError
def mock_distributions(path=None):
del path
distributions_calls.append("scan")
return [fake_distribution]
monkeypatch.setattr(
core_constraints_module.importlib_metadata,
"distribution",
mock_distribution,
)
monkeypatch.setattr(
core_constraints_module.importlib_metadata,
"distributions",
mock_distributions,
)
monkeypatch.setattr(
core_constraints_module,
"collect_installed_distribution_versions",
lambda paths: {"shared-lib": "2.0"},
)
core_constraints_module._get_core_constraints.cache_clear()
try:
first = core_constraints_module._get_core_constraints(None)
second = core_constraints_module._get_core_constraints(None)
finally:
core_constraints_module._get_core_constraints.cache_clear()
assert first == ("shared-lib==2.0",)
assert second == ("shared-lib==2.0",)
assert distribution_calls == ["AstrBot", "AstrBot-App"]
assert distributions_calls == ["scan"]
def test_get_core_constraints_skips_distributions_with_unreadable_top_level(
monkeypatch,
):
class BrokenDistribution:
metadata = {"Name": "Broken-App"}
requires = []
def read_text(self, name):
if name == "top_level.txt":
raise OSError("cannot read top_level.txt")
return ""
class FakeFallbackDistribution:
metadata = {"Name": "AstrBot-App"}
requires = ["shared-lib>=1.0"]
def read_text(self, name):
if name == "top_level.txt":
return "astrbot\n"
return ""
broken_distribution = BrokenDistribution()
fake_distribution = FakeFallbackDistribution()
def mock_distribution(name):
if name == "AstrBot":
raise pip_installer_module.importlib_metadata.PackageNotFoundError
if name == "AstrBot-App":
return fake_distribution
raise pip_installer_module.importlib_metadata.PackageNotFoundError
def mock_distributions(path=None):
del path
return [broken_distribution, fake_distribution]
monkeypatch.setattr(
core_constraints_module.importlib_metadata,
"distribution",
mock_distribution,
)
monkeypatch.setattr(
core_constraints_module.importlib_metadata,
"distributions",
mock_distributions,
)
monkeypatch.setattr(
core_constraints_module,
"collect_installed_distribution_versions",
lambda paths: {"shared-lib": "2.0"},
)
core_constraints_module._get_core_constraints.cache_clear()
try:
constraints = core_constraints_module._get_core_constraints(None)
finally:
core_constraints_module._get_core_constraints.cache_clear()
assert constraints == ("shared-lib==2.0",)
def test_core_constraints_file_propagates_inner_conflict_without_fake_warning(
monkeypatch,
):
warning_logs = []
conflict = pip_installer_module.DependencyConflictError(
"core conflict",
[],
is_core_conflict=True,
)
monkeypatch.setattr(
core_constraints_module,
"_get_core_constraints",
lambda core_dist_name: ("aiohttp==3.13.3",),
)
monkeypatch.setattr(
"astrbot.core.utils.core_constraints.logger.warning",
lambda line, *args: warning_logs.append(line % args if args else line),
)
with pytest.raises(
pip_installer_module.DependencyConflictError,
match="core conflict",
):
provider = core_constraints_module.CoreConstraintsProvider("AstrBot")
with provider.constraints_file() as constraints_path:
assert constraints_path is not None
raise conflict
assert warning_logs == []
def test_iter_requirement_lines_expands_nested_requirement_files(tmp_path):
base_requirements = tmp_path / "base.txt"
base_requirements.write_text("demo-package==1.0\n", encoding="utf-8")
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text(
"# comment\n-r base.txt\n--extra-index-url https://example.com/simple\n",
encoding="utf-8",
)
lines = list(requirements_utils._iter_requirement_lines(str(requirements_path)))
assert lines == [
"demo-package==1.0",
"--extra-index-url https://example.com/simple",
]
def test_build_pip_args_extracts_requested_requirements():
installer = PipInstaller("")
args, requested = installer._build_pip_args(
"--index-url https://example.com/simple demo-package",
None,
None,
)
assert args == [
"install",
"--index-url",
"https://example.com/simple",
"demo-package",
]
assert requested == {"demo-package"}
def test_build_pip_args_appends_default_index_when_not_overridden():
installer = PipInstaller("")
args, requested = installer._build_pip_args("demo-package", None, None)
assert args == ["install", "demo-package", "-i", "https://pypi.org/simple"]
assert requested == {"demo-package"}
@pytest.mark.asyncio
async def test_install_splits_space_separated_packages(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="demo-package another-package>=1.0")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:3] == ["install", "demo-package", "another-package>=1.0"]
@pytest.mark.asyncio
async def test_install_splits_three_space_separated_packages(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="demo-package another-package extra-package>=1.0"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"demo-package",
"another-package",
"extra-package>=1.0",
]
@pytest.mark.asyncio
async def test_install_splits_three_bare_packages(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="demo-package another-package extra-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"demo-package",
"another-package",
"extra-package",
]
@pytest.mark.asyncio
async def test_install_tracks_multiline_packages_for_desktop_client(
monkeypatch, tmp_path
):
monkeypatch.setenv("ASTRBOT_DESKTOP_CLIENT", "1")
monkeypatch.delattr("sys.frozen", raising=False)
site_packages_path = tmp_path / "site-packages"
run_pip = _make_run_pip_mock()
ensure_preferred_calls = []
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.get_astrbot_site_packages_path",
lambda: str(site_packages_path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._prepend_sys_path",
lambda path: None,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._ensure_plugin_dependencies_preferred",
lambda path, requirements: ensure_preferred_calls.append((path, requirements)),
)
installer = PipInstaller("")
await installer.install(package_name="demo-package\nanother-package>=1.0\n")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:3] == ["install", "demo-package", "another-package>=1.0"]
assert ensure_preferred_calls == [
(str(site_packages_path), {"demo-package", "another-package"})
]
@pytest.mark.asyncio
async def test_install_splits_space_separated_packages_within_multiline_input(
monkeypatch,
):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="demo-package another-package\nextra-package\n"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"demo-package",
"another-package",
"extra-package",
]
@pytest.mark.asyncio
async def test_install_keeps_single_requirement_with_marker_intact(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="demo-package ; python_version < '4'")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:2] == [
"install",
"demo-package ; python_version < '4'",
]
@pytest.mark.asyncio
async def test_install_keeps_single_requirement_with_compact_marker_intact(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name='demo-package; python_version < "4"')
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:2] == [
"install",
'demo-package; python_version < "4"',
]
@pytest.mark.asyncio
async def test_install_keeps_single_requirement_with_version_range_intact(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="demo-package >= 1.0, < 2.0")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:2] == [
"install",
"demo-package >= 1.0, < 2.0",
]
@pytest.mark.asyncio
async def test_install_tracks_only_real_requirement_names_for_spaced_single_requirement(
monkeypatch, tmp_path
):
monkeypatch.setenv("ASTRBOT_DESKTOP_CLIENT", "1")
monkeypatch.delattr("sys.frozen", raising=False)
site_packages_path = tmp_path / "site-packages"
run_pip = _make_run_pip_mock()
ensure_preferred_calls = []
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.get_astrbot_site_packages_path",
lambda: str(site_packages_path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._prepend_sys_path",
lambda path: None,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._ensure_plugin_dependencies_preferred",
lambda path, requirements: ensure_preferred_calls.append((path, requirements)),
)
installer = PipInstaller("")
await installer.install(package_name="demo-package >= 1.0, < 2.0")
assert ensure_preferred_calls == [(str(site_packages_path), {"demo-package"})]
def test_prefer_installed_dependencies_prefers_modules_for_requirements_in_desktop_runtime(
monkeypatch, tmp_path
):
monkeypatch.setenv("ASTRBOT_DESKTOP_CLIENT", "1")
monkeypatch.delattr("sys.frozen", raising=False)
site_packages_path = tmp_path / "site-packages"
site_packages_path.mkdir()
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("demo-package>=1.0\n", encoding="utf-8")
prepend_calls = []
preferred_calls = []
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.get_astrbot_site_packages_path",
lambda: str(site_packages_path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._prepend_sys_path",
lambda path: prepend_calls.append(path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._ensure_plugin_dependencies_preferred",
lambda path, requirements: preferred_calls.append((path, requirements)),
)
installer = PipInstaller("")
installer.prefer_installed_dependencies(str(requirements_path))
assert prepend_calls == [str(site_packages_path)]
assert preferred_calls == [(str(site_packages_path), {"demo-package"})]
@pytest.mark.asyncio
async def test_install_multiline_input_strips_comments_and_splits_options(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name=(
"demo-package==1.0 # pinned\n"
"--extra-index-url https://example.com/simple\n"
"another-package\n"
)
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:5] == [
"install",
"demo-package==1.0",
"--extra-index-url",
"https://example.com/simple",
"another-package",
]
@pytest.mark.asyncio
async def test_install_single_line_input_strips_inline_comment(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="requests==2.31.0 # latest")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:2] == ["install", "requests==2.31.0"]
@pytest.mark.asyncio
async def test_install_splits_single_line_editable_option_input(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="-e .")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:3] == ["install", "-e", "."]
@pytest.mark.asyncio
async def test_install_splits_single_line_option_with_url(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="--index-url https://example.com/simple demo-package"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"--index-url",
"https://example.com/simple",
"demo-package",
]
assert recorded_args.count("--index-url") == 1
assert "-i" not in recorded_args
@pytest.mark.asyncio
async def test_install_tracks_requirement_name_for_single_line_option_input(
monkeypatch, tmp_path
):
monkeypatch.setenv("ASTRBOT_DESKTOP_CLIENT", "1")
monkeypatch.delattr("sys.frozen", raising=False)
site_packages_path = tmp_path / "site-packages"
run_pip = _make_run_pip_mock()
ensure_preferred_calls = []
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.get_astrbot_site_packages_path",
lambda: str(site_packages_path),
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._prepend_sys_path",
lambda path: None,
)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer._ensure_plugin_dependencies_preferred",
lambda path, requirements: ensure_preferred_calls.append((path, requirements)),
)
installer = PipInstaller("")
await installer.install(
package_name="--index-url https://example.com/simple demo-package"
)
assert ensure_preferred_calls == [(str(site_packages_path), {"demo-package"})]
@pytest.mark.asyncio
async def test_install_keeps_equals_form_index_override(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="--index-url=https://example.com/simple demo-package"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:3] == [
"install",
"--index-url=https://example.com/simple",
"demo-package",
]
assert "-i" not in recorded_args
@pytest.mark.asyncio
async def test_install_keeps_short_form_index_override(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="-ihttps://example.com/simple demo-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:3] == [
"install",
"-ihttps://example.com/simple",
"demo-package",
]
assert "-i" not in recorded_args
@pytest.mark.asyncio
async def test_install_preserves_url_fragment_in_option_input(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="--index-url https://example.com/simple#frag demo-package"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"--index-url",
"https://example.com/simple#frag",
"demo-package",
]
assert "-i" not in recorded_args
def test_find_missing_requirements_returns_none_for_editable_local_path_reference(
tmp_path,
):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text("-e ../sharedlib\n", encoding="utf-8")
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing is None
@pytest.mark.parametrize(
"requirement_line",
[
"-e sharedlib\n",
"--editable=.\\sharedlib\n",
],
)
def test_find_missing_requirements_returns_none_for_editable_local_path_variants(
tmp_path, requirement_line
):
requirements_path = tmp_path / "requirements.txt"
requirements_path.write_text(requirement_line, encoding="utf-8")
missing = requirements_utils.find_missing_requirements(str(requirements_path))
assert missing is None
@pytest.mark.asyncio
async def test_install_strips_inline_comment_from_option_line(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name=(
"--extra-index-url https://example.com/simple # mirror\ndemo-package\n"
)
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == [
"install",
"--extra-index-url",
"https://example.com/simple",
"demo-package",
]
@pytest.mark.asyncio
async def test_install_falls_back_to_raw_input_for_invalid_token_string(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
raw_input = "demo-package !!! another-package"
await installer.install(package_name=raw_input)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:4] == ["install", "demo-package", "!!!", "another-package"]
@pytest.mark.asyncio
async def test_install_ignores_whitespace_only_package_string(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name=" ")
run_pip.assert_not_awaited()
@pytest.mark.asyncio
async def test_install_ignores_missing_package_and_requirements(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install()
run_pip.assert_not_awaited()
@pytest.mark.asyncio
async def test_install_respects_index_override_in_pip_install_arg(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("--index-url https://example.com/simple")
await installer.install(package_name="demo-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert "install" in recorded_args
assert "demo-package" in recorded_args
assert "--index-url" in recorded_args
assert "https://example.com/simple" in recorded_args
# Verify that default index overrides are NOT present
assert "mirrors.aliyun.com" not in recorded_args
assert "https://pypi.org/simple" not in recorded_args
@pytest.mark.asyncio
async def test_install_respects_no_index_with_find_links(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(
package_name="--no-index --find-links /tmp/wheels demo-package"
)
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert recorded_args[0:5] == [
"install",
"--no-index",
"--find-links",
"/tmp/wheels",
"demo-package",
]
assert "-i" not in recorded_args
def test_redact_pip_args_for_logging_redacts_inline_url_credentials():
redacted_args = pip_installer_module._redact_pip_args_for_logging(
[
"install",
"--index-url=https://user:secret@example.com/simple",
"demo-package",
]
)
assert redacted_args == [
"install",
"--index-url=https://<redacted>@example.com/simple",
"demo-package",
]
def test_redact_pip_args_for_logging_redacts_sensitive_option_value_pairs():
redacted_args = pip_installer_module._redact_pip_args_for_logging(
[
"install",
"--password",
"super-secret",
"--token",
"opaque-token",
"demo-package",
]
)
assert redacted_args == [
"install",
"--password",
"****",
"--token",
"****",
"demo-package",
]
def test_redact_pip_args_for_logging_redacts_inline_sensitive_values():
redacted_args = pip_installer_module._redact_pip_args_for_logging(
[
"install",
"--api-token=super-secret",
"password=hunter2",
"demo-package",
]
)
assert redacted_args == [
"install",
"--api-token=****",
"password=****",
"demo-package",
]
@pytest.mark.asyncio
async def test_install_logs_redacted_pip_argv_when_credentials_present(monkeypatch):
run_pip = _make_run_pip_mock()
logged_lines = []
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
monkeypatch.setattr(
"astrbot.core.utils.pip_installer.logger.info",
lambda line, *args: logged_lines.append(line % args if args else line),
)
installer = PipInstaller("")
await installer.install(
package_name="--index-url https://user:secret@example.com/simple demo-package"
)
argv_logs = [line for line in logged_lines if line.startswith("Pip 包管理器 argv:")]
assert len(argv_logs) == 1
assert "secret" not in argv_logs[0]
assert "user:" not in argv_logs[0]
assert "https://<redacted>@example.com/simple" in argv_logs[0]
@pytest.mark.asyncio
async def test_install_does_not_add_aliyun_trusted_host_for_default_index(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("")
await installer.install(package_name="demo-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert "-i" in recorded_args
assert "https://pypi.org/simple" in recorded_args
assert "--trusted-host" not in recorded_args
@pytest.mark.asyncio
async def test_install_adds_aliyun_trusted_host_only_for_aliyun_index(monkeypatch):
run_pip = _make_run_pip_mock()
monkeypatch.setattr(PipInstaller, "_run_pip_in_process", run_pip)
installer = PipInstaller("", pypi_index_url="https://mirrors.aliyun.com/simple")
await installer.install(package_name="demo-package")
run_pip.assert_awaited_once()
recorded_args = run_pip.await_args_list[0].args[0]
assert "-i" in recorded_args
assert "https://mirrors.aliyun.com/simple" in recorded_args
trusted_host_index = recorded_args.index("--trusted-host")
assert recorded_args[trusted_host_index + 1] == "mirrors.aliyun.com"
|