doc.go

// Package is is a mini testing helper.
//
//     func TestSomething(t *testing.T) {
//       is := is.New(t)
//       obj, err := MethodBeingTested()
//       is.OK(obj, err) // list of objects, all must be OK
//       is.Equal(obj, "Hello world")
//     }
//
// OK
//
// is.OK asserts that the specified object is OK, which means
// different things for different types:
//
//     bool  - OK means not false
//     int   - OK means not zero
//     error - OK means nil
//     string - OK means not ""
//     func() - OK means does not panic
//     everything else - OK means not nil
//
// Equality
//
// is.Equal asserts that two objects are effectively equal.
//
// Panics
//
// is.Panic and is.PanicWith asserts that the func() will panic.
// PanicWith specifies the panic text that is expected:
//
//     func TestInvalidArgs(t *testing.T) {
//       is := is.New(t)
//       is.Panic(func(){
//         SomeMethod(1)
//       })
//       is.PanicWith("invalid args, both cannot be nil", func(){
//         OtherMethod(nil, nil)
//       })
//     }
//
// Relaxed
//
// To prevent is from stopping when the first assertion fails,
// you can use is.Relaxed(t), rather than is.New(t).
//
//     func TestManyThings(t *testing.T) {
//       is := is.Relaxed(t)
//       thing, err := Something();
//       is.OK(thing)
//       is.Nil(err)
//       another, err := Another();
//       is.Nil(another)
//       is.Err(err)
//       // all assertions will be tried
//     }
package is