Documentation

Overview

    Package testhelper container methods that are useful for writing unit tests.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	// Mux is a multiplexer that can be used to register handlers.
    	Mux *http.ServeMux
    
    	// Server is an in-memory HTTP server for testing.
    	Server *httptest.Server
    )

    Functions

    func AssertDeepEquals

    func AssertDeepEquals(t *testing.T, expected, actual interface{})

      AssertDeepEquals - like Equals - performs a comparison - but on more complex structures that requires deeper inspection

      func AssertEquals

      func AssertEquals(t *testing.T, expected, actual interface{})

        AssertEquals compares two arbitrary values and performs a comparison. If the comparison fails, a fatal error is raised that will fail the test

        func AssertJSONEquals

        func AssertJSONEquals(t *testing.T, expectedJSON string, actual interface{})

          AssertJSONEquals serializes a value as JSON, parses an expected string as JSON, and ensures that both are consistent. If they aren't, the expected and actual structures are pretty-printed and shown for comparison.

          This is useful for comparing structures that are built as nested map[string]interface{} values, which are a pain to construct as literals.

          func AssertNoErr

          func AssertNoErr(t *testing.T, e error)

            AssertNoErr is a convenience function for checking whether an error value is an actual error

            func CheckDeepEquals

            func CheckDeepEquals(t *testing.T, expected, actual interface{})

              CheckDeepEquals is similar to AssertDeepEquals, except with a non-fatal error

              func CheckEquals

              func CheckEquals(t *testing.T, expected, actual interface{})

                CheckEquals is similar to AssertEquals, except with a non-fatal error

                func CheckJSONEquals

                func CheckJSONEquals(t *testing.T, expectedJSON string, actual interface{})

                  CheckJSONEquals is similar to AssertJSONEquals, but nonfatal.

                  func CheckNoErr

                  func CheckNoErr(t *testing.T, e error)

                    CheckNoErr is similar to AssertNoErr, except with a non-fatal error

                    func Endpoint

                    func Endpoint() string

                      Endpoint returns a fake endpoint that will actually target the Mux.

                      func SetupHTTP

                      func SetupHTTP()

                        SetupHTTP prepares the Mux and Server.

                        func TeardownHTTP

                        func TeardownHTTP()

                          TeardownHTTP releases HTTP-related resources.

                          func TestBody

                          func TestBody(t *testing.T, r *http.Request, expected string)

                            TestBody verifies that the request body matches an expected body.

                            func TestFormValues

                            func TestFormValues(t *testing.T, r *http.Request, values map[string]string)

                              TestFormValues ensures that all the URL parameters given to the http.Request are the same as values.

                              func TestHeader

                              func TestHeader(t *testing.T, r *http.Request, header string, expected string)

                                TestHeader checks that the header on the http.Request matches the expected value.

                                func TestJSONRequest

                                func TestJSONRequest(t *testing.T, r *http.Request, expected string)

                                  TestJSONRequest verifies that the JSON payload of a request matches an expected structure, without asserting things about whitespace or ordering.

                                  func TestMethod

                                  func TestMethod(t *testing.T, r *http.Request, expected string)

                                    TestMethod checks that the Request has the expected method (e.g. GET, POST).

                                    Types

                                    This section is empty.

                                    Directories

                                    Path Synopsis