Skip to content

Commit

Permalink
Add PanicAssertionFunc (#1337, #730)
Browse files Browse the repository at this point in the history
Add a `PanicAssertionFunc` to ease writing table-driven tests for panic
assertion.

Closes #730
  • Loading branch information
fahimbagar committed Mar 5, 2024
1 parent bb548d0 commit 8585d8d
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
4 changes: 4 additions & 0 deletions assert/assertions.go
Expand Up @@ -45,6 +45,10 @@ type BoolAssertionFunc func(TestingT, bool, ...interface{}) bool
// for table driven tests.
type ErrorAssertionFunc func(TestingT, error, ...interface{}) bool

// PanicAssertionFunc is a common function prototype when validating a panic value. Can be useful
// for table driven tests.
type PanicAssertionFunc = func(t TestingT, f PanicTestFunc, msgAndArgs ...interface{}) bool

// Comparison is a custom function that returns true on success and false on failure
type Comparison func() (success bool)

Expand Down
36 changes: 36 additions & 0 deletions assert/assertions_test.go
Expand Up @@ -2789,6 +2789,42 @@ func TestErrorAssertionFunc(t *testing.T) {
}
}

func ExamplePanicAssertionFunc() {
t := &testing.T{} // provided by test

tests := []struct {
name string
panicFn PanicTestFunc
assertion PanicAssertionFunc
}{
{"with panic", func() { panic(nil) }, Panics},
{"without panic", func() {}, NotPanics},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, tt.panicFn)
})
}
}

func TestPanicAssertionFunc(t *testing.T) {
tests := []struct {
name string
panicFn PanicTestFunc
assertion PanicAssertionFunc
}{
{"not panic", func() {}, NotPanics},
{"panic", func() { panic(nil) }, Panics},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
tt.assertion(t, tt.panicFn)
})
}
}

func TestEventuallyFalse(t *testing.T) {
mockT := new(testing.T)

Expand Down

0 comments on commit 8585d8d

Please sign in to comment.