Refine test assertion output #423
Conversation
- allow colorized diffs, use `COLOR_DIFF=true` to force on - clarify what is unexpected or missing - reference specific expected field and index when appropriate - hide "for config X" for the default config, continue to show for extra configs Signed-off-by: Scott Andrews <andrewssc@vmware.com>
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #423 +/- ##
==========================================
+ Coverage 60.78% 60.89% +0.11%
==========================================
Files 25 26 +1
Lines 2494 2514 +20
==========================================
+ Hits 1516 1531 +15
- Misses 893 896 +3
- Partials 85 87 +2
☔ View full report in Codecov by Sentry. |
| ) | ||
|
|
||
| func init() { | ||
| if _, ok := os.LookupEnv("COLOR_DIFF"); ok { |
There was a problem hiding this comment.
[issue, suggestion]: I get a coloured diff even if COLOR_DIFF is not set. It seems that COLOR_DIFF does not override faith/color's https://github.com/fatih/color#disableenable-color mechanics. Since faith/color is already being clever depending on the connected output, couldn't we drop COLOR_DIFF and let the fatih/color handle it? After all, NO_COLOR would be a way to disable it.
There was a problem hiding this comment.
interesting, while testing I could never get the color to be active by default. I assumed there was something about go test is executing that triggered the default to no color. I added COLOR_DIFF to force color on.
How are you executing the code? Version of go, os, console.
There was a problem hiding this comment.
❯ go version
go version go1.21.0 darwin/amd64
❯ uname -a
Darwin ***** 22.6.0 Darwin Kernel Version 22.6.0: Wed Jul 5 22:21:56 PDT 2023; root:xnu-8796.141.3~6/RELEASE_X86_64 x86_64
❯ # terminal
❯ kitty --version
kitty 0.29.2 created by Kovid Goyal
❯ # run tests
❯ go run github.com/onsi/ginkgo/v2/ginkgo --keep-going -r
...
There was a problem hiding this comment.
I see colorized output by default with both kitty and ginkgo, but using either a different test runner or a different terminal and it's all plain text.
NO_COLOR is only used to disable color output. NO_COLOR=true and NO_COLOR=false are equivalent ways to disable color output. I'm using COLOR_DIFF as a way to override the tty detection and force colorized output. I'm up for ways to be smarter about the default detection.
There was a problem hiding this comment.
@scothis Thanks for running the experiments and making the call. Yay colors!
COLOR_DIFF=trueto force on