Fix the -jvm-debug and -h flags in the ash template (#1630)

* Add bash and ash tests for the -jvm-debug and -h flags

* Add missing functions to the ash template

* replace bash syntax with ash compatible one

* Revert "Fixes remote debug connections closing (#1546)"

This reverts commit 665e4e2.

* fix sbt 2.0 cross-build for new tests

---------

Co-authored-by: Muki Seiler <muuki88@users.noreply.github.com>

src/main/resources/com/typesafe/sbt/packager/archetypes/scripts/ash-template

@@ -1,5 +1,10 @@
 #!/bin/sh
 
+die() {
+  echo "$@" 1>&2
+  exit 1
+}
+
 realpath () {
 (
   TARGET_FILE="$1"
@@ -51,6 +56,19 @@ addResidual () {
   residual_args="$residual_args $(shellEscape "$1")"
 }
 
+addDebugger () {
+  addJava "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=$1"
+}
+
+require_arg () {
+  local type="$1"
+  local opt="$2"
+  local arg="$3"
+  if [ -z "$arg" ] || [ "${arg#-}" != "$arg" ]; then
+    die "$opt requires <$type> argument"
+  fi
+}
+
 # Allow user to specify java options. These get listed first per bash-template.
 if [ -n "$JAVA_OPTS" ]
 then
@@ -81,10 +99,6 @@ process_args () {
     case "$1" in
              --) shift && no_more_snp_opts=1 && break ;;
        -h|-help) usage; exit 1 ;;
-    -v|-verbose) verbose=1 && shift ;;
-      -d|-debug) debug=1 && shift ;;
-
-    -no-version-check) no_version_check=1 && shift ;;
 
            -mem) echo "!! WARNING !! -mem option is ignored. Please use -J-Xmx and -J-Xms" && shift 2 ;;
      -jvm-debug) require_arg port "$1" "$2" && addDebugger $2 && shift 2 ;;
@@ -99,13 +113,41 @@ process_args () {
     esac
   done
 
-  if [ $no_more_snp_opts ]; then
+  if [ $no_more_snp_opts -ne 0 ]; then
     while [ $# -gt 0 ]; do
       addResidual "$1" && shift
     done
   fi
 }
 
+usage() {
+ cat <<EOM
+Usage: $script_name [options]
+
+  -h | -help         print this message
+  -main <classname>  Define a custom main class
+  -jvm-debug <port>  Turn on JVM debugging, open at the given port.
+
+  # java version (default: java from PATH, currently $(java -version 2>&1 | grep version))
+  -java-home <path>         alternate JAVA_HOME
+
+  # jvm options and output control
+  JAVA_OPTS          environment variable, if unset uses "$java_opts"
+  -Dkey=val          pass -Dkey=val directly to the java runtime
+  -J-X               pass option -X directly to the java runtime
+                     (-J is stripped)
+
+  # special option
+  --                 To stop parsing built-in commands from the rest of the command-line.
+                     e.g.) enabling debug and sending -d as app argument
+                     \$ ./start-script -d -- -d
+
+In the case of duplicated or conflicting options, basically the order above
+shows precedence: JAVA_OPTS lowest, command line options highest except "--".
+${{available_main_classes}}
+EOM
+}
+
 app_commands=""
 residual_args=""
 real_script_path="$(realpath "$0")"

src/main/resources/com/typesafe/sbt/packager/archetypes/scripts/bash-template

@@ -154,7 +154,7 @@ addResidual () {
   residual_args+=( "$1" )
 }
 addDebugger () {
-  addJava "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:$1"
+  addJava "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=$1"
 }
 
 require_arg () {

src/sbt-test/ash/script-debug/build.sbt

@@ -0,0 +1,15 @@
+enablePlugins(JavaAppPackaging, AshScriptPlugin)
+
+name := "script-debug"
+
+version := "0.1.0"
+
+TaskKey[Unit]("runCheck") := {
+  val cwd = (Universal / stagingDirectory).value
+  val cmd = Seq((cwd / "bin" / packageName.value).getAbsolutePath, "-jvm-debug", "0")
+  val output = (sys.process.Process(cmd, cwd).!!).replaceAll("\n", "")
+
+  assert(output.contains("Listening for transport dt_socket at address:"),
+    "Application did not start in debug mode: \n" + output)
+  assert(output.contains("SUCCESS!"), "Application did not run successfully: \n" + output)
+}

src/sbt-test/ash/script-debug/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/ash/script-debug/src/main/scala/MainApp.scala

@@ -0,0 +1,3 @@
+object MainApp extends App {
+  println("SUCCESS!")
+}

src/sbt-test/ash/script-debug/test

@@ -0,0 +1,4 @@
+# Run the staging and check the script.
+> stage
+$ exists target/**/universal/stage/bin/script-debug
+> runCheck

src/sbt-test/ash/script-help/build.sbt

@@ -0,0 +1,26 @@
+enablePlugins(JavaAppPackaging, AshScriptPlugin)
+
+name := "script-help"
+
+version := "0.1.0"
+
+TaskKey[Unit]("runCheck") := {
+  val cwd = (Universal / stagingDirectory).value
+  val cmd = Seq((cwd / "bin" / packageName.value).getAbsolutePath, "-h")
+
+  val buffer = new StringBuffer
+  val code = sys.process.Process(cmd, cwd).run(scala.sys.process.BasicIO(false, buffer, None)).exitValue()
+  assert(code == 1, "Exit code for -h was not 1: " + code)
+
+  val output = buffer.toString.replaceAll("\n", "")
+
+  val expectedHelpSamples = Seq(
+    "-h | -help", "print this message",
+    "-jvm-debug",
+    "JAVA_OPTS",
+    "special option"
+  )
+
+  assert(expectedHelpSamples.forall(output.contains(_)),
+    s"Application did not print the correct help message: \n" + output)
+}

src/sbt-test/ash/script-help/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/ash/script-help/src/main/scala/MainApp.scala

@@ -0,0 +1,3 @@
+object MainApp extends App {
+  println("SUCCESS!")
+}

src/sbt-test/ash/script-help/test

@@ -0,0 +1,4 @@
+# Run the staging and check the script.
+> stage
+$ exists target/**/universal/stage/bin/script-help
+> runCheck

src/sbt-test/bash/script-debug/build.sbt

@@ -0,0 +1,17 @@
+import java.net.ServerSocket
+
+enablePlugins(JavaAppPackaging)
+
+name := "script-debug"
+
+version := "0.1.0"
+
+TaskKey[Unit]("runCheck") := {
+  val cwd = (Universal / stagingDirectory).value
+  val cmd = Seq((cwd / "bin" / packageName.value).getAbsolutePath, "-jvm-debug", "0")
+  val output = (sys.process.Process(cmd, cwd).!!).replaceAll("\n", "")
+
+  assert(output.contains("Listening for transport dt_socket at address:"),
+    "Application did not start in debug mode: \n" + output)
+  assert(output.contains("SUCCESS!"), "Application did not run successfully: \n" + output)
+}

src/sbt-test/bash/script-debug/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/bash/script-debug/src/main/scala/MainApp.scala

@@ -0,0 +1,3 @@
+object MainApp extends App {
+  println("SUCCESS!")
+}

src/sbt-test/bash/script-debug/test

@@ -0,0 +1,4 @@
+# Run the staging and check the script.
+> stage
+$ exists target/**/universal/stage/bin/script-debug
+> runCheck

src/sbt-test/bash/script-help/build.sbt

@@ -0,0 +1,26 @@
+enablePlugins(JavaAppPackaging)
+
+name := "script-help"
+
+version := "0.1.0"
+
+TaskKey[Unit]("runCheck") := {
+  val cwd = (Universal / stagingDirectory).value
+  val cmd = Seq((cwd / "bin" / packageName.value).getAbsolutePath, "-h")
+
+  val buffer = new StringBuffer
+  val code = sys.process.Process(cmd, cwd).run(scala.sys.process.BasicIO(false, buffer, None)).exitValue()
+  assert(code == 1, "Exit code for -h was not 1: " + code)
+
+  val output = buffer.toString.replaceAll("\n", "")
+
+  val expectedHelpSamples = Seq(
+    "-h | -help", "print this message",
+    "-jvm-debug",
+    "JAVA_OPTS",
+    "special option"
+  )
+
+  assert(expectedHelpSamples.forall(output.contains(_)),
+    s"Application did not print the correct help message: \n" + output)
+}

src/sbt-test/bash/script-help/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.github.sbt" % "sbt-native-packager" % sys.props("project.version"))

src/sbt-test/bash/script-help/src/main/scala/MainApp.scala

@@ -0,0 +1,3 @@
+object MainApp extends App {
+  println("SUCCESS!")
+}

src/sbt-test/bash/script-help/test

@@ -0,0 +1,4 @@
+# Run the staging and check the script.
+> stage
+$ exists target/**/universal/stage/bin/script-help
+> runCheck