Fix & refactor script wrapper tests

Author: Gedochao

modules/integration/src/main/scala/scala/cli/integration/TestInputs.scala

@@ -34,6 +34,7 @@ final case class TestInputs(maybeCharset: Option[Charset], files: (os.RelPath, S
       writeIn(tmpDir)
       f(tmpDir)
     }
+  def fileNames: Seq[String] = files.flatMap(_._1.lastOpt)
 }
 
 object TestInputs {

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

@@ -22,9 +22,10 @@ import scala.jdk.CollectionConverters.*
 import scala.util.control.NonFatal
 import scala.util.{Failure, Properties, Success, Try}
 
-abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArgs {
+abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArgs
+    with ScriptWrapperTestDefinitions {
   _: TestScalaVersion =>
-  private lazy val extraOptions = scalaVersionArgs ++ TestUtil.extraOptions
+  protected lazy val extraOptions: Seq[String] = scalaVersionArgs ++ TestUtil.extraOptions
 
   import BspTestDefinitions.*
 
@@ -61,12 +62,12 @@ abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArg
     pool.shutdown()
   }
 
-  private def extractMainTargets(targets: Seq[BuildTargetIdentifier]): BuildTargetIdentifier =
+  protected def extractMainTargets(targets: Seq[BuildTargetIdentifier]): BuildTargetIdentifier =
     targets.collectFirst {
       case t if !t.getUri.contains("-test") => t
     }.get
 
-  private def extractTestTargets(targets: Seq[BuildTargetIdentifier]): BuildTargetIdentifier =
+  protected def extractTestTargets(targets: Seq[BuildTargetIdentifier]): BuildTargetIdentifier =
     targets.collectFirst {
       case t if t.getUri.contains("-test") => t
     }.get
@@ -78,7 +79,8 @@ abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArg
     pauseDuration: FiniteDuration = 5.seconds,
     bspOptions: List[String] = List.empty,
     reuseRoot: Option[os.Path] = None,
-    stdErrOpt: Option[os.RelPath] = None
+    stdErrOpt: Option[os.RelPath] = None,
+    extraOptionsOverride: Seq[String] = extraOptions
   )(
     f: (
       os.Path,
@@ -93,7 +95,7 @@ abstract class BspTestDefinitions extends ScalaCliSuite with TestScalaVersionArg
       val stdErrPathOpt: Option[os.ProcessOutput] = stdErrOpt.map(path => inputsRoot / path)
       val stderr: os.ProcessOutput                = stdErrPathOpt.getOrElse(os.Inherit)
 
-      val proc = os.proc(TestUtil.cli, "bsp", bspOptions ++ extraOptions, args)
+      val proc = os.proc(TestUtil.cli, "bsp", bspOptions ++ extraOptionsOverride, args)
         .spawn(cwd = root, stderr = stderr)
       var remoteServer: b.BuildServer & b.ScalaBuildServer & b.JavaBuildServer & b.JvmBuildServer =
         null

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

@@ -1,3 +1,3 @@
 package scala.cli.integration
 
-class BspTests212 extends BspTestDefinitions with Test212
+class BspTests212 extends BspTestDefinitions with BspTests2Definitions with Test212

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

@@ -8,8 +8,7 @@ import scala.async.Async.{async, await}
 import scala.concurrent.ExecutionContext.Implicits.global
 import scala.jdk.CollectionConverters.*
 
-class BspTests213 extends BspTestDefinitions with Test213 {
-
+class BspTests213 extends BspTestDefinitions with BspTests2Definitions with Test213 {
   List(".sc", ".scala").foreach { filetype =>
     test(s"bsp should report actionable diagnostic from bloop for $filetype files (Scala 2.13)") {
       val fileName = s"Hello$filetype"
@@ -73,5 +72,4 @@ class BspTests213 extends BspTestDefinitions with Test213 {
       }
     }
   }
-
 }

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

@@ -0,0 +1,31 @@
+package scala.cli.integration
+
+import scala.concurrent.ExecutionContext.Implicits.global
+
+trait BspTests2Definitions { _: BspTestDefinitions =>
+  for {
+    useDirectives <- Seq(true, false)
+    (directive, options) <- Seq(
+      (s"//> using scala $actualScalaVersion", Seq("--scala", actualScalaVersion))
+    )
+    extraOptionsOverride =
+      if (useDirectives) TestUtil.extraOptions else TestUtil.extraOptions ++ options
+    testNameSuffix = if (useDirectives) directive else options.mkString(" ")
+  } test(s"BSP App object wrapper forced with $testNameSuffix") {
+    val (script1, script2) = "script1.sc" -> "script2.sc"
+    val directiveString    = if (useDirectives) directive else ""
+    val inputs = TestInputs(
+      os.rel / script1 ->
+        s"""//> using platform js
+           |$directiveString
+           |
+           |def main(args: String*): Unit = println("Hello")
+           |main()
+           |""".stripMargin,
+      os.rel / script2 ->
+        """println("Hello")
+          |""".stripMargin
+    )
+    testScriptWrappers(inputs, extraOptionsOverride = extraOptionsOverride)(expectAppWrapper)
+  }
+}

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

@@ -0,0 +1,52 @@
+package scala.cli.integration
+
+import scala.concurrent.ExecutionContext.Implicits.global
+
+trait BspTests3Definitions { _: BspTestDefinitions =>
+  test("BSP class wrapper for Scala 3") {
+    val (script1, script2) = "script1.sc" -> "script2.sc"
+    val inputs = TestInputs(
+      os.rel / script1 ->
+        s"""def main(args: String*): Unit = println("Hello")
+           |main()
+           |""".stripMargin,
+      os.rel / script2 ->
+        s"""//> using dep "org.scalatest::scalatest:3.2.15"
+           |
+           |import org.scalatest.*, flatspec.*, matchers.*
+           |
+           |class PiTest extends AnyFlatSpec with should.Matchers {
+           |  "pi calculus" should "return a precise enough pi value" in {
+           |    math.Pi shouldBe 3.14158d +- 0.001d
+           |  }
+           |}
+           |org.scalatest.tools.Runner.main(Array("-oDF", "-s", classOf[PiTest].getName))""".stripMargin
+    )
+    testScriptWrappers(inputs)(expectClassWrapper)
+  }
+
+  for {
+    useDirectives <- Seq(true, false)
+    (directive, options) <- Seq(
+      ("//> using object.wrapper", Seq("--object-wrapper")),
+      ("//> using platform js", Seq("--js"))
+    )
+    wrapperOptions = if (useDirectives) Nil else options
+    testNameSuffix = if (useDirectives) directive else options.mkString(" ")
+  } test(s"BSP object wrapper forced with $testNameSuffix") {
+    val (script1, script2) = "script1.sc" -> "script2.sc"
+    val directiveString    = if (useDirectives) directive else ""
+    val inputs = TestInputs(
+      os.rel / script1 ->
+        s"""$directiveString
+           |
+           |def main(args: String*): Unit = println("Hello")
+           |main()
+           |""".stripMargin,
+      os.rel / script2 ->
+        """println("Hello")
+          |""".stripMargin
+    )
+    testScriptWrappers(inputs, bspOptions = wrapperOptions)(expectObjectWrapper)
+  }
+}

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

@@ -1,3 +1,3 @@
 package scala.cli.integration
 
-class BspTests3Lts extends BspTestDefinitions with Test3Lts
+class BspTests3Lts extends BspTestDefinitions with BspTests3Definitions with Test3Lts

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

@@ -1,3 +1,3 @@
 package scala.cli.integration
 
-class BspTests3NextRc extends BspTestDefinitions with Test3NextRc
+class BspTests3NextRc extends BspTestDefinitions with BspTests3Definitions with Test3NextRc

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

@@ -1,3 +1,3 @@
 package scala.cli.integration
 
-class BspTestsDefault extends BspTestDefinitions with TestDefault
+class BspTestsDefault extends BspTestDefinitions with BspTests3Definitions with TestDefault

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

@@ -0,0 +1,87 @@
+package scala.cli.integration
+
+import ch.epfl.scala.bsp4j as b
+import com.eed3si9n.expecty.Expecty.expect
+
+import scala.async.Async.{async, await}
+import scala.concurrent.ExecutionContext
+import scala.jdk.CollectionConverters.*
+
+trait ScriptWrapperTestDefinitions extends ScalaCliSuite { _: BspTestDefinitions =>
+  private def appWrapperSnippet(wrapperName: String)    = s"object $wrapperName extends App {"
+  private def classWrapperSnippet(wrapperName: String)  = s"final class $wrapperName$$_"
+  private def objectWrapperSnippet(wrapperName: String) = s"object $wrapperName {"
+  def expectScriptWrapper(
+    path: os.Path,
+    containsCheck: String => Boolean,
+    doesNotContainCheck: String => Boolean
+  ): Unit = {
+    val generatedFileContent = os.read(path)
+    assert(
+      containsCheck(generatedFileContent),
+      clue(s"Generated file content: $generatedFileContent")
+    )
+    assert(
+      doesNotContainCheck(generatedFileContent),
+      clue(s"Generated file content: $generatedFileContent")
+    )
+  }
+  def expectAppWrapper(wrapperName: String, path: os.Path): Unit =
+    expectScriptWrapper(
+      path,
+      _.contains(appWrapperSnippet(wrapperName)),
+      content =>
+        !content.contains(classWrapperSnippet(wrapperName)) &&
+        !content.contains(objectWrapperSnippet(wrapperName))
+    )
+
+  def expectObjectWrapper(wrapperName: String, path: os.Path): Unit =
+    expectScriptWrapper(
+      path,
+      _.contains(objectWrapperSnippet(wrapperName)),
+      content =>
+        !content.contains(classWrapperSnippet(wrapperName)) &&
+        !content.contains(appWrapperSnippet(wrapperName))
+    )
+
+  def expectClassWrapper(wrapperName: String, path: os.Path): Unit =
+    expectScriptWrapper(
+      path,
+      _.contains(classWrapperSnippet(wrapperName)),
+      content =>
+        !content.contains(appWrapperSnippet(wrapperName)) &&
+        !content.contains(objectWrapperSnippet(wrapperName))
+    )
+
+  def testScriptWrappers(
+    inputs: TestInputs,
+    bspOptions: Seq[String] = Nil,
+    extraOptionsOverride: Seq[String] = extraOptions
+  )(expectWrapperFunction: (String, os.Path) => Unit)(implicit ec: ExecutionContext): Unit = {
+    withBsp(
+      inputs,
+      inputs.fileNames ++ Seq("--power") ++ bspOptions,
+      extraOptionsOverride = extraOptionsOverride
+    ) {
+      (root, _, remoteServer) =>
+        async {
+          val buildTargetsResp = await(remoteServer.workspaceBuildTargets().asScala)
+          val targets          = buildTargetsResp.getTargets.asScala.map(_.getId).asJava
+          val compileParams    = new b.CompileParams(targets)
+          val buildResp        = await(remoteServer.buildTargetCompile(compileParams).asScala)
+          expect(buildResp.getStatusCode == b.StatusCode.OK)
+          val projectDir = os.list(root / Constants.workspaceDirName).filter(
+            _.baseName.startsWith(root.baseName + "_")
+          )
+          expect(projectDir.size == 1)
+          inputs.fileNames.map(_.stripSuffix(".sc")).foreach {
+            scriptName =>
+              expectWrapperFunction(
+                scriptName,
+                projectDir.head / "src_generated" / "main" / s"$scriptName.scala"
+              )
+          }
+        }
+    }
+  }
+}