fix some more interesting edge cases

Author: bitfield

.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 jobs:
   test:
     docker:
-      - image: cimg/go:1.18
+      - image: cimg/go:1.17
     steps:
       - checkout
       - run: go version

README.md

@@ -73,7 +73,7 @@ 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).
+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.
 
 ## Multiple packages
 
@@ -271,32 +271,37 @@ Here is the complete `gotestdox` rendering of its own tests (sorted for readabil
 ```
 github.com/bitfield/gotestdox:
  ✔ EventString formats pass and fail events differently (0.00s)
- ✔ ExecGoTest returns not OK when command errors (0.02s)
- ✔ ExecGoTest returns not OK when tests fail (0.79s)
- ✔ ExecGoTest returns OK when tests pass (0.66s)
- ✔ Filter returns not OK on parsing error (0.00s)
+ ✔ ExecGoTest sets OK to false when command errors (0.03s)
+ ✔ ExecGoTest sets OK to false when tests fail (0.76s)
+ ✔ ExecGoTest sets OK to true when tests pass (0.90s)
  ✔ Filter sets OK to false if any test fails (0.01s)
- ✔ Filter sets OK to true if there are no test failures (0.01s)
+ ✔ Filter sets OK to false on parsing error (0.00s)
+ ✔ Filter sets OK to true if there are no test failures (0.00s)
  ✔ NewTestDoxer returns testdoxer with standard IO streams (0.00s)
  ✔ ParseJSON errors on invalid JSON (0.00s)
  ✔ ParseJSON returns valid data for valid JSON (0.00s)
  ✔ Prettify (0.00s)
  ✔ Prettify correctly renders a well-formed test name (0.00s)
+ ✔ Prettify does not break words when a digit follows an = sign (0.00s)
  ✔ Prettify does not erase the final digit in words that end with a digit (0.00s)
  ✔ Prettify does not treat an underscore in a subtest name as marking the end of a multiword function name (0.00s)
  ✔ Prettify doesn't incorrectly title-case single-letter words (0.00s)
  ✔ Prettify eliminates any words containing underscores after splitting (0.00s)
+ ✔ Prettify handles a test with no name, but with subtests (0.00s)
  ✔ Prettify handles multiple underscores, with the first marking the end of a multiword function name (0.00s)
  ✔ Prettify inserts a word break before subtest names beginning with a lowercase letter (0.00s)
  ✔ Prettify is okay with test names not in the form of a sentence (0.00s)
  ✔ Prettify keeps a trailing digit as part of an initialism (0.00s)
  ✔ Prettify keeps numbers within a hyphenated word (0.00s)
+ ✔ Prettify keeps together digits in numbers that are standalone words (0.00s)
  ✔ Prettify keeps together hyphenated words with initial capitals (0.00s)
  ✔ Prettify keeps together hyphenated words with initialisms (0.00s)
  ✔ Prettify knows that just test is a valid test name (0.00s)
  ✔ Prettify preserves capitalisation of initialism when it is the first word (0.00s)
  ✔ Prettify preserves capitalisation of initialisms such as PDF (0.00s)
  ✔ Prettify preserves capitalisation of two-letter initialisms such as OK (0.00s)
+ ✔ Prettify preserves initialisms containing digits (0.00s)
+ ✔ Prettify preserves initialisms containing digits with two or more leading alpha characters (0.00s)
  ✔ Prettify preserves longer all-caps words (0.00s)
  ✔ Prettify recognises a dash followed by a digit as a negative number (0.00s)
  ✔ Prettify renders subtest names without the slash, and with underscores replaced by spaces (0.00s)
@@ -308,7 +313,7 @@ github.com/bitfield/gotestdox:
  ✔ Prettify treats consecutive underscores as a single word break (0.00s)
  ✔ Prettify treats numbers as word separators (0.00s)
  ✔ Prettify treats underscores as word breaks (0.00s)
- ✔ Relevant is false for non pass fail events (0.00s)
+ ✔ Relevant is false for non test pass fail events (0.00s)
  ✔ Relevant is true for test pass or fail events (0.00s)
 ```
 

fuzz_test.go

@@ -0,0 +1,32 @@
+//go:build go1.18
+
+package gotestdox_test
+
+import (
+	"strings"
+	"testing"
+	"unicode"
+
+	"github.com/bitfield/gotestdox"
+)
+
+func FuzzPrettify(f *testing.F) {
+	for _, tc := range Cases {
+		f.Add(tc.input)
+	}
+	f.Fuzz(func(t *testing.T, input string) {
+		if len(input) > 0 && unicode.IsLower([]rune(input)[0]) {
+			t.Skip()
+		}
+		got := gotestdox.Prettify(input)
+		if got == "" {
+			t.Skip()
+		}
+		if strings.ContainsRune(got, '_') {
+			t.Errorf("%q: contains underscore %q", input, got)
+		}
+		if strings.ContainsRune(got, '/') {
+			t.Errorf("%q: contains slash %q", input, got)
+		}
+	})
+}

gotestdox.go

@@ -84,7 +84,7 @@ func (td *TestDoxer) Filter() {
 		}
 		if event.Package != curPkg {
 			if curPkg != "" {
-				fmt.Fprintln(td.Stdout, curPkg)
+				fmt.Fprintln(td.Stdout)
 			}
 			fmt.Fprintf(td.Stdout, "%s:\n", event.Package)
 			curPkg = event.Package

gotestdox_test.go

@@ -76,7 +76,7 @@ func TestRelevantIsTrueForTestPassOrFailEvents(t *testing.T) {
 	}
 }
 
-func TestRelevantIsFalseForNonPassFailEvents(t *testing.T) {
+func TestRelevantIsFalseForNonTestPassFailEvents(t *testing.T) {
 	t.Parallel()
 	tcs := []gotestdox.Event{
 		{
@@ -158,7 +158,7 @@ func TestFilterSetsOKToFalseIfAnyTestFails(t *testing.T) {
 	}
 }
 
-func TestFilterReturnsNotOKOnParsingError(t *testing.T) {
+func TestFilterSetsOKToFalseOnParsingError(t *testing.T) {
 	t.Parallel()
 	td := gotestdox.TestDoxer{
 		Stdin:  strings.NewReader("invalid"),
@@ -171,7 +171,7 @@ func TestFilterReturnsNotOKOnParsingError(t *testing.T) {
 	}
 }
 
-func TestExecGoTest_ReturnsOKWhenTestsPass(t *testing.T) {
+func TestExecGoTest_SetsOKToTrueWhenTestsPass(t *testing.T) {
 	t.Parallel()
 	path := newTempTestPath(t, passingTest)
 	td := gotestdox.TestDoxer{
@@ -185,7 +185,7 @@ func TestExecGoTest_ReturnsOKWhenTestsPass(t *testing.T) {
 	}
 }
 
-func TestExecGoTest_ReturnsNotOKWhenTestsFail(t *testing.T) {
+func TestExecGoTest_SetsOKToFalseWhenTestsFail(t *testing.T) {
 	t.Parallel()
 	path := newTempTestPath(t, failingTest)
 	td := gotestdox.TestDoxer{
@@ -199,7 +199,7 @@ func TestExecGoTest_ReturnsNotOKWhenTestsFail(t *testing.T) {
 	}
 }
 
-func TestExecGoTest_ReturnsNotOKWhenCommandErrors(t *testing.T) {
+func TestExecGoTest_SetsOKToFalseWhenCommandErrors(t *testing.T) {
 	t.Parallel()
 	td := gotestdox.TestDoxer{
 		Stdout: io.Discard,

prettifier.go

@@ -103,6 +103,9 @@ func start(p *prettifier, r rune) stateFunc {
 	case unicode.IsUpper(r):
 		p.emitRune(r)
 		return inWordUpper
+	case r == '/':
+		p.inSubTest = true
+		return betweenWords
 	default:
 		return start
 	}
@@ -117,6 +120,9 @@ func betweenWords(p *prettifier, r rune) stateFunc {
 	case unicode.IsLower(r):
 		p.emitRune(r)
 		return inWordLower
+	case unicode.IsDigit(r):
+		p.emitRune(r)
+		return inNumber
 	case r == '_':
 		p.seenUnderscore = true
 		return betweenWords
@@ -179,7 +185,7 @@ func inInitialism(p *prettifier, r rune) stateFunc {
 func inWordUpper(p *prettifier, r rune) stateFunc {
 	p.log("inWordUpper", p.curWord, string(r))
 	switch {
-	case unicode.IsUpper(r):
+	case unicode.IsUpper(r), unicode.IsDigit(r):
 		p.emitRune(r)
 		return inInitialism
 	case r == '_':
@@ -212,7 +218,7 @@ func inWordLower(p *prettifier, r rune) stateFunc {
 		p.emitRune(r)
 		return inWordUpper
 	case unicode.IsDigit(r):
-		if !strings.HasSuffix(p.curWord, "-") {
+		if !strings.HasSuffix(p.curWord, "-") && !strings.HasSuffix(p.curWord, "=") {
 			p.emitWord()
 		}
 		p.emitRune(r)

prettifier_test.go

@@ -2,9 +2,7 @@ package gotestdox_test
 
 import (
 	"fmt"
-	"strings"
 	"testing"
-	"unicode"
 
 	"github.com/bitfield/gotestdox"
 	"github.com/google/go-cmp/cmp"
@@ -22,6 +20,13 @@ func TestPrettify(t *testing.T) {
 	}
 }
 
+func BenchmarkPrettify(b *testing.B) {
+	input := "TestParseJSON_CorrectlyParsesASingleGoTestJSONOutputLine"
+	for i := 0; i < b.N; i++ {
+		_ = gotestdox.Prettify(input)
+	}
+}
+
 func ExamplePrettify() {
 	input := "TestFoo/has_well-formed_output"
 	fmt.Println(gotestdox.Prettify(input))
@@ -36,27 +41,6 @@ func ExamplePrettify_underscoreHint() {
 	// HandleInput closes input after reading
 }
 
-func FuzzPrettify(f *testing.F) {
-	for _, tc := range Cases {
-		f.Add(tc.input)
-	}
-	f.Fuzz(func(t *testing.T, input string) {
-		if len(input) > 0 && unicode.IsLower([]rune(input)[0]) {
-			t.Skip()
-		}
-		got := gotestdox.Prettify(input)
-		if got == "" {
-			t.Skip()
-		}
-		if strings.ContainsRune(got, '_') {
-			t.Errorf("%q: contains underscore %q", input, got)
-		}
-		if strings.ContainsRune(got, '/') {
-			t.Errorf("%q: contains slash %q", input, got)
-		}
-	})
-}
-
 var Cases = []struct {
 	name, input, want string
 }{
@@ -195,4 +179,29 @@ var Cases = []struct {
 		input: "TestListObjects/FS-Test71",
 		want:  "List objects FS-test 71",
 	},
+	{
+		name:  "keeps together digits in numbers that are standalone words",
+		input: "TestLex11",
+		want:  "Lex 11",
+	},
+	{
+		name:  "handles a test with no name, but with subtests",
+		input: "Test/default/issue12839",
+		want:  "Default issue 12839",
+	},
+	{
+		name:  "does not break words when a digit follows an = sign",
+		input: "TestUniformFactorial/n=3",
+		want:  "Uniform factorial n=3",
+	},
+	{
+		name:  "preserves initialisms containing digits",
+		input: "TestS390XOperandParser",
+		want:  "S390X operand parser",
+	},
+	{
+		name:  "preserves initialisms containing digits with two or more leading alpha characters",
+		input: "TestBC35A",
+		want:  "BC35A",
+	},
 }