[Studio] Add --with-llama-cpp-dir installer flag to reuse a local llama.cpp #6472
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| #!/bin/bash | ||
| # Static analysis: the --with-llama-cpp-dir flag must be wired consistently | ||
| # across both installers (install.sh / install.ps1) and both setup scripts | ||
| # (studio/setup.sh / studio/setup.ps1). | ||
| # | ||
| # The flag lets a user point the installer at a local llama.cpp directory so it | ||
| # skips BOTH the prebuilt download (Phase 3) and the source build (Phase 4), | ||
| # linking the local dir into the canonical install location instead. The path | ||
| # crosses the installer->setup boundary via the UNSLOTH_LOCAL_LLAMA_CPP_DIR env | ||
| # var. These checks pin that contract so a future refactor of either side can't | ||
| # silently break it (e.g. installer parses the flag but setup never reads the | ||
| # env var, or setup links the dir but still runs the build). | ||
| # | ||
| # This is a shape/wiring test, not a behavioral one: it greps the committed | ||
| # scripts. It needs no Python, no GPU, no network. | ||
| set -e | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" | ||
| INSTALL_SH="$SCRIPT_DIR/../../install.sh" | ||
| INSTALL_PS1="$SCRIPT_DIR/../../install.ps1" | ||
| SETUP_SH="$SCRIPT_DIR/../../studio/setup.sh" | ||
| SETUP_PS1="$SCRIPT_DIR/../../studio/setup.ps1" | ||
| ENV_VAR="UNSLOTH_LOCAL_LLAMA_CPP_DIR" | ||
| PASS=0 | ||
| FAIL=0 | ||
|
|
||
| assert_contains() { | ||
| _label="$1"; _file="$2"; _needle="$3" | ||
| if grep -qF -- "$_needle" "$_file"; then | ||
| echo " PASS: $_label" | ||
| PASS=$((PASS + 1)) | ||
| else | ||
| echo " FAIL: $_label (expected to find '$_needle' in $(basename "$_file"))" | ||
| FAIL=$((FAIL + 1)) | ||
| fi | ||
| } | ||
|
|
||
| # Count of distinct lines matching a regex, used to assert a guard appears | ||
| # in more than one place (e.g. env var forwarded on both setup invocations). | ||
| assert_min_count() { | ||
| _label="$1"; _file="$2"; _pattern="$3"; _min="$4" | ||
| _n=$(grep -cE -- "$_pattern" "$_file" || true) | ||
| if [ "$_n" -ge "$_min" ]; then | ||
| echo " PASS: $_label (found $_n, need >= $_min)" | ||
| PASS=$((PASS + 1)) | ||
| else | ||
| echo " FAIL: $_label (found $_n in $(basename "$_file"), need >= $_min)" | ||
| FAIL=$((FAIL + 1)) | ||
| fi | ||
| } | ||
|
|
||
| echo "" | ||
| echo "=== install.sh: parses --with-llama-cpp-dir and forwards the env var ===" | ||
|
|
||
| assert_contains \ | ||
| "install.sh: accepts --with-llama-cpp-dir flag" \ | ||
| "$INSTALL_SH" "--with-llama-cpp-dir" | ||
| assert_contains \ | ||
| "install.sh: validates the path exists before forwarding" \ | ||
| "$INSTALL_SH" 'if [ ! -d "$_WITH_LLAMA_CPP_DIR" ]; then' | ||
| # The path must be forwarded to setup.sh on BOTH the local and the | ||
| # non-local setup invocations, else --local users (the documented path) | ||
| # would silently lose the flag. | ||
| assert_min_count \ | ||
| "install.sh: forwards $ENV_VAR on both setup invocations" \ | ||
| "$INSTALL_SH" "$ENV_VAR=\"\\\$_WITH_LLAMA_CPP_DIR\"" 2 | ||
|
|
||
| echo "" | ||
| echo "=== install.ps1: parses --with-llama-cpp-dir and forwards the env var ===" | ||
|
|
||
| assert_contains \ | ||
| "install.ps1: accepts --with-llama-cpp-dir flag" \ | ||
| "$INSTALL_PS1" '"--with-llama-cpp-dir"' | ||
| assert_contains \ | ||
| "install.ps1: errors when flag is given with no path argument" \ | ||
| "$INSTALL_PS1" "--with-llama-cpp-dir requires a path argument" | ||
| assert_contains \ | ||
| "install.ps1: validates the path exists before forwarding" \ | ||
| "$INSTALL_PS1" "--with-llama-cpp-dir path does not exist" | ||
| assert_contains \ | ||
| "install.ps1: exports $ENV_VAR for setup.ps1" \ | ||
| "$INSTALL_PS1" "\$env:$ENV_VAR =" | ||
| # The exported env var must be cleaned up so a later setup invocation in the | ||
| # same shell session doesn't inherit a stale local-dir link. | ||
| assert_contains \ | ||
| "install.ps1: clears $ENV_VAR after the setup run" \ | ||
| "$INSTALL_PS1" "Remove-Item Env:$ENV_VAR" | ||
|
|
||
| echo "" | ||
| echo "=== studio/setup.sh: reads the env var, links, and skips download+build ===" | ||
|
|
||
| assert_contains \ | ||
| "setup.sh: reads $ENV_VAR" \ | ||
| "$SETUP_SH" "$ENV_VAR" | ||
| assert_contains \ | ||
| "setup.sh: symlinks the local dir into the canonical install location" \ | ||
| "$SETUP_SH" 'ln -sfn "$_RESOLVED_LOCAL" "$LLAMA_CPP_DIR"' | ||
| assert_contains \ | ||
| "setup.sh: disables the source build when the local dir is linked" \ | ||
| "$SETUP_SH" "_NEED_LLAMA_SOURCE_BUILD=false" | ||
| assert_contains \ | ||
| "setup.sh: skips the prebuilt download when the local dir is linked" \ | ||
| "$SETUP_SH" "_SKIP_PREBUILT_INSTALL=true" | ||
| # The link branch must short-circuit the FORCE_COMPILE / prebuilt chain rather | ||
| # than fall through into it. | ||
| assert_contains \ | ||
| "setup.sh: link branch gates the prebuilt/compile chain" \ | ||
| "$SETUP_SH" 'if [ "$_LOCAL_LLAMA_CPP_LINKED" = true ]; then' | ||
|
|
||
| echo "" | ||
| echo "=== studio/setup.ps1: reads the env var, junctions, and skips download+build ===" | ||
|
|
||
| assert_contains \ | ||
| "setup.ps1: reads $ENV_VAR" \ | ||
| "$SETUP_PS1" "\$env:$ENV_VAR" | ||
| assert_contains \ | ||
| "setup.ps1: creates a directory junction into the canonical location" \ | ||
| "$SETUP_PS1" "mklink /J" | ||
| assert_contains \ | ||
| "setup.ps1: falls back to a copy when the junction can't be created" \ | ||
| "$SETUP_PS1" "Copy-Item -Recurse -Path \$ResolvedLocal -Destination \$LlamaCppDir" | ||
|
Imagineer99 marked this conversation as resolved.
Outdated
|
||
| assert_contains \ | ||
| "setup.ps1: disables the source build when the local dir is linked" \ | ||
| "$SETUP_PS1" '$NeedLlamaSourceBuild = $false' | ||
| # The link branch must gate the prebuilt-install chain (the elseif on | ||
| # FORCE_COMPILE), and the 'prebuilt (validated)' banner must be suppressed | ||
| # when we linked a local dir instead of validating a real prebuilt. | ||
| assert_contains \ | ||
| "setup.ps1: link branch gates the prebuilt/compile chain" \ | ||
| "$SETUP_PS1" 'if ($LocalLlamaCppLinked) {' | ||
| assert_contains \ | ||
| "setup.ps1: 'prebuilt (validated)' banner excludes the linked-dir case" \ | ||
| "$SETUP_PS1" '-not $NeedLlamaSourceBuild -and -not $LocalLlamaCppLinked' | ||
|
|
||
| echo "" | ||
| echo "=== both setup scripts: a local dir pointing at the canonical path is a no-op ===" | ||
|
|
||
| # Guard against the self-link footgun: if the user passes the canonical install | ||
| # dir itself, neither script should delete-then-link it onto itself. | ||
| assert_contains \ | ||
| "setup.sh: ignores a local dir equal to the canonical install location" \ | ||
| "$SETUP_SH" 'if [ "$_RESOLVED_LOCAL" = "$LLAMA_CPP_DIR" ]; then' | ||
| assert_contains \ | ||
| "setup.ps1: ignores a local dir equal to the canonical install location" \ | ||
| "$SETUP_PS1" 'if ($ResolvedLocal -eq $LlamaCppDir) {' | ||
|
|
||
| echo "" | ||
| echo "=== Results ===" | ||
| echo " PASS: $PASS" | ||
| echo " FAIL: $FAIL" | ||
| if [ "$FAIL" -gt 0 ]; then | ||
| echo "FAILED" | ||
| exit 1 | ||
| fi | ||
| echo "ALL PASSED" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When
--with-llama-cpp-diris mistyped in a PowerShell session that already hasUNSLOTH_STUDIO_HOMEor the installer state env vars set, this validation returns after the code above has removed/overwritten those env vars but before thetry/finallythat restores them starts. That leaves the caller's session pointed back at the default Studio home (or with staleSTUDIO_LOCAL_INSTALL/skip flags), so a subsequent setup in the same shell can install into the wrong root; move this validation before mutating env vars or include it inside the restorefinally.Useful? React with 👍 / 👎.