Merge pull request #1172 from Gedochao/fix-snippets-for-windows

Fix snippet tests for Windows

Author: romanowski

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

@@ -2004,22 +2004,24 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
 
   test("correctly run a script snippet") {
     emptyInputs.fromRoot { root =>
-      val msg =
-        "123456" // FIXME: change this to a a non-numeric string when Windows encoding is handled properly
-      val res = os.proc(TestUtil.cli, "-e", s"println($msg)", extraOptions).call(cwd = root)
+      val msg       = "Hello world"
+      val quotation = TestUtil.argQuotationMark
+      val res =
+        os.proc(TestUtil.cli, "-e", s"println($quotation$msg$quotation)", extraOptions)
+          .call(cwd = root)
       expect(res.out.text().trim == msg)
     }
   }
 
   test("correctly run a scala snippet") {
     emptyInputs.fromRoot { root =>
-      val msg =
-        "123456" // FIXME: change this to a a non-numeric string when Windows encoding is handled properly
+      val msg       = "Hello world"
+      val quotation = TestUtil.argQuotationMark
       val res =
         os.proc(
           TestUtil.cli,
           "--scala-snippet",
-          s"object Hello extends App { println($msg) }",
+          s"object Hello extends App { println($quotation$msg$quotation) }",
           extraOptions
         )
           .call(cwd = root)
@@ -2029,12 +2031,12 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
 
   test("correctly run a java snippet") {
     emptyInputs.fromRoot { root =>
-      val msg =
-        "123456" // FIXME: change this to a a non-numeric string when Windows encoding is handled properly
+      val quotation = TestUtil.argQuotationMark
+      val msg       = "Hello world"
       val res = os.proc(
         TestUtil.cli,
         "--java-snippet",
-        s"public class Main { public static void main(String[] args) { System.out.println($msg); } }",
+        s"public class Main { public static void main(String[] args) { System.out.println($quotation$msg$quotation); } }",
         extraOptions
       )
         .call(cwd = root)

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

@@ -1,5 +1,7 @@
 package scala.cli.integration
 
+import os.{CommandResult, Path}
+
 import java.io.File
 import java.util.concurrent.atomic.AtomicInteger
 import java.util.concurrent.{ExecutorService, Executors, ScheduledExecutorService, ThreadFactory}
@@ -10,11 +12,11 @@ import scala.util.Properties
 
 object TestUtil {
 
-  val cliKind     = sys.props("test.scala-cli.kind")
-  val isNativeCli = cliKind.startsWith("native")
-  val isCI        = System.getenv("CI") != null
-  val cliPath     = sys.props("test.scala-cli.path")
-  val cli         = cliCommand(cliPath)
+  val cliKind: String      = sys.props("test.scala-cli.kind")
+  val isNativeCli: Boolean = cliKind.startsWith("native")
+  val isCI: Boolean        = System.getenv("CI") != null
+  val cliPath: String      = sys.props("test.scala-cli.path")
+  val cli: Seq[String]     = cliCommand(cliPath)
 
   def cliCommand(cliPath: String): Seq[String] =
     if (isNativeCli)
@@ -23,7 +25,7 @@ object TestUtil {
       Seq("java", "-Xmx512m", "-Xms128m", "-jar", cliPath)
 
   // format: off
-  val extraOptions = List(
+  val extraOptions: List[String] = List(
     "--bloop-startup-timeout", "2min",
     "--bloop-bsp-timeout", "1min"
   )
@@ -58,7 +60,7 @@ object TestUtil {
       .map(_.getAbsolutePath)
   }
 
-  def cs = Constants.cs
+  def cs: String = Constants.cs
 
   def threadPool(prefix: String, size: Int): ExecutorService =
     Executors.newFixedThreadPool(size, daemonThreadFactory(prefix))
@@ -68,9 +70,9 @@ object TestUtil {
 
   private def daemonThreadFactory(prefix: String): ThreadFactory =
     new ThreadFactory {
-      val counter        = new AtomicInteger
-      def threadNumber() = counter.incrementAndGet()
-      def newThread(r: Runnable) =
+      val counter             = new AtomicInteger
+      def threadNumber(): Int = counter.incrementAndGet()
+      def newThread(r: Runnable): Thread =
         new Thread(r, s"$prefix-thread-${threadNumber()}") {
           setDaemon(true)
           setPriority(Thread.NORM_PRIORITY)
@@ -105,21 +107,27 @@ object TestUtil {
 
   def retryOnCi[T](maxAttempts: Int = 3, waitDuration: FiniteDuration = 5.seconds)(
     run: => T
-  ) = retry(if (isCI) maxAttempts else 1, waitDuration)(run)
+  ): T = retry(if (isCI) maxAttempts else 1, waitDuration)(run)
 
   // Same as os.RelPath.toString, but for the use of File.separator instead of "/"
   def relPathStr(relPath: os.RelPath): String =
     (Seq.fill(relPath.ups)("..") ++ relPath.segments).mkString(File.separator)
 
-  def kill(pid: Int) =
+  def kill(pid: Int): CommandResult =
     if (Properties.isWin)
       os.proc("taskkill", "/F", "/PID", pid).call()
     else
       os.proc("kill", pid).call()
 
-  def pwd =
+  def pwd: Path =
     if (Properties.isWin)
       os.Path(os.pwd.toIO.getCanonicalFile)
     else
       os.pwd
+
+  /** @return
+    *   2 quotation marks (") when run for Windows, or a single one otherwise. This is necessary to
+    *   escape the quotation marks passed in args for the Windows command line.
+    */
+  def argQuotationMark: String = if (Properties.isWin) "\"\"" else "\""
 }