tests for script internal and external wildcard classpath use cases

Author: philwalk

compiler/test-resources/scripting/classpathReport.sc

@@ -1,3 +1,9 @@
 #!dist/target/pack/bin/scala -classpath 'dist/target/pack/lib/*'
+
+import java.nio.file.Paths
+
 def main(args: Array[String]): Unit =
-  println(sys.props("java.class.path"))
+  val cwd = Paths.get(".").toAbsolutePath.toString.replace('\\','/').replaceAll("/$","")
+  printf("cwd: %s\n",cwd)
+  printf("classpath: %s\n",sys.props("java.class.path"))
+

compiler/test/dotty/tools/scripting/ClasspathTests.scala

@@ -22,27 +22,35 @@ class ClasspathTests:
 
   // only interested in classpath test scripts
   def testFiles = scripts("/scripting").filter { _.getName.matches("classpath.*[.]sc") }
+  val testScriptName = "classpathReport.sc"
+  def testScript = testFiles.find { _.getName == testScriptName } match
+    case None => sys.error(s"test script not found: ${testScriptName}")
+    case Some(file) => file
+
+  def packBinScalaExists:Boolean =
+    val scalaScriptPath = Paths.get("dist/target/pack/bin/scala")
+    scalaScriptPath.toFile.exists
 
   /*
-   * Call test scripts
+   * verify java command line generated by scalac.
    */
   @Test def scalacEchoTest =
-    for scriptFile <- testFiles do
-      val relpath = scriptFile.toPath.relpath.norm
-      printf("===> test script name [%s]\n",relpath)
-      printf("%s\n",relpath)
-      printf("bash is [%s]\n",bashExe)
-      
+    val relpath = testScript.toPath.relpath.norm
+    printf("===> scalacEchoTest for script [%s]\n",relpath)
+    printf("bash is [%s]\n",bashExe)
+
+    if packBinScalaExists then
       val echoTest = "SCALAC_ECHO_TEST=1"
-      val bashCmdline = s"SCALA_OPTS= $echoTest dist/target/pack/bin/scala -classpath 'lib/*' $relpath"
+      val bashCmdline = s"SCALA_OPTS= $echoTest dist/target/pack/bin/scala -classpath '$wildcardEntry' $relpath"
 
       // ask [dist/bin/scalac] to echo generated command line so we can verify some things
       val cmd = Array(bashExe,"-c",bashCmdline)
 
-      cmd.foreach { printf("[%s]\n",_) }
+      //cmd.foreach { printf("[%s]\n",_) }
 
       val javaCommandLine = exec(cmd:_*).mkString(" ").split(" ").filter { _.trim.nonEmpty }
-      javaCommandLine.foreach { printf("scalac-java-command[%s]\n",_) }
+      printf("\n==================== isWin[%s], cygwin[%s], mingw[%s], msys[%s]\n",isWin,cygwin,mingw,msys)
+      javaCommandLine.foreach { printf("java-command[%s]\n",_) }
 
       val output = scala.collection.mutable.Queue(javaCommandLine:_*)
       output.dequeueWhile( _ != "dotty.tools.scripting.Main")
@@ -66,7 +74,6 @@ class ClasspathTests:
       // PR #10761: verify that [dist/bin/scala] -classpath processing adds $psep to wildcard if Windows
       val classpathValue = consumeNext
       printf("classpath value [%s]\n",classpathValue)
-      if isWin then printf("cygwin[%s], mingw[%s], msys[%s]\n",cygwin,mingw,msys)
       assert( !winshell || classpathValue.contains(psep) )
 
       // expecting -script next
@@ -77,12 +84,57 @@ class ClasspathTests:
         printf("last: %s\nrelp: %s\n",javaCommandLine.last,relpath)
         assert(javaCommandLine.last == relpath,s"unexpected output passed to scripting.Main")
 
+  /*
+   * verify classpath reported by called script.
+   */
+  @Test def hashbangClasspathVerifyTest =
+    val relpath = testScript.toPath.relpath.norm
+    printf("===> hashbangClasspathVerifyTest for script [%s]\n",relpath)
+    printf("bash is [%s]\n",bashExe)
+
+    if false && packBinScalaExists then
+      val bashCmdline = s"SCALA_OPTS= $relpath"
+      val cmd = Array(bashExe,"-c",bashCmdline)
+
+      cmd.foreach { printf("[%s]\n",_) }
+
+      // test script reports the classpath it sees 
+      val scriptOutput = exec(cmd:_*)
+      val scriptCwd = findTaggedLine("cwd",scriptOutput)
+      printf("script ran in directory [%s]\n",scriptCwd)
+      val scriptCp = findTaggedLine("classpath",scriptOutput)
+
+      val hashbangClasspathJars = scriptCp.split(psep).map { _.getName }.sorted.distinct
+      val packlibJars = listJars(s"$scriptCwd/dist/target/pack/lib").sorted.distinct
+     
+      // verify that the classpath set in the hashbang line is effective
+      if hashbangClasspathJars.size != packlibJars.size then
+        printf("%d test script jars in classpath\n",hashbangClasspathJars.size)
+        printf("%d jar files in dist/target/pack/lib\n",packlibJars.size)
+
+      assert(hashbangClasspathJars.size == packlibJars.size)
 
+
+//////////////// end of tests ////////////////
 lazy val cwd = Paths.get(".").toAbsolutePath
+lazy val wildcardEntry = "dist/target/pack/lib/*"
+
+def listJars(dir: String) =
+  val packlibDir = Paths.get(dir).toFile
+  if packlibDir.isDirectory then
+    packlibDir.listFiles.toList.map { _.getName }.filter { _.endsWith(".jar") }
+  else
+    Nil
 
 import scala.jdk.CollectionConverters._
 lazy val env:Map[String,String] = System.getenv.asScala.toMap
 
+// script output expected as "<tag>: <value>"
+def findTaggedLine(tag: String, lines: Seq[String]): String =
+  lines.find { _.startsWith(tag) } match
+    case None => sys.error(s"no $tag: found in script output")
+    case Some(cwd) => cwd.dropWhile( _ != ' ').trim // discard tag
+
 def exec(cmd: String *): Seq[String] = Process(cmd).lazyLines_!.toList
 
 def which(str:String) =
@@ -125,6 +177,8 @@ extension(p:Path)
   def norm: String = p.toString.replace('\\','/')
 
 extension(path: String)
+  def getName: String = norm.replaceAll(".*/","")
+
   // Normalize path separator, convert relative path to absolute
   def norm: String =
     path.replace('\\', '/') match {

dist/bin/scala

@@ -53,7 +53,7 @@ truncated_params="${*#-}"
 # options_indicator != 0 if at least one parameter is not an option
 options_indicator=$(( ${#all_params} - ${#truncated_params} - $# ))
 
-[ -n "$SCALA_OPTS" ] && set -- $SCALA_OPTS $@
+[ -n "$SCALA_OPTS" ] && set -- $SCALA_OPTS "$@"
 
 while [[ $# -gt 0 ]]; do
   case "$1" in
@@ -65,19 +65,18 @@ while [[ $# -gt 0 ]]; do
       execute_run=true
       shift
       ;;
-    -cp | -classpath)
-      CLASS_PATH="$2"
-      if [[ $cygwin || $mingw || $msys ]]; then
-        # in Windows, need to protect a single wildcard entry from jdk globbing.
-        # (jdk globbing replaces a single wildcard arg to multiple jar file args!)
-        if [[ $CLASS_PATH =~ \* && ! $CLASS_PATH =~ \; ]]; then
-          CLASS_PATH=";$CLASS_PATH"
-        fi
-      fi
+    -cp | -classpath )
+      CLASS_PATH="$2${PSEP}"
       class_path_count+=1
       shift
       shift
       ;;
+    -cp*|-classpath*)
+      # hashbang can combine args, e.g. "-classpath 'lib/*'"
+      CLASS_PATH="${1#* *}${PSEP}"
+      echo "CLASS_PATH[$CLASS_PATH]" 1>&2
+      class_path_count+=1
+      ;;
     -with-compiler)
       with_compiler=true
       shift

dist/bin/scalac

@@ -119,11 +119,8 @@ classpathArgs
 if [ "$PROG_NAME" == "$ScriptingMain" ]; then
   scripting_string="-script $target_script ${scripting_args[@]}"
 fi
-if [ -n "$SCALAC_ECHO_TEST" ]; then
-  EVAL=echo # to test with EVAL=echo
-else
-  EVAL=eval
-fi
+
+EVAL=eval ; [ -n "$SCALAC_ECHO_TEST" ] && EVAL=echo
 $EVAL "\"$JAVACMD\"" \
      ${JAVA_OPTS:-$default_java_opts} \
      "${DEBUG-}" \