script extension can be either '.sc' or empty string (#3802)

* fix for 3789 - script if .sc, or (if no extension) has shebang

* verify-non-directory in shebang-test

* reorder isDir case ahead of isShebangScript

* added integration test for enabled case

* restore line endings

* adjust new test

* quote msg

* fix quoted msg

* Apply suggestions from code review

suggested changes

Co-authored-by: Piotr Chabelski <[email protected]>

* remove isScript extra paren

* add script.sources property

* fix failing CI / Checks test due to import order

* revert treating .scala files as Script

* revert attempt #2

* revert /Inputs.scala changes

* Apply suggestions from code review

Co-authored-by: Piotr Chabelski <[email protected]>

* legal script extension restricted to .sc or empty string

* remove unrelated code

* cleanup imports

* corrected hasShebang check

* corrected hasShebang test

* hasShebang adapted for /dev/fd

* input sc script def

* fix tests

* avoid hasShebang test of streamed bytes

* disable hasShebang test for streams

* Update modules/integration/src/test/scala/scala/cli/integration/RunScriptTestDefinitions.scala

Co-authored-by: Piotr Chabelski <[email protected]>

---------

Co-authored-by: Piotr Chabelski <[email protected]>
Co-authored-by: Phil <[email protected]>

Author: 3 people

modules/build/src/main/scala/scala/build/input/ElementsUtils.scala

@@ -9,8 +9,10 @@ import scala.build.internal.Constants
 
 object ElementsUtils {
   extension (p: os.Path) {
-    def hasShebang: Boolean = os.read.bytes(p, offset = 0, count = 2) == Array('#', '!')
-    def isScript: Boolean   = p.ext == "sc" || (p.hasShebang && p.ext != "scala")
+    def hasShebang: Boolean =
+      os.isFile(p) && !p.toString.startsWith("/dev/fd/") &&
+      String(os.read.bytes(p, offset = 0, count = 2)) == "#!"
+    def isScript: Boolean = p.ext == "sc" || (p.hasShebang && p.ext.isEmpty)
   }
 
   extension (d: Directory) {
@@ -25,12 +27,13 @@ object ElementsUtils {
             ProjectScalaFile(d.path, p.subRelativeTo(d.path))
           case p if p.last.endsWith(".scala") =>
             SourceScalaFile(d.path, p.subRelativeTo(d.path))
-          case p if p.last.endsWith(".sc") || p.hasShebang =>
-            Script(d.path, p.subRelativeTo(d.path), None)
           case p if p.last.endsWith(".c") || p.last.endsWith(".h") =>
             CFile(d.path, p.subRelativeTo(d.path))
           case p if p.last.endsWith(".md") && enableMarkdown =>
             MarkdownFile(d.path, p.subRelativeTo(d.path))
+          case p if p.last.endsWith(".sc") =>
+            // TODO: hasShebang test without consuming 1st 2 bytes of Stream
+            Script(d.path, p.subRelativeTo(d.path), None)
         }
         .toVector
         .sortBy(_.subPath.segments)

modules/build/src/main/scala/scala/build/input/Inputs.scala

@@ -276,15 +276,16 @@ object Inputs {
         else if path.last == Constants.projectFileName then
           Right(Seq(ProjectScalaFile(dir, subPath)))
         else if os.isDir(path) then Right(Seq(Directory(path)))
-        else if arg.endsWith(".sc") || (os.exists(path) && isShebangScript(String(content))) then
-          Right(Seq(Script(dir, subPath, Some(arg))))
+        else if arg.endsWith(".sc") then Right(Seq(Script(dir, subPath, Some(arg))))
         else if arg.endsWith(".scala") then Right(Seq(SourceScalaFile(dir, subPath)))
         else if arg.endsWith(".java") then Right(Seq(JavaFile(dir, subPath)))
         else if arg.endsWith(".jar") then Right(Seq(JarFile(dir, subPath)))
         else if arg.endsWith(".c") || arg.endsWith(".h") then Right(Seq(CFile(dir, subPath)))
         else if arg.endsWith(".md") then Right(Seq(MarkdownFile(dir, subPath)))
         else if acceptFds && arg.startsWith("/dev/fd/") then
           Right(Seq(VirtualScript(content, arg, os.sub / s"input-${idx + 1}.sc")))
+        else if path.ext.isEmpty && os.exists(path) && path.isScript then
+          Right(Seq(Script(dir, subPath, Some(arg))))
         else if programInvokeData.subCommand == SubCommand.Shebang && os.exists(path) then
           if isShebangScript(String(content)) then Right(Seq(Script(dir, subPath, Some(arg))))
           else

modules/cli/src/main/scala/scala/cli/commands/run/Run.scala

@@ -590,6 +590,7 @@ object Run extends ScalaCommand[RunOptions] with BuildCommandHelpers {
               }
               else
                 (Nil, Map.empty[String, String])
+
             val allJavaOpts = pythonJavaProps ++ baseJavaProps
             if showCommand then
               Left {

modules/integration/src/test/scala/scala/cli/integration/RunScriptTestDefinitions.scala

@@ -574,17 +574,19 @@ trait RunScriptTestDefinitions { _: RunTestDefinitions =>
     }
 
   test("script file with shebang header and no extension run with scala-cli") {
-    val msg    = "compiled and ran"
-    val inputs = TestInputs(
-      os.rel / "scriptWithShebang" ->
+    val expected   = "success"
+    val scriptName = "scriptWithShebang"
+    val inputs     = TestInputs(
+      os.rel / scriptName ->
         s"""|#!/usr/bin/env -S ${TestUtil.cli.mkString(" ")} shebang
             |//> using scala $actualScalaVersion
-            |println(s"$msg")""".stripMargin
+            |println(s"$expected")""".stripMargin
     )
+    val cmd = TestUtil.cli ++ Seq(scriptName)
     inputs.fromRoot { root =>
-      val output = os.proc(TestUtil.cli, "scriptWithShebang")
+      val actual = os.proc(cmd)
         .call(cwd = root).out.trim()
-      expect(output == msg)
+      expect(actual == expected)
     }
   }