Merge pull request #99 from retronym/ticket/75

Add a mode to reuse JVM for test execution

Author: retronym

src/main/scala/scala/tools/partest/PartestDefaults.scala

@@ -15,8 +15,18 @@ object PartestDefaults {
 
   def testBuild   = prop("partest.build")
   def errorCount  = prop("partest.errors")  map (_.toInt) getOrElse 0
-  def numThreads  = prop("partest.threads") map (_.toInt) getOrElse runtime.availableProcessors
+  def numThreads  = math.max(1, prop("partest.threads") map (_.toInt) getOrElse runtime.availableProcessors)
+  def execInProcess: Boolean = {
+    val prop = java.lang.Boolean.getBoolean("partest.exec.in.process")
+    if (prop && numThreads > 1) warningMessage
+    prop
+  }
+  private lazy val warningMessage: Unit = {
+    println("Note: test execution will be non-parallel under -Dpartest.exec.in.process")
+  }
+
   def waitTime    = Duration(prop("partest.timeout") getOrElse "4 hours")
+  def printDurationThreshold = java.lang.Integer.getInteger("partest.print.duration.threshold.ms", 5000)
 
   //def timeout     = "1200000"   // per-test timeout
 

src/main/scala/scala/tools/partest/nest/DelegatingSecurityManager.scala

@@ -0,0 +1,34 @@
+package scala.tools.partest.nest
+
+import java.io.FileDescriptor
+import java.net.InetAddress
+import java.security.Permission
+
+class DelegatingSecurityManager(delegate: SecurityManager) extends SecurityManager {
+  override def checkExit(status: Int): Unit = if (delegate ne null) delegate.checkExit(status)
+  override def checkPermission(perm: Permission): Unit = if (delegate ne null) delegate.checkPermission(perm)
+  override def checkPermission(perm: Permission, context: AnyRef): Unit = if (delegate ne null) delegate.checkPermission(perm, context)
+  override def checkExec(cmd: String): Unit = if (delegate ne null) delegate.checkExec(cmd)
+  override def checkWrite(file: String): Unit = if (delegate ne null) delegate.checkWrite(file)
+  override def checkDelete(file: String): Unit = if (delegate ne null) delegate.checkDelete(file)
+  override def checkRead(file: String): Unit = if (delegate ne null) delegate.checkRead(file)
+  override def checkRead(file: String, context: scala.Any): Unit = if (delegate ne null) delegate.checkRead(file, context)
+  override def checkPropertyAccess(key: String): Unit = if (delegate ne null) delegate.checkPropertyAccess(key)
+  override def checkAccept(host: String, port: Int): Unit = if (delegate ne null) delegate.checkAccept(host, port)
+  override def checkWrite(fd: FileDescriptor): Unit = if (delegate ne null) delegate.checkWrite(fd)
+  override def checkPrintJobAccess(): Unit = if (delegate ne null) delegate.checkPrintJobAccess()
+  override def checkMulticast(maddr: InetAddress): Unit = if (delegate ne null) delegate.checkMulticast(maddr)
+  override def checkSetFactory(): Unit = if (delegate ne null) delegate.checkSetFactory()
+  override def checkLink(lib: String): Unit = if (delegate ne null) delegate.checkLink(lib)
+  override def checkSecurityAccess(target: String): Unit = if (delegate ne null) delegate.checkSecurityAccess(target)
+  override def checkListen(port: Int): Unit = if (delegate ne null) delegate.checkListen(port)
+  override def checkAccess(t: Thread): Unit = if (delegate ne null) delegate.checkAccess(t)
+  override def checkAccess(g: ThreadGroup): Unit = if (delegate ne null) delegate.checkAccess(g)
+  override def checkCreateClassLoader(): Unit = if (delegate ne null) delegate.checkCreateClassLoader()
+  override def checkPackageDefinition(pkg: String): Unit = if (delegate ne null) delegate.checkPackageDefinition(pkg)
+  override def checkConnect(host: String, port: Int): Unit = if (delegate ne null) delegate.checkConnect(host, port)
+  override def checkConnect(host: String, port: Int, context: scala.Any): Unit = if (delegate ne null) delegate.checkConnect(host, port, context)
+  override def checkPackageAccess(pkg: String): Unit = if (delegate ne null) delegate.checkPackageAccess(pkg)
+  override def checkPropertiesAccess(): Unit = if (delegate ne null) delegate.checkPropertiesAccess()
+  override def checkRead(fd: FileDescriptor): Unit = if (delegate ne null) delegate.checkRead(fd)
+}

src/main/scala/scala/tools/partest/nest/NestUI.scala

@@ -52,7 +52,7 @@ class NestUI(val verbose: Boolean = false, val debug: Boolean = false, val terse
     }
   }
 
-  def statusLine(state: TestState) = {
+  def statusLine(state: TestState, durationMs: Long) = {
     import state._
     import TestState._
     val colorizer = state match {
@@ -62,10 +62,11 @@ class NestUI(val verbose: Boolean = false, val debug: Boolean = false, val terse
       case _           => red
     }
     val word = bold(colorizer(state.shortStatus))
-    f"$word $testNumber - $testIdent%-40s$reasonString"
+    def durationString = if (durationMs > PartestDefaults.printDurationThreshold) f"[duration ${(1.0 * durationMs) / 1000}%.2fs]" else ""
+    f"$word $testNumber - $testIdent%-40s$reasonString$durationString"
   }
 
-  def reportTest(state: TestState, info: TestInfo): Unit = {
+  def reportTest(state: TestState, info: TestInfo, durationMs: Long): Unit = {
     if (terse && state.isOk) {
       if (dotCount >= DotWidth) {
         outline("\n.")
@@ -75,7 +76,7 @@ class NestUI(val verbose: Boolean = false, val debug: Boolean = false, val terse
         dotCount += 1
       }
     } else {
-      echo(statusLine(state))
+      echo(statusLine(state, durationMs))
       if (!state.isOk) {
         def showLog() = if (info.logFile.canRead) {
           echo(bold(cyan(s"##### Log file '${info.logFile}' from failed test #####\n")))

src/main/scala/scala/tools/partest/nest/Runner.scala

@@ -5,24 +5,29 @@
 package scala.tools.partest
 package nest
 
-import java.io.{ Console => _, _ }
+import java.io.{Console => _, _}
+import java.lang.reflect.InvocationTargetException
+import java.nio.charset.Charset
+import java.nio.file.{Files, StandardOpenOption}
 import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 import java.util.concurrent.TimeUnit.NANOSECONDS
+
 import scala.collection.mutable.ListBuffer
 import scala.concurrent.duration.Duration
 import scala.reflect.internal.FatalError
 import scala.reflect.internal.util.ScalaClassLoader
-import scala.sys.process.{ Process, ProcessLogger }
-import scala.tools.nsc.Properties.{ envOrNone, isWin, javaHome, propOrEmpty, versionMsg, javaVmName, javaVmVersion, javaVmInfo }
-import scala.tools.nsc.{ Settings, CompilerCommand, Global }
+import scala.sys.process.{Process, ProcessLogger}
+import scala.tools.nsc.Properties.{envOrNone, isWin, javaHome, javaVmInfo, javaVmName, javaVmVersion, propOrEmpty, versionMsg}
+import scala.tools.nsc.{CompilerCommand, Global, Settings}
 import scala.tools.nsc.reporters.ConsoleReporter
 import scala.tools.nsc.util.stackTraceString
-import scala.util.{ Try, Success, Failure }
+import scala.util.{Failure, Success, Try}
 import ClassPath.join
-import TestState.{ Pass, Fail, Crash, Uninitialized, Updated }
-
-import FileManager.{ compareContents, joinPaths, withTempFile }
+import TestState.{Crash, Fail, Pass, Uninitialized, Updated}
+import FileManager.{compareContents, joinPaths, withTempFile}
+import scala.reflect.internal.util.ScalaClassLoader.URLClassLoader
+import scala.util.control.ControlThrowable
 
 trait TestInfo {
   /** pos/t1234 */
@@ -53,6 +58,7 @@ trait TestInfo {
 
 /** Run a single test. Rubber meets road. */
 class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestUI) extends TestInfo {
+  private val stopwatch = new Stopwatch()
 
   import suiteRunner.{fileManager => fm, _}
   val fileManager = fm
@@ -125,9 +131,7 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     )
 
     pushTranscript(args mkString " ")
-    val captured = StreamCapture(runCommand(args, logFile))
-    if (captured.result) genPass() else {
-      logFile appendAll captured.stderr
+    if (runCommand(args, logFile)) genPass() else {
       genFail("java compilation failed")
     }
   }
@@ -157,8 +161,6 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     if (javaopts.nonEmpty)
       nestUI.verbose(s"Found javaopts file '$argsFile', using options: '${javaopts.mkString(",")}'")
 
-    val testFullPath = testFile.getAbsolutePath
-
     // Note! As this currently functions, suiteRunner.javaOpts must precede argString
     // because when an option is repeated to java only the last one wins.
     // That means until now all the .javaopts files were being ignored because
@@ -167,30 +169,15 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     //
     // debug: Found javaopts file 'files/shootout/message.scala-2.javaopts', using options: '-Xss32k'
     // debug: java -Xss32k -Xss2m -Xms256M -Xmx1024M -classpath [...]
-    val extras = if (nestUI.debug) List("-Dpartest.debug=true") else Nil
-    val propertyOptions = List(
-      "-Dfile.encoding=UTF-8",
-      "-Djava.library.path="+logFile.getParentFile.getAbsolutePath,
-      "-Dpartest.output="+outDir.getAbsolutePath,
-      "-Dpartest.lib="+libraryUnderTest.getAbsolutePath,
-      "-Dpartest.reflect="+reflectUnderTest.getAbsolutePath,
-      "-Dpartest.comp="+compilerUnderTest.getAbsolutePath,
-      "-Dpartest.cwd="+outDir.getParent,
-      "-Dpartest.test-path="+testFullPath,
-      "-Dpartest.testname="+fileBase,
-      "-Djavacmd="+javaCmdPath,
-      "-Djavaccmd="+javacCmdPath,
-      "-Duser.language=en",
-      "-Duser.country=US"
-    ) ++ extras
+    val propertyOpts = propertyOptions(fork = true).map { case (k, v) => s"-D$k=$v" }
 
     val classpath = joinPaths(extraClasspath ++ testClassPath)
 
     javaCmdPath +: (
       (suiteRunner.javaOpts.split(' ') ++ extraJavaOptions ++ javaopts).filter(_ != "").toList ++ Seq(
         "-classpath",
         join(outDir.toString, classpath)
-      ) ++ propertyOptions ++ Seq(
+      ) ++ propertyOpts ++ Seq(
         "scala.tools.nsc.MainGenericRunner",
         "-usejavacp",
         "Test",
@@ -199,6 +186,40 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     )
   }
 
+  def propertyOptions(fork: Boolean): List[(String, String)] = {
+    val testFullPath = testFile.getAbsolutePath
+    val extras =   if (nestUI.debug) List("partest.debug" -> "true") else Nil
+    val immutablePropsToCheck = List[(String, String)](
+      "file.encoding" -> "UTF-8",
+      "user.language" -> "en",
+      "user.country" -> "US"
+    )
+    val immutablePropsForkOnly = List[(String, String)](
+      "java.library.path" -> logFile.getParentFile.getAbsolutePath,
+    )
+    val shared = List(
+      "partest.output" -> ("" + outDir.getAbsolutePath),
+      "partest.lib" -> ("" + libraryUnderTest.jfile.getAbsolutePath),
+      "partest.reflect" -> ("" + reflectUnderTest.jfile.getAbsolutePath),
+      "partest.comp" -> ("" + compilerUnderTest.jfile.getAbsolutePath),
+      "partest.cwd" -> ("" + outDir.getParent),
+      "partest.test-path" -> ("" + testFullPath),
+      "partest.testname" -> ("" + fileBase),
+      "javacmd" -> ("" + javaCmdPath),
+      "javaccmd" -> ("" + javacCmdPath),
+    ) ++ extras
+    if (fork) {
+      immutablePropsToCheck ++ immutablePropsForkOnly ++ shared
+    } else {
+      for ((k, requiredValue) <- immutablePropsToCheck) {
+        val actual = System.getProperty(k)
+        assert(actual == requiredValue, s"Unable to run test without forking as the current JVM has an incorrect system property. For $k, found $actual, required $requiredValue")
+      }
+      shared
+    }
+  }
+
+
   /** Runs command redirecting standard out and
    *  error out to output file.
    */
@@ -235,6 +256,50 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     }
   }
 
+  def execTestInProcess(classesDir: File, log: File): Boolean = {
+    stopwatch.pause()
+    suiteRunner.synchronized {
+      stopwatch.start()
+      def run(): Unit = {
+        StreamCapture.withExtraProperties(propertyOptions(fork = false).toMap) {
+          try {
+            val out = Files.newOutputStream(log.toPath, StandardOpenOption.APPEND)
+            try {
+              val loader = new URLClassLoader(classesDir.toURI.toURL :: Nil, getClass.getClassLoader)
+              StreamCapture.capturingOutErr(out) {
+                val cls = loader.loadClass("Test")
+                val main = cls.getDeclaredMethod("main", classOf[Array[String]])
+                try {
+                  main.invoke(null, Array[String]("jvm"))
+                } catch {
+                  case ite: InvocationTargetException => throw ite.getCause
+                }
+              }
+            }  finally {
+              out.close()
+            }
+          } catch {
+            case t: ControlThrowable => throw t
+            case t: Throwable =>
+              // We'll let the checkfile diffing report this failure
+              Files.write(log.toPath, stackTraceString(t).getBytes(Charset.defaultCharset()), StandardOpenOption.APPEND)
+          }
+        }
+      }
+
+      pushTranscript(s"<in process execution of $testIdent> > ${logFile.getName}")
+
+      TrapExit(() => run()) match {
+        case Left((status, throwable)) if status != 0 =>
+          setLastState(genFail("non-zero exit code"))
+          false
+        case _ =>
+          setLastState(genPass())
+          true
+      }
+    }
+  }
+
   override def toString = s"""Test($testIdent, lastState = $lastState)"""
 
   // result is unused
@@ -641,9 +706,10 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
     (diffIsOk, LogContext(logFile, swr, wr))
   }
 
-  def run(): TestState = {
+  def run(): (TestState, Long) = {
     // javac runner, for one, would merely append to an existing log file, so just delete it before we start
     logFile.delete()
+    stopwatch.start()
 
     if (kind == "neg" || (kind endsWith "-neg")) runNegTest()
     else kind match {
@@ -652,10 +718,18 @@ class Runner(val testFile: File, val suiteRunner: SuiteRunner, val nestUI: NestU
       case "res"          => runResidentTest()
       case "scalap"       => runScalapTest()
       case "script"       => runScriptTest()
-      case _              => runTestCommon(execTest(outDir, logFile) && diffIsOk)
+      case _              => runRunTest()
     }
 
-    lastState
+    (lastState, stopwatch.stop)
+  }
+
+  private def runRunTest(): Unit = {
+    val argsFile  = testFile changeExtension "javaopts"
+    val javaopts = readOptionsFile(argsFile)
+    val execInProcess = PartestDefaults.execInProcess && javaopts.isEmpty && !Set("specialized", "instrumented").contains(testFile.getParentFile.getName)
+    def exec() = if (execInProcess) execTestInProcess(outDir, logFile) else execTest(outDir, logFile)
+    runTestCommon(exec() && diffIsOk)
   }
 
   private def decompileClass(clazz: Class[_], isPackageObject: Boolean): String = {
@@ -738,6 +812,8 @@ class SuiteRunner(
   // TODO: make this immutable
   PathSettings.testSourcePath = testSourcePath
 
+  val durations = collection.concurrent.TrieMap[File, Long]()
+
   def banner = {
     val baseDir = fileManager.compilerUnderTest.parent.toString
     def relativize(path: String) = path.replace(baseDir, s"$$baseDir").replace(PathSettings.srcDir.toString, "$sourceDir")
@@ -759,29 +835,35 @@ class SuiteRunner(
     // |Java Classpath:             ${sys.props("java.class.path")}
   }
 
-  def onFinishTest(testFile: File, result: TestState, durationMs: Long): TestState = result
+  def onFinishTest(testFile: File, result: TestState, durationMs: Long): TestState = {
+    durations(testFile) = durationMs
+    result
+  }
 
   def runTest(testFile: File): TestState = {
     val start = System.nanoTime()
     val runner = new Runner(testFile, this, nestUI)
+    var stopwatchDuration: Option[Long] = None
 
     // when option "--failed" is provided execute test only if log
     // is present (which means it failed before)
     val state =
       if (failed && !runner.logFile.canRead)
         runner.genPass()
       else {
-        val (state, _) =
-          try timed(runner.run())
+        val (state, durationMs) =
+          try runner.run()
           catch {
             case t: Throwable => throw new RuntimeException(s"Error running $testFile", t)
           }
-        nestUI.reportTest(state, runner)
+        stopwatchDuration = Some(durationMs)
+        nestUI.reportTest(state, runner, durationMs)
         runner.cleanup()
         state
       }
     val end = System.nanoTime()
-    onFinishTest(testFile, state, TimeUnit.NANOSECONDS.toMillis(end - start))
+    val durationMs = stopwatchDuration.getOrElse(TimeUnit.NANOSECONDS.toMillis(end - start))
+    onFinishTest(testFile, state, durationMs)
   }
 
   def runTestsForFiles(kindFiles: Array[File], kind: String): Array[TestState] = {

src/main/scala/scala/tools/partest/nest/Stopwatch.scala

@@ -0,0 +1,24 @@
+package scala.tools.partest.nest
+
+/**
+  * Measured elapsed time between between calls to `start` and `stop`.
+  * May be `pause`-ed and re-`started` before `stop` is eventually called.
+  */
+final class Stopwatch {
+  private var base: Option[Long] = None
+  private var elapsed = 0L
+  def pause(): Unit = {
+    assert(base.isDefined)
+    val now = System.nanoTime
+    elapsed += (now - base.get)
+    base = None
+  }
+  def start(): Unit = {
+    base = Some(System.nanoTime())
+  }
+
+  def stop(): Long = {
+    pause()
+    (1.0 * elapsed / 1000 / 1000).toLong
+  }
+}