Add updateCheckFiles to override tests check files with output

Also updated `testFromTasty` checkfiles using it to remove first comment line
which cannot be tested on Windows adn added missing EOLs.

Author: nicolasstucki

compiler/test/dotty/tools/dotc/CompilationTests.scala

@@ -303,7 +303,7 @@ class CompilationTests extends ParallelTesting {
 }
 
 object CompilationTests {
-  implicit val summaryReport: SummaryReporting = new SummaryReport
+  implicit val summaryReport: SummaryReporting = new SummaryReport(updateCheckFiles = false)
   @AfterClass def cleanup(): Unit = summaryReport.echoSummary()
 
   def sources(paths: JStream[Path], excludedFiles: List[String] = Nil): List[String] = {

compiler/test/dotty/tools/dotc/FromTastyTests.scala

@@ -51,6 +51,6 @@ class FromTastyTests extends ParallelTesting {
 }
 
 object FromTastyTests {
-  implicit val summaryReport: SummaryReporting = new SummaryReport
+  implicit val summaryReport: SummaryReporting = new SummaryReport(updateCheckFiles = false)
   @AfterClass def cleanup(): Unit = summaryReport.echoSummary()
 }

compiler/test/dotty/tools/dotc/IdempotencyTests.scala

@@ -72,6 +72,6 @@ class IdempotencyTests extends ParallelTesting {
 }
 
 object IdempotencyTests {
-  implicit val summaryReport: SummaryReporting = new SummaryReport
+  implicit val summaryReport: SummaryReporting = new SummaryReport(updateCheckFiles = false)
   @AfterClass def cleanup(): Unit = summaryReport.echoSummary()
 }

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

@@ -505,6 +505,12 @@ trait ParallelTesting extends RunnerOrchestration { self =>
       this
     }
 
+    protected def updateCheckFile(checkFile: JFile, lines: Seq[String]): Unit = {
+      val outFile = dotty.tools.io.File(checkFile.toPath)
+      outFile.writeAll(lines.mkString("", EOL, EOL))
+      echo("Updated checkfile: " + checkFile.getPath)
+    }
+
     /** Returns all files in directory or the file if not a directory */
     private def flattenFiles(f: JFile): Array[JFile] =
       if (f.isDirectory) f.listFiles.flatMap(flattenFiles)
@@ -537,28 +543,32 @@ trait ParallelTesting extends RunnerOrchestration { self =>
                     val output = Source.fromFile(outDir.getParent + "_decompiled" + JFile.separator + outDir.getName
                       + JFile.separator + "decompiled.scala", "UTF-8").getLines().map {line =>
                       stripTrailingWhitespaces.unapplySeq(line).map(_.head).getOrElse(line)
-                    }.toList
+                    }.filter(!_.startsWith(ignoredFilePathLine)).toList
 
-                    val check: String = Source.fromFile(checkFile, "UTF-8").getLines().filter(!_.startsWith(ignoredFilePathLine))
+                    val check: String = Source.fromFile(checkFile, "UTF-8").getLines()
                       .mkString(EOL)
 
-                    if (output.filter(!_.startsWith(ignoredFilePathLine)).mkString(EOL) != check) {
+                    if (output.mkString(EOL) != check) {
                       val outFile = dotty.tools.io.File(checkFile.toPath).addExtension(".out")
-                      outFile.writeAll(output.mkString(EOL))
-                      val msg =
-                        s"""Output differed for test $name, use the following command to see the diff:
-                           |  > diff $checkFile $outFile
+                      if (summaryReport.updateCheckFiles) {
+                        updateCheckFile(checkFile, output)
+                      } else {
+                        outFile.writeAll(output.mkString("", EOL, ""))
+                        val msg =
+                          s"""Output differed for test $name, use the following command to see the diff:
+                             |  > diff $checkFile $outFile
                         """.stripMargin
 
-                      echo(msg)
-                      addFailureInstruction(msg)
+                        echo(msg)
+                        addFailureInstruction(msg)
 
-                      // Print build instructions to file and summary:
-                      val buildInstr = testSource.buildInstructions(0, rep.warningCount)
-                      addFailureInstruction(buildInstr)
+                        // Print build instructions to file and summary:
+                        val buildInstr = testSource.buildInstructions(0, rep.warningCount)
+                        addFailureInstruction(buildInstr)
 
-                      // Fail target:
-                      failTestSource(testSource)
+                        // Fail target:
+                        failTestSource(testSource)
+                      }
                     }
                   case _ =>
                 }
@@ -631,6 +641,9 @@ trait ParallelTesting extends RunnerOrchestration { self =>
 
             // Fail target:
             failTestSource(testSource)
+
+            if (summaryReport.updateCheckFiles)
+              updateCheckFile(checkFile.get, outputLines)
           }
         }
 
@@ -766,7 +779,11 @@ trait ParallelTesting extends RunnerOrchestration { self =>
         }
         def checkFileTest(sourceName: String, checkFile: JFile, actual: List[String]) = {
           val expexted = Source.fromFile(checkFile, "UTF-8").getLines().toList
-          diffMessage(sourceName, actual, expexted).foreach(fail)
+          for (msg <- diffMessage(sourceName, actual, expexted)) {
+            fail(msg)
+            if (summaryReport.updateCheckFiles)
+              updateCheckFile(checkFile, actual)
+          }
         }
 
         val (compilerCrashed, expectedErrors, actualErrors, hasMissingAnnotations, errorMap) = testSource match {

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

@@ -40,6 +40,9 @@ trait SummaryReporting {
 
   /** Echoes contents of `it` to file *immediately* then flushes */
   def echoToLog(it: Iterator[String]): Unit
+
+  /** Echoes outputs of the test into the thier checkfiles */
+  def updateCheckFiles: Boolean
 }
 
 /** A summary report that doesn't do anything */
@@ -53,12 +56,13 @@ final class NoSummaryReport extends SummaryReporting {
   def echoSummary(): Unit = ()
   def echoToLog(msg: String): Unit = ()
   def echoToLog(it: Iterator[String]): Unit = ()
+  def updateCheckFiles: Boolean = false
 }
 
 /** A summary report that logs to both stdout and the `TestReporter.logWriter`
  *  which outputs to a log file in `./testlogs/`
  */
-final class SummaryReport extends SummaryReporting {
+final class SummaryReport(val updateCheckFiles: Boolean) extends SummaryReporting {
   import scala.collection.JavaConverters._
 
   private val startingMessages = new java.util.concurrent.ConcurrentLinkedDeque[String]

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

@@ -20,7 +20,7 @@ class VulpixMetaTests extends ParallelTesting {
   def isInteractive = false // Don't beautify output for interactive use.
   def testFilter = None // Run all the tests.
 
-  implicit val summaryReport: SummaryReporting = new SummaryReport
+  implicit val summaryReport: SummaryReporting = new SummaryReport(updateCheckFiles = false)
   implicit def testGroup: TestGroup = TestGroup("VulpixMetaTests")
 
   @Test def compilePos: Unit = compileFilesInDir("tests/vulpix-tests/meta/pos", defaultOptions).checkCompile()

tests/pos/classWithCompObj.decompiled

@@ -1,3 +1,2 @@
-/** Decompiled from out/posTestFromTasty/pos/classWithCompObj/Foo.class */
 class Foo()
-object Foo
+object Foo

tests/pos/conforms.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/conforms/Test.class */
 object Test {
   def f[A, B](x: A)(implicit e: scala.Predef.<:<[A, B]): B = e.apply(x)
-}
+}

tests/pos/i0306.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i0306/bar.class */
 object bar {
   class C[T <: scala.Seq[_ >: scala.Nothing <: scala.Any]]()
   val x: scala.AnyRef = new bar.C[scala.collection.Seq[_ >: scala.Nothing <: scala.Any]]()

tests/pos/i1181.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i1181/Test.class */
 object Test {
   def foo[M[_$1]](x: M[scala.Int]): M[scala.Int] = x
   type Alias[A] = scala.Tuple2[A, A]

tests/pos/i1444.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i1444/Test.class */
 object Test {
   class Cls(implicit x: Test.X)
   class ClsImpl() extends Test.Cls()(Test.AnX)
@@ -8,4 +7,4 @@ object Test {
   class Tr2Impl() extends Test.Tr2()(Test.AnX)
   trait X() extends java.lang.Object
   object AnX extends Test.X
-}
+}

tests/pos/i1570.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i1570/Test.class */
 object Test {
   inline def foo(n: scala.Int): scala.Int = Test.bar(n)
   inline def bar(n: scala.Int): scala.Int = n

tests/pos/i2104b.decompiled

@@ -1,10 +1,8 @@
-/** Decompiled from out/posTestFromTasty/pos/i2104b/Cons.tasty */
 trait Cons[+H, +T]() extends java.lang.Object
 object Cons {
   def apply[H, T](h: H, t: T): Cons[H, T] = scala.Predef.???
   def unapply[H, T](t: Cons[H, T]): scala.Option[Pair[H, T]] = scala.Predef.???
 }
-/** Decompiled from out/posTestFromTasty/pos/i2104b/Pair.tasty */
 case class Pair[A, B](_1: A, _2: B) {
   override def hashCode(): scala.Int = {
     var acc: scala.Int = 2479866
@@ -32,10 +30,9 @@ case class Pair[A, B](_1: A, _2: B) {
   }
 }
 object Pair extends scala.AnyRef
-/** Decompiled from out/posTestFromTasty/pos/i2104b/Test.tasty */
 object Test {
   def main(args: scala.Array[scala.Predef.String]): scala.Unit = Cons.apply[scala.Option[scala.Int], scala.None.type](scala.Option.apply[scala.Int](1), scala.None) match {
     case Cons(scala.Some(i), scala.None) =>
       ()
   }
-}
+}

tests/pos/i4526-2.decompiled

@@ -1,2 +1 @@
-/** Decompiled from out/posTestFromTasty/pos/i4526-2/Foo.class */
 class Foo(x: scala.Int, y: scala.Int)

tests/pos/i4526a.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i4526a/bar/Foo.class */
 package bar {
   class Foo() {
     protected[bar] def foo(): scala.Int = 0

tests/pos/i4526b.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i4526b/Foo.class */
 class Foo() {
   def justdoit(f: scala.Either[scala.Int, scala.Predef.String]): scala.Predef.String = f match {
     case scala.Left(i) =>

tests/pos/i4678.decompiled

@@ -1,14 +1,8 @@
-/** Decompiled from out/posTestFromTasty/pos/i4678/Foo.tasty */
 class Foo() {
   val x: scala.Int = (1: @annot1 @annot2 @annot3 @annot4 @annot5)
 }
-/** Decompiled from out/posTestFromTasty/pos/i4678/annot1.tasty */
 class annot1() extends scala.annotation.Annotation
-/** Decompiled from out/posTestFromTasty/pos/i4678/annot2.tasty */
 class annot2() extends scala.annotation.Annotation
-/** Decompiled from out/posTestFromTasty/pos/i4678/annot3.tasty */
 class annot3() extends scala.annotation.Annotation
-/** Decompiled from out/posTestFromTasty/pos/i4678/annot4.tasty */
 class annot4() extends scala.annotation.Annotation
-/** Decompiled from out/posTestFromTasty/pos/i4678/annot5.tasty */
-class annot5() extends scala.annotation.Annotation
+class annot5() extends scala.annotation.Annotation

tests/pos/i566.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/i566/Test.class */
 class Test() {
   type T = scala.Predef.String
   type U

tests/pos/lambda.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/lambda/foo/Foo.class */
 package foo {
   class Foo() {
     ((x: scala.Int) => 2)

tests/pos/methodTypes.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/methodTypes/Foo.class */
 class Foo() {
   val x: scala.Int = 1
   def y: scala.Int = 2

tests/pos/selftypes.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/selftypes/selftypes.class */
 object selftypes {
   trait A() extends java.lang.Object { self: selftypes.AB =>
     type AA = scala.List[this.BX]

tests/pos/simple-repeated-args.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simple-repeated-args/Foo.class */
 class Foo() {
   scala.List.apply[scala.Any](1, "2", '3')
   scala.Array.apply(1)

tests/pos/simpleAnnot.decompiled

@@ -1,9 +1,7 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleAnnot/Foo.tasty */
 class Foo() {
   @annot type A = scala.Int
   @annot val a: scala.Int = scala.Predef.???
   val b: scala.Int @annot = scala.Predef.???
   def c(x: scala.Int): scala.Int = (x: @annot)
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleAnnot/annot.tasty */
-class annot() extends scala.annotation.Annotation
+class annot() extends scala.annotation.Annotation

tests/pos/simpleCaseClass-1.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleCaseClass-1/A.tasty */
 case class A() {
   override def hashCode(): scala.Int = 1914112431
   override def equals(x$0: scala.Any): scala.Boolean = A.this.eq(x$0.asInstanceOf[java.lang.Object]).||(x$0 match {
@@ -16,4 +15,4 @@ case class A() {
       throw new java.lang.IndexOutOfBoundsException(n.toString())
   }
 }
-object A extends scala.Function0[A]
+object A extends scala.Function0[A]

tests/pos/simpleCaseClass-2.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleCaseClass-2/A.tasty */
 case class A(x: scala.Int) {
   override def hashCode(): scala.Int = {
     var acc: scala.Int = 65
@@ -22,4 +21,4 @@ case class A(x: scala.Int) {
       throw new java.lang.IndexOutOfBoundsException(n.toString())
   }
 }
-object A extends scala.Function1[scala.Int, A]
+object A extends scala.Function1[scala.Int, A]

tests/pos/simpleCaseClass-3.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleCaseClass-3/A.tasty */
 case class A[T](x: T) {
   override def hashCode(): scala.Int = {
     var acc: scala.Int = 65
@@ -22,4 +21,4 @@ case class A[T](x: T) {
       throw new java.lang.IndexOutOfBoundsException(n.toString())
   }
 }
-object A extends scala.AnyRef
+object A extends scala.AnyRef

tests/pos/simpleCaseObject.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleCaseObject/foo/Foo.tasty */
 package foo {
   case object Foo {
     override def hashCode(): scala.Int = 1045991777
@@ -11,4 +10,4 @@ package foo {
         throw new java.lang.IndexOutOfBoundsException(n.toString())
     }
   }
-}
+}

tests/pos/simpleClass-2.decompiled

@@ -1,8 +1,6 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleClass-2/foo/A.tasty */
 package foo {
   class A() extends foo.B
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleClass-2/foo/B.tasty */
 package foo {
   class B()
-}
+}

tests/pos/simpleClass-3.decompiled

@@ -1,6 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleClass-3/A.class */
 class A() extends B with C
-/** Decompiled from out/posTestFromTasty/pos/simpleClass-3/B.class */
 trait B() extends java.lang.Object
-/** Decompiled from out/posTestFromTasty/pos/simpleClass-3/C.class */
-trait C() extends java.lang.Object
+trait C() extends java.lang.Object

tests/pos/simpleClass.decompiled

@@ -1,8 +1,6 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleClass/foo/A.tasty */
 package foo {
   class A()
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleClass/foo/B.tasty */
 package foo {
   class B() extends foo.A
-}
+}

tests/pos/simpleConstructor.decompiled

@@ -1,4 +1,2 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleConstructor/A.class */
 class A(a: scala.Int, val b: scala.Int, var c: scala.Int)
-/** Decompiled from out/posTestFromTasty/pos/simpleConstructor/B.class */
 class B(protected val x: scala.Int, protected[B] val y: scala.Int, private[B] val z: scala.Int)

tests/pos/simpleDoWhile.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleDoWhile/Foo.class */
 class Foo() {
   def foo: scala.Unit = {
     var i: scala.Int = 1

tests/pos/simpleExtractors-1.decompiled

@@ -1,20 +1,15 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-1/Bar.class */
 object Bar {
   def unapply(arg: scala.Any): scala.Option[scala.Any] = scala.Some.apply[scala.Any](arg)
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-1/BarSeq.class */
 object BarSeq {
   def unapplySeq(arg: scala.Any): scala.Option[scala.Seq[scala.Any]] = scala.Some.apply[collection.immutable.List[scala.Any]](scala.List.apply[scala.Any](arg))
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-1/Baz.class */
 object Baz {
   def unapply[T](arg: T): scala.Option[T] = scala.Some.apply[T](arg)
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-1/BazSeq.class */
 object BazSeq {
   def unapplySeq[T](arg: T): scala.Option[scala.Seq[T]] = scala.Some.apply[collection.immutable.List[T]](scala.List.apply[T](arg))
 }
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-1/Foo.class */
 class Foo() {
   def bar(x: scala.Any): scala.Unit = x match {
     case Bar(a) =>

tests/pos/simpleExtractors-2.decompiled

@@ -1,4 +1,3 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleExtractors-2/Foo.class */
 class Foo() {
   def bar(x: scala.Any): scala.Unit = x match {
     case scala.Some(scala.Some(i: scala.Int)) =>

tests/pos/simpleInline.decompiled

@@ -1,5 +1,4 @@
-/** Decompiled from out/posTestFromTasty/pos/simpleInline/Foo.class */
 class Foo() {
   inline def foo: scala.Int = (9: scala.Int)
   def bar: scala.Int = (9: scala.Int)
-}
+}