testing: explain how SkipNow and FailNow stop execution
SkipNow and FailNow must be called from the goroutine running the test. This is already documented, but it's easy to call them by mistake when writing subtests. In the following: func TestPanic(t *testing.T) { t.Run("", func(t2 *testing.T) { t.FailNow() // BAD: should be t2.FailNow() }) } the FailNow call on the outer t *testing.T correctly triggers a panic panic: test executed panic(nil) or runtime.Goexit The error message confuses users (see issues #17421, #21175) because there is no way to trace back the relevant part of the message ("test executed ... runtime.Goexit") to a bad FailNow call without checking the testing package source code and finding out that FailNow calls runtime.Goexit. To help users debug the panic message, mention in the SkipNow and FailNow documentation that they stop execution by calling runtime.Goexit. Fixes #21175 Change-Id: I0a3e5f768e72b464474380cfffbf2b67396ac1b5 Reviewed-on: https://go-review.googlesource.com/52770Reviewed-by: Ian Lance Taylor <iant@golang.org>
Showing
Please
register
or
sign in
to comment