* tests: read checked-in files as UTF-8 instead of the platform default Path.read_text() with no encoding uses locale.getpreferredencoding(), which is UTF-8 on the Linux runners and cp1252 on a stock Windows install. Nine module-level reads of checked-in source files were relying on that default. studio/backend/routes/inference.py carries the DeepSeek tool-call token regexes, so it holds U+FF5C and U+2581. Under cp1252 that read raised UnicodeDecodeError on byte 0x81 at position 97806, and because the reads run at import time it took test_cancel_atomicity.py and test_cancel_id_wiring.py out at collection, not as failures. Green on CI, permanently broken for a Windows contributor running the suite locally. Adds a guard: at module scope there is no tmp_path fixture, so a bare read_text()/write_text()/open() there is always touching a checked-in file. That makes the rule mechanical enough to enforce with no allowlist, while staying quiet about temp-dir I/O inside test bodies where the platform default is harmless. The repo already spells this correctly in 464 other places; this only stops the stragglers coming back. * tests: cover import-time helper reads and keep the guard py3.9-safe Follows up on the Codex review: - add `from __future__ import annotations`, since `str | None` in `_offender` is evaluated at import on Python 3.9 and pyproject declares requires-python ">=3.9,<3.15". - widen the guard from module scope to import time. Class bodies and the bodies of module-level helpers called from an executing statement run during collection too, so `CODE = _extract_mixed_precision_code()` was the same hazard as an inline read. `if __name__ == "__main__":` blocks are skipped: pytest never executes them. - scan studio/backend/tests/ as well as tests/. Both trees are collected on Windows by separate CI jobs, and the offender that started this, test_tool_xml_strip.py reading routes/inference.py, lives there. Widening it surfaced seven more import-time reads of checked-in sources; all now name utf-8. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Harden the import-time encoding guard for PR #7438 Close the detector gaps raised in review, all of which I reproduced against the actual AST before changing anything. False negatives (the guard let a real hazard through): - _is_main_guard ignored the comparison operator, so if __name__ != "__main__" counted as script-only even though its body runs at import. - The else arm of a main guard was discarded with the rest of the If node. - Decorators and argument defaults on a module-level def were skipped with the body, though both are evaluated when the def executes. - Path.open() in text mode was invisible; only builtin open() was matched. - encoding = None and encoding = "locale" both re-select the platform default, but the keyword merely being present counted as pinned. False positives (the guard would have blocked a compliant contributor): - A non-literal mode fell through to the "r" default, so open(p, mode) was flagged even when mode is "rb", where adding encoding= is a ValueError and there is no edit that satisfies the rule. - Same for open(*args) and a **kwargs splat, which hide the mode and can hide an encoding. - Lambda bodies and comprehension elements were walked even though neither runs at definition. Verified: still reports the same 22 offenders on unpatched main, green on this branch and on the tree merged with latest main (557 files), and an adversarial corpus of 33 cases now scores zero false positives and zero false negatives. Also corrected two docstring claims: neither collecting job runs on Windows, and the read is governed by locale.getencoding(). * Walk eager comprehensions and treat io.open as the builtin Two regressions from the previous commit, both reproduced against the AST before changing anything. Lumping list, set and dict comprehensions in with generator expressions was wrong. Only a genexp is lazy; the other three run their element expression, their filters and their nested iterators immediately, so CONTENTS = [p.read_text() for p in PATHS] at module scope is an import-time read the guard was silently missing. Comprehensions are now walked in full and only the genexp keeps the outermost-iterable-only treatment. io was also in the not-a-path-opener list, but io.open is the builtin, with the same mode position and the same platform default. io.open(CHECKED_IN_FILE) is exactly the hazard this guard exists for, so it is matched now, with binary modes and a pinned encoding still exempt. tarfile.open and fitz.open stay exempt since neither has an encoding to name. Verified: 13 targeted cases covering all five eager comprehension forms and io.open in text, binary and pinned shapes all classify correctly; still 22 offenders on unpatched main; green on this branch and on the tree merged with latest main. * Close three more walker gaps in the import-time guard All three reproduced against the AST first. A generator expression handed straight to a call is consumed there, so DATA = "".join(p.read_text() for p in paths) runs its element at import. Only an unconsumed genexp bound to a name stays lazy, so the walker now follows the consumed ones in full and keeps the outermost-iterable-only treatment for the rest. if "__main__" == __name__ is an equivalent and accepted spelling of the main guard, but requiring __name__ on the left meant its body was treated as import-time code. That is a false positive on a block pytest never runs, so both operand orders are recognised now. The helper table was built from module-level defs only, so a def in a class body invoked while the class is constructed was never followed, contradicting the walker's stated coverage of class bodies. Helpers are now collected from the module body and from class bodies at any nesting. Verified: 15 targeted cases including all three fixes and the earlier ones still classify correctly; still 22 offenders on unpatched main; green on this branch and on the tree merged with latest main. * Handle positional read_text encodings, lazy generators and nested helpers * Guard reads reached from test bodies, unbound Path calls and __file__ paths * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Follow derived paths, skip lazy generator helpers, cover compressed openers * Guard the CLI tests, helper parameters and unbound Path arguments * Discover test roots and follow literal, in-place and tuple-derived paths * Identify module openers by import, unwrap starred paths, pin subprocess snippets * Resolve import origins, seed helper locals, follow named generators and parametrize * Scope imports lexically, list tracked test files, bind unpacked names * Resolve aliased openers, keyword-only params, destructured targets, next() * Pin the encoding on subprocess snippets, workflow lint and CLI output for PR #7438 * Harden the CLI encoding guard against detached streams for PR #7438 * Tighten the encoding guard's path and scope analysis for PR #7438 * Resolve path provenance more precisely and keep POSIX stream encodings for PR #7438 * Resolve qualified path classes and scope conditional imports for PR #7438 * Scope CLI stream setup to the entry point and align two encoding pairs for PR #7438 --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: danielhanchen <danielhanchen@gmail.com>
1133 lines
48 KiB
Python
1133 lines
48 KiB
Python
"""Tests for PR #4562 bug fixes (1-4), latest-tag resolution, and binary_env."""
|
|
|
|
import importlib.util
|
|
import json
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
import textwrap
|
|
import urllib.parse
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
PACKAGE_ROOT = Path(__file__).resolve().parents[3]
|
|
MODULE_PATH = PACKAGE_ROOT / "studio" / "install_llama_prebuilt.py"
|
|
SPEC = importlib.util.spec_from_file_location("studio_install_llama_prebuilt", MODULE_PATH)
|
|
assert SPEC is not None and SPEC.loader is not None
|
|
MOD = importlib.util.module_from_spec(SPEC)
|
|
sys.modules[SPEC.name] = MOD
|
|
SPEC.loader.exec_module(MOD)
|
|
|
|
binary_env = MOD.binary_env
|
|
HostInfo = MOD.HostInfo
|
|
resolve_requested_llama_tag = MOD.resolve_requested_llama_tag
|
|
PublishedReleaseBundle = MOD.PublishedReleaseBundle
|
|
ApprovedArtifactHash = MOD.ApprovedArtifactHash
|
|
ApprovedReleaseChecksums = MOD.ApprovedReleaseChecksums
|
|
source_archive_logical_name = MOD.source_archive_logical_name
|
|
|
|
SETUP_SH = PACKAGE_ROOT / "studio" / "setup.sh"
|
|
SETUP_PS1 = PACKAGE_ROOT / "studio" / "setup.ps1"
|
|
|
|
|
|
def make_host(*, system: str) -> HostInfo:
|
|
"""HostInfo for the given OS."""
|
|
return HostInfo(
|
|
system = system,
|
|
machine = "x86_64" if system != "Darwin" else "arm64",
|
|
is_windows = (system == "Windows"),
|
|
is_linux = (system == "Linux"),
|
|
is_macos = (system == "Darwin"),
|
|
is_x86_64 = (system != "Darwin"),
|
|
is_arm64 = (system == "Darwin"),
|
|
nvidia_smi = None,
|
|
driver_cuda_version = None,
|
|
compute_caps = [],
|
|
visible_cuda_devices = None,
|
|
has_physical_nvidia = False,
|
|
has_usable_nvidia = False,
|
|
)
|
|
|
|
|
|
BASH = "/bin/bash"
|
|
|
|
|
|
def run_bash(
|
|
script: str,
|
|
*,
|
|
timeout: int = 10,
|
|
env: dict | None = None,
|
|
) -> str:
|
|
"""Run a bash fragment, return stdout."""
|
|
run_env = os.environ.copy()
|
|
if env:
|
|
run_env.update(env)
|
|
result = subprocess.run(
|
|
[BASH, "-c", script],
|
|
capture_output = True,
|
|
text = True,
|
|
timeout = timeout,
|
|
env = run_env,
|
|
)
|
|
assert (
|
|
result.returncode == 0
|
|
), f"bash script failed (exit {result.returncode}):\n{result.stderr}"
|
|
return result.stdout.strip()
|
|
|
|
|
|
class TestBinaryEnvCrossPlatform:
|
|
"""binary_env returns correct library paths for all OSes (Bug 4)."""
|
|
|
|
def test_linux_includes_binary_parent_in_ld_library_path(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
install_dir = tmp_path / "llama.cpp"
|
|
bin_dir = install_dir / "build" / "bin"
|
|
bin_dir.mkdir(parents = True)
|
|
binary_path = bin_dir / "llama-server"
|
|
binary_path.write_bytes(b"fake")
|
|
|
|
host = make_host(system = "Linux")
|
|
monkeypatch.setattr(MOD, "linux_runtime_dirs", lambda _bp: [])
|
|
|
|
env = binary_env(binary_path, install_dir, host)
|
|
ld_dirs = env["LD_LIBRARY_PATH"].split(os.pathsep)
|
|
assert str(bin_dir) in ld_dirs, f"build/bin not in LD_LIBRARY_PATH: {ld_dirs}"
|
|
assert str(install_dir) in ld_dirs, f"install_dir not in LD_LIBRARY_PATH: {ld_dirs}"
|
|
|
|
def test_linux_binary_parent_comes_before_install_dir(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
"""build/bin should be searched before install_dir for .so files."""
|
|
install_dir = tmp_path / "llama.cpp"
|
|
bin_dir = install_dir / "build" / "bin"
|
|
bin_dir.mkdir(parents = True)
|
|
binary_path = bin_dir / "llama-server"
|
|
binary_path.write_bytes(b"fake")
|
|
|
|
host = make_host(system = "Linux")
|
|
monkeypatch.setattr(MOD, "linux_runtime_dirs", lambda _bp: [])
|
|
|
|
env = binary_env(binary_path, install_dir, host)
|
|
ld_dirs = env["LD_LIBRARY_PATH"].split(os.pathsep)
|
|
bin_idx = ld_dirs.index(str(bin_dir))
|
|
install_idx = ld_dirs.index(str(install_dir))
|
|
assert bin_idx < install_idx, "binary_path.parent should come before install_dir"
|
|
|
|
def test_linux_deduplicates_when_binary_parent_equals_install_dir(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
"""When binary is directly in install_dir, no duplicate entries."""
|
|
install_dir = tmp_path / "llama.cpp"
|
|
install_dir.mkdir(parents = True)
|
|
binary_path = install_dir / "llama-server"
|
|
binary_path.write_bytes(b"fake")
|
|
|
|
host = make_host(system = "Linux")
|
|
monkeypatch.setattr(MOD, "linux_runtime_dirs", lambda _bp: [])
|
|
|
|
env = binary_env(binary_path, install_dir, host)
|
|
ld_dirs = [d for d in env["LD_LIBRARY_PATH"].split(os.pathsep) if d]
|
|
count = ld_dirs.count(str(install_dir))
|
|
assert count == 1, f"install_dir appears {count} times in LD_LIBRARY_PATH"
|
|
|
|
def test_linux_preserves_existing_ld_library_path(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
install_dir = tmp_path / "llama.cpp"
|
|
bin_dir = install_dir / "build" / "bin"
|
|
bin_dir.mkdir(parents = True)
|
|
binary_path = bin_dir / "llama-server"
|
|
binary_path.write_bytes(b"fake")
|
|
|
|
# Real dirs so dedupe_existing_dirs keeps them.
|
|
custom_lib = tmp_path / "custom_lib"
|
|
other_lib = tmp_path / "other_lib"
|
|
custom_lib.mkdir()
|
|
other_lib.mkdir()
|
|
|
|
host = make_host(system = "Linux")
|
|
monkeypatch.setattr(MOD, "linux_runtime_dirs", lambda _bp: [])
|
|
original = os.environ.get("LD_LIBRARY_PATH", "")
|
|
os.environ["LD_LIBRARY_PATH"] = f"{custom_lib}:{other_lib}"
|
|
try:
|
|
env = binary_env(binary_path, install_dir, host)
|
|
finally:
|
|
if original:
|
|
os.environ["LD_LIBRARY_PATH"] = original
|
|
else:
|
|
os.environ.pop("LD_LIBRARY_PATH", None)
|
|
ld_dirs = env["LD_LIBRARY_PATH"].split(os.pathsep)
|
|
assert str(custom_lib.resolve()) in ld_dirs
|
|
assert str(other_lib.resolve()) in ld_dirs
|
|
|
|
def test_windows_includes_binary_parent_in_path(
|
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
install_dir = tmp_path / "llama.cpp"
|
|
bin_dir = install_dir / "build" / "bin" / "Release"
|
|
bin_dir.mkdir(parents = True)
|
|
binary_path = bin_dir / "llama-server.exe"
|
|
binary_path.write_bytes(b"MZ")
|
|
|
|
host = make_host(system = "Windows")
|
|
monkeypatch.setattr(MOD, "windows_runtime_dirs_for_runtime_line", lambda _rt: [])
|
|
|
|
env = binary_env(binary_path, install_dir, host)
|
|
path_dirs = env["PATH"].split(os.pathsep)
|
|
assert str(bin_dir) in path_dirs, f"build/bin/Release not in PATH: {path_dirs}"
|
|
|
|
def test_macos_sets_dyld_library_path(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
|
|
install_dir = tmp_path / "llama.cpp"
|
|
install_dir.mkdir(parents = True)
|
|
bin_dir = install_dir / "build" / "bin"
|
|
binary_path = bin_dir / "llama-server"
|
|
binary_path.parent.mkdir(parents = True)
|
|
binary_path.write_bytes(b"fake")
|
|
|
|
host = make_host(system = "Darwin")
|
|
monkeypatch.delenv("DYLD_LIBRARY_PATH", raising = False)
|
|
|
|
env = binary_env(binary_path, install_dir, host)
|
|
dyld_parts = [p for p in env["DYLD_LIBRARY_PATH"].split(os.pathsep) if p]
|
|
assert str(bin_dir) in dyld_parts, f"build/bin not in DYLD_LIBRARY_PATH: {dyld_parts}"
|
|
assert str(install_dir) in dyld_parts, f"install_dir not in DYLD_LIBRARY_PATH: {dyld_parts}"
|
|
# build/bin must come before install_dir.
|
|
assert dyld_parts.index(str(bin_dir)) < dyld_parts.index(str(install_dir))
|
|
|
|
|
|
class TestResolveRequestedLlamaTag:
|
|
def test_concrete_tag_passes_through(self):
|
|
assert resolve_requested_llama_tag("b8508") == "b8508"
|
|
|
|
def test_none_resolves_to_latest(self, monkeypatch: pytest.MonkeyPatch):
|
|
monkeypatch.setattr(MOD, "latest_upstream_release_tag", lambda: "b9999")
|
|
assert resolve_requested_llama_tag(None) == "b9999"
|
|
|
|
def test_latest_resolves_to_upstream(self, monkeypatch: pytest.MonkeyPatch):
|
|
monkeypatch.setattr(MOD, "latest_upstream_release_tag", lambda: "b1234")
|
|
assert resolve_requested_llama_tag("latest") == "b1234"
|
|
|
|
def test_empty_string_resolves_to_latest(self, monkeypatch: pytest.MonkeyPatch):
|
|
monkeypatch.setattr(MOD, "latest_upstream_release_tag", lambda: "b5555")
|
|
assert resolve_requested_llama_tag("") == "b5555"
|
|
|
|
def test_latest_with_published_repo_uses_latest_valid_published_release(
|
|
self, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
invalid = PublishedReleaseBundle(
|
|
repo = "unslothai/llama.cpp",
|
|
release_tag = "v2.0",
|
|
upstream_tag = "b9000",
|
|
assets = {},
|
|
manifest_asset_name = "llama-prebuilt-manifest.json",
|
|
artifacts = [],
|
|
selection_log = [],
|
|
)
|
|
valid = PublishedReleaseBundle(
|
|
repo = "unslothai/llama.cpp",
|
|
release_tag = "v1.0",
|
|
upstream_tag = "b8999",
|
|
assets = {},
|
|
manifest_asset_name = "llama-prebuilt-manifest.json",
|
|
artifacts = [],
|
|
selection_log = [],
|
|
)
|
|
|
|
monkeypatch.setattr(
|
|
MOD,
|
|
"iter_published_release_bundles",
|
|
lambda repo, published_release_tag = "": iter([invalid, valid]),
|
|
)
|
|
|
|
def fake_load(repo, release_tag):
|
|
if release_tag == "v2.0":
|
|
raise MOD.PrebuiltFallback("checksum asset missing")
|
|
return ApprovedReleaseChecksums(
|
|
repo = repo,
|
|
release_tag = release_tag,
|
|
upstream_tag = "b8999",
|
|
source_commit = None,
|
|
artifacts = {
|
|
source_archive_logical_name("b8999"): ApprovedArtifactHash(
|
|
asset_name = source_archive_logical_name("b8999"),
|
|
sha256 = "a" * 64,
|
|
repo = "ggml-org/llama.cpp",
|
|
kind = "upstream-source",
|
|
)
|
|
},
|
|
)
|
|
|
|
monkeypatch.setattr(MOD, "load_approved_release_checksums", fake_load)
|
|
monkeypatch.setattr(MOD, "latest_upstream_release_tag", lambda: "b7777")
|
|
|
|
assert resolve_requested_llama_tag("latest", "unslothai/llama.cpp") == "b8999"
|
|
|
|
def test_latest_with_published_release_tag_passes_pin_through(
|
|
self, monkeypatch: pytest.MonkeyPatch
|
|
):
|
|
captured = {}
|
|
|
|
def fake_resolve(
|
|
requested_tag,
|
|
published_repo,
|
|
published_release_tag = "",
|
|
):
|
|
captured["requested_tag"] = requested_tag
|
|
captured["published_repo"] = published_repo
|
|
captured["published_release_tag"] = published_release_tag
|
|
return MOD.ResolvedPublishedRelease(
|
|
bundle = PublishedReleaseBundle(
|
|
repo = published_repo,
|
|
release_tag = published_release_tag,
|
|
upstream_tag = "b9001",
|
|
assets = {},
|
|
manifest_asset_name = "llama-prebuilt-manifest.json",
|
|
artifacts = [],
|
|
selection_log = [],
|
|
),
|
|
checksums = ApprovedReleaseChecksums(
|
|
repo = published_repo,
|
|
release_tag = published_release_tag,
|
|
upstream_tag = "b9001",
|
|
artifacts = {
|
|
source_archive_logical_name("b9001"): ApprovedArtifactHash(
|
|
asset_name = source_archive_logical_name("b9001"),
|
|
sha256 = "a" * 64,
|
|
repo = "ggml-org/llama.cpp",
|
|
kind = "upstream-source",
|
|
)
|
|
},
|
|
),
|
|
)
|
|
|
|
monkeypatch.setattr(MOD, "resolve_published_release", fake_resolve)
|
|
|
|
assert (
|
|
resolve_requested_llama_tag(
|
|
"latest",
|
|
"unslothai/llama.cpp",
|
|
"llama-prebuilt-main",
|
|
)
|
|
== "b9001"
|
|
)
|
|
assert captured == {
|
|
"requested_tag": "latest",
|
|
"published_repo": "unslothai/llama.cpp",
|
|
"published_release_tag": "llama-prebuilt-main",
|
|
}
|
|
|
|
|
|
class TestFetchJsonRetries:
|
|
def test_fetch_json_retries_invalid_github_api_json(self, monkeypatch: pytest.MonkeyPatch):
|
|
calls = {"count": 0}
|
|
|
|
def fake_download_bytes(url, **kwargs):
|
|
calls["count"] += 1
|
|
if calls["count"] == 1:
|
|
return b'{"incomplete":"payload'
|
|
return json.dumps([{"tag_name": "b8635"}]).encode("utf-8")
|
|
|
|
monkeypatch.setattr(MOD, "download_bytes", fake_download_bytes)
|
|
monkeypatch.setattr(MOD, "sleep_backoff", lambda _attempt: None)
|
|
|
|
payload = MOD.fetch_json(
|
|
"https://api.github.com/repos/ggml-org/llama.cpp/releases?per_page=100&page=1"
|
|
)
|
|
|
|
assert isinstance(payload, list)
|
|
assert payload[0]["tag_name"] == "b8635"
|
|
assert calls["count"] == 2
|
|
|
|
def test_github_releases_honors_max_pages(self, monkeypatch: pytest.MonkeyPatch):
|
|
seen_pages: list[int] = []
|
|
|
|
def fake_fetch_json(url: str):
|
|
parsed = urllib.parse.urlparse(url)
|
|
params = urllib.parse.parse_qs(parsed.query)
|
|
page = int(params["page"][0])
|
|
seen_pages.append(page)
|
|
return [{"tag_name": f"b{page:04d}"} for _ in range(100)]
|
|
|
|
monkeypatch.setattr(MOD, "fetch_json", fake_fetch_json)
|
|
|
|
releases = MOD.github_releases("ggml-org/llama.cpp", max_pages = 2)
|
|
|
|
assert seen_pages == [1, 2]
|
|
assert len(releases) == 200
|
|
|
|
|
|
class TestSetupShLogic:
|
|
"""setup.sh fragments via bash subprocess with controlled PATH."""
|
|
|
|
def test_cmake_missing_preserves_install(self, tmp_path: Path):
|
|
"""Bug 3: cmake missing -> rm -rf must NOT run."""
|
|
llama_dir = tmp_path / "llama.cpp"
|
|
llama_dir.mkdir()
|
|
marker = llama_dir / "marker.txt"
|
|
marker.write_text("existing")
|
|
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
# Mock git but NOT cmake.
|
|
(mock_bin / "git").write_text("#!/bin/bash\nexit 0\n")
|
|
(mock_bin / "git").chmod(0o755)
|
|
|
|
# PATH: mock_bin first, then system dirs without cmake.
|
|
safe_dirs = [str(mock_bin)]
|
|
for d in os.environ.get("PATH", "").split(":"):
|
|
if d and not os.path.isfile(os.path.join(d, "cmake")):
|
|
safe_dirs.append(d)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export LLAMA_CPP_DIR="{llama_dir}"
|
|
if ! command -v cmake &>/dev/null; then
|
|
echo "cmake_missing"
|
|
elif ! command -v git &>/dev/null; then
|
|
echo "git_missing"
|
|
else
|
|
rm -rf "$LLAMA_CPP_DIR"
|
|
echo "would_clone"
|
|
fi
|
|
""")
|
|
output = run_bash(script, env = {"PATH": ":".join(safe_dirs)})
|
|
assert "cmake_missing" in output
|
|
assert marker.exists(), "Install dir was deleted despite cmake missing!"
|
|
|
|
def test_git_missing_preserves_install(self, tmp_path: Path):
|
|
"""Bug 3: git missing -> rm -rf must NOT run."""
|
|
llama_dir = tmp_path / "llama.cpp"
|
|
llama_dir.mkdir()
|
|
marker = llama_dir / "marker.txt"
|
|
marker.write_text("existing")
|
|
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
# Mock cmake but NOT git.
|
|
(mock_bin / "cmake").write_text("#!/bin/bash\nexit 0\n")
|
|
(mock_bin / "cmake").chmod(0o755)
|
|
|
|
# PATH: mock_bin first, then system dirs without git.
|
|
safe_dirs = [str(mock_bin)]
|
|
for d in os.environ.get("PATH", "").split(":"):
|
|
if d and not os.path.isfile(os.path.join(d, "git")):
|
|
safe_dirs.append(d)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export LLAMA_CPP_DIR="{llama_dir}"
|
|
if ! command -v cmake &>/dev/null; then
|
|
echo "cmake_missing"
|
|
elif ! command -v git &>/dev/null; then
|
|
echo "git_missing"
|
|
else
|
|
rm -rf "$LLAMA_CPP_DIR"
|
|
echo "would_clone"
|
|
fi
|
|
""")
|
|
output = run_bash(script, env = {"PATH": ":".join(safe_dirs)})
|
|
assert "git_missing" in output
|
|
assert marker.exists(), "Install dir was deleted despite git missing!"
|
|
|
|
def test_both_present_runs_rm_and_clone(self, tmp_path: Path):
|
|
"""Bug 3: both present -> rm -rf runs before clone."""
|
|
llama_dir = tmp_path / "llama.cpp"
|
|
llama_dir.mkdir()
|
|
marker = llama_dir / "marker.txt"
|
|
marker.write_text("existing")
|
|
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
(mock_bin / "cmake").write_text("#!/bin/bash\nexit 0\n")
|
|
(mock_bin / "cmake").chmod(0o755)
|
|
(mock_bin / "git").write_text("#!/bin/bash\nexit 0\n")
|
|
(mock_bin / "git").chmod(0o755)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
export LLAMA_CPP_DIR="{llama_dir}"
|
|
if ! command -v cmake &>/dev/null; then
|
|
echo "cmake_missing"
|
|
elif ! command -v git &>/dev/null; then
|
|
echo "git_missing"
|
|
else
|
|
rm -rf "$LLAMA_CPP_DIR"
|
|
echo "would_clone"
|
|
fi
|
|
""")
|
|
output = run_bash(script)
|
|
assert "would_clone" in output
|
|
assert not marker.exists(), "Install dir should have been deleted"
|
|
|
|
def test_clone_uses_pinned_tag(self, tmp_path: Path):
|
|
"""Bug 2: git clone should use --branch with the resolved tag."""
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
log_file = tmp_path / "git_calls.log"
|
|
(mock_bin / "git").write_text(f'#!/bin/bash\necho "$*" >> {log_file}\nexit 0\n')
|
|
(mock_bin / "git").chmod(0o755)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
git clone --depth 1 --branch "b8508" https://github.com/ggml-org/llama.cpp.git /tmp/llama_test
|
|
""")
|
|
run_bash(script)
|
|
log = log_file.read_text()
|
|
assert "--branch b8508" in log, f"Expected --branch b8508 in: {log}"
|
|
|
|
def test_fetch_checkout_b_pattern(self, tmp_path: Path):
|
|
"""Bug 1: Re-run should use fetch + checkout -B, not pull + checkout FETCH_HEAD."""
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
log_file = tmp_path / "git_calls.log"
|
|
(mock_bin / "git").write_text(f'#!/bin/bash\necho "$*" >> {log_file}\nexit 0\n')
|
|
(mock_bin / "git").chmod(0o755)
|
|
|
|
llama_dir = tmp_path / "llama.cpp"
|
|
llama_dir.mkdir()
|
|
(llama_dir / ".git").mkdir()
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
LlamaCppDir="{llama_dir}"
|
|
ResolvedLlamaTag="b8508"
|
|
if [ -d "$LlamaCppDir/.git" ]; then
|
|
git -C "$LlamaCppDir" fetch --depth 1 origin "$ResolvedLlamaTag"
|
|
if [ $? -ne 0 ]; then
|
|
echo "WARN: fetch failed"
|
|
else
|
|
git -C "$LlamaCppDir" checkout -B unsloth-llama-build FETCH_HEAD
|
|
fi
|
|
fi
|
|
""")
|
|
run_bash(script)
|
|
log = log_file.read_text()
|
|
assert "fetch --depth 1 origin b8508" in log
|
|
assert "checkout -B unsloth-llama-build FETCH_HEAD" in log
|
|
assert "pull" not in log, "Should use fetch, not pull"
|
|
|
|
def test_fetch_failure_warns_not_aborts(self, tmp_path: Path):
|
|
"""Bug 1: fetch failure should warn and continue, not set BuildOk=false."""
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
(mock_bin / "git").write_text(
|
|
'#!/bin/bash\nif echo "$*" | grep -q fetch; then exit 1; fi\nexit 0\n'
|
|
)
|
|
(mock_bin / "git").chmod(0o755)
|
|
|
|
llama_dir = tmp_path / "llama.cpp"
|
|
llama_dir.mkdir()
|
|
(llama_dir / ".git").mkdir()
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
LlamaCppDir="{llama_dir}"
|
|
ResolvedLlamaTag="b8508"
|
|
BuildOk=true
|
|
if [ -d "$LlamaCppDir/.git" ]; then
|
|
git -C "$LlamaCppDir" fetch --depth 1 origin "$ResolvedLlamaTag"
|
|
if [ $? -ne 0 ]; then
|
|
echo "WARN: fetch failed -- using existing source"
|
|
else
|
|
git -C "$LlamaCppDir" checkout -B unsloth-llama-build FETCH_HEAD
|
|
fi
|
|
fi
|
|
echo "BuildOk=$BuildOk"
|
|
""")
|
|
output = run_bash(script)
|
|
assert "WARN: fetch failed" in output
|
|
assert "BuildOk=true" in output
|
|
|
|
|
|
class TestLatestTagResolution:
|
|
"""Fallback chain: helper resolver -> raw."""
|
|
|
|
RESOLVE_TEMPLATE = textwrap.dedent("""\
|
|
_REQUESTED_LLAMA_TAG="{requested_tag}"
|
|
_RESOLVED_LLAMA_TAG=""
|
|
_RESOLVE_UPSTREAM_STATUS={resolve_status}
|
|
if [ "$_RESOLVE_UPSTREAM_STATUS" -eq 0 ] && [ -n "{resolved_tag}" ]; then
|
|
_RESOLVED_LLAMA_TAG="{resolved_tag}"
|
|
else
|
|
_RESOLVED_LLAMA_TAG="$_REQUESTED_LLAMA_TAG"
|
|
fi
|
|
echo "$_RESOLVED_LLAMA_TAG"
|
|
""")
|
|
|
|
def _run_resolve(
|
|
self, tmp_path: Path, requested_tag: str, resolved_tag: str, resolve_status: int
|
|
) -> str:
|
|
script = self.RESOLVE_TEMPLATE.format(
|
|
requested_tag = requested_tag,
|
|
resolved_tag = resolved_tag,
|
|
resolve_status = resolve_status,
|
|
)
|
|
return run_bash(script)
|
|
|
|
def test_helper_resolution_succeeds(self, tmp_path: Path):
|
|
output = self._run_resolve(
|
|
tmp_path,
|
|
"latest",
|
|
resolved_tag = "b8508",
|
|
resolve_status = 0,
|
|
)
|
|
assert output == "b8508"
|
|
|
|
def test_helper_resolution_falls_back_to_raw_requested_tag(self, tmp_path: Path):
|
|
output = self._run_resolve(
|
|
tmp_path,
|
|
"latest",
|
|
resolved_tag = "",
|
|
resolve_status = 1,
|
|
)
|
|
assert output == "latest"
|
|
|
|
def test_concrete_tag_passes_through_when_helper_fails(self, tmp_path: Path):
|
|
output = self._run_resolve(
|
|
tmp_path,
|
|
"b7777",
|
|
resolved_tag = "",
|
|
resolve_status = 1,
|
|
)
|
|
assert output == "b7777"
|
|
|
|
def test_env_override_unsloth_llama_tag(self):
|
|
output = run_bash(
|
|
'echo "${UNSLOTH_LLAMA_TAG:-latest}"',
|
|
env = {"UNSLOTH_LLAMA_TAG": "b1234"},
|
|
)
|
|
assert output == "b1234"
|
|
|
|
def test_env_unset_defaults_to_latest(self):
|
|
env = os.environ.copy()
|
|
env.pop("UNSLOTH_LLAMA_TAG", None)
|
|
output = run_bash('echo "${UNSLOTH_LLAMA_TAG:-latest}"', env = env)
|
|
assert output == "latest"
|
|
|
|
def test_env_empty_defaults_to_latest(self):
|
|
output = run_bash(
|
|
'echo "${UNSLOTH_LLAMA_TAG:-latest}"',
|
|
env = {"UNSLOTH_LLAMA_TAG": ""},
|
|
)
|
|
assert output == "latest"
|
|
|
|
|
|
class TestSourceCodePatterns:
|
|
"""Verify the source files contain the expected fix patterns."""
|
|
|
|
def test_setup_sh_no_rm_before_prereq_check(self):
|
|
"""rm -rf must appear AFTER cmake/git checks, not before."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
# Anchor on the source-build cmake check block.
|
|
idx_block = content.find("command -v cmake")
|
|
assert idx_block != -1
|
|
block = content[idx_block:]
|
|
idx_cmake = block.find("command -v cmake")
|
|
idx_git = block.find("command -v git")
|
|
idx_rm = block.find("rm -rf")
|
|
assert idx_rm > idx_cmake, "rm -rf should come after cmake check"
|
|
assert idx_rm > idx_git, "rm -rf should come after git check"
|
|
|
|
def test_setup_sh_clone_uses_branch_tag(self):
|
|
"""git clone in source-build should use --branch via the clone args array."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "_CLONE_ARGS=(git clone --depth 1)" in content
|
|
assert (
|
|
'_CLONE_ARGS+=(--branch "$_RESOLVED_SOURCE_REF")' in content
|
|
), "_CLONE_ARGS should be extended with --branch $_RESOLVED_SOURCE_REF"
|
|
# --branch only when tag is not "latest".
|
|
assert (
|
|
'_RESOLVED_SOURCE_REF" != "latest"' in content
|
|
), "Should guard against literal 'latest' tag"
|
|
|
|
def test_setup_sh_source_build_uses_helper_latest_tag_only(self):
|
|
"""Shell source fallback should only use helper latest-tag resolution."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "--resolve-source-build" not in content
|
|
assert "--resolve-install-tag" not in content
|
|
assert '--resolve-llama-tag latest --published-repo "ggml-org/llama.cpp"' in content
|
|
assert "--output-format json" in content
|
|
assert "_RESOLVED_SOURCE_URL" in content
|
|
assert "_RESOLVED_SOURCE_REF_KIND" in content
|
|
assert "_RESOLVED_SOURCE_REF" in content
|
|
|
|
def test_setup_sh_prebuilt_install_entrypoint(self):
|
|
"""Shell prebuilt path uses the helper install entrypoint, not the old releases-latest flow."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "--resolve-install-tag" not in content
|
|
assert "_HELPER_RELEASE_REPO}/releases/latest" not in content
|
|
assert "ggml-org/llama.cpp/releases/latest" not in content
|
|
|
|
def test_setup_sh_routes_every_host_to_fork(self):
|
|
"""CPU-only Linux (the last ggml-org artifact consumer) now routes to the
|
|
fork like every other host, so the release-repo decision is unconditional.
|
|
Guards against a silent reintroduction of a ggml-org CPU routing branch.
|
|
GPU usability detection (used for PyTorch / source decisions) must stay."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert '_HELPER_RELEASE_REPO="unslothai/llama.cpp"' in content
|
|
assert '_HELPER_RELEASE_REPO="ggml-org/llama.cpp"' not in content
|
|
# Usability gating (not routing) still distinguishes a hidden GPU.
|
|
assert '[ "$_setup_nvidia_usable" = true ]' in content
|
|
assert "CUDA_VISIBLE_DEVICES" in content
|
|
# The GPU-tooling probe (PR #4562) stays: ROCm detection goes through
|
|
# command -v, not a bare presence loop that mishandled a hidden nvidia-smi.
|
|
assert "command -v rocminfo" in content
|
|
assert "command -v amd-smi" in content
|
|
|
|
def test_setup_sh_reports_installed_prebuilt_release(self):
|
|
"""Shell wrapper should report the installed prebuilt release from metadata."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "UNSLOTH_PREBUILT_INFO.json" in content
|
|
assert "installed release:" in content
|
|
assert 'print_installed_llama_prebuilt_release "$LLAMA_CPP_DIR"' in content
|
|
|
|
def test_setup_sh_macos_arm64_uses_metal_flags(self):
|
|
"""Apple Silicon source builds should explicitly enable Metal like upstream."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "_IS_MACOS_ARM64=true" in content
|
|
assert 'if [ "$_IS_MACOS_ARM64" = true ]; then' in content
|
|
assert "-DGGML_METAL=ON" in content
|
|
assert "-DGGML_METAL_EMBED_LIBRARY=ON" in content
|
|
assert "-DGGML_METAL_USE_BF16=ON" in content
|
|
assert "-DCMAKE_INSTALL_RPATH=@loader_path" in content
|
|
assert "-DCMAKE_BUILD_WITH_INSTALL_RPATH=ON" in content
|
|
|
|
def test_setup_sh_macos_metal_configure_has_cpu_fallback(self):
|
|
"""GPU configure/build failure retries a CPU build. Stays label-agnostic
|
|
(PR #5826 generalised the Metal-only wording via $_FB_LABEL)."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "_TRY_METAL_CPU_FALLBACK=true" in content
|
|
assert 'configure failed; retrying CPU build..." "$C_WARN"' in content
|
|
assert 'build failed; retrying CPU build..." "$C_WARN"' in content
|
|
assert 'run_quiet_no_exit "cmake llama.cpp (cpu fallback)"' in content
|
|
assert "-DGGML_METAL=OFF" in content
|
|
# Reset to false in both fallback branches: 1 init + 2 resets = >=3.
|
|
assert content.count("_TRY_METAL_CPU_FALLBACK=false") >= 3, (
|
|
"_TRY_METAL_CPU_FALLBACK=false should appear at least 3 times "
|
|
"(init + configure fallback + build fallback)"
|
|
)
|
|
# Fallback helper must exist and Metal must reach it via the shortcut.
|
|
assert "_gpu_fallback_label()" in content
|
|
assert 'echo "Metal"' in content
|
|
|
|
def test_setup_sh_exports_allow_unsupported_compiler(self):
|
|
"""PR #5826: a fresh CUDA toolkit's host-compiler whitelist lags distro gcc/clang
|
|
(nvcc "#error -- unsupported GNU version"). setup.sh exports
|
|
NVCC_PREPEND_FLAGS=-allow-unsupported-compiler via env, not CMAKE_ARGS (word-splitting safety)."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert "-allow-unsupported-compiler" in content
|
|
# Via NVCC_PREPEND_FLAGS (covers the configure-time probe too), not CMAKE_ARGS.
|
|
assert "export NVCC_PREPEND_FLAGS=" in content
|
|
cmake_args_lines = [line for line in content.splitlines() if "CMAKE_ARGS=" in line]
|
|
assert all(
|
|
"-allow-unsupported-compiler" not in line for line in cmake_args_lines
|
|
), "flag must stay out of CMAKE_ARGS (bash word-splitting safety)"
|
|
|
|
def test_setup_ps1_exports_allow_unsupported_compiler(self):
|
|
"""Windows parity for PR #5826: CUDA toolkit whitelist lags MSVC. setup.ps1 sets
|
|
NVCC_PREPEND_FLAGS=-allow-unsupported-compiler in the CUDA branch via env, out of $CmakeArgs."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "-allow-unsupported-compiler" in content
|
|
# Via process env, not $CmakeArgs, so it reaches both the configure probe and `cmake --build`.
|
|
assert "$env:NVCC_PREPEND_FLAGS" in content
|
|
cmake_args_lines = [line for line in content.splitlines() if "$CmakeArgs +=" in line]
|
|
assert all(
|
|
"-allow-unsupported-compiler" not in line for line in cmake_args_lines
|
|
), "flag must not be pushed into the $CmakeArgs array"
|
|
# Must be scoped to the CUDA-on branch, not set for CPU-only builds. The
|
|
# branch also has an early GGML_CUDA=OFF (undetectable-arch CPU fallback,
|
|
# #5854), so anchor on GGML_CUDA=ON and the final (no-GPU) GGML_CUDA=OFF.
|
|
flag_idx = content.index("-allow-unsupported-compiler")
|
|
cuda_guard_idx = content.index("if ($HasNvidiaSmi -and $NvccPath)")
|
|
cuda_on_idx = content.index("'-DGGML_CUDA=ON'")
|
|
cpu_else_idx = content.rindex("'-DGGML_CUDA=OFF'")
|
|
assert cuda_guard_idx < cuda_on_idx < flag_idx < cpu_else_idx, (
|
|
"NVCC_PREPEND_FLAGS must be set inside the CUDA-on branch, after "
|
|
"-DGGML_CUDA=ON and before the final CPU GGML_CUDA=OFF branch"
|
|
)
|
|
|
|
def test_macos_arm64_cpu_fallback_args_exclude_rpath(self):
|
|
"""CPU fallback args must NOT contain Metal-only RPATH flags at runtime."""
|
|
script = '_IS_MACOS_ARM64=true\nNVCC_PATH=""\nGPU_BACKEND=""\n' + _GPU_BACKEND_FRAGMENT
|
|
output = run_bash(script)
|
|
fallback_line = next(
|
|
line for line in output.splitlines() if line.startswith("CPU_FALLBACK_CMAKE_ARGS=")
|
|
)
|
|
assert "-DGGML_METAL=OFF" in fallback_line
|
|
assert (
|
|
"@loader_path" not in fallback_line
|
|
), "CPU fallback args should not contain RPATH flags"
|
|
assert (
|
|
"-DCMAKE_BUILD_WITH_INSTALL_RPATH=ON" not in fallback_line
|
|
), "CPU fallback args should not contain RPATH build flag"
|
|
|
|
def test_setup_sh_does_not_enable_metal_for_intel_macos(self):
|
|
"""Intel macOS should stay on the existing non-Metal path in this patch."""
|
|
content = SETUP_SH.read_text(encoding = "utf-8")
|
|
assert 'if [ "$_IS_MACOS_ARM64" = true ]; then' in content
|
|
assert (
|
|
'Darwin" ] && { [ "$_HOST_MACHINE" = "arm64" ] || [ "$_HOST_MACHINE" = "aarch64" ]; }'
|
|
in content
|
|
)
|
|
assert (
|
|
"x86_64"
|
|
not in content[
|
|
content.find("-DGGML_METAL=ON") - 200 : content.find("-DGGML_METAL=ON") + 200
|
|
]
|
|
)
|
|
|
|
def test_setup_ps1_uses_checkout_b(self):
|
|
"""PS1 should use checkout -B, not checkout --force FETCH_HEAD."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "checkout -B unsloth-llama-build" in content
|
|
assert "checkout --force FETCH_HEAD" not in content
|
|
|
|
def test_setup_ps1_clone_uses_branch_tag(self):
|
|
"""PS1 clone should use --branch with the resolved tag."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "--branch" in content and "$ResolvedSourceRef" in content
|
|
# The old commented-out clone line should be gone.
|
|
assert "# git clone --depth 1 --branch" not in content
|
|
|
|
def test_setup_ps1_no_git_pull(self):
|
|
"""PS1 should use fetch, not pull (which fails in detached HEAD)."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
# No "git pull" in the source-build section (only valid on a branch).
|
|
lines = content.splitlines()
|
|
for i, line in enumerate(lines):
|
|
stripped = line.strip()
|
|
if "git pull" in stripped and not stripped.startswith("#"):
|
|
# Allowed elsewhere; fail only in the llama.cpp build section.
|
|
context = "\n".join(lines[max(0, i - 5) : i + 5])
|
|
if "LlamaCppDir" in context:
|
|
pytest.fail(f"Found 'git pull' in llama.cpp build section at line {i + 1}")
|
|
|
|
def test_setup_ps1_prebuilt_install_entrypoint(self):
|
|
"""PS1 prebuilt path uses the helper install entrypoint, not the old releases-latest flow."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "--resolve-install-tag" not in content
|
|
assert "$HelperReleaseRepo/releases/latest" not in content
|
|
assert "ggml-org/llama.cpp/releases/latest" not in content
|
|
|
|
def test_setup_ps1_reports_installed_prebuilt_release(self):
|
|
"""PS1 wrapper should report the installed prebuilt release from metadata."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "Get-InstalledLlamaPrebuiltRelease" in content
|
|
assert "UNSLOTH_PREBUILT_INFO.json" in content
|
|
assert "installed release:" in content
|
|
assert (
|
|
"$installedRelease = Get-InstalledLlamaPrebuiltRelease -InstallDir $LlamaCppDir"
|
|
in content
|
|
)
|
|
|
|
def test_setup_ps1_source_build_uses_helper_latest_tag_only(self):
|
|
"""PS1 source fallback should only use helper latest-tag resolution."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "--resolve-source-build" not in content
|
|
assert "--resolve-install-tag" not in content
|
|
assert (
|
|
'"--resolve-llama-tag", "latest", "--published-repo", "ggml-org/llama.cpp"' in content
|
|
)
|
|
assert '--output-format", "json"' in content
|
|
assert "$ResolvedSourceUrl" in content
|
|
assert "$ResolvedSourceRefKind" in content
|
|
assert "$ResolvedSourceRef" in content
|
|
|
|
def test_setup_ps1_prebuilt_install_disables_native_error_abort(self):
|
|
"""PS1 prebuilt install should not abort setup on helper stderr."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
install_idx = content.index("& python @prebuiltArgs 2>&1")
|
|
block = content[max(0, install_idx - 800) : install_idx + 800]
|
|
assert "$PSNativeCommandUseErrorActionPreference = $false" in block
|
|
assert "$restoreNativeErrorPreference = $true" in block
|
|
assert "$PSNativeCommandUseErrorActionPreference = $previousNativeErrorPreference" in block
|
|
|
|
def test_setup_ps1_helper_disables_error_action_abort(self):
|
|
"""Helper resolution should suppress terminating NativeCommandError on PS 5.1."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
helper_idx = content.index("function Invoke-LlamaHelper")
|
|
block = content[helper_idx : helper_idx + 2200]
|
|
assert "$previousErrorActionPreference = $ErrorActionPreference" in block
|
|
assert '$ErrorActionPreference = "Continue"' in block
|
|
assert "$ErrorActionPreference = $previousErrorActionPreference" in block
|
|
|
|
def test_setup_ps1_uses_local_tempfile_helper(self):
|
|
"""PS1 should not depend on New-TemporaryFile being available anywhere."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "function New-UnslothTemporaryFile" in content
|
|
assert "$resolveErrorLog = New-TemporaryFile" not in content
|
|
|
|
def test_setup_ps1_find_nvcc_uses_version_sort_for_latest_toolkit(self):
|
|
"""The unconstrained nvcc fallback should not sort toolkit dirs lexicographically."""
|
|
content = SETUP_PS1.read_text(encoding = "utf-8")
|
|
assert "Sort-Object Name | Select-Object -Last 1" not in content
|
|
assert "Sort-Object { [version]($_.Name -replace '^v','') } -Descending" in content
|
|
|
|
def test_binary_env_linux_has_binary_parent(self):
|
|
"""The Linux branch of binary_env should include binary_path.parent."""
|
|
content = MODULE_PATH.read_text(encoding = "utf-8")
|
|
in_func = False
|
|
in_linux = False
|
|
found = False
|
|
for line in content.splitlines():
|
|
if "def binary_env(" in line:
|
|
in_func = True
|
|
elif in_func and line and not line[0].isspace() and "def " in line:
|
|
break
|
|
if in_func and "host.is_linux" in line:
|
|
in_linux = True
|
|
if in_linux and "binary_path.parent" in line:
|
|
found = True
|
|
break
|
|
assert found, "binary_path.parent not found in Linux branch of binary_env"
|
|
|
|
|
|
# Bash fragment mirroring setup.sh's GPU backend decision chain.
|
|
# _IS_MACOS_ARM64, NVCC_PATH, GPU_BACKEND are injected by tests.
|
|
_GPU_BACKEND_FRAGMENT = textwrap.dedent("""\
|
|
CMAKE_ARGS="-DLLAMA_BUILD_TESTS=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
CPU_FALLBACK_CMAKE_ARGS="$CMAKE_ARGS"
|
|
|
|
_BUILD_DESC="building"
|
|
if [ "$_IS_MACOS_ARM64" = true ]; then
|
|
_BUILD_DESC="building (Metal)"
|
|
CMAKE_ARGS="$CMAKE_ARGS -DGGML_METAL=ON -DGGML_METAL_EMBED_LIBRARY=ON -DGGML_METAL_USE_BF16=ON -DCMAKE_INSTALL_RPATH=@loader_path -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON"
|
|
CPU_FALLBACK_CMAKE_ARGS="$CPU_FALLBACK_CMAKE_ARGS -DGGML_METAL=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=true
|
|
elif [ -n "$NVCC_PATH" ]; then
|
|
CMAKE_ARGS="$CMAKE_ARGS -DGGML_CUDA=ON"
|
|
_BUILD_DESC="building (CUDA)"
|
|
elif [ "$GPU_BACKEND" = "rocm" ]; then
|
|
CMAKE_ARGS="$CMAKE_ARGS -DGGML_HIP=ON"
|
|
_BUILD_DESC="building (ROCm)"
|
|
else
|
|
_BUILD_DESC="building (CPU)"
|
|
fi
|
|
|
|
echo "CMAKE_ARGS=$CMAKE_ARGS"
|
|
echo "CPU_FALLBACK_CMAKE_ARGS=$CPU_FALLBACK_CMAKE_ARGS"
|
|
echo "BUILD_DESC=$_BUILD_DESC"
|
|
echo "TRY_METAL_CPU_FALLBACK=$_TRY_METAL_CPU_FALLBACK"
|
|
""")
|
|
|
|
|
|
class TestMacOSMetalBuildLogic:
|
|
"""Behavioral bash tests for the Metal GPU backend logic."""
|
|
|
|
def test_macos_arm64_cmake_args_contain_metal_flags(self):
|
|
"""macOS arm64 should enable Metal, not CUDA."""
|
|
script = '_IS_MACOS_ARM64=true\nNVCC_PATH=""\nGPU_BACKEND=""\n' + _GPU_BACKEND_FRAGMENT
|
|
output = run_bash(script)
|
|
assert "-DGGML_METAL=ON" in output
|
|
assert "-DGGML_CUDA=ON" not in output
|
|
assert "BUILD_DESC=building (Metal)" in output
|
|
|
|
def test_intel_macos_no_metal_flags(self):
|
|
"""Intel macOS (not arm64) should not get Metal flags."""
|
|
script = '_IS_MACOS_ARM64=false\nNVCC_PATH=""\nGPU_BACKEND=""\n' + _GPU_BACKEND_FRAGMENT
|
|
output = run_bash(script)
|
|
assert "-DGGML_METAL=ON" not in output
|
|
assert "BUILD_DESC=building (CPU)" in output
|
|
|
|
def test_macos_arm64_metal_precedes_nvcc(self):
|
|
"""Even with nvcc in PATH, macOS arm64 should use Metal, not CUDA."""
|
|
script = (
|
|
'_IS_MACOS_ARM64=true\nNVCC_PATH="/usr/local/cuda/bin/nvcc"\n'
|
|
'GPU_BACKEND="cuda"\n' + _GPU_BACKEND_FRAGMENT
|
|
)
|
|
output = run_bash(script)
|
|
assert "-DGGML_METAL=ON" in output
|
|
assert "-DGGML_CUDA=ON" not in output
|
|
assert "BUILD_DESC=building (Metal)" in output
|
|
|
|
def test_metal_cpu_fallback_triggers_on_cmake_failure(self, tmp_path: Path):
|
|
"""When cmake fails on Metal, the fallback should retry with -DGGML_METAL=OFF."""
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
calls_file = tmp_path / "cmake_calls.log"
|
|
# cmake logs args; fails first call (Metal), succeeds second (CPU fallback).
|
|
cmake_script = mock_bin / "cmake"
|
|
cmake_script.write_text(
|
|
textwrap.dedent(f"""\
|
|
#!/bin/bash
|
|
echo "$*" >> "{calls_file}"
|
|
COUNTER_FILE="{tmp_path}/cmake_counter"
|
|
if [ ! -f "$COUNTER_FILE" ]; then
|
|
echo 1 > "$COUNTER_FILE"
|
|
exit 1
|
|
fi
|
|
exit 0
|
|
""")
|
|
)
|
|
cmake_script.chmod(0o755)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
_IS_MACOS_ARM64=true
|
|
NVCC_PATH=""
|
|
GPU_BACKEND=""
|
|
CMAKE_ARGS="-DLLAMA_BUILD_TESTS=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
CPU_FALLBACK_CMAKE_ARGS="$CMAKE_ARGS"
|
|
|
|
_BUILD_DESC="building"
|
|
if [ "$_IS_MACOS_ARM64" = true ]; then
|
|
_BUILD_DESC="building (Metal)"
|
|
CMAKE_ARGS="$CMAKE_ARGS -DGGML_METAL=ON -DGGML_METAL_EMBED_LIBRARY=ON -DGGML_METAL_USE_BF16=ON -DCMAKE_INSTALL_RPATH=@loader_path -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON"
|
|
CPU_FALLBACK_CMAKE_ARGS="$CPU_FALLBACK_CMAKE_ARGS -DGGML_METAL=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=true
|
|
fi
|
|
|
|
BUILD_OK=true
|
|
_BUILD_TMP="{tmp_path}/build_tmp"
|
|
mkdir -p "$_BUILD_TMP"
|
|
if ! cmake -S "$_BUILD_TMP" -B "$_BUILD_TMP/build" $CMAKE_ARGS; then
|
|
if [ "$_TRY_METAL_CPU_FALLBACK" = true ]; then
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
echo "FALLBACK_TRIGGERED"
|
|
rm -rf "$_BUILD_TMP/build"
|
|
cmake -S "$_BUILD_TMP" -B "$_BUILD_TMP/build" $CPU_FALLBACK_CMAKE_ARGS || BUILD_OK=false
|
|
if [ "$BUILD_OK" = true ]; then
|
|
_BUILD_DESC="building (CPU fallback)"
|
|
fi
|
|
else
|
|
BUILD_OK=false
|
|
fi
|
|
fi
|
|
|
|
echo "BUILD_OK=$BUILD_OK"
|
|
echo "BUILD_DESC=$_BUILD_DESC"
|
|
echo "TRY_METAL_CPU_FALLBACK=$_TRY_METAL_CPU_FALLBACK"
|
|
""")
|
|
output = run_bash(script)
|
|
assert "FALLBACK_TRIGGERED" in output
|
|
assert "BUILD_OK=true" in output
|
|
assert "BUILD_DESC=building (CPU fallback)" in output
|
|
assert (
|
|
"TRY_METAL_CPU_FALLBACK=false" in output
|
|
), "Fallback flag should be reset to false after configure fallback"
|
|
|
|
# First cmake call has Metal ON, second has Metal OFF.
|
|
calls = calls_file.read_text().splitlines()
|
|
assert len(calls) >= 2, f"Expected >= 2 cmake calls, got {len(calls)}"
|
|
assert "-DGGML_METAL=ON" in calls[0], f"First cmake call should have Metal ON: {calls[0]}"
|
|
assert (
|
|
"-DGGML_METAL=OFF" in calls[1]
|
|
), f"Second cmake call should have Metal OFF: {calls[1]}"
|
|
assert (
|
|
"-DGGML_METAL=ON" not in calls[1]
|
|
), f"Second cmake call should NOT have Metal ON: {calls[1]}"
|
|
assert "@loader_path" not in calls[1], f"CPU fallback should not have RPATH: {calls[1]}"
|
|
assert (
|
|
"-DCMAKE_BUILD_WITH_INSTALL_RPATH=ON" not in calls[1]
|
|
), f"CPU fallback should not have RPATH build flag: {calls[1]}"
|
|
|
|
def test_metal_build_failure_retries_cpu_fallback(self, tmp_path: Path):
|
|
"""When cmake --build fails on Metal, the fallback should re-configure and rebuild with CPU."""
|
|
mock_bin = tmp_path / "mock_bin"
|
|
mock_bin.mkdir()
|
|
calls_file = tmp_path / "cmake_calls.log"
|
|
# cmake mock: configure always succeeds; first --build fails, rest succeed.
|
|
cmake_script = mock_bin / "cmake"
|
|
cmake_script.write_text(
|
|
textwrap.dedent(f"""\
|
|
#!/bin/bash
|
|
echo "$*" >> "{calls_file}"
|
|
if [ "$1" = "--build" ]; then
|
|
BUILD_COUNTER_FILE="{tmp_path}/build_counter"
|
|
if [ ! -f "$BUILD_COUNTER_FILE" ]; then
|
|
echo 1 > "$BUILD_COUNTER_FILE"
|
|
exit 1
|
|
fi
|
|
fi
|
|
exit 0
|
|
""")
|
|
)
|
|
cmake_script.chmod(0o755)
|
|
|
|
script = textwrap.dedent(f"""\
|
|
export PATH="{mock_bin}:$PATH"
|
|
_IS_MACOS_ARM64=true
|
|
NVCC_PATH=""
|
|
GPU_BACKEND=""
|
|
CMAKE_ARGS="-DLLAMA_BUILD_TESTS=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
CPU_FALLBACK_CMAKE_ARGS="$CMAKE_ARGS"
|
|
CMAKE_GENERATOR_ARGS=""
|
|
NCPU=2
|
|
|
|
_BUILD_DESC="building"
|
|
if [ "$_IS_MACOS_ARM64" = true ]; then
|
|
_BUILD_DESC="building (Metal)"
|
|
CMAKE_ARGS="$CMAKE_ARGS -DGGML_METAL=ON -DGGML_METAL_EMBED_LIBRARY=ON -DGGML_METAL_USE_BF16=ON -DCMAKE_INSTALL_RPATH=@loader_path -DCMAKE_BUILD_WITH_INSTALL_RPATH=ON"
|
|
CPU_FALLBACK_CMAKE_ARGS="$CPU_FALLBACK_CMAKE_ARGS -DGGML_METAL=OFF"
|
|
_TRY_METAL_CPU_FALLBACK=true
|
|
fi
|
|
|
|
BUILD_OK=true
|
|
_BUILD_TMP="{tmp_path}/build_tmp"
|
|
mkdir -p "$_BUILD_TMP"
|
|
|
|
# Configure (succeeds)
|
|
if ! cmake $CMAKE_GENERATOR_ARGS -S "$_BUILD_TMP" -B "$_BUILD_TMP/build" $CMAKE_ARGS; then
|
|
if [ "$_TRY_METAL_CPU_FALLBACK" = true ]; then
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
echo "CONFIGURE_FALLBACK"
|
|
rm -rf "$_BUILD_TMP/build"
|
|
cmake $CMAKE_GENERATOR_ARGS -S "$_BUILD_TMP" -B "$_BUILD_TMP/build" $CPU_FALLBACK_CMAKE_ARGS || BUILD_OK=false
|
|
if [ "$BUILD_OK" = true ]; then
|
|
_BUILD_DESC="building (CPU fallback)"
|
|
fi
|
|
else
|
|
BUILD_OK=false
|
|
fi
|
|
fi
|
|
|
|
# Build (first --build fails, triggers fallback)
|
|
if [ "$BUILD_OK" = true ]; then
|
|
if ! cmake --build "$_BUILD_TMP/build" --config Release --target llama-server -j"$NCPU"; then
|
|
if [ "$_TRY_METAL_CPU_FALLBACK" = true ]; then
|
|
_TRY_METAL_CPU_FALLBACK=false
|
|
echo "BUILD_FALLBACK_TRIGGERED"
|
|
rm -rf "$_BUILD_TMP/build"
|
|
if cmake $CMAKE_GENERATOR_ARGS -S "$_BUILD_TMP" -B "$_BUILD_TMP/build" $CPU_FALLBACK_CMAKE_ARGS; then
|
|
_BUILD_DESC="building (CPU fallback)"
|
|
cmake --build "$_BUILD_TMP/build" --config Release --target llama-server -j"$NCPU" || BUILD_OK=false
|
|
else
|
|
BUILD_OK=false
|
|
fi
|
|
else
|
|
BUILD_OK=false
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
echo "BUILD_OK=$BUILD_OK"
|
|
echo "BUILD_DESC=$_BUILD_DESC"
|
|
echo "TRY_METAL_CPU_FALLBACK=$_TRY_METAL_CPU_FALLBACK"
|
|
""")
|
|
output = run_bash(script)
|
|
assert "CONFIGURE_FALLBACK" not in output, "Configure should have succeeded"
|
|
assert "BUILD_FALLBACK_TRIGGERED" in output
|
|
assert "BUILD_OK=true" in output
|
|
assert "BUILD_DESC=building (CPU fallback)" in output
|
|
assert (
|
|
"TRY_METAL_CPU_FALLBACK=false" in output
|
|
), "Fallback flag should be reset to false after build fallback"
|
|
|
|
# configure (Metal ON), build (fails), re-configure (Metal OFF), rebuild.
|
|
calls = calls_file.read_text().splitlines()
|
|
assert len(calls) >= 4, f"Expected >= 4 cmake calls, got {len(calls)}: {calls}"
|
|
assert "-DGGML_METAL=ON" in calls[0]
|
|
assert "--build" in calls[1]
|
|
assert "-DGGML_METAL=OFF" in calls[2]
|
|
assert "-DGGML_METAL=ON" not in calls[2]
|
|
assert "@loader_path" not in calls[2], f"CPU fallback should not have RPATH: {calls[2]}"
|
|
assert (
|
|
"-DCMAKE_BUILD_WITH_INSTALL_RPATH=ON" not in calls[2]
|
|
), f"CPU fallback should not have RPATH build flag: {calls[2]}"
|
|
assert (
|
|
"-DLLAMA_BUILD_TESTS=OFF" in calls[2]
|
|
), f"CPU fallback should preserve baseline flags: {calls[2]}"
|
|
assert "--build" in calls[3]
|