Files
unslothai--unsloth/tests/studio/install/test_pr5940_followups.py
T
wehub-resource-sync e93507a09c
Lockfile supply-chain audit / lockfile supply-chain audit (push) Has been cancelled
Windows Studio GGUF CI / GPU prebuilt resolves without Visual Studio (push) Has been cancelled
Windows Studio GGUF CI / setup.ps1 unit tests (VS 2026 / CMake guard) (push) Has been cancelled
Windows Studio GGUF CI / real-VS detection (VS 2022) (push) Has been cancelled
Windows Studio GGUF CI / real-VS detection (VS 2026) (push) Has been cancelled
Windows Studio GGUF CI / VC++ runtime detect + install round-trip (windows-2025-vs2026) (push) Has been cancelled
Windows Studio GGUF CI / VC++ runtime detect + install round-trip (windows-latest) (push) Has been cancelled
Windows Studio Update CI / Studio Updating Tests (push) Has been cancelled
Wheel CI / Wheel build + content sanity + import smoke (push) Has been cancelled
Lint CI / Source lint (Python + shell + YAML + JSON + safety nets) (push) Has been cancelled
MLX CI on Mac M1 / dispatch (push) Has been cancelled
Security audit / advisory audit (pip + npm + cargo) (push) Has been cancelled
Security audit / pip scan-packages :: extras (push) Has been cancelled
Security audit / pip scan-packages :: studio (push) Has been cancelled
Security audit / pip scan-packages :: hf-stack (push) Has been cancelled
Security audit / npm scan-packages (Studio frontend tarballs) (push) Has been cancelled
Security audit / workflow-trigger lint (pull_request_target / cache-poisoning) (push) Has been cancelled
Security audit / pytest tests/security (push) Has been cancelled
Security audit / npm provenance + new install-script diff (push) Has been cancelled
Studio API CI / Studio API & Auth Tests (push) Has been cancelled
Backend CI / (Python 3.10) (push) Has been cancelled
Backend CI / (Python 3.11) (push) Has been cancelled
Backend CI / (Python 3.12) (push) Has been cancelled
Backend CI / (Python 3.13) (push) Has been cancelled
Backend CI / Repo tests (CPU) (push) Has been cancelled
Frontend CI / Frontend build + bundle sanity (push) Has been cancelled
Studio GGUF CI / OpenAI, Anthropic API tests (push) Has been cancelled
Studio GGUF CI / Tool calling Tests (push) Has been cancelled
Studio GGUF CI / JSON, images (push) Has been cancelled
Mac Studio GGUF CI / OpenAI, Anthropic API tests (push) Has been cancelled
Mac Studio GGUF CI / Tool calling Tests (push) Has been cancelled
Mac Studio GGUF CI / JSON, images (push) Has been cancelled
Mac Studio Install Matrix CI / Install + load (macos-14) (push) Has been cancelled
Mac Studio Install Matrix CI / Install + load (macos-15) (push) Has been cancelled
Mac Studio Install Matrix CI / Install + load (macos-26) (push) Has been cancelled
Mac Studio Install Matrix CI / Install + load (macos-15-intel) (push) Has been cancelled
Mac Studio API CI / Studio API & Auth Tests (push) Has been cancelled
Mac Studio Install Matrix CI / Install + load (macos-26-intel) (push) Has been cancelled
Mac Studio UI CI / Chat UI Tests (push) Has been cancelled
Studio Tauri CI / Tauri Linux debug build (no codesign) (push) Has been cancelled
Mac Studio Update CI / Studio Updating Tests (push) Has been cancelled
Studio UI CI / Chat UI Tests (push) Has been cancelled
Windows Studio API CI / Studio API & Auth Tests (push) Has been cancelled
Windows Studio UI CI / Chat UI Tests (push) Has been cancelled
Studio Update CI / Studio Updating Tests (push) Has been cancelled
Core / Core (HF=default + TRL=default) (push) Has been cancelled
Core / Core (HF=4.57.6 + TRL<1) (push) Has been cancelled
Core / Core (HF=latest + TRL=latest) (push) Has been cancelled
Core / llama.cpp build + smoke (push) Has been cancelled
Windows Studio GGUF CI / OpenAI, Anthropic API tests (push) Has been cancelled
Windows Studio GGUF CI / Tool calling Tests (push) Has been cancelled
Windows Studio GGUF CI / JSON, images (push) Has been cancelled
Windows Studio GGUF CI / Studio install + inference without Visual Studio (push) Has been cancelled
Studio export capability / capability (macos-latest) (push) Has been cancelled
Studio export capability / capability (ubuntu-latest) (push) Has been cancelled
Studio export capability / capability (windows-latest) (push) Has been cancelled
Cross-platform parity / parity (macos-latest) (push) Has been cancelled
Cross-platform parity / parity (windows-latest) (push) Has been cancelled
Scorecard supply-chain security / Scorecard analysis (push) Has been cancelled
Studio load-orchestrator CI / test (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:59:56 +08:00

869 lines
40 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-only
# Copyright 2026-present the Unsloth AI Inc. team. All rights reserved.
"""AMD-Windows installer follow-ups (PR #5940): hf-hub validation-model fetch
+ urllib fallback, amd-smi RunAsInvoker injection, name->arch table parity.
Mock-only; no AMD hardware or network required."""
import importlib.util
import os
import re
import subprocess
import sys
import tempfile
from pathlib import Path
from unittest.mock import MagicMock, patch
import pytest
PACKAGE_ROOT = Path(__file__).resolve().parents[3]
# install_llama_prebuilt.py is self-contained, so it loads without the studio backend.
_PREBUILT_PATH = PACKAGE_ROOT / "studio" / "install_llama_prebuilt.py"
_SPEC = importlib.util.spec_from_file_location(
"studio_install_llama_prebuilt_pr5940", _PREBUILT_PATH
)
assert _SPEC is not None and _SPEC.loader is not None
prebuilt = importlib.util.module_from_spec(_SPEC)
sys.modules[_SPEC.name] = prebuilt
_SPEC.loader.exec_module(prebuilt)
_INSTALL_PS1 = PACKAGE_ROOT / "install.ps1"
_SETUP_PS1 = PACKAGE_ROOT / "studio" / "setup.ps1"
_INSTALL_SH = PACKAGE_ROOT / "install.sh"
_AMD_PY = PACKAGE_ROOT / "studio" / "backend" / "utils" / "hardware" / "amd.py"
_PYSTACK_PY = PACKAGE_ROOT / "studio" / "install_python_stack.py"
# ── _hf_resolve_url_parts ────────────────────────────────────────────────────
def test_hf_resolve_url_parts_valid():
assert prebuilt._hf_resolve_url_parts(
"https://huggingface.co/ggml-org/models/resolve/main/tinyllamas/stories260K.gguf"
) == ("ggml-org/models", "main", "tinyllamas/stories260K.gguf")
@pytest.mark.parametrize(
"url",
[
"https://github.com/owner/repo/releases/download/x.gguf", # not huggingface
"https://huggingface.co/owner/repo", # no /resolve/<rev>/
"https://huggingface.co/owner/repo/blob/main/x.gguf", # /blob/ not /resolve/
"not even a url",
],
)
def test_hf_resolve_url_parts_non_hf_returns_none(url):
assert prebuilt._hf_resolve_url_parts(url) is None
# ── _fetch_validation_model_bytes ────────────────────────────────────────────
def test_fetch_validation_model_prefers_huggingface_hub(tmp_path):
model = tmp_path / "stories260K.gguf"
model.write_bytes(b"GGUF-via-hf")
fake_hf = MagicMock(return_value = str(model))
with (
patch.object(prebuilt, "validated_validation_model_bytes", side_effect = lambda b: b),
patch.dict(sys.modules, {"huggingface_hub": MagicMock(hf_hub_download = fake_hf)}),
):
assert prebuilt._fetch_validation_model_bytes() == b"GGUF-via-hf"
assert fake_hf.called # hf path was taken, urllib not needed
def test_fetch_validation_model_falls_back_to_urllib_on_hf_failure():
fake_hf = MagicMock(side_effect = RuntimeError("hf unreachable"))
with (
patch.object(prebuilt, "validated_validation_model_bytes", side_effect = lambda b: b),
patch.dict(sys.modules, {"huggingface_hub": MagicMock(hf_hub_download = fake_hf)}),
patch.object(prebuilt, "download_bytes", return_value = b"GGUF-via-urllib") as dl,
):
assert prebuilt._fetch_validation_model_bytes() == b"GGUF-via-urllib"
assert dl.called # fell back to the direct URL download
# ── run_capture amd-smi RunAsInvoker injection ───────────────────────────────
def _capture_env(command, system):
captured = {"env": "sentinel"}
def fake_run(cmd, **kwargs):
captured["env"] = kwargs.get("env")
return subprocess.CompletedProcess(cmd, 0, "", "")
with (
patch.object(prebuilt.subprocess, "run", side_effect = fake_run),
patch.object(prebuilt.platform, "system", return_value = system),
):
prebuilt.run_capture(command)
return captured["env"]
def test_run_capture_injects_runasinvoker_for_amd_smi_on_windows():
env = _capture_env(["amd-smi", "list"], "Windows")
assert env is not None and env.get("__COMPAT_LAYER") == "RunAsInvoker"
def test_run_capture_injects_for_full_path_amd_smi_exe_on_windows():
env = _capture_env(["amd-smi.exe", "version"], "Windows")
assert env is not None and env.get("__COMPAT_LAYER") == "RunAsInvoker"
def test_run_capture_no_injection_for_non_amd_smi_on_windows():
assert _capture_env(["rocminfo"], "Windows") is None
def test_run_capture_no_injection_on_linux():
# amd-smi does not auto-elevate on Linux, so no env override is applied.
assert _capture_env(["amd-smi", "list"], "Linux") is None
# ── name->arch table parity (install.ps1 vs setup.ps1) ───────────────────────
def _ps_name_arch_rows(text):
return re.findall(r'@\{\s*P\s*=\s*"([^"]*)"\s*;\s*A\s*=\s*"(gfx[0-9a-z]+)"', text)
def test_ps_name_arch_tables_in_sync():
t1 = _ps_name_arch_rows(_INSTALL_PS1.read_text(encoding = "utf-8"))
t2 = _ps_name_arch_rows(_SETUP_PS1.read_text(encoding = "utf-8"))
assert t1, "no nameArchTable found in install.ps1"
assert t1 == t2, f"name->arch tables drifted:\ninstall.ps1={t1}\nsetup.ps1={t2}"
def test_rx_7700s_resolves_to_gfx1102_not_gfx1100():
rows = _ps_name_arch_rows(_INSTALL_PS1.read_text(encoding = "utf-8"))
name = "AMD Radeon RX 7700S"
matched = next((arch for pattern, arch in rows if re.search(pattern, name)), None)
assert matched == "gfx1102", f"RX 7700S matched {matched!r}, expected gfx1102"
def test_radeon_8060s_resolves_to_gfx1151():
rows = _ps_name_arch_rows(_INSTALL_PS1.read_text(encoding = "utf-8"))
name = "AMD Radeon(TM) 8060S Graphics"
matched = next((arch for pattern, arch in rows if re.search(pattern, name)), None)
assert matched == "gfx1151"
def _sh_name_arch_rows(text, var = "_gpu_disp_gfx"):
"""Parse a bash name->arch case table into ordered [(substr_tokens, arch), ...]."""
rows = []
for line in text.splitlines():
m = re.search(var + r'="(gfx[0-9a-z]+)"', line)
if not m or '*"' not in line:
continue
tokens = re.findall(r'\*"([^"]+)"\*', line)
if tokens:
rows.append((tokens, m.group(1)))
return rows
def _sh_resolve(rows, name):
for tokens, arch in rows:
if any(tok in name for tok in tokens): # bash *"X"* == substring
return arch
return None
def test_install_sh_name_arch_agrees_with_ps_for_strix_and_non_amd():
"""install.sh name->arch table must match the PowerShell source on the Strix
Halo/Point split and never misclassify NVIDIA/Intel as an AMD gfx."""
sh_rows = _sh_name_arch_rows(_INSTALL_SH.read_text(encoding = "utf-8"))
ps_rows = _ps_name_arch_rows(_INSTALL_PS1.read_text(encoding = "utf-8"))
assert sh_rows, "no name->arch case table found in install.sh"
cases = {
"AMD Radeon(TM) 8060S Graphics": "gfx1151", # Strix Halo
"AMD Ryzen AI Max+ PRO 395 w/ Radeon 8060S": "gfx1151",
"AMD Radeon 890M Graphics": "gfx1150", # Strix Point (NOT gfx1151)
"AMD Ryzen AI 9 HX 370 w/ Radeon 890M": "gfx1150",
"AMD Radeon RX 7700S": "gfx1102",
"NVIDIA GeForce RTX 4090": None,
"Intel(R) Arc A770 Graphics": None,
}
for name, expect in cases.items():
sh = _sh_resolve(sh_rows, name)
assert sh == expect, f"install.sh: {name!r} -> {sh!r}, expected {expect!r}"
if expect is not None: # cross-check bash agrees with the PowerShell table
ps = next((a for p, a in ps_rows if re.search(p, name)), None)
assert sh == ps, f"install.sh/install.ps1 drift for {name!r}: {sh!r} vs {ps!r}"
def test_setup_sh_name_arch_table_in_sync_with_install_sh():
"""studio/setup.sh's name->arch table must stay row-for-row identical to
install.sh's (order carries the RX 7700S -> gfx1102 rule)."""
install_rows = _sh_name_arch_rows(_INSTALL_SH.read_text(encoding = "utf-8"))
setup_rows = _sh_name_arch_rows(
(PACKAGE_ROOT / "studio" / "setup.sh").read_text(encoding = "utf-8"),
var = "_setup_gfx",
)
assert setup_rows, "no name->arch case table found in studio/setup.sh"
assert install_rows == setup_rows, (
"bash name->arch tables drifted:\n"
f"install.sh={install_rows}\nstudio/setup.sh={setup_rows}"
)
# Guards historical drift: Strix Point -> gfx1150, RX 7700S -> gfx1102 (before gfx1100).
for name, expect in {
"AMD Radeon 890M Graphics": "gfx1150",
"AMD Ryzen AI 9 HX 370 w/ Radeon 890M": "gfx1150",
"AMD Radeon(TM) 8060S Graphics": "gfx1151",
"AMD Radeon RX 7700S": "gfx1102",
}.items():
got = _sh_resolve(setup_rows, name)
assert got == expect, f"setup.sh: {name!r} -> {got!r}, expected {expect!r}"
# ── amd-smi gating (DiskPart UAC-prompt avoidance) ───────────────────────────
# On Windows w/o a HIP SDK, amd-smi pops a UAC/DiskPart prompt RunAsInvoker
# can't suppress, so _amd_smi_allowed() skips it unless HIP-SDK or opt-in.
def _amd_smi_allowed_under(system, hipinfo_present, env):
# Build a real (temp) PATH so _external_hipinfo_on_path scans it like prod;
# an external hipinfo.exe outside the pinned venv models a real HIP SDK.
with tempfile.TemporaryDirectory() as tmp:
venv_root = os.path.join(tmp, "venv")
os.makedirs(venv_root)
path_env = dict(env)
if hipinfo_present:
sdk_bin = os.path.join(tmp, "hipsdk", "bin")
os.makedirs(sdk_bin)
open(os.path.join(sdk_bin, "hipinfo.exe"), "w").close()
path_env["PATH"] = sdk_bin + os.pathsep + path_env.get("PATH", "")
with (
patch.object(prebuilt.platform, "system", return_value = system),
patch.object(prebuilt.sys, "prefix", venv_root),
patch.dict(prebuilt.os.environ, path_env, clear = True),
):
return prebuilt._amd_smi_allowed()
def test_amd_smi_allowed_on_linux_regardless():
# Linux amd-smi does not elevate -> always allowed.
assert _amd_smi_allowed_under("Linux", hipinfo_present = False, env = {}) is True
def test_amd_smi_skipped_on_windows_without_hip_sdk():
# The DiskPart fix: no HIP SDK + no opt-in -> do not spawn amd-smi.
assert _amd_smi_allowed_under("Windows", hipinfo_present = False, env = {}) is False
def test_amd_smi_allowed_on_windows_with_hip_sdk():
# hipinfo present => amd-smi runs un-elevated, so it is allowed.
assert _amd_smi_allowed_under("Windows", hipinfo_present = True, env = {}) is True
def test_amd_smi_opt_in_forces_on_windows_no_sdk():
assert (
_amd_smi_allowed_under(
"Windows", hipinfo_present = False, env = {"UNSLOTH_ENABLE_AMD_SMI": "1"}
)
is True
)
def test_amd_smi_opt_out_overrides_hip_sdk():
assert (
_amd_smi_allowed_under("Windows", hipinfo_present = True, env = {"UNSLOTH_ENABLE_AMD_SMI": "0"})
is False
)
def test_amd_smi_skipped_when_hipinfo_is_venv_internal(tmp_path):
# The venv hipInfo.exe (AMD wheel via the bnb fix) is NOT a HIP SDK and must
# not re-open the gate -- else amd-smi pops the DiskPart UAC mid-install on
# Strix Halo with no real HIP SDK (the snapcast3r/UBER6 bug).
venv_root = tmp_path / "venv"
venv_scripts = venv_root / "Scripts"
venv_scripts.mkdir(parents = True)
(venv_scripts / "hipinfo.exe").write_text("")
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(venv_root)),
patch.dict(prebuilt.os.environ, {"PATH": str(venv_scripts)}, clear = True),
):
assert prebuilt._amd_smi_allowed() is False
def test_amd_smi_allowed_when_hipinfo_outside_venv(tmp_path):
# A hipinfo from a real HIP SDK (outside the venv) still opens the gate, so
# HIP-SDK Windows users keep amd-smi (no regression for the venv-exclusion).
sdk_bin = tmp_path / "hipsdk" / "bin"
sdk_bin.mkdir(parents = True)
(sdk_bin / "hipinfo.exe").write_text("")
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(tmp_path / "venv")),
patch.dict(prebuilt.os.environ, {"PATH": str(sdk_bin)}, clear = True),
):
assert prebuilt._amd_smi_allowed() is True
def test_amd_smi_allowed_when_external_hipinfo_shadowed_by_venv(tmp_path):
# Venv hipInfo first on PATH (bnb fix), real SDK's later, HIP_PATH/ROCM_PATH
# unset. A first-hit which/Get-Command stops at the venv copy and wrongly
# closes the gate; scanning every PATH entry must still find the external SDK.
venv_root = tmp_path / "venv"
venv_scripts = venv_root / "Scripts"
venv_scripts.mkdir(parents = True)
(venv_scripts / "hipinfo.exe").write_text("")
sdk_bin = tmp_path / "hipsdk" / "bin"
sdk_bin.mkdir(parents = True)
(sdk_bin / "hipinfo.exe").write_text("")
path = str(venv_scripts) + os.pathsep + str(sdk_bin) # venv copy first
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(venv_root)),
patch.dict(prebuilt.os.environ, {"PATH": path}, clear = True),
):
assert prebuilt._amd_smi_allowed() is True
def test_amd_smi_skipped_when_env_root_hipinfo_is_venv_internal(tmp_path):
# The venv exclusion must also cover the HIP_PATH/ROCM_PATH fallback: a hipinfo
# under <venv>/_rocm_sdk_core/bin is still not a real HIP SDK.
venv_root = tmp_path / "venv"
hip_root = venv_root / "_rocm_sdk_core"
(hip_root / "bin").mkdir(parents = True)
(hip_root / "bin" / "hipinfo.exe").write_text("")
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(venv_root)),
patch.dict(prebuilt.os.environ, {"ROCM_PATH": str(hip_root)}, clear = True),
):
assert prebuilt._amd_smi_allowed() is False
def test_amd_smi_allowed_when_env_root_hipinfo_outside_venv(tmp_path):
# A real HIP SDK pointed to by HIP_PATH (outside the venv) still opens the
# gate, so the env-root venv filter does not regress HIP-SDK Windows users.
hip_root = tmp_path / "hipsdk"
(hip_root / "bin").mkdir(parents = True)
(hip_root / "bin" / "hipinfo.exe").write_text("")
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(tmp_path / "venv")),
patch.dict(prebuilt.os.environ, {"HIP_PATH": str(hip_root)}, clear = True),
):
assert prebuilt._amd_smi_allowed() is True
def test_external_hipinfo_on_path_skips_venv_only(tmp_path):
# The helper itself: a PATH holding only the venv-internal hipInfo must not
# count as an external HIP SDK (the whole point of the venv filter).
venv_root = tmp_path / "venv"
venv_scripts = venv_root / "Scripts"
venv_scripts.mkdir(parents = True)
(venv_scripts / "hipinfo.exe").write_text("")
with (
patch.object(prebuilt.sys, "prefix", str(venv_root)),
patch.dict(prebuilt.os.environ, {"PATH": str(venv_scripts)}, clear = True),
):
assert prebuilt._external_hipinfo_on_path() is False
def test_python_hipinfo_gates_scan_all_path_entries():
# All three copies of the amd-smi HIP-SDK probe must scan every PATH entry
# (not just the first shutil.which hit) so the venv-internal hipInfo cannot
# shadow a real SDK's hipinfo later on PATH.
for src in (_PREBUILT_PATH, _AMD_PY, _PYSTACK_PY):
text = src.read_text(encoding = "utf-8")
assert (
"_external_hipinfo_on_path" in text
), f"{src.name} must use the PATH-scanning hipinfo helper"
def test_path_inside_venv_resolves_symlinks(tmp_path):
# realpath (not abspath): a venv reached through a symlink/junction must
# still count as inside, else its hipInfo escapes the filter and amd-smi
# pops the DiskPart UAC. abspath would leave the alias unresolved here.
real = tmp_path / "real"
(real / "Scripts").mkdir(parents = True)
(real / "Scripts" / "hipInfo.exe").write_text("")
link = tmp_path / "link"
try:
link.symlink_to(real, target_is_directory = True)
except (OSError, NotImplementedError):
pytest.skip("symlinks not permitted on this runner")
with patch.object(prebuilt.sys, "prefix", str(real)):
assert prebuilt._path_inside_venv(str(link / "Scripts" / "hipInfo.exe")) is True
def test_ps_installers_gate_amd_smi_on_windows():
# Both PowerShell installers must gate amd-smi like _amd_smi_allowed().
for ps in (_INSTALL_PS1, _SETUP_PS1):
text = ps.read_text(encoding = "utf-8")
assert "UNSLOTH_ENABLE_AMD_SMI" in text, f"{ps.name} missing amd-smi opt-in gate"
assert "amdSmiAllowed" in text, f"{ps.name} missing amd-smi gate variable"
# The HIP-SDK probe must exclude the venv-internal hipInfo.exe (mirrors
# _path_inside_venv()), else amd-smi can still pop the DiskPart UAC.
assert (
"Test-HipinfoIsVenvInternal" in text
), f"{ps.name} missing venv-internal hipinfo exclusion helper"
# Get-Command returns only the first hipinfo; scan -All and skip the venv
# copy so a real SDK hipinfo later on PATH is not shadowed (codex P2).
assert (
"Get-Command hipinfo -CommandType Application -All" in text
), f"{ps.name} must enumerate all hipinfo executables on PATH (-CommandType Application -All)"
assert (
"Test-HipinfoIsVenvInternal $_.Source" in text
), f"{ps.name} must run the venv exclusion while scanning hipinfo candidates"
# The HIP_PATH/ROCM_PATH candidate must also be venv-filtered, else an env
# var pointing into the venv reopens the gate.
assert (
"Test-HipinfoIsVenvInternal $hipinfoCandidate" in text
), f"{ps.name} must run the venv exclusion on the HIP_PATH/ROCM_PATH candidate"
# VenvDir/VIRTUAL_ENV can be unset at probe time (the update flow), so the
# venv root must also be derived from the setup python.
assert (
"UNSLOTH_SETUP_PYTHON" in text
), f"{ps.name} venv-internal check must seed the venv root from UNSLOTH_SETUP_PYTHON"
# A custom Studio home moves the venv off the default path; it must be
# seeded too or its hipInfo escapes the filter and reopens the gate.
assert (
"UNSLOTH_STUDIO_HOME" in text
), f"{ps.name} venv-internal check must seed the venv root from UNSLOTH_STUDIO_HOME"
@pytest.mark.parametrize("ps", [_INSTALL_PS1, _SETUP_PS1], ids = ["install.ps1", "setup.ps1"])
def test_ps_venv_probe_expands_tilde_for_custom_studio_home(ps):
# The probe seeds the venv root from a custom Studio home; a ~\studio form
# must expand to USERPROFILE like the canonical resolver, else GetFullPath
# keeps the literal ~ (cwd-relative) and the hipInfo escapes the filter.
text = ps.read_text(encoding = "utf-8")
i = text.find("$studioHomeEnv = ")
j = text.find('Join-Path $studioHomeEnv "unsloth_studio"', i)
assert i != -1 and j != -1, f"{ps.name}: studioHomeEnv venv-root seed not found"
block = text[i:j]
assert "USERPROFILE" in block and ".Substring(1)" in block, (
f"{ps.name}: the venv-internal probe must expand a leading ~ in the custom "
"Studio home before seeding the venv root (mirroring the canonical resolver)"
)
# The ~ expansion must be guarded on a non-empty USERPROFILE; otherwise
# Join-Path $env:USERPROFILE throws on a service/SYSTEM account with no profile,
# aborting the whole probe (and the install).
assert "IsNullOrWhiteSpace($env:USERPROFILE)" in block, (
f"{ps.name}: the ~ expansion must guard against an empty $env:USERPROFILE "
"before Join-Path (else it throws on a profile-less account)"
)
# A bare "~" leaves an empty child path, which Join-Path rejects on PS 5.1, so
# the expansion must fall back to USERPROFILE directly (joining only a non-empty
# remainder) rather than call Join-Path with "".
assert "$studioHomeRest" in block and "else { $env:USERPROFILE }" in block, (
f"{ps.name}: the ~ expansion must handle a bare ~ without passing an empty "
"child path to Join-Path (PS 5.1 rejects it)"
)
def _ps_floor_map(text, prefix):
# {gfx -> spec} for entries like "gfx1151" = "torchvision>=0.26.0,<0.27.0".
return dict(re.findall(r'"(gfx[0-9a-z]+)"\s*=\s*"(' + re.escape(prefix) + r'[^"]*)"', text))
def test_install_setup_ps_rocm_torch_floors_in_sync():
# install.ps1/setup.ps1 pull from AMD's per-arch index; their torch and
# companion floor maps must match so both resolve the same ABI-consistent trio
# (install.ps1 once left companions bare -> incompatible set -> CPU).
it = _INSTALL_PS1.read_text(encoding = "utf-8")
st = _SETUP_PS1.read_text(encoding = "utf-8")
for prefix in ("torch>=", "torchvision>=", "torchaudio>="):
i_map = _ps_floor_map(it, prefix)
s_map = _ps_floor_map(st, prefix)
assert i_map, f"install.ps1 has no {prefix!r} floor map"
assert (
i_map == s_map
), f"{prefix!r} floor map drift:\ninstall.ps1={i_map}\nsetup.ps1={s_map}"
# Strix Halo (the field case) must be pinned, not bare.
assert _ps_floor_map(it, "torchvision>=").get("gfx1151") == "torchvision>=0.26.0,<0.27.0"
# The ROCm install must pass the pinned companion specs, not bare names.
assert (
"$torchSpec $visionSpec $audioSpec" in it
), "install.ps1 ROCm install must use the pinned companion specs"
def test_install_ps1_rocm_cpu_fallback_uses_retry():
# The ROCm->CPU fallback (likeliest to hit a transient index issue) once used
# the non-retrying helper; it must retry like every other torch install here.
text = _INSTALL_PS1.read_text(encoding = "utf-8")
i = text.find("ROCm PyTorch install failed")
assert i != -1, "ROCm->CPU fallback block not found in install.ps1"
window = text[i : i + 600]
assert (
"Invoke-InstallCommandRetry" in window
), "the ROCm->CPU fallback torch install must use Invoke-InstallCommandRetry"
# Must --force-reinstall: a failed ROCm install can leave an unpinned ROCm torch
# that still satisfies the CPU torch>= range, so without it uv keeps the ROCm
# build and only swaps companions -> mismatched venv the repair block won't fix.
assert "--force-reinstall" in window, (
"the ROCm->CPU fallback must --force-reinstall so a partial ROCm torch is "
"replaced by the CPU build"
)
def test_setup_ps1_rocm_cpu_fallback_force_reinstalls():
# setup.ps1's CPU block is shared with the genuine CPU-only path, so it force-
# reinstalls only after an AMD ROCm fallback ($ROCmCpuFallback) -- evicting a
# partial ROCm torch without slowing the common CPU install.
text = _SETUP_PS1.read_text(encoding = "utf-8")
assert "$ROCmCpuFallback = $true" in text, (
"setup.ps1 must flag the AMD ROCm->CPU fallback so the CPU install can force-"
"reinstall a partial ROCm torch"
)
# Build $cpuForce as a real array, NOT via an if-expression: PowerShell collapses
# `$x = if (..) { @("--force-reinstall") }` to a scalar string, which @splat then
# enumerates char-by-char into broken single-letter args (- - f o r c e ...).
assert (
"$cpuForce = @()" in text
and 'if ($ROCmCpuFallback) { $cpuForce = @("--force-reinstall") }' in text
), (
"setup.ps1 must build $cpuForce as an array assigned outside an if-expression "
"so @splat passes a single --force-reinstall arg, not per-character"
)
assert "$cpuForce = if ($ROCmCpuFallback)" not in text, (
'setup.ps1 must NOT assign $cpuForce from an if-expression (collapses @("x") '
"to a scalar string that @splat explodes char-by-char)"
)
def test_install_python_stack_gates_every_amd_smi_spawn():
# Regression for the DiskPart UAC prompt: every function naming `amd-smi`
# AND spawning a subprocess must gate it behind _amd_smi_allowed().
import ast
src = (PACKAGE_ROOT / "studio" / "install_python_stack.py").read_text(encoding = "utf-8")
tree = ast.parse(src)
def _names_amd_smi_command(node):
# Exact "amd-smi"/"amd-smi.exe" constant, not a substring in a log.
return any(
isinstance(n, ast.Constant)
and isinstance(n.value, str)
and n.value.lower() in ("amd-smi", "amd-smi.exe")
for n in ast.walk(node)
)
def _spawns_subprocess(node):
for n in ast.walk(node):
if (
isinstance(n, ast.Call)
and isinstance(n.func, ast.Attribute)
and isinstance(n.func.value, ast.Name)
and n.func.value.id == "subprocess"
):
return True
return False
def _references_gate(node):
return any(isinstance(n, ast.Name) and n.id == "_amd_smi_allowed" for n in ast.walk(node))
offenders = [
node.name
for node in ast.walk(tree)
if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))
and _names_amd_smi_command(node)
and _spawns_subprocess(node)
and not _references_gate(node)
]
assert not offenders, (
"install_python_stack.py spawns amd-smi without an _amd_smi_allowed() "
f"gate in: {offenders} -- this pops the Windows UAC/DiskPart prompt on "
"Adrenalin-only (no HIP SDK) hosts."
)
def test_install_ps1_installs_rocm_torch_for_known_arch():
# A known AMD arch (even name-inferred, $HasROCm false) must select the ROCm
# index directly, not a CPU base that setup.ps1 then force-reinstalls as ROCm.
# The repo.amd.com wheels bundle their runtime (no HIP SDK), so gate on $ROCmGfxArch.
text = _INSTALL_PS1.read_text(encoding = "utf-8")
gates = [
ln
for ln in text.splitlines()
if '$TorchIndexUrl -like "*/cpu"' in ln and ln.lstrip().startswith("if ")
]
assert gates, "ROCm-index selection gate not found in install.ps1"
assert any("$ROCmGfxArch" in ln for ln in gates), (
"install.ps1 gates ROCm torch only on probe-verified ROCm ($HasROCm); a "
"known/name-inferred arch should install ROCm directly to avoid a wasted "
"CPU PyTorch base that setup.ps1 immediately force-reinstalls."
)
# ── PR #6296 follow-ups (review-bot findings) ────────────────────────────────
def test_external_hipinfo_strips_quoted_path_entries(tmp_path):
# Windows PATH entries can carry surrounding double quotes; the scan must strip
# them before os.path.join, else a real HIP SDK in a quoted dir is missed and a
# genuine AMD box silently loses amd-smi VRAM polling.
sdk_bin = tmp_path / "hip sdk" / "bin"
sdk_bin.mkdir(parents = True)
(sdk_bin / "hipinfo.exe").write_text("")
quoted = '"' + str(sdk_bin) + '"' # the literal quotes Windows can leave on PATH
with (
patch.object(prebuilt.platform, "system", return_value = "Windows"),
patch.object(prebuilt.sys, "prefix", str(tmp_path / "venv")),
patch.dict(prebuilt.os.environ, {"PATH": quoted}, clear = True),
):
assert prebuilt._external_hipinfo_on_path() is True
assert prebuilt._amd_smi_allowed() is True
def test_python_hipinfo_strips_quotes_in_all_copies():
# All three copies of the PATH scan must strip surrounding quotes from entries.
for src in (_PREBUILT_PATH, _AMD_PY, _PYSTACK_PY):
text = src.read_text(encoding = "utf-8")
assert "strip('\"')" in text, f"{src.name} must strip quotes from PATH entries"
def test_python_path_inside_venv_guards_root_prefix_in_all_copies():
# If sys.prefix resolves to a bare root (C:\ or /), commonpath matches every
# path on the filesystem and classifies a real external hipinfo as
# venv-internal, silently disabling amd-smi. All three copies must guard it.
for src in (_PREBUILT_PATH, _AMD_PY, _PYSTACK_PY):
text = src.read_text(encoding = "utf-8")
assert (
"os.path.dirname(" in text and ") == " in text and "return False" in text
), f"{src.name} _path_inside_venv must guard a root-dir sys.prefix"
def test_path_inside_venv_returns_false_for_root_prefix():
# Behavioral: with sys.prefix realpath == a bare root, no external path counts as
# inside the venv (so a real HIP SDK on the same drive still opens the gate).
root = "C:\\" if os.name == "nt" else "/"
real = os.path.realpath
with patch.object(
prebuilt.os.path,
"realpath",
side_effect = lambda p: root if p == prebuilt.sys.prefix else real(p),
):
ext = os.path.join(root, "hip", "bin", "hipinfo.exe")
assert prebuilt._path_inside_venv(ext) is False
@pytest.mark.parametrize("ps", [_INSTALL_PS1, _SETUP_PS1], ids = ["install.ps1", "setup.ps1"])
def test_ps_venv_probe_skips_drive_root(ps):
# A non-venv UNSLOTH_SETUP_PYTHON like C:\Python311\python.exe yields a bare
# drive root (C:) as a venv root; without a guard it matches every path on that
# drive and misclassifies a real HIP SDK as venv-internal, disabling amd-smi.
text = ps.read_text(encoding = "utf-8")
assert "'^[a-zA-Z]:$'" in text, (
f"{ps.name} venv-internal probe must skip bare drive roots so a non-venv "
"UNSLOTH_SETUP_PYTHON doesn't match the whole drive"
)
@pytest.mark.parametrize("ps", [_INSTALL_PS1, _SETUP_PS1], ids = ["install.ps1", "setup.ps1"])
def test_ps_env_fallback_iterates_all_hip_roots(ps):
# The HIP_PATH/ROCM_PATH fallback must iterate every env root (incl. HIP_PATH_57)
# and take the first non-venv hipinfo, so a venv-internal HIP_PATH can't mask a
# real SDK in ROCM_PATH (single-root selection would bail on the venv copy).
text = ps.read_text(encoding = "utf-8")
assert 'foreach ($hipEnvLabel in @("HIP_PATH", "HIP_PATH_57", "ROCM_PATH"))' in text, (
f"{ps.name} must iterate HIP_PATH/HIP_PATH_57/ROCM_PATH in the env fallback, "
"not pick a single root"
)
def test_install_ps1_clears_rocm_index_after_cpu_fallback():
# After the ROCm->CPU fallback, $ROCmIndexUrl must be cleared so the later
# flavor-repair block doesn't retry the just-failed index and Exit-InstallFailure
# (the fallback lets install complete; setup.ps1 retries ROCm).
text = _INSTALL_PS1.read_text(encoding = "utf-8")
i = text.find("ROCm PyTorch install failed")
assert i != -1, "ROCm->CPU fallback block not found in install.ps1"
window = text[i : i + 1800]
assert "$ROCmIndexUrl = $null" in window, (
"install.ps1 must clear $ROCmIndexUrl after the CPU fallback so the repair "
"block does not re-trigger the failed ROCm index and abort the install"
)
def test_install_ps1_rocm_repair_pins_companions():
# The flavor-repair ROCm reinstall must use the pinned companion specs (like the
# fresh ROCm install), not bare torchvision/torchaudio, which can resolve an
# ABI-incompatible trio on AMD's per-arch index.
text = _INSTALL_PS1.read_text(encoding = "utf-8")
i = text.find("PyTorch flavor mismatch (installed $installedTorchTag, need ROCm)")
assert i != -1, "ROCm flavor-repair block not found in install.ps1"
window = text[i : i + 400]
assert "$rocmSpec $visionSpec $audioSpec" in window, (
"the ROCm repair reinstall must pass the pinned $visionSpec/$audioSpec, not "
"bare torchvision/torchaudio"
)
def test_install_sh_wsl_reroute_uses_pipefail():
# The `curl | sh` reroute runs via `bash -lc`; without pipefail a failed curl is
# masked by sh exiting 0 on empty input, so the reroute would wrongly report
# success and exit 0 from the parent installer.
text = _INSTALL_SH.read_text(encoding = "utf-8")
assert "set -o pipefail" in text, "reroute must enable pipefail"
# The reroute targets the selected distro ($_rr_target: 24.04 preferred, 22.04
# fallback) via bash -lc; find that exec line.
i = text.find('wsl.exe -d "$_rr_target" -- bash -lc')
assert i != -1, "WSL reroute command not found in install.sh"
# pipefail is set in the exports prefix the reroute bash -lc runs; the wsl.exe
# call must wire that prefix in (a failed curl is otherwise masked by sh exit 0).
line = text[text.rfind("\n", 0, i) + 1 : text.find("\n", i)]
assert (
"$_rr_exports" in line
), "install.sh WSL reroute `bash -lc` must run the pipefail exports prefix"
def test_install_sh_wsl_reroute_propagates_tauri_need_sudo_exit():
# In --tauri mode the rerouted child uses exit 2 ([TAURI:NEED_SUDO]) to ask the
# desktop app to elevate for the target distro. The reroute must propagate that
# code instead of masking it as a generic failure and dropping to CPU here.
text = _INSTALL_SH.read_text(encoding = "utf-8")
i = text.find('wsl.exe -d "$_rr_target" -- bash -lc')
assert i != -1, "WSL reroute command not found in install.sh"
window = text[i : i + 500]
assert (
'[ "$_rr_rc" -eq 2 ]' in window and "exit 2" in window
), "the reroute must propagate the child's tauri exit 2 (NEED_SUDO)"
assert '[ "$TAURI_MODE" = true ]' in window, (
"exit-2 propagation must be gated on --tauri mode so the CLI path still falls "
"back to CPU on a generic reroute failure"
)
def test_uninstall_sh_preserves_shared_icon_for_surviving_shortcut():
# %LOCALAPPDATA%\Unsloth Studio\unsloth.ico is shared with the native install
# and other WSL distros; both removal paths must keep it while any "Unsloth
# Studio*.lnk" survives (reciprocal of uninstall.ps1's
# _RemoveDataDirKeepingWslIcon), not delete it unconditionally.
text = (PACKAGE_ROOT / "scripts" / "uninstall.sh").read_text(encoding = "utf-8")
assert "_drop_shared_icon_if_unused" in text, (
"uninstall.sh drvfs path must gate the shared-icon deletion behind a "
"shortcut-in-use check, not delete unconditionally"
)
assert "iconInUse" in text, (
"uninstall.sh powershell-interop path must keep the icon when an Unsloth "
"shortcut still uses it"
)
# An empty $env:LOCALAPPDATA (service/SYSTEM account) makes Join-Path throw and
# aborts the icon cleanup; the interop snippet must guard it like uninstall.ps1.
assert "IsNullOrWhiteSpace($env:LOCALAPPDATA)" in text, (
"uninstall.sh powershell-interop path must guard an empty $env:LOCALAPPDATA "
"before Join-Path (else cleanup throws on a profile-less account)"
)
def test_uninstall_removes_managed_node_runtime():
# The isolated Node.js runtime (install_node_prebuilt.py) lives at ~/.unsloth/node
# in default mode, a sibling of studio -- deleting <studio> misses it, so both
# uninstallers must remove it explicitly (env/custom mode nests it under the
# custom root, removed with that root).
sh = (PACKAGE_ROOT / "scripts" / "uninstall.sh").read_text(encoding = "utf-8")
assert (
'_remove_path "$HOME/.unsloth/node"' in sh
), "uninstall.sh must remove the default-mode ~/.unsloth/node runtime"
ps = (PACKAGE_ROOT / "scripts" / "uninstall.ps1").read_text(encoding = "utf-8")
assert (
'$defaultNode = if ($defaultUnslothHome) { Join-Path $defaultUnslothHome "node" }' in ps
), "uninstall.ps1 must resolve the default-mode ~/.unsloth\\node runtime dir"
assert (
"_RemovePath $defaultNode" in ps
), "uninstall.ps1 must remove the default-mode ~/.unsloth\\node runtime"
def test_install_python_stack_windows_rocm_repair_pins_and_is_nonfatal():
# The Windows AMD ROCm repair in _ensure_rocm_torch() must mirror the PS
# installer: (1) pin torchvision/torchaudio for the arches the PS side pins so
# the per-arch index resolves an ABI-consistent trio, and (2) be nonfatal so a
# transient index failure doesn't abort the install after the PS side already
# fell back to CPU torch.
text = _PYSTACK_PY.read_text(encoding = "utf-8")
assert (
"_WINDOWS_ROCM_TORCH_PKG_SPECS" in text
), "install_python_stack.py must define a Windows per-arch ROCm companion pin map"
for gfx in ("gfx1201", "gfx1200", "gfx1151", "gfx1150"):
assert re.search(
r'"' + gfx + r'":\s*_ROCM_TORCH_PKG_SPECS\["rocm7\.2"\]', text
), f"{gfx} must pin to the rocm7.2 trio like install.ps1/setup.ps1"
i = text.find('f"ROCm torch (Windows, {gfx_arch})"')
assert i != -1, "Windows ROCm repair pip call not found"
# The nearest preceding call must be the nonfatal pip_install_try, not pip_install.
j = text.rfind("pip_install_try(", 0, i)
k = text.rfind("pip_install(", 0, i)
assert j != -1 and (
k == -1 or j > k
), "Windows ROCm repair must use the nonfatal pip_install_try wrapping the trio"
window = text[i : i + 700]
assert (
"_torch_pkg" in window and "_vision_pkg" in window and "_audio_pkg" in window
), "Windows ROCm repair must pass the pinned companion trio, not bare names"
assert (
"keeping the existing torch build" in window
), "Windows ROCm repair must keep the existing build (nonfatal) when the index fails"
def _load_pystack():
# install_python_stack.py imports from backend.*, so put studio/ on sys.path.
import importlib.util
studio_dir = str(PACKAGE_ROOT / "studio")
if studio_dir not in sys.path:
sys.path.insert(0, studio_dir)
spec = importlib.util.spec_from_file_location("pystack_pr6296", _PYSTACK_PY)
mod = importlib.util.module_from_spec(spec)
sys.modules[spec.name] = mod
spec.loader.exec_module(mod)
return mod
def test_windows_rocm_repair_nonfatal_keeps_cpu_torch_on_index_failure(monkeypatch):
# Behavioral: with a Windows AMD box whose per-arch index is down, the repair
# must attempt the pinned trio via the nonfatal helper, NOT call the fatal
# pip_install, and NOT proceed to bitsandbytes -- so the overall install
# survives the index failure with the existing (CPU) torch intact.
try:
ps = _load_pystack()
except Exception as exc: # minimal CI without backend deps
pytest.skip(f"install_python_stack deps unavailable: {exc}")
calls = {"try": [], "fatal": 0, "bnb": 0}
monkeypatch.setattr(ps, "IS_WINDOWS", True)
monkeypatch.setattr(ps, "IS_MACOS", False)
monkeypatch.setattr(ps, "_TORCH_BACKEND", "rocm", raising = False)
monkeypatch.setattr(ps, "_has_usable_nvidia_gpu", lambda: False)
monkeypatch.setattr(ps, "_detect_windows_gfx_arch", lambda: "gfx1151")
monkeypatch.setattr(
ps, "_windows_rocm_index_url", lambda a: "https://repo.amd.com/rocm/whl/gfx1151/"
)
# torch is not already a ROCm build -> the version probe prints nothing.
monkeypatch.setattr(
ps.subprocess, "run", lambda *a, **k: subprocess.CompletedProcess(a, 0, b"", b"")
)
def fake_try(label, *args, **kw):
calls["try"].append((label, args, kw))
return False # simulate the AMD index being unreachable
monkeypatch.setattr(ps, "pip_install_try", fake_try)
monkeypatch.setattr(
ps, "pip_install", lambda *a, **k: calls.__setitem__("fatal", calls["fatal"] + 1)
)
monkeypatch.setattr(
ps,
"_install_bnb_windows_rocm",
lambda *a, **k: calls.__setitem__("bnb", calls["bnb"] + 1) or True,
)
monkeypatch.delenv("UNSLOTH_ROCM_TORCH_INSTALLED", raising = False)
ps._ensure_rocm_torch() # must not raise / SystemExit
assert calls["fatal"] == 0, "Windows ROCm repair must not use the fatal pip_install"
assert len(calls["try"]) == 1, "expected one nonfatal ROCm torch install attempt"
_, args, _ = calls["try"][0]
assert "torch>=2.11.0,<2.12.0" in args, "torch must be pinned to the rocm7.2 floor"
assert "torchvision>=0.26.0,<0.27.0" in args, "torchvision companion must be pinned"
assert "torchaudio>=2.11.0,<2.12.0" in args, "torchaudio companion must be pinned"
assert calls["bnb"] == 0, "a failed ROCm torch install must not proceed to bitsandbytes"
if __name__ == "__main__":
pytest.main([__file__, "-v"])