Add DebugStepAssert and parsing

Author: adpi2

compiler/test/dotty/tools/debug/DebugStepAssert.scala

@@ -0,0 +1,56 @@
+package dotty.tools.debug
+
+import scala.util.Using
+import scala.io.Source
+import java.nio.charset.StandardCharsets
+import scala.io.Codec
+import dotty.tools.io.JFile
+import java.nio.file.Files
+import dotty.tools.readLines
+
+/**
+ * A debug step and an associated assertion to validate the step.
+ * A sequence of DebugStepAssert is parsed from the check file in tests/debug
+ */
+private[debug] case class DebugStepAssert[T](step: DebugStep[T], assert: T => Unit)
+
+private[debug] object DebugStepAssert:
+  import DebugStep.*
+  def parseCheckFile(checkFile: JFile): Seq[DebugStepAssert[?]] =
+    val sym = "[a-zA-Z0-9$.]+"
+    val line = "\\d+"
+    val break = s"break ($sym) ($line)".r
+    val step = s"step ($sym|$line)".r
+    val next = s"next ($sym|$line)".r
+    val comment = "// .*".r
+    val empty = "\\w*".r
+    readLines(checkFile).flatMap:
+      case break(className , lineStr) =>
+        val line = lineStr.toInt
+        Some(DebugStepAssert(Break(className, line), checkFrame(className, line)))
+      case step(pattern) => Some(DebugStepAssert(Step, checkLineOrMethod(pattern)))
+      case next(pattern) => Some(DebugStepAssert(Step, checkLineOrMethod(pattern)))
+      case comment() | empty() => None
+      case invalid => throw new Exception(s"Cannot parse debug step: $invalid")
+
+  private def checkFrame(className: String, line: Int)(frame: Frame): Unit =
+    assert(className.matches(frame.className))
+    assert(frame.line == line)
+
+  private def checkLineOrMethod(pattern: String): Frame => Unit =
+    if "(\\d+)".r.matches(pattern) then checkLine(pattern.toInt) else checkMethod(pattern)
+
+  private def checkLine(line: Int)(frame: Frame): Unit = assert(frame.line == line)
+
+  private def checkMethod(method: String)(frame: Frame): Unit =
+    assert(method.matches(s"${frame.className}.${frame.methodName}"))
+end DebugStepAssert
+
+private[debug] enum DebugStep[T]:
+  case Break(className: String, line: Int) extends DebugStep[Frame]
+  case Step extends DebugStep[Frame]
+  case Next extends DebugStep[Frame]
+
+private[debug] case class Frame(className: String, methodName: String, line: Int)
+
+

compiler/test/dotty/tools/debug/DebugTests.scala

@@ -42,6 +42,8 @@ object DebugTests extends ParallelTesting:
     private def verifyDebug(dir: JFile, testSource: TestSource, warnings: Int, reporters: Seq[TestReporter], logger: LoggedRunnable) =
       if Properties.testsNoRun then addNoRunWarning()
       else
+        val checkFile = testSource.checkFile.getOrElse(throw new Exception("Missing check file"))
+        val debugSteps = DebugStepAssert.parseCheckFile(checkFile)
         val status = debugMain(testSource.runClassPath): debuggee =>
           val debugger = Debugger(debuggee.jdiPort, maxDuration)
           try debuggee.launch()

compiler/test/dotty/tools/dotc/coverage/CoverageTests.scala

@@ -110,9 +110,8 @@ class CoverageTests:
     if run then
       val path = if isDirectory then inputFile.toString else inputFile.getParent.toString
       val test = compileDir(path, options)
-      test.checkFilePaths.foreach { checkFilePath =>
-        assert(checkFilePath.exists, s"Expected checkfile for $path $checkFilePath does not exist.")
-      }
+      test.checkFiles.foreach: checkFile =>
+        assert(checkFile.exists, s"Expected checkfile for $path $checkFile does not exist.")
       test.checkRuns()
     else
       val test =

compiler/test/dotty/tools/vulpix/ParallelTesting.scala

@@ -70,6 +70,7 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     def outDir: JFile
     def flags: TestFlags
     def sourceFiles: Array[JFile]
+    def checkFile: Option[JFile]
 
     def runClassPath: String = outDir.getPath + JFile.pathSeparator + flags.runClassPath
 
@@ -183,6 +184,10 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     decompilation: Boolean = false
   ) extends TestSource {
     def sourceFiles: Array[JFile] = files.filter(isSourceFile)
+
+    def checkFile: Option[JFile] =
+      sourceFiles.map(f => new JFile(f.getPath.replaceFirst("\\.(scala|java)$", ".check")))
+        .find(_.exists())
   }
 
   /** A test source whose files will be compiled separately according to their
@@ -214,6 +219,12 @@ trait ParallelTesting extends RunnerOrchestration { self =>
         .map { (g, f) => (g, f.sorted) }
 
     def sourceFiles = compilationGroups.map(_._2).flatten.toArray
+
+    def checkFile: Option[JFile] =
+      val platform =
+        if allToolArgs.getOrElse(ToolName.Target, Nil).nonEmpty then s".$testPlatform"
+        else ""
+      Some(new JFile(dir.getPath + platform + ".check")).filter(_.exists)
   }
 
   protected def shouldSkipTestSource(testSource: TestSource): Boolean = false
@@ -259,12 +270,6 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     final def countWarnings(reporters: Seq[TestReporter]) = countErrorsAndWarnings(reporters)._2
     final def reporterFailed(r: TestReporter) = r.errorCount > 0
 
-    /**
-     * For a given test source, returns a check file against which the result of the test run
-     * should be compared. Is used by implementations of this trait.
-     */
-    final def checkFile(testSource: TestSource): Option[JFile] = (CompilationLogic.checkFilePath(testSource)).filter(_.exists)
-
     /**
      * Checks if the given actual lines are the same as the ones in the check file.
      * If not, fails the test.
@@ -340,22 +345,6 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     }
   }
 
-  object CompilationLogic {
-    private[ParallelTesting] def checkFilePath(testSource: TestSource) = testSource match {
-      case ts: JointCompilationSource =>
-        ts.files.collectFirst {
-          case f if !f.isDirectory =>
-            new JFile(f.getPath.replaceFirst("\\.(scala|java)$", ".check"))
-        }
-      case ts: SeparateCompilationSource =>
-        val platform =
-          if testSource.allToolArgs.getOrElse(ToolName.Target, Nil).nonEmpty then
-            s".$testPlatform"
-          else ""
-        Option(new JFile(ts.dir.getPath + platform + ".check"))
-    }
-  }
-
   /** Each `Test` takes the `testSources` and performs the compilation and assertions
    *  according to the implementing class "neg", "run" or "pos".
    */
@@ -735,7 +724,7 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     private def mkReporter = TestReporter.reporter(realStdout, logLevel = mkLogLevel)
 
     protected def diffCheckfile(testSource: TestSource, reporters: Seq[TestReporter], logger: LoggedRunnable) =
-      checkFile(testSource).foreach(diffTest(testSource, _, reporterOutputLines(reporters), reporters, logger))
+      testSource.checkFile.foreach(diffTest(testSource, _, reporterOutputLines(reporters), reporters, logger))
 
     private def reporterOutputLines(reporters: Seq[TestReporter]): List[String] =
       reporters.flatMap(_.consoleOutput.split("\n")).toList
@@ -938,7 +927,7 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     }
 
     override def onSuccess(testSource: TestSource, reporters: Seq[TestReporter], logger: LoggedRunnable) =
-      verifyOutput(checkFile(testSource), testSource.outDir, testSource, countWarnings(reporters), reporters, logger)
+      verifyOutput(testSource.checkFile, testSource.outDir, testSource, countWarnings(reporters), reporters, logger)
   }
 
   private final class NegTest(testSources: List[TestSource], times: Int, threadLimit: Option[Int], suppressAllOutput: Boolean)(implicit summaryReport: SummaryReporting)
@@ -1177,7 +1166,7 @@ trait ParallelTesting extends RunnerOrchestration { self =>
     def this(targets: List[TestSource]) =
       this(targets, 1, true, None, false, false)
 
-    def checkFilePaths: List[JFile] = targets.map(CompilationLogic.checkFilePath).flatten
+    def checkFiles: List[JFile] = targets.flatMap(_.checkFile)
 
     def copy(targets: List[TestSource],
       times: Int = times,

compiler/test/dotty/tools/vulpix/RunnerOrchestration.scala

@@ -56,9 +56,9 @@ trait RunnerOrchestration {
     monitor.runMain(classPath)
 
   trait Debuggee:
-    // the jdi port to connect the debugger
+    /** the jdi port to connect the debugger */
     def jdiPort: Int
-    // start the main method in the background
+    /** start the main method in the background */
     def launch(): Unit
 
   /** Provide a Debuggee for debugging the Test class's main method

tests/debug/for.check

@@ -0,0 +1,3 @@
+break Test$ 3
+step 4
+step 10

tests/debug/function.check

@@ -0,0 +1,9 @@
+break Test$ 4
+step 5
+step 10
+break Test$ 6
+step 7
+step 8
+next 9
+next 10
+next 11

tests/debug/if.check

@@ -0,0 +1,8 @@
+break Test$ 4
+step 5
+step 6
+step 8
+step 9
+step 13
+step 16
+step 18

tests/debug/method.check

@@ -0,0 +1,8 @@
+break Test$ 3
+step 4
+step 5
+step 10
+step 11
+step 12
+step 5
+step 6

tests/debug/nested-method.check

@@ -0,0 +1,8 @@
+break Test$ 3
+step 4
+step 12
+step 7
+step 8
+step 9
+step 12
+step 13

tests/debug/sequence.check

@@ -0,0 +1,7 @@
+break Test$ 3
+step 4
+step 5
+step 6
+step 7
+step 8
+step 9

tests/debug/tailrec.check

@@ -0,0 +1,11 @@
+break Test$ 12
+step 13
+step 3
+step 6
+step 3
+break Test$ 14
+step 3
+step 4
+// incorrect debug line
+step 6
+step 15

tests/debug/while.check

@@ -0,0 +1,5 @@
+break Test$ 6
+step 8
+step 9
+step 8
+break Test$ 12