Report failing fuzz tests

Author: bitfield

README.md

@@ -90,7 +90,9 @@ will run the command:
 
 `go test -json -run ParseJSON`
 
-You can supply a list of packages to test, or any other arguments or flags understood by `go test`. However, `gotestdox` only prints events about *tests* (ignoring benchmarks and examples). It doesn't report fuzz tests, since they don't tend to have useful names.
+You can supply a list of packages to test, or any other arguments or flags understood by `go test`. However, `gotestdox` only prints events about *tests* (ignoring benchmarks and examples). 
+
+Since fuzz test cases are autogenerated and don't tend to have useful names, these are not included in `gotestdox` output unless they are failing.
 
 ## Multiple packages
 

gotestdox.go

@@ -127,7 +127,7 @@ func (td *TestDoxer) Filter() {
 			})
 			for _, r := range tests {
 				fmt.Fprintln(td.Stdout, r.String())
-				if r.Action == "fail" {
+				if r.Action == ActionFail {
 					for _, line := range outputs[r.Test] {
 						fmt.Fprint(td.Stdout, line)
 					}
@@ -136,10 +136,10 @@ func (td *TestDoxer) Filter() {
 			fmt.Fprintln(td.Stdout)
 		case event.IsOutput():
 			outputs[event.Test] = append(outputs[event.Test], event.Output)
-		case event.IsTestResult():
+		case event.IsTestResult(), event.IsFuzzFail():
 			event.Sentence = Prettify(event.Test)
 			results[event.Package] = append(results[event.Package], event)
-			if event.Action == "fail" {
+			if event.Action == ActionFail {
 				td.OK = false
 			}
 		}
@@ -158,6 +158,11 @@ func ParseJSON(line string) (Event, error) {
 	return event, nil
 }
 
+const (
+	ActionPass = "pass"
+	ActionFail = "fail"
+)
+
 // Event represents a Go test event as recorded by the 'go test -json' command.
 // It does not attempt to unmarshal all the data, only those fields it needs to
 // know about. It is based on the (unexported) 'event' struct used by Go's
@@ -184,7 +189,7 @@ type Event struct {
 // set, check marks will be shown in green and x's in red.
 func (e Event) String() string {
 	status := color.RedString("x")
-	if e.Action == "pass" {
+	if e.Action == ActionPass {
 		status = color.GreenString("✔")
 	}
 	return fmt.Sprintf(" %s %s (%.2fs)", status, e.Sentence, e.Elapsed)
@@ -195,24 +200,43 @@ func (e Event) String() string {
 // (for example, examples) are ignored, and all events on tests other than pass
 // or fail events (for example, run or pause events) are also ignored.
 func (e Event) IsTestResult() bool {
-	// Skip events on benchmarks and examples
-	if !strings.HasPrefix(e.Test, "Test") {
+	// Skip events on benchmarks, examples, and fuzz tests
+	if strings.HasPrefix(e.Test, "Benchmark") {
+		return false
+	}
+	if strings.HasPrefix(e.Test, "Example") {
+		return false
+	}
+	if strings.HasPrefix(e.Test, "Fuzz") {
+		return false
+	}
+	if e.Test == "" {
 		return false
 	}
-	if e.Action == "pass" || e.Action == "fail" {
+	if e.Action == ActionPass || e.Action == ActionFail {
 		return true
 	}
 	return false
 }
 
+func (e Event) IsFuzzFail() bool {
+	if !strings.HasPrefix(e.Test, "Fuzz") {
+		return false
+	}
+	if e.Action != ActionFail {
+		return false
+	}
+	return true
+}
+
 // IsPackageResult determines whether or not the test event is a package pass
 // or fail event. That is, whether it indicates the passing or failing of a
 // package as a whole, rather than some individual test within the package.
 func (e Event) IsPackageResult() bool {
 	if e.Test != "" {
 		return false
 	}
-	if e.Action == "pass" || e.Action == "fail" {
+	if e.Action == ActionPass || e.Action == ActionFail {
 		return true
 	}
 	return false

gotestdox_test.go

@@ -70,6 +70,36 @@ func TestEventString_FormatsPassAndFailEventsDifferently(t *testing.T) {
 	}
 }
 
+func TestIsFuzzFail_IsTrueForFuzzFailEvents(t *testing.T) {
+	t.Parallel()
+	event := gotestdox.Event{
+		Action: "fail",
+		Test:   "FuzzBar",
+	}
+	if !event.IsFuzzFail() {
+		t.Errorf("false for %q event on %q", event.Action, event.Test)
+	}
+}
+
+func TestIsFuzzFail_IsFalseForNonFuzzFailEvents(t *testing.T) {
+	t.Parallel()
+	tcs := []gotestdox.Event{
+		{
+			Action: "pass",
+			Test:   "FuzzBar",
+		},
+		{
+			Action: "fail",
+			Test:   "TestFooDoesX",
+		},
+	}
+	for _, event := range tcs {
+		if event.IsFuzzFail() {
+			t.Errorf("true for %q event on %q", event.Action, event.Test)
+		}
+	}
+}
+
 func TestIsTestResult_IsTrueForTestPassOrFailEvents(t *testing.T) {
 	t.Parallel()
 	tcs := []gotestdox.Event{
@@ -108,6 +138,10 @@ func TestIsTestResult_IsFalseForNonTestPassFailEvents(t *testing.T) {
 			Action: "fail",
 			Test:   "",
 		},
+		{
+			Action: "pass",
+			Test:   "FuzzBar",
+		},
 		{
 			Action: "run",
 			Test:   "TestFooDoesX",

prettifier.go

@@ -56,19 +56,24 @@ import (
 // (copious) debug information to the [DebugWriter] stream, elaborating on its
 // decisions.
 func Prettify(input string) string {
+	var prefix string
 	p := &prettifier{
-		input: []rune(strings.TrimPrefix(input, "Test")),
 		words: []string{},
 		debug: io.Discard,
 	}
 	if os.Getenv("GOTESTDOX_DEBUG") != "" {
 		p.debug = DebugWriter
 	}
 	p.log("input:", input)
+	if strings.HasPrefix(input, "Fuzz") {
+		input = strings.TrimPrefix(input, "Fuzz")
+		prefix = "[fuzz] "
+	}
+	p.input = []rune(strings.TrimPrefix(input, "Test"))
 	for state := betweenWords; state != nil; {
 		state = state(p)
 	}
-	result := strings.Join(p.words, " ")
+	result := prefix + strings.Join(p.words, " ")
 	p.log(fmt.Sprintf("result: %q", result))
 	return result
 }
@@ -127,7 +132,7 @@ func (p *prettifier) emit() {
 	word := string(p.input[p.start:p.pos])
 	switch {
 	case len(p.words) == 0:
-		// This is the first word
+		// This is the first word, capitalise it
 		word = cases.Title(language.Und, cases.NoLower).String(word)
 	case len(word) == 1:
 		// Single letter word such as A

prettifier_test.go

@@ -234,4 +234,9 @@ var Cases = []struct {
 		input: "TestShiftTransforms255To0",
 		want:  "Shift transforms 255 to 0",
 	},
+	{
+		name:  "correctly formats fuzz test names",
+		input: "FuzzPrettify",
+		want:  "[fuzz] Prettify",
+	},
 }