Add testdox format #359

bitfield · 2023-08-13T14:34:08Z

This format shows test names as full sentences, which is useful both for autogenerating documentation ("dox"), and for encouraging programmers to write their test names as sentences describing the behaviour of the unit under test.

The specific method of formatting test names as sentences is that used by https://github.com/bitfield/gotestdox.

dnephin

This is awesome, thank you for building gotestdox and adding this format!

I pushed a commit to use the same icons we use in other formats. There's a --format-hivis option to change the icons to more colorful ones. In a future version we might look at making those the default.

Left a couple suggestions/comments for small changes, but overall this looks great and I would like to add this format.

cmd/main.go

testjson/format.go

dnephin · 2023-08-20T19:06:31Z

testjson/format.go

+			}
+			fmt.Fprintln(buf)
+			return buf.Flush()
+		case event.Action.IsTerminal():


I changed this to IsTerminal so that skipped tests show up in the output as well. Does that sound ok to you?

Again, it makes sense to show skipped tests in a test runner, but a documentation generator takes the opposite view. Since these tests are skipped, they don't by definition assert anything about the behaviour of the code under test.

dnephin · 2023-08-20T19:09:48Z

testjson/format.go

+			if !event.Action.IsTerminal() {
+				return nil
+			}
+			if opts.HideEmptyPackages && len(results[event.Package]) == 0 {


I added opts.HideEmptyPackages here to match the behaviour of other formats. Print the empty package by default, but --format-hide-empty-pkg can be set to hide these (for projects that have lots of empty packages).

bitfield · 2023-08-21T10:10:31Z

I pushed a commit to use the same icons we use in other formats. There's a --format-hivis option to change the icons to more colorful ones. In a future version we might look at making those the default.

I leave that up to you, of course. But you might be interested to know why gotestdox uses the emojis it does. One of my first users was a blind developer who uses a screen reader, and he reported that the ✘ emoji I was using is pronounced by the screen reader as something like "heavy ballot x", which is weird (gotestsum's is pronounced "heavy multiplication x", which is even weirder). Changing it to simply x made the output a lot more accessible for him.

dnephin · 2023-08-26T04:17:58Z

Ah, I had not considered screen readers but that's a great point! I'd love to provide some better support. Maybe --format-audible or something like that could change the x to "failed test", etc? The pattern here for switching between the original icons and the new hivis icons seems like it would make it easy to switch to other options as well.

Thank you for explaining the design decisions in gotestdox!

This format shows test names as full sentences, which is useful both for autogenerating documentation ("dox"), and for encouraging programmers to write their test names as sentences describing the behaviour of the unit under test. The specific method of formatting test names as sentences is that used by https://github.com/bitfield/gotestdox.

And only hide Fuzz test cases, always report the top level test function.

afbjorklund · 2023-08-30T20:30:46Z

I added --format-icons text, which outputs "PASS" for ✓, "SKIP" for ∅ and "FAIL" for ✖

#366 (comment)

bitfield force-pushed the testdox branch from 33a6fa8 to 9073966 Compare August 13, 2023 14:40

dnephin reviewed Aug 20, 2023

View reviewed changes

cmd/main.go Outdated Show resolved Hide resolved

dnephin reviewed Aug 20, 2023

View reviewed changes

bitfield and others added 2 commits August 27, 2023 17:32

Use the same icons as other gotestsum formats

61b66b7

dnephin force-pushed the testdox branch from 73dfa81 to c768413 Compare August 27, 2023 21:44

Keep empty packages by default in testdox format

18c1f57

And only hide Fuzz test cases, always report the top level test function.

dnephin force-pushed the testdox branch 2 times, most recently from 0466efc to 18c1f57 Compare August 27, 2023 21:50

dnephin approved these changes Aug 27, 2023

View reviewed changes

dnephin merged commit 2098fe3 into gotestyourself:main Aug 27, 2023
1 check passed

dnephin mentioned this pull request Aug 27, 2023

Add format-icons flag for nerdfonts instead of unicode #366

Merged

Jumziey mentioned this pull request Sep 2, 2023

Added a verbose flag which makes gotestdox print the output of tests. bitfield/gotestdox#13

Closed

chenrui333 mentioned this pull request Sep 17, 2023

gotestsum 1.11.0 Homebrew/homebrew-core#143293

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add testdox format #359

Add testdox format #359

bitfield commented Aug 13, 2023

dnephin left a comment •

edited

Loading

dnephin Aug 20, 2023

bitfield Aug 21, 2023

dnephin Aug 20, 2023

bitfield commented Aug 21, 2023

dnephin commented Aug 26, 2023

afbjorklund commented Aug 30, 2023 •

edited

Loading

Add testdox format #359

Add testdox format #359

Conversation

bitfield commented Aug 13, 2023

dnephin left a comment • edited Loading

Choose a reason for hiding this comment

dnephin Aug 20, 2023

Choose a reason for hiding this comment

bitfield Aug 21, 2023

Choose a reason for hiding this comment

dnephin Aug 20, 2023

Choose a reason for hiding this comment

bitfield commented Aug 21, 2023

dnephin commented Aug 26, 2023

afbjorklund commented Aug 30, 2023 • edited Loading

dnephin left a comment •

edited

Loading

afbjorklund commented Aug 30, 2023 •

edited

Loading