testify/README.md

1.8 KiB

Testify - Thou shalt write tests

Go code (golang) set of packages that provide many tools for testifying that your code will behave as you intend.

  • Easy assertions
  • Mocking
  • HTTP response trapping

Read the API documentation: http://go.pkgdoc.org/github.com/stretchrcom/testify

assert package

The assert package provides some helpful methods that allow you to write better test code in Go.

See it in action:

func TestSomething(t *testing.T) {

  // assert equality
  assert.Equal(t, 123, 123, "they should be equal")

  // assert inequality
  assert.NotEqual(t, 123, 456, "they should not be equal")

  // assert for nil (good for errors)
  assert.Nil(t, object)

  // assert for not nil (good when you expect something)
  if assert.NotNil(t, object) {

  	// now we know that object isn't nil, we are safe to make
  	// further assertions without causing any errors
    assert.Equal(t, "Something", object.Value)

  }

}
  • Every assert func takes the testing.T object as the first argument. This is how it writes the errors out through the normal go test capabilities.
  • Every assert func returns a bool indicating whether the assertion was successful or not, this is useful for if you want to go on making further assertions under certain conditions.

http package

The http package contains test objects useful for testing code that relies on the net/http package.

mock package

The mock package provides a mechanism for easily writing mock objects that can be used in place of real objects when writing test code.

For more information on how to write mock code, check out the API documentation for the mock package.