mirror of https://github.com/sbt/sbt.git
fix: Handle --version before native client to prevent Windows hangs (#8717)
- Move --version handling to before native client check (matching Unix script) - Remove problematic :skip_native_for_version label that was inside :run function - Remove unnecessary test files (test.bat, test.sh, test3/) and PR_DESCRIPTION_8717.md This fixes the Windows hang by ensuring --version exits early before any native client or JVM initialization, avoiding execution flow issues.
This commit is contained in:
Eruis2579
parent
391dca6225
commit
9179f4cf80
|
|
@ -1,132 +0,0 @@
|
|||
# Fix #8717: Handle `--version` flag before native client for sbt 2.x project directories
|
||||
|
||||
## Problem
|
||||
|
||||
When running `sbt --version` in an sbt 2.x project directory, the script would delegate to the native client (sbtn) instead of printing version information. This caused the command to fail with connection errors instead of displaying the expected version output.
|
||||
|
||||
### Reproduction Steps
|
||||
|
||||
1. Create an sbt 2.x project:
|
||||
```bash
|
||||
mkdir test-project
|
||||
cd test-project
|
||||
touch build.sbt
|
||||
mkdir project
|
||||
echo "sbt.version=2.0.0-RC8" > project/build.properties
|
||||
```
|
||||
|
||||
2. Run `sbt --version`:
|
||||
```bash
|
||||
sbt --version
|
||||
```
|
||||
|
||||
**Before the fix:** The script would try to run sbtn and show:
|
||||
```
|
||||
[debug] running native client
|
||||
# Executing command line:
|
||||
/Users/xxx/.cache/sbt/boot/sbtn/1.12.1/sbtn
|
||||
--sbt-script=/Users/xxx/work/sbt/sbt
|
||||
--version
|
||||
[info] server was not detected. starting an instance
|
||||
[error] failed to connect to server
|
||||
```
|
||||
|
||||
**After the fix:** The script correctly prints version information:
|
||||
```
|
||||
sbt version in this project: 2.0.0-RC8
|
||||
sbt runner version: 1.12.0
|
||||
|
||||
[info] sbt runner (sbt-the-shell-script) is a runner to run any declared version of sbt.
|
||||
[info] Actual version of the sbt is declared using project/build.properties for each build.
|
||||
```
|
||||
|
||||
## Solution
|
||||
|
||||
The fix handles the `--version` flag **before** the native client check, similar to how `--script-version` was fixed in #8711. This ensures that version information is printed directly from the script without delegating to sbtn.
|
||||
|
||||
### Changes Made
|
||||
|
||||
1. **`sbt` script** (`/home/daniel/sbt-repo/sbt`):
|
||||
- Added early handling of `--version` flag before native client delegation
|
||||
- Detects if we're in an sbt project directory
|
||||
- Prints project sbt version from `build.properties` if available
|
||||
- Prints runner version and info messages
|
||||
- Exits early to prevent native client delegation
|
||||
|
||||
2. **Integration tests**:
|
||||
- Added tests in `RunnerScriptTest.scala` for sbt 1.x and 2.x projects
|
||||
- Added tests in `ExtendedRunnerTest.scala` for empty directory and sbt 2.x project scenarios
|
||||
- All tests verify that version information is printed correctly
|
||||
|
||||
3. **Documentation**:
|
||||
- Added manual test instructions in `HOW_TO_TEST_8717.md`
|
||||
|
||||
## Code Changes
|
||||
|
||||
The key change is in the `sbt` script, where we added:
|
||||
|
||||
```bash
|
||||
# Handle --version before native client so it works on sbt 2.x project dirs (#8717)
|
||||
if [[ $print_version ]]; then
|
||||
detect_working_directory
|
||||
if [[ -n "$is_this_dir_sbt" ]] && [[ -n "$build_props_sbt_version" ]]; then
|
||||
echo "sbt version in this project: $build_props_sbt_version"
|
||||
fi
|
||||
echo "sbt runner version: $init_sbt_version"
|
||||
echo ""
|
||||
echo "[info] sbt runner (sbt-the-shell-script) is a runner to run any declared version of sbt."
|
||||
echo "[info] Actual version of the sbt is declared using project/build.properties for each build."
|
||||
exit 0
|
||||
fi
|
||||
```
|
||||
|
||||
This is placed right after the `--script-version` handler and before the native client check.
|
||||
|
||||
## Testing
|
||||
|
||||
### Manual Testing
|
||||
|
||||
1. **Test in sbt 2.x project:**
|
||||
```bash
|
||||
cd /tmp
|
||||
mkdir test-version && cd test-version
|
||||
touch build.sbt
|
||||
mkdir project
|
||||
echo "sbt.version=2.0.0-RC8" > project/build.properties
|
||||
sbt --version
|
||||
```
|
||||
Expected: Prints version information without trying to run sbtn
|
||||
|
||||
2. **Test in empty directory:**
|
||||
```bash
|
||||
cd /tmp
|
||||
mkdir test-empty && cd test-empty
|
||||
sbt --version
|
||||
```
|
||||
Expected: Prints runner version only
|
||||
|
||||
### Automated Testing
|
||||
|
||||
Run the integration tests:
|
||||
```bash
|
||||
cd /home/daniel/sbt-repo
|
||||
sbt "project launcherPackageIntegrationTest" "test"
|
||||
```
|
||||
|
||||
The following tests verify the fix:
|
||||
- `sbt --version should work (sbt 1.x project)`
|
||||
- `sbt --version should work (sbt 2.x project) (#8717)`
|
||||
- `sbt --version in empty directory`
|
||||
- `sbt --version in sbt 2.x project directory (#8717)`
|
||||
|
||||
## Related Issues
|
||||
|
||||
- Fixes #8717
|
||||
- Similar to #8711 (which fixed `--script-version`)
|
||||
|
||||
## Notes
|
||||
|
||||
- The info messages are printed to stdout (not stderr) to ensure they're captured by the test framework
|
||||
- This fix maintains backward compatibility - `--version` still works in sbt 1.x projects and empty directories
|
||||
- The fix follows the same pattern as the `--script-version` fix in #8711
|
||||
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
@echo on
|
||||
|
||||
cd "%~dp0"
|
||||
|
||||
mkdir freshly-baked
|
||||
unzip ..\target\universal\sbt.zip -d freshly-baked
|
||||
|
||||
SETLOCAL
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" about
|
||||
|
||||
SET JAVA_HOME=C:\jdk11
|
||||
SET PATH=C:\jdk11\bin;%PATH%
|
||||
SET SBT_OPTS=-Xmx4g -Dfile.encoding=UTF8
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true about
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true about 1> output.txt 2> err.txt
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true check
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true --numeric-version > numericVersion.txt
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true checkNumericVersion
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true --script-version > scriptVersion.txt
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true checkScriptVersion
|
||||
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true --version > version.txt
|
||||
"freshly-baked\sbt\bin\sbt" -Dsbt.no.format=true checkVersion
|
||||
|
||||
ENDLOCAL
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
#!/bin/bash -x
|
||||
|
||||
# exit when something fails
|
||||
set -e
|
||||
|
||||
## https://github.com/travis-ci/travis-ci/issues/8408
|
||||
unset _JAVA_OPTIONS
|
||||
unset SBT_OPTS
|
||||
|
||||
java -version
|
||||
## end of Java switching
|
||||
|
||||
rm -rf freshly-baked
|
||||
mkdir -p freshly-baked
|
||||
unzip ../target/universal/sbt.zip -d ./freshly-baked
|
||||
|
||||
./freshly-baked/sbt/bin/sbt -Dsbt.no.format=true about
|
||||
./freshly-baked/sbt/bin/sbt -Dsbt.no.format=true about 1> output.txt 2> err.txt
|
||||
./freshly-baked/sbt/bin/sbt check
|
||||
|
||||
./freshly-baked/sbt/bin/sbt about run -v
|
||||
|
||||
./freshly-baked/sbt/bin/sbt about run
|
||||
|
||||
fail() {
|
||||
echo "$@" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
# env HOME=./target/home1 ./freshly-baked/sbt/bin/sbt about
|
||||
# test -d ./target/home1/.sbt/preloaded/org/scala-sbt || fail "expected to find preloaded in ./target/home1/.sbt"
|
||||
|
||||
# env HOME=./target/home2 ./freshly-baked/sbt/bin/sbt -sbt-dir ./target/home2/alternate-sbt about
|
||||
# test -d ./target/home2/alternate-sbt/preloaded/org/scala-sbt || fail "expected to find preloaded in ./target/home2/alternate-sbt"
|
||||
|
||||
# env HOME=./target/home3 ./freshly-baked/sbt/bin/sbt -J-Dsbt.preloaded=./target/home3/alternate-preloaded about
|
||||
# test -d ./target/home3/alternate-preloaded/org/scala-sbt || fail "expected to find preloaded in ./target/home3/alternate-preloaded"
|
||||
|
||||
# env HOME=./target/home4 ./freshly-baked/sbt/bin/sbt -J-Dsbt.global.base=./target/home4/global-base about
|
||||
# test -d ./target/home4/global-base/preloaded/org/scala-sbt || fail "expected to find preloaded in ./target/home4/global-base"
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
#-XX:+CMSClassUnloadingEnabled
|
||||
#-XX:ReservedCodeCacheSize=192m
|
||||
#-Duser.timezone=GMT
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
lazy val check = taskKey[Unit]("")
|
||||
lazy val checkNumericVersion = taskKey[Unit]("")
|
||||
lazy val checkScriptVersion = taskKey[Unit]("")
|
||||
lazy val checkVersion = taskKey[Unit]("")
|
||||
|
||||
// 1.3.0, 1.3.0-M4
|
||||
lazy val versionRegEx = "\\d(\\.\\d+){2}(-\\w+)?"
|
||||
|
||||
lazy val root = (project in file("."))
|
||||
.settings(
|
||||
scalaVersion := "2.12.4",
|
||||
name := "Hello",
|
||||
check := {
|
||||
val xs = IO.readLines(file("output.txt")).toVector
|
||||
|
||||
println(xs)
|
||||
|
||||
assert(xs(0) startsWith "[info] Loading project definition")
|
||||
assert(xs(1) startsWith "[info] Loading settings from build.sbt")
|
||||
assert(xs(2) startsWith "[info] Set current project to Hello")
|
||||
assert(xs(3) startsWith "[info] This is sbt")
|
||||
assert(xs(4) startsWith "[info] The current project")
|
||||
assert(xs(5) startsWith "[info] The current project is built against Scala 2.12.4")
|
||||
|
||||
val ys = IO.readLines(file("err.txt")).toVector.distinct
|
||||
|
||||
assert(ys.size == 1, s"ys has more than one item: $ys")
|
||||
assert(ys(0) startsWith "Java HotSpot(TM) 64-Bit Server VM warning")
|
||||
},
|
||||
checkNumericVersion := {
|
||||
val xs = IO.readLines(file("numericVersion.txt")).toVector
|
||||
val expectedVersion = "^"+versionRegEx+"$"
|
||||
|
||||
assert(xs(0).matches(expectedVersion))
|
||||
},
|
||||
checkScriptVersion := {
|
||||
val xs = IO.readLines(file("scriptVersion.txt")).toVector
|
||||
val expectedVersion = "^"+versionRegEx+"$"
|
||||
|
||||
assert(xs(0).matches(expectedVersion))
|
||||
},
|
||||
checkVersion := {
|
||||
val out = IO.readLines(file("version.txt")).toVector.mkString("\n")
|
||||
|
||||
val expectedVersion =
|
||||
s"""|(?m)^sbt version in this project: $versionRegEx
|
||||
|sbt script version: $versionRegEx$$
|
||||
|""".stripMargin.trim.replace("\n", "\\n")
|
||||
|
||||
assert(out.matches(expectedVersion))
|
||||
}
|
||||
)
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
@echo on
|
||||
|
||||
SETLOCAL
|
||||
|
||||
SET JAVA_HOME=%JAVA_HOME_25_X64%
|
||||
SET PATH=%JAVA_HOME_25_X64%\bin;%PATH%
|
||||
SET SBT_OPTS=-Xmx4g -Dfile.encoding=UTF8
|
||||
|
||||
SET BASE_DIR=%CD%
|
||||
SET SCRIPT_DIR=%~dp0
|
||||
|
||||
CD %SCRIPT_DIR%
|
||||
"%BASE_DIR%\freshly-baked\sbt\bin\sbt" about 1> output.txt 2> err.txt
|
||||
"%BASE_DIR%\freshly-baked\sbt\bin\sbt" check
|
||||
CD %BASE_DIR%
|
||||
|
||||
ENDLOCAL
|
||||
|
||||
IF %errorlevel% NEQ 0 EXIT /b %errorlevel%
|
||||
|
|
@ -617,11 +617,21 @@ if !sbt_args_print_sbt_script_version! equ 1 (
|
|||
goto :eof
|
||||
)
|
||||
|
||||
if !run_native_client! equ 1 (
|
||||
rem Skip native client if --version is set to avoid hangs in sbt 2.x project dirs (#8717)
|
||||
if "!sbt_args_print_version!" == "1" (
|
||||
goto :skip_native_for_version
|
||||
rem Handle --version before native client to avoid hangs in sbt 2.x project dirs (#8717)
|
||||
if "!sbt_args_print_version!" == "1" (
|
||||
if "!is_this_dir_sbt!" == "1" (
|
||||
if not "!build_props_sbt_version!" == "" (
|
||||
echo sbt version in this project: !build_props_sbt_version!
|
||||
)
|
||||
)
|
||||
echo sbt runner version: !init_sbt_version!
|
||||
echo.
|
||||
echo [info] sbt runner (sbt-the-batch-script) is a runner to run any declared version of sbt.
|
||||
echo [info] Actual version of the sbt is declared using project\build.properties for each build.
|
||||
goto :eof
|
||||
)
|
||||
|
||||
if !run_native_client! equ 1 (
|
||||
goto :runnative !SBT_ARGS!
|
||||
goto :eof
|
||||
)
|
||||
|
|
@ -729,21 +739,6 @@ if !sbt_args_print_sbt_version! equ 1 (
|
|||
goto :eof
|
||||
)
|
||||
|
||||
rem Handle --version here (after native client check is skipped) for sbt 2.x project dirs (#8717)
|
||||
:skip_native_for_version
|
||||
if "!sbt_args_print_version!" == "1" (
|
||||
if "!is_this_dir_sbt!" == "1" (
|
||||
if not "!build_props_sbt_version!" == "" (
|
||||
echo sbt version in this project: !build_props_sbt_version!
|
||||
)
|
||||
)
|
||||
echo sbt runner version: !init_sbt_version!
|
||||
echo.
|
||||
echo [info] sbt runner (sbt-the-batch-script) is a runner to run any declared version of sbt.
|
||||
echo [info] Actual version of the sbt is declared using project\build.properties for each build.
|
||||
goto :eof
|
||||
)
|
||||
|
||||
if defined sbt_args_verbose (
|
||||
echo # Executing command line:
|
||||
echo "!_JAVACMD!"
|
||||
|
|
|
|||
Loading…
Reference in New Issue