Added integration tests which run in client-server mode (#1835)

Pull request: #1835

.github/workflows/actions.yml

@@ -20,13 +20,11 @@ jobs:
           # unit and module tests
           - ./mill -i -k "{main,scalalib,scalajslib,scalanativelib,testrunner,bsp}.__.test"
           # additional integration tests
-          - ./mill -i -k "integration.{local,forked}"
+          - ./mill -i -k "integration.{local,forked,forked-server}"
           # integrtion tests of thirdparty repos
           - ./mill -i -k "integration.thirdparty.{local,forked}"
           # contrib tests
           - ./mill -i -k "contrib._.test"
-          # - ./mill -i integration.test "mill.integration.local.JawnTests"
-          #- ./mill -i integration.test "mill.integration.local.{AcyclicTests,AmmoniteTests}"
           - ./mill -i docs.antora.githubPages
         include:
           # Just some reporting to enable reasoning about library upgrades
@@ -91,7 +89,7 @@ jobs:
         buildcmd:
           - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "{__.publishLocal,assembly,__.compile}"
           - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "{main,scalalib,scalajslib,bsp}.__.test"
-          - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "integration.{local,forked}"
+          - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "integration.{local,forked,forked-server}"
           - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "integration.thirdparty.{local,forked}"
           - cmd /C %GITHUB_WORKSPACE%\ci\mill.bat -i -d -k "contrib.__.test"
 

build.sc

@@ -906,13 +906,15 @@ object integration extends MillScalaModule {
 
   // Integration test of Mill
   object local extends ITests
-  object forked extends ITests {
+  trait Forked extends ITests {
     override def moduleDeps: Seq[JavaModule] = super.moduleDeps ++ Seq(integration.local)
 
     override def forkEnv: Target[Map[String, String]] = super.forkEnv() ++ Map(
       "MILL_TEST_RELEASE" -> testMill().path.toString()
     )
   }
+  object forked extends Forked
+  object `forked-server` extends Forked
 
   // Test of various third-party repositories
   object thirdparty extends Module {

integration/forked-server/src/forked-server-tests.scala

@@ -0,0 +1,8 @@
+package mill.integration
+package forked.server
+
+object DocAnnotationsTests extends DocAnnotationsTests(fork = true, clientServer = true)
+object HygieneTests extends HygieneTests(fork = true, clientServer = true)
+object LargeProjectTests extends LargeProjectTests(fork = true, clientServer = true)
+object ScriptsInvalidationTests extends ScriptsInvalidationTests(fork = true, clientServer = true)
+object ScriptsInvalidationForeignTests extends ScriptsInvalidationForeignTests(fork = true, clientServer = true)

integration/forked/src/forked-tests.scala

@@ -0,0 +1,8 @@
+package mill.integration
+package forked
+
+object DocAnnotationsTests extends DocAnnotationsTests(fork = true, clientServer = false)
+object HygieneTests extends HygieneTests(fork = true, clientServer = false)
+object LargeProjectTests extends LargeProjectTests(fork = true, clientServer = false)
+object ScriptsInvalidationTests extends ScriptsInvalidationTests(fork = true, clientServer = false)
+object ScriptsInvalidationForeignTests extends ScriptsInvalidationForeignTests(fork = true, clientServer = false)

integration/local/src/DocAnnotationsTests.scala

@@ -3,7 +3,8 @@ package mill.integration
 import mill.util.ScriptTestSuite
 import utest._
 
-class DocAnnotationsTests(fork: Boolean) extends IntegrationTestSuite("docannotations", fork) {
+class DocAnnotationsTests(fork: Boolean, clientServer: Boolean)
+    extends IntegrationTestSuite("docannotations", fork, clientServer) {
   val tests = Tests {
     initWorkspace()
     "test" - {

integration/local/src/HygieneTests.scala

@@ -3,7 +3,8 @@ package mill.integration
 import mill.util.ScriptTestSuite
 import utest._
 
-class HygieneTests(fork: Boolean) extends IntegrationTestSuite("hygiene", fork) {
+class HygieneTests(fork: Boolean, clientServer: Boolean)
+    extends IntegrationTestSuite("hygiene", fork, clientServer) {
   val tests = Tests {
     initWorkspace()
 

integration/local/src/IntegrationTestSuite.scala

@@ -3,7 +3,7 @@ package mill.integration
 import mill.util.ScriptTestSuite
 import utest._
 
-abstract class IntegrationTestSuite(override val workspaceSlug: String, fork: Boolean)
+abstract class IntegrationTestSuite(override val workspaceSlug: String, fork: Boolean, clientServer: Boolean = false)
     extends ScriptTestSuite(fork) {
 
   override def workspacePath: os.Path =

integration/local/src/LargeProjectTests.scala

@@ -3,7 +3,8 @@ package mill.integration
 import mill.util.ScriptTestSuite
 import utest._
 
-class LargeProjectTests(fork: Boolean) extends IntegrationTestSuite("large-project", fork) {
+class LargeProjectTests(fork: Boolean, clientServer: Boolean)
+    extends IntegrationTestSuite("large-project", fork, clientServer) {
   val tests = Tests {
     initWorkspace()
     "test" - {

integration/local/src/ScriptsInvalidationForeignTests.scala

@@ -6,7 +6,8 @@ import utest._
 
 import scala.collection.mutable
 
-class ScriptsInvalidationForeignTests(fork: Boolean) extends IntegrationTestSuite("invalidation-foreign", fork) {
+class ScriptsInvalidationForeignTests(fork: Boolean, clientServer: Boolean)
+    extends IntegrationTestSuite("invalidation-foreign", fork, clientServer) {
 
   override def buildPath = os.sub / "foreignA" / "build.sc"
 

integration/local/src/ScriptsInvalidationTests.scala

@@ -5,7 +5,8 @@ import utest._
 
 import scala.collection.mutable
 
-class ScriptsInvalidationTests(fork: Boolean) extends IntegrationTestSuite("invalidation", fork) {
+class ScriptsInvalidationTests(fork: Boolean, clientServer: Boolean)
+    extends IntegrationTestSuite("invalidation", fork, clientServer) {
 
   def runTask(task: String) = {
     val (successful, stdout) = evalStdout(task)

integration/local/src/local/Tests.scala → integration/local/src/local/local-tests.scala

@@ -1,8 +1,8 @@
 package mill.integration
 package local
 
-object DocAnnotationsTests extends DocAnnotationsTests(fork = false)
-object HygieneTests extends HygieneTests(fork = false)
-object LargeProjectTests extends LargeProjectTests(fork = false)
-object ScriptsInvalidationTests extends ScriptsInvalidationTests(fork = false)
-object ScriptsInvalidationForeignTests extends ScriptsInvalidationForeignTests(fork = false)
+object DocAnnotationsTests extends DocAnnotationsTests(fork = false, false)
+object HygieneTests extends HygieneTests(fork = false, false)
+object LargeProjectTests extends LargeProjectTests(fork = false, false)
+object ScriptsInvalidationTests extends ScriptsInvalidationTests(fork = false, false)
+object ScriptsInvalidationForeignTests extends ScriptsInvalidationForeignTests(fork = false, false)

main/test/src/util/ScriptTestSuite.scala

@@ -9,8 +9,9 @@ import os.Path
 import utest._
 
 import java.nio.file.NoSuchFileException
+import scala.util.control.NonFatal
 
-abstract class ScriptTestSuite(fork: Boolean) extends TestSuite {
+abstract class ScriptTestSuite(fork: Boolean, clientServer: Boolean = false) extends TestSuite {
   def workspaceSlug: String
   def scriptSourcePath: os.Path
   def buildPath: os.SubPath = os.sub / "build.sc"
@@ -90,18 +91,35 @@ abstract class ScriptTestSuite(fork: Boolean) extends TestSuite {
       throw new NoSuchFileException(s"Mill binary to use for test not found under: ${millRelease}")
     }
 
+    val extraArgs = if (clientServer) Seq() else Seq("--no-server")
+    val env = Map("MILL_TEST_SUITE" -> this.getClass().toString())
+
     try {
-      os.proc(millReleaseFile, "-i", s).call(
-        wd,
+      os.proc(millReleaseFile, extraArgs, s).call(
+        cwd = wd,
         stdin = os.Inherit,
         stdout = stdout,
-        stderr = os.Inherit
+        stderr = os.Inherit,
+        env = env
       )
+      if (clientServer) {
+        // try to stop the server
+        try {
+          os.proc(millReleaseFile, "shutdown").call(
+            cwd = wd,
+            stdin = os.Inherit,
+            stdout = stdout,
+            stderr = os.Inherit,
+            env = env
+          )
+        } catch { case NonFatal(_) => }
+      }
       true
-    } catch { case e: Throwable => false }
+    } catch { case NonFatal(_) => false }
   }
   def meta(s: String): String = {
-    val Seq((List(selector), _)) = mill.define.ParseArgs.apply(Seq(s), SelectMode.Single).getOrElse(???)
+    val Seq((List(selector), _)) =
+      mill.define.ParseArgs.apply(Seq(s), SelectMode.Single).getOrElse(???)
 
     val segments = selector._2.value.flatMap(_.pathSegments)
     os.read(wd / "out" / segments.init / s"${segments.last}.json")