Drop control characters from output

Fixes: #138

Author: janisz

parser/gotest/internal/collector/collector.go

@@ -4,13 +4,24 @@ package collector
 
 import (
 	"sort"
+	"strings"
 	"time"
+	"unicode"
 )
 
 // line is a single line of output captured at some point in time.
 type line struct {
 	Timestamp time.Time
-	Text      string
+	text      string
+}
+
+func (l line) SafeText() string {
+	return strings.Map(func(r rune) rune {
+		if unicode.IsControl(r) && !unicode.IsSpace(r) {
+			return -1
+		}
+		return r
+	}, l.text)
 }
 
 // Output stores output lines grouped by id. Output can be retrieved for one or
@@ -44,7 +55,7 @@ func (o *Output) Contains(id int) bool {
 func (o *Output) Get(id int) []string {
 	var lines []string
 	for _, line := range o.m[id] {
-		lines = append(lines, line.Text)
+		lines = append(lines, line.SafeText())
 	}
 	return lines
 }
@@ -61,7 +72,7 @@ func (o *Output) GetAll(ids ...int) []string {
 	})
 	var lines []string
 	for _, line := range output {
-		lines = append(lines, line.Text)
+		lines = append(lines, line.SafeText())
 	}
 	return lines
 }

parser/gotest/internal/collector/collector_test.go

@@ -89,3 +89,12 @@ func TestMerge(t *testing.T) {
 		t.Errorf("Get(2) after Merge(2, 1) incorrect (-want +got):\n%s", diff)
 	}
 }
+
+func TestSafeText(t *testing.T) {
+	l := line{text: "\tx\x00y\x1bz\n"}
+	got := l.SafeText()
+	want := "\txyz\n"
+	if diff := cmp.Diff(want, got); diff != "" {
+		t.Errorf("SafeText() for %q incorrect (-want +got):\n%s", l.text, diff)
+	}
+}

testdata/035-report.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<testsuites tests="9">
-	<testsuite name="package/whitespace" tests="9" failures="0" errors="0" id="0" hostname="hostname" time="0.001" timestamp="2022-01-01T00:00:00Z">
+<testsuites tests="11">
+	<testsuite name="package/whitespace" tests="11" failures="0" errors="0" id="0" hostname="hostname" time="0.001" timestamp="2022-01-01T00:00:00Z">
 		<properties>
 			<property name="go.version" value="1.0"></property>
 		</properties>
@@ -45,6 +45,10 @@ one-newline
 two-newlines
 two-newlines
 two-newlines]]></system-out>
+		</testcase>
+		<testcase name="TestControl" classname="package/whitespace" time="0.000">
+			<system-out><![CDATA[    whitespace_test.go:49: log control
+printf control]]></system-out>
 		</testcase>
 		<testcase name="TestSubTests" classname="package/whitespace" time="0.000"></testcase>
 		<testcase name="TestSubTests/TestFlat" classname="package/whitespace" time="0.000">
@@ -89,5 +93,9 @@ two-newlines
 two-newlines
 two-newlines]]></system-out>
 		</testcase>
+		<testcase name="TestSubTests/TestControl" classname="package/whitespace" time="0.000">
+			<system-out><![CDATA[    whitespace_test.go:49: log control
+printf control]]></system-out>
+		</testcase>
 	</testsuite>
 </testsuites>

testdata/035-whitespace.txt

@@ -45,9 +45,15 @@ func TestWithNewlinesFlat(t *testing.T) {
 	fmt.Println("two-newlines\ntwo-newlines\ntwo-newlines")
 }
 
+func TestControl(t *testing.T) {
+	t.Logf("log\x00 control")
+	fmt.Printf("printf\x00 control\n")
+}
+
 func TestSubTests(t *testing.T) {
 	t.Run("TestFlat", TestFlat)
 	t.Run("TestWithSpace", TestWithSpace)
 	t.Run("TestWithTab", TestWithTab)
 	t.Run("TestWithNewlinesFlat", TestWithNewlinesFlat)
+	t.Run("TestControl", TestControl)
 }