From 2b953246bcbc686f8f09f462959e211eba3c069c Mon Sep 17 00:00:00 2001
From: Jamie Thompson <bishbashboshjt@gmail.com>
Date: Fri, 10 May 2024 11:20:58 +0200
Subject: [PATCH] adjust test sources to be clear which are meant to be
 self-executing

---
 .../test-resources/scripting/argfileClasspath.sc |  9 ---------
 ...pathReport.sc => classpathReport_scalacli.sc} |  2 +-
 .../test-resources/scripting/cpArgumentsFile.txt |  1 -
 compiler/test-resources/scripting/envtest.sc     |  2 ++
 compiler/test-resources/scripting/envtestNu.sc   |  2 --
 .../test-resources/scripting/envtest_scalacli.sc |  3 +++
 compiler/test-resources/scripting/hashBang.sc    |  2 +-
 compiler/test-resources/scripting/hashBang.scala |  4 ++--
 .../test-resources/scripting/scriptName.scala    |  2 +-
 compiler/test-resources/scripting/scriptPath.sc  |  2 +-
 .../{scriptPathNu.sc => scriptPath_scalacli.sc}  |  2 +-
 compiler/test-resources/scripting/showArgs.sc    |  2 +-
 .../{showArgsNu.sc => showArgs_scalacli.sc}      |  3 ++-
 .../test-resources/scripting/sqlDateError.sc     |  2 +-
 .../test-resources/scripting/sqlDateErrorNu.sc   |  6 ------
 .../scripting/sqlDateError_scalacli.sc           |  6 ++++++
 compiler/test-resources/scripting/touchFile.sc   |  2 +-
 .../test-resources/scripting/unglobClasspath.sc  |  6 ------
 .../scripting/unglobClasspath_scalacli.sc        |  9 +++++++++
 .../dotty/tools/scripting/BashScriptsTests.scala | 14 +++++++-------
 .../dotty/tools/scripting/ClasspathTests.scala   |  8 ++++----
 .../dotty/tools/scripting/ScriptingTests.scala   | 16 +++++++---------
 22 files changed, 50 insertions(+), 55 deletions(-)
 delete mode 100755 compiler/test-resources/scripting/argfileClasspath.sc
 rename compiler/test-resources/scripting/{classpathReport.sc => classpathReport_scalacli.sc} (91%)
 delete mode 100755 compiler/test-resources/scripting/cpArgumentsFile.txt
 delete mode 100755 compiler/test-resources/scripting/envtestNu.sc
 create mode 100755 compiler/test-resources/scripting/envtest_scalacli.sc
 rename compiler/test-resources/scripting/{scriptPathNu.sc => scriptPath_scalacli.sc} (87%)
 rename compiler/test-resources/scripting/{showArgsNu.sc => showArgs_scalacli.sc} (68%)
 delete mode 100755 compiler/test-resources/scripting/sqlDateErrorNu.sc
 create mode 100755 compiler/test-resources/scripting/sqlDateError_scalacli.sc
 delete mode 100755 compiler/test-resources/scripting/unglobClasspath.sc
 create mode 100755 compiler/test-resources/scripting/unglobClasspath_scalacli.sc

diff --git a/compiler/test-resources/scripting/argfileClasspath.sc b/compiler/test-resources/scripting/argfileClasspath.sc
deleted file mode 100755
index c31371ba8934..000000000000
--- a/compiler/test-resources/scripting/argfileClasspath.sc
+++ /dev/null
@@ -1,9 +0,0 @@
-#!dist/target/pack/bin/scala @compiler/test-resources/scripting/cpArgumentsFile.txt
-
-import java.nio.file.Paths
-
-def main(args: Array[String]): Unit =
-  val cwd = Paths.get(".").toAbsolutePath.toString.replace('\\', '/').replaceAll("/$", "")
-  printf("cwd: %s\n", cwd)
-  printf("classpath: %s\n", sys.props("java.class.path"))
-
diff --git a/compiler/test-resources/scripting/classpathReport.sc b/compiler/test-resources/scripting/classpathReport_scalacli.sc
similarity index 91%
rename from compiler/test-resources/scripting/classpathReport.sc
rename to compiler/test-resources/scripting/classpathReport_scalacli.sc
index cc68c4b1d52e..0b2552b3ac84 100755
--- a/compiler/test-resources/scripting/classpathReport.sc
+++ b/compiler/test-resources/scripting/classpathReport_scalacli.sc
@@ -1,5 +1,5 @@
 #!/usr/bin/env bin/scala
-
+// This file is a Scala CLI script.
 import java.nio.file.Paths
 
 // def main(args: Array[String]): Unit = // MIGRATION: Scala CLI expects `*.sc` files to be straight-line code
diff --git a/compiler/test-resources/scripting/cpArgumentsFile.txt b/compiler/test-resources/scripting/cpArgumentsFile.txt
deleted file mode 100755
index 73037eb7d9bc..000000000000
--- a/compiler/test-resources/scripting/cpArgumentsFile.txt
+++ /dev/null
@@ -1 +0,0 @@
--classpath dist/target/pack/lib/*
diff --git a/compiler/test-resources/scripting/envtest.sc b/compiler/test-resources/scripting/envtest.sc
index b2fde1b32339..724580449229 100755
--- a/compiler/test-resources/scripting/envtest.sc
+++ b/compiler/test-resources/scripting/envtest.sc
@@ -1,2 +1,4 @@
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
+
 def main(args: Array[String]): Unit =
   println("Hello " + util.Properties.propOrNull("key"))
diff --git a/compiler/test-resources/scripting/envtestNu.sc b/compiler/test-resources/scripting/envtestNu.sc
deleted file mode 100755
index fe4cd7851b0a..000000000000
--- a/compiler/test-resources/scripting/envtestNu.sc
+++ /dev/null
@@ -1,2 +0,0 @@
-// MIGRATION: Scala CLI expects `*.sc` files to be straight-line code
-  println("Hello " + util.Properties.propOrNull("key"))
diff --git a/compiler/test-resources/scripting/envtest_scalacli.sc b/compiler/test-resources/scripting/envtest_scalacli.sc
new file mode 100755
index 000000000000..993ea1691640
--- /dev/null
+++ b/compiler/test-resources/scripting/envtest_scalacli.sc
@@ -0,0 +1,3 @@
+// This file is a Scala CLI script.
+
+println("Hello " + util.Properties.propOrNull("key"))
diff --git a/compiler/test-resources/scripting/hashBang.sc b/compiler/test-resources/scripting/hashBang.sc
index d767bd1a1592..98884bc050c0 100755
--- a/compiler/test-resources/scripting/hashBang.sc
+++ b/compiler/test-resources/scripting/hashBang.sc
@@ -1,4 +1,4 @@
-#!/usr/bin/env scala
+#!/usr/bin/env fake-program-to-test-hashbang-removal
 # comment
 STUFF=nada
 !#
diff --git a/compiler/test-resources/scripting/hashBang.scala b/compiler/test-resources/scripting/hashBang.scala
index 1aab26269f86..b7bf6b541854 100755
--- a/compiler/test-resources/scripting/hashBang.scala
+++ b/compiler/test-resources/scripting/hashBang.scala
@@ -1,8 +1,8 @@
-#!/usr/bin/env scala
+#!/usr/bin/env fake-program-to-test-hashbang-removal
 # comment
 STUFF=nada
 !#
-
+// everything above this point should be ignored by the compiler
 def main(args: Array[String]): Unit =
   System.err.printf("mainClassFromStack: %s\n",mainFromStack)
   assert(mainFromStack.contains("hashBang"),s"fromStack[$mainFromStack]")
diff --git a/compiler/test-resources/scripting/scriptName.scala b/compiler/test-resources/scripting/scriptName.scala
index 21aec32fe0bb..7e479197d567 100755
--- a/compiler/test-resources/scripting/scriptName.scala
+++ b/compiler/test-resources/scripting/scriptName.scala
@@ -1,4 +1,4 @@
-#!/usr/bin/env scala
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
 
   def main(args: Array[String]): Unit =
     val name = Option(sys.props("script.name")) match {
diff --git a/compiler/test-resources/scripting/scriptPath.sc b/compiler/test-resources/scripting/scriptPath.sc
index 46cd5e8a7385..e29e659d09d4 100755
--- a/compiler/test-resources/scripting/scriptPath.sc
+++ b/compiler/test-resources/scripting/scriptPath.sc
@@ -1,4 +1,4 @@
-#!dist/target/pack/bin/scala
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
 
   def main(args: Array[String]): Unit =
     args.zipWithIndex.foreach { case (arg,i) => printf("arg %d: [%s]\n",i,arg) }
diff --git a/compiler/test-resources/scripting/scriptPathNu.sc b/compiler/test-resources/scripting/scriptPath_scalacli.sc
similarity index 87%
rename from compiler/test-resources/scripting/scriptPathNu.sc
rename to compiler/test-resources/scripting/scriptPath_scalacli.sc
index bb3e459654b9..c13888d0e4b1 100755
--- a/compiler/test-resources/scripting/scriptPathNu.sc
+++ b/compiler/test-resources/scripting/scriptPath_scalacli.sc
@@ -4,7 +4,7 @@
 
 args.zipWithIndex.foreach { case (arg,i) => printf("arg %d: [%s]\n",i,arg) }
 
-if !scriptPath.endsWith("scriptPathNu.sc") then
+if !scriptPath.endsWith("scriptPath_scalacli.sc") then
   printf( s"incorrect script.path defined as [$scriptPath]")
 else
   printf("scriptPath: %s\n", scriptPath) // report the value
diff --git a/compiler/test-resources/scripting/showArgs.sc b/compiler/test-resources/scripting/showArgs.sc
index 8ef08f8962b0..69d552b9cf5f 100755
--- a/compiler/test-resources/scripting/showArgs.sc
+++ b/compiler/test-resources/scripting/showArgs.sc
@@ -1,4 +1,4 @@
-#!/usr/bin/env bin/scala
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
 
 // precise output format expected by BashScriptsTests.scala
 def main(args: Array[String]): Unit =
diff --git a/compiler/test-resources/scripting/showArgsNu.sc b/compiler/test-resources/scripting/showArgs_scalacli.sc
similarity index 68%
rename from compiler/test-resources/scripting/showArgsNu.sc
rename to compiler/test-resources/scripting/showArgs_scalacli.sc
index f4c1aa6af257..4591ac159345 100755
--- a/compiler/test-resources/scripting/showArgsNu.sc
+++ b/compiler/test-resources/scripting/showArgs_scalacli.sc
@@ -1,6 +1,7 @@
 #!/usr/bin/env bin/scala
 
+// This file is a Scala CLI script.
+
 // precise output format expected by BashScriptsTests.scala
-// MIGRATION: Scala CLI expects `*.sc` files to be straight-line code
 for (a,i) <- args.zipWithIndex do
   printf(s"arg %2d:[%s]\n",i,a)
diff --git a/compiler/test-resources/scripting/sqlDateError.sc b/compiler/test-resources/scripting/sqlDateError.sc
index 35160fd6fcd5..e7c3a623c6c1 100755
--- a/compiler/test-resources/scripting/sqlDateError.sc
+++ b/compiler/test-resources/scripting/sqlDateError.sc
@@ -1,4 +1,4 @@
-#!/usr/bin/env bin/scala
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
 
 def main(args: Array[String]): Unit = {
   println(new java.sql.Date(100L))
diff --git a/compiler/test-resources/scripting/sqlDateErrorNu.sc b/compiler/test-resources/scripting/sqlDateErrorNu.sc
deleted file mode 100755
index a6f1bd50297d..000000000000
--- a/compiler/test-resources/scripting/sqlDateErrorNu.sc
+++ /dev/null
@@ -1,6 +0,0 @@
-#!/usr/bin/env bin/scala
-
-// def main(args: Array[String]): Unit = { MIGRATION: Scala CLI expects `*.sc` files to be straight-line code
-  println(new java.sql.Date(100L))
-  System.err.println("SCALA_OPTS="+Option(System.getenv("SCALA_OPTS")).getOrElse(""))
-// }
diff --git a/compiler/test-resources/scripting/sqlDateError_scalacli.sc b/compiler/test-resources/scripting/sqlDateError_scalacli.sc
new file mode 100755
index 000000000000..10b58821a6e4
--- /dev/null
+++ b/compiler/test-resources/scripting/sqlDateError_scalacli.sc
@@ -0,0 +1,6 @@
+#!/usr/bin/env bin/scala
+
+// This file is a Scala CLI script.
+
+println(new java.sql.Date(100L))
+System.err.println("SCALA_OPTS="+Option(System.getenv("SCALA_OPTS")).getOrElse(""))
diff --git a/compiler/test-resources/scripting/touchFile.sc b/compiler/test-resources/scripting/touchFile.sc
index 974f8a64d192..b46b3c99d786 100755
--- a/compiler/test-resources/scripting/touchFile.sc
+++ b/compiler/test-resources/scripting/touchFile.sc
@@ -1,4 +1,4 @@
-#!/usr/bin/env scala
+// this file is intended to be ran as an argument to the dotty.tools.scripting.ScriptingDriver class
 
 import java.io.File
 
diff --git a/compiler/test-resources/scripting/unglobClasspath.sc b/compiler/test-resources/scripting/unglobClasspath.sc
deleted file mode 100755
index deab2b8982ac..000000000000
--- a/compiler/test-resources/scripting/unglobClasspath.sc
+++ /dev/null
@@ -1,6 +0,0 @@
-// won't compile unless classpath is set correctly
-import dotty.tools.tasty.TastyFormat
-
-// def main(args: Array[String]) = // MIGRATION: Scala CLI expects `*.sc` files to be straight-line code
-  val cp = sys.props("java.class.path")
-  printf("unglobbed classpath: %s\n", cp)
diff --git a/compiler/test-resources/scripting/unglobClasspath_scalacli.sc b/compiler/test-resources/scripting/unglobClasspath_scalacli.sc
new file mode 100755
index 000000000000..ccc4cf667085
--- /dev/null
+++ b/compiler/test-resources/scripting/unglobClasspath_scalacli.sc
@@ -0,0 +1,9 @@
+// This file is a Scala CLI script.
+
+import dotty.tools.tasty.TastyFormat
+//     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+//     not visible on default classpath, "compiler/test/dotty/tools/scripting/ClasspathTests.scala"
+//     adds it to classpath via a compiler argument `-classpath 'org/scala-lang/tasty-core_3/$VERSION/*'`
+
+val cp = sys.props("java.class.path")
+printf("unglobbed classpath: %s\n", cp)
diff --git a/compiler/test/dotty/tools/scripting/BashScriptsTests.scala b/compiler/test/dotty/tools/scripting/BashScriptsTests.scala
index 25bc54e2dcbe..96881515dbf8 100644
--- a/compiler/test/dotty/tools/scripting/BashScriptsTests.scala
+++ b/compiler/test/dotty/tools/scripting/BashScriptsTests.scala
@@ -50,7 +50,7 @@ object BashScriptsTests:
   val testScriptArgs = Seq(
     "a", "b", "c", "-repl", "-run", "-script", "-debug"
   )
-  val Seq(showArgsScript, showArgsScalaCli) = Seq("showArgs.sc", "showArgsNu.sc").map { name =>
+  val Seq(showArgsScript, showArgsScalaCli) = Seq("showArgs.sc", "showArgs_scalacli.sc").map { name =>
     testFiles.find(_.getName == name).get.absPath
   }
 
@@ -66,7 +66,7 @@ object BashScriptsTests:
     }
     file
 
-  val Seq(envtestNuSc, envtestScala) = Seq("envtestNu.sc", "envtest.scala").map { testFile(_) }
+  val Seq(envtestNuSc, envtestScala) = Seq("envtest_scalacli.sc", "envtest.scala").map { testFile(_) }
 
   // create command line with given options, execute specified script, return stdout
   def callScript(tag: String, script: String, keyPre: String): String =
@@ -173,13 +173,13 @@ class BashScriptsTests:
         assert(stdout == expectedOutput)
 
   /*
-   * verify that scriptPathNu.sc sees a valid script.path property,
-   * and that it's value is the path to "scriptPathNu.sc".
+   * verify that scriptPath_scalacli.sc sees a valid script.path property,
+   * and that it's value is the path to "scriptPath_scalacli.sc".
    */
   @Category(Array(classOf[BootstrappedOnlyTests]))
   @Test def verifyScriptPathProperty =
     assumeFalse("Scripts do not yet support Scala 2 library TASTy", Properties.usingScalaLibraryTasty)
-    val scriptFile = testFiles.find(_.getName == "scriptPathNu.sc").get
+    val scriptFile = testFiles.find(_.getName == "scriptPath_scalacli.sc").get
     val expected = s"${scriptFile.getName}"
     printf("===> verify valid system property script.path is reported by script [%s]\n", scriptFile.getName)
     printf("calling scriptFile: %s\n", scriptFile)
@@ -196,7 +196,7 @@ class BashScriptsTests:
    */
   @Test def verifyScalaOpts =
     assumeFalse("Scripts do not yet support Scala 2 library TASTy", Properties.usingScalaLibraryTasty)
-    val scriptFile = testFiles.find(_.getName == "classpathReport.sc").get
+    val scriptFile = testFiles.find(_.getName == "classpathReport_scalacli.sc").get
     printf("===> verify SCALA_OPTS='@argsfile' is properly handled by `dist/bin/scala`\n")
     val envPairs = List(("SCALA_OPTS", s"@$argsfile"))
     val (validTest, exitCode, stdout, stderr) = bashCommand(scriptFile.absPath, envPairs)
@@ -219,7 +219,7 @@ class BashScriptsTests:
    */
   @Test def sqlDateTest =
     assumeFalse("Scripts do not yet support Scala 2 library TASTy", Properties.usingScalaLibraryTasty)
-    val scriptBase = "sqlDateErrorNu"
+    val scriptBase = "sqlDateError_scalacli"
     val scriptFile = testFiles.find(_.getName == s"$scriptBase.sc").get
     val testJar = testFile(s"$scriptBase.jar") // jar should not be created when scriptFile runs
     val tj = Paths.get(testJar).toFile
diff --git a/compiler/test/dotty/tools/scripting/ClasspathTests.scala b/compiler/test/dotty/tools/scripting/ClasspathTests.scala
index 5107af5eee43..f77dd80bd981 100755
--- a/compiler/test/dotty/tools/scripting/ClasspathTests.scala
+++ b/compiler/test/dotty/tools/scripting/ClasspathTests.scala
@@ -24,7 +24,7 @@ class ClasspathTests:
   @Ignore
   @Test def hashbangClasspathVerifyTest = {
     // only interested in classpath test scripts
-    val testScriptName = "classpathReport.sc"
+    val testScriptName = "classpathReport_scalacli.sc"
     val testScript = scripts("/scripting").find { _.getName.matches(testScriptName) } match
       case None => sys.error(s"test script not found: ${testScriptName}")
       case Some(file) => file
@@ -39,7 +39,7 @@ class ClasspathTests:
 
       cmd.foreach { printf("[%s]\n", _) }
 
-      // classpathReport.sc is expected to produce two lines:
+      // classpathReport_scalacli.sc is expected to produce two lines:
       // cwd: <current-working-directory-seen-by-the-script>
       // classpath: <classpath-seen-by-the-script>
 
@@ -51,7 +51,7 @@ class ClasspathTests:
       // convert scriptCp to a list of files
       val hashbangJars: List[File] = scriptCp.split(psep).map { _.toFile }.toList
       val hashbangClasspathJars = hashbangJars.map { _.name }.sorted.distinct // get jar basenames, remove duplicates
-      val packlibDir: String = ??? /* ??? was s"$scriptCwd/$packLibDir" */ // classpathReport.sc specifies a wildcard classpath in this directory
+      val packlibDir: String = ??? /* ??? was s"$scriptCwd/$packLibDir" */ // classpathReport_scalacli.sc specifies a wildcard classpath in this directory
       val packlibJars: List[File] = listJars(packlibDir) // classpath entries expected to have been reported by the script
 
       printf("%d jar files in dist/target/pack/lib\n", packlibJars.size)
@@ -78,7 +78,7 @@ class ClasspathTests:
    * verify classpath is unglobbed by MainGenericRunner.
    */
   @Test def unglobClasspathVerifyTest = {
-    val testScriptName = "unglobClasspath.sc"
+    val testScriptName = "unglobClasspath_scalacli.sc"
     val testScript = scripts("/scripting").find { _.name.matches(testScriptName) } match
       case None => sys.error(s"test script not found: ${testScriptName}")
       case Some(file) => file
diff --git a/compiler/test/dotty/tools/scripting/ScriptingTests.scala b/compiler/test/dotty/tools/scripting/ScriptingTests.scala
index 713695b62f4a..8d07cb137917 100644
--- a/compiler/test/dotty/tools/scripting/ScriptingTests.scala
+++ b/compiler/test/dotty/tools/scripting/ScriptingTests.scala
@@ -17,7 +17,11 @@ import org.junit.Assume.assumeFalse
 /** Runs all tests contained in `compiler/test-resources/scripting/` */
 class ScriptingTests:
   // classpath tests managed by scripting.ClasspathTests.scala
-  def testFiles = scripts("/scripting").filter { ! _.getName.toLowerCase.contains("classpath") }
+  def testFiles = scripts("/scripting").filter { sc =>
+    val name = sc.getName.toLowerCase
+    !name.contains("classpath")
+    && !name.contains("_scalacli")
+  }
 
   /*
    * Call .scala scripts without -save option, verify no jar created
@@ -47,10 +51,7 @@ class ScriptingTests:
    */
   @Test def scriptingMainTests =
     assumeFalse("Scripts do not yet support Scala 2 library TASTy", Properties.usingScalaLibraryTasty)
-    for
-      (scriptFile, scriptArgs) <- scalaFilesWithArgs(".sc")
-      if !scriptFile.getName().endsWith("Nu.sc")
-    do
+    for (scriptFile, scriptArgs) <- scalaFilesWithArgs(".sc") do
       showScriptUnderTest(scriptFile)
       val unexpectedJar = script2jar(scriptFile)
       unexpectedJar.delete
@@ -69,10 +70,7 @@ class ScriptingTests:
    */
   @Test def scriptingJarTest =
     assumeFalse("Scripts do not yet support Scala 2 library TASTy", Properties.usingScalaLibraryTasty)
-    for
-      (scriptFile, scriptArgs) <- scalaFilesWithArgs(".sc")
-      if !scriptFile.getName().endsWith("Nu.sc")
-    do
+    for (scriptFile, scriptArgs) <- scalaFilesWithArgs(".sc") do
       showScriptUnderTest(scriptFile)
       val expectedJar = script2jar(scriptFile)
       expectedJar.delete