make golden literal printing configurable

Author: lihaoyi

utest/src-js/utest/framework/TestSuitePlatformSpecific.scala

@@ -5,5 +5,5 @@ trait TestSuitePlatformSpecific {
 }
 
 object TestSuitePlatformSpecific {
-  def processGolden(allSuites: Seq[utest.TestSuite]): Unit = ()
+  def processGolden(allSuites: Seq[utest.TestSuite], goldenLiteralPrinter: Any => String): Unit = ()
 }

utest/src-jvm/utest/asserts/AssertsPlatformSpecific.scala

@@ -23,7 +23,7 @@ trait AssertsPlatformSpecific {
       if (!sys.env.get("UTEST_UPDATE_GOLDEN_TESTS").exists(_.nonEmpty)) {
         throwAssertionError(goldenFilePath.toString, goldenFileContents, actualValue)
       } else {
-        reporter.apply(GoldenFix(goldenFilePath, actualValue, 0, goldenFileContents.length))
+        reporter.apply(GoldenFix(goldenFilePath, new GoldenFix.Literal(actualValue), 0, goldenFileContents.length))
       }
     }
   }
@@ -43,7 +43,7 @@ trait AssertsPlatformSpecific {
         reporter.apply(
           GoldenFix(
             Path.of(goldenLiteral.sourceFile),
-            utest.shaded.pprint.PPrinter.BlackWhite.apply(actualValue).plainText,
+            actualValue,
             goldenLiteral.startOffset,
             goldenLiteral.endOffset
           )

utest/src-jvm/utest/framework/GoldenFix.scala

@@ -3,11 +3,14 @@ package utest.framework
 import scala.collection.mutable.ArrayBuffer
 
 case class GoldenFix(path: java.nio.file.Path,
-                     contents: String,
+                     contents: Any,
                      startOffset: Int,
                      endOffset: Int)
 
 object GoldenFix {
+  class Literal(s: String) {
+    override def toString = s
+  }
   // vendored from
   // https://github.com/com-lihaoyi/fastparse/blob/d8f95daef21d6e6f9734624237f993f4cebfa881/fastparse/src/fastparse/internal/Util.scala
   //
@@ -53,15 +56,15 @@ object GoldenFix {
     def apply(v: GoldenFix): Unit
   }
 
-  def applyAll(fixes: Seq[GoldenFix]): Unit = {
+  def applyAll(fixes: Seq[GoldenFix], goldenLiteralPrinter: Any => String): Unit = {
     for((path, group) <- fixes.groupBy(_.path)){
       println(s"UTEST_UPDATE_GOLDEN_TESTS detected, uTest applying ${group.size} golden fixes to file $path")
       val text = java.nio.file.Files.readString(path)
-      java.nio.file.Files.writeString(path, applyToText(text, group))
+      java.nio.file.Files.writeString(path, applyToText(text, group, goldenLiteralPrinter))
     }
   }
 
-  def applyToText(text0: String, fixes: Seq[GoldenFix]): String = {
+  def applyToText(text0: String, fixes: Seq[GoldenFix], goldenLiteralPrinter: Any => String): String = {
     var text = text0
     val sorted = fixes.map(t => t.startOffset -> t).toMap.map(_._2).toSeq.sortBy(_.startOffset)
     sorted.sliding(2).collect{ case Seq(prev, next) =>
@@ -74,7 +77,7 @@ object GoldenFix {
       val (startLine, startCol) = lineColumnLookup(fix.startOffset, lineNumberLookupTable)
       val (endLine, endCol) = lineColumnLookup(fix.endOffset, lineNumberLookupTable)
       println(s"Updating line:column $startLine:$startCol to $endLine:$endCol")
-      val indentedContents = fix.contents.linesWithSeparators.mkString(" " * startCol)
+      val indentedContents = goldenLiteralPrinter(fix.contents).linesWithSeparators.mkString(" " * startCol)
       text = text.patch(
         fix.startOffset + lengthOffset, indentedContents,
         fix.endOffset - fix.startOffset

utest/src-jvm/utest/framework/TestSuitePlatformSpecific.scala

@@ -8,14 +8,14 @@ trait TestSuitePlatformSpecific {
 }
 
 object TestSuitePlatformSpecific {
-  def processGolden(allSuites: Seq[utest.TestSuite]): Unit = {
+  def processGolden(allSuites: Seq[utest.TestSuite], goldenLiteralPrinter: Any => String): Unit = {
     if (sys.env.contains("UTEST_UPDATE_GOLDEN_TESTS")) {
       val goldenFixes = allSuites.flatMap { suite =>
         suite.utestGoldenReports.synchronized {
           suite.utestGoldenReports.toList
         }
       }
-      GoldenFix.applyAll(goldenFixes)
+      GoldenFix.applyAll(goldenFixes, goldenLiteralPrinter)
     }
   }
 }

utest/src-native/utest/framework/TestSuitePlatformSpecific.scala

@@ -6,5 +6,5 @@ trait TestSuitePlatformSpecific {
 
 
 object TestSuitePlatformSpecific {
-  def processGolden(allSuites: Seq[utest.TestSuite]): Unit = ()
+  def processGolden(allSuites: Seq[utest.TestSuite], goldenLiteralPrinter: Any => String): Unit = ()
 }

utest/src/utest/framework/Formatter.scala

@@ -33,6 +33,8 @@ trait Formatter {
     else fansi.Color.Red
   )
 
+  def goldenLiteralPrinter(x: Any): String = pprint.PPrinter.BlackWhite.apply(x).plainText
+
   def formatMillisColor = toggledColor(fansi.Bold.Faint)
 
   def exceptionStackFrameHighlighter(s: StackTraceElement): Boolean = true

utest/src/utest/runner/MasterRunner.scala

@@ -45,7 +45,7 @@ final class MasterRunner(args: Array[String],
   val allSuites = collection.mutable.Buffer.empty[TestSuite]
   override def registerSuite(x: TestSuite) = allSuites.synchronized { allSuites.append(x) }
   def done(): String = {
-    utest.framework.TestSuitePlatformSpecific.processGolden(allSuites.toSeq)
+    utest.framework.TestSuitePlatformSpecific.processGolden(allSuites.toSeq, formatter.goldenLiteralPrinter)
 
     teardown()
     val total = success.get() + failure.get()

utest/test/src-jvm/test/utest/GoldenFixTests.scala

@@ -25,28 +25,35 @@ object GoldenFixTests extends utest.TestSuite {
     test("single") {
       val replaced = GoldenFix.applyToText(
         "0123456789",
-        Seq(GoldenFix(null, "Hello", 0, 0))
+        Seq(GoldenFix(null, new GoldenFix.Literal("Hello"), 0, 0)),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(replaced == "Hello0123456789")
     }
     test("middle") {
       val replaced = GoldenFix.applyToText(
         "0123456789",
-        Seq(GoldenFix(null, "Hello", 5, 5))
+        Seq(GoldenFix(null, new GoldenFix.Literal("Hello"), 5, 5)),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(replaced == "01234Hello56789")
     }
     test("replace") {
       val replaced = GoldenFix.applyToText(
         "0123456789",
-        Seq(GoldenFix(null, "Hello", 4, 6))
+        Seq(GoldenFix(null, new GoldenFix.Literal("Hello"), 4, 6)),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(replaced == "0123Hello6789")
     }
     test("replaceTwice") {
       val replaced = GoldenFix.applyToText(
         "0123456789",
-        Seq(GoldenFix(null, "Hello", 0, 1), GoldenFix(null, "World", 5, 6))
+        Seq(
+          GoldenFix(null, new GoldenFix.Literal("Hello"), 0, 1),
+          GoldenFix(null, new GoldenFix.Literal("World"), 5, 6)
+        ),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(replaced == "Hello1234World6789")
     }
@@ -55,7 +62,8 @@ object GoldenFixTests extends utest.TestSuite {
         """Hello
           |World
           |""".stripMargin,
-        Seq(GoldenFix(null, "I am\nCow", 2, 4))
+        Seq(GoldenFix(null, new GoldenFix.Literal("I am\nCow"), 2, 4)),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(
         replaced ==
@@ -71,9 +79,10 @@ object GoldenFixTests extends utest.TestSuite {
           |World
           |""".stripMargin,
         Seq(
-          GoldenFix(null, "I am\nCow", 2, 4),
-          GoldenFix(null, "Hear\nMe\nMoo", 7, 8)
-        )
+          GoldenFix(null, new GoldenFix.Literal("I am\nCow"), 2, 4),
+          GoldenFix(null, new GoldenFix.Literal("Hear\nMe\nMoo"), 7, 8)
+        ),
+        utest.shaded.pprint.PPrinter.BlackWhite.apply(_).plainText
       )
       Predef.assert(
         replaced ==