NotNil
NotNil operator checks that data is not nil
(or is a non-nil
interface, containing a non-nil
pointer.)
got := &Person{}
td.Cmp(t, got, td.NotNil()) // succeeds
td.Cmp(t, got, td.Not(nil)) // succeeds too, but be careful it is first
// because of got type *Person ≠ untyped nil so prefer NotNil()
but:
var got fmt.Stringer = (*bytes.Buffer)(nil)
td.Cmp(t, got, td.NotNil()) // fails
td.Cmp(t, got, td.Not(nil)) // succeeds, as the interface is not nil
See also Nil
, NotEmpty
and NotZero
.
See also NotNil godoc.
Example
Base example
t := &testing.T{}
var got fmt.Stringer = &bytes.Buffer{}
// nil value can be compared directly with Not(nil), no need of NotNil() here
ok := td.Cmp(t, got, td.Not(nil))
fmt.Println(ok)
// But it works with NotNil() anyway
ok = td.Cmp(t, got, td.NotNil())
fmt.Println(ok)
got = (*bytes.Buffer)(nil)
// In the case of an interface containing a nil pointer, comparing
// with Not(nil) succeeds, as the interface is not nil
ok = td.Cmp(t, got, td.Not(nil))
fmt.Println(ok)
// In this case NotNil() fails
ok = td.Cmp(t, got, td.NotNil())
fmt.Println(ok)
// Output:
// true
// true
// true
// false
CmpNotNil shortcut
func CmpNotNil(t TestingT, got any, args ...any) bool
CmpNotNil is a shortcut for:
td.Cmp(t, got, td.NotNil(), args...)
See above for details.
Returns true if the test is OK, false if it fails.
If t is a *T
then its Config field is inherited.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1
and
the first item of args is a string
and contains a ‘%’ rune
then
fmt.Fprintf
is used to compose the name, else args are passed to
fmt.Fprint
. Do not forget it is the name of the test, not the
reason of a potential failure.
See also CmpNotNil godoc.
Example
Base example
t := &testing.T{}
var got fmt.Stringer = &bytes.Buffer{}
// nil value can be compared directly with Not(nil), no need of NotNil() here
ok := td.Cmp(t, got, td.Not(nil))
fmt.Println(ok)
// But it works with NotNil() anyway
ok = td.CmpNotNil(t, got)
fmt.Println(ok)
got = (*bytes.Buffer)(nil)
// In the case of an interface containing a nil pointer, comparing
// with Not(nil) succeeds, as the interface is not nil
ok = td.Cmp(t, got, td.Not(nil))
fmt.Println(ok)
// In this case NotNil() fails
ok = td.CmpNotNil(t, got)
fmt.Println(ok)
// Output:
// true
// true
// true
// false
T.NotNil shortcut
func (t *T) NotNil(got any, args ...any) bool
NotNil is a shortcut for:
t.Cmp(got, td.NotNil(), args...)
See above for details.
Returns true if the test is OK, false if it fails.
args… are optional and allow to name the test. This name is
used in case of failure to qualify the test. If len(args) > 1
and
the first item of args is a string
and contains a ‘%’ rune
then
fmt.Fprintf
is used to compose the name, else args are passed to
fmt.Fprint
. Do not forget it is the name of the test, not the
reason of a potential failure.
See also T.NotNil godoc.
Example
Base example
t := td.NewT(&testing.T{})
var got fmt.Stringer = &bytes.Buffer{}
// nil value can be compared directly with Not(nil), no need of NotNil() here
ok := t.Cmp(got, td.Not(nil))
fmt.Println(ok)
// But it works with NotNil() anyway
ok = t.NotNil(got)
fmt.Println(ok)
got = (*bytes.Buffer)(nil)
// In the case of an interface containing a nil pointer, comparing
// with Not(nil) succeeds, as the interface is not nil
ok = t.Cmp(got, td.Not(nil))
fmt.Println(ok)
// In this case NotNil() fails
ok = t.NotNil(got)
fmt.Println(ok)
// Output:
// true
// true
// true
// false