Allow for embedded newlines in diagnostics.

Author: tesujimath

util/tap/tap.go

@@ -24,6 +24,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"strings"
 )
 import "testing/quick"
 
@@ -112,12 +113,18 @@ func (t *T) AutoPlan() {
 	t.printf("1..%d\n", t.Count())
 }
 
-// Diagnostic generates a diagnostic from the message.
+func escapeNewlines(s string) string {
+	return strings.Replace(strings.TrimRight(s, "\n"), "\n", "\n# ", -1)
+}
+
+// Diagnostic generates a diagnostic from the message,
+// which may span multiple lines.
 func (t *T) Diagnostic(message string) {
-	t.printf("# %s\n", message)
+	t.printf("# %s\n", escapeNewlines(message))
 }
 
-// Diagnosticf generates a diagnostic from the format string and arguments.
+// Diagnosticf generates a diagnostic from the format string and arguments,
+// which may span multiple lines.
 func (t *T) Diagnosticf(format string, a ...interface{}) {
-	t.printf("# "+format+"\n", a...)
+	t.printf("# "+escapeNewlines(format)+"\n", a...)
 }

util/tap/test/diagnostic/main.go

@@ -7,5 +7,7 @@ func main() {
 	t.Header(1)
 	t.Diagnostic("expecting all to be well")
 	t.Diagnosticf("here's some perfectly magical output: %d %s 0x%X.", 6, "abracadabra", 28)
+	t.Diagnostic("some\nmultiline\ntext\n")
+	t.Diagnosticf("%d lines\n%s multiline\ntext", 3, "more")
 	t.Pass("all good")
 }