apitest

package

v0.1.1-0...-d0f436e Latest Latest Go to latest Published: Feb 18, 2021 License: MPL-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package apitest provides few tools helping you write tests

This section is empty.

This section is empty.

func AssertError(t *testing.T, expect jsonapi.Error, data interface{}, err error) jsonapi.Error

AssertError validates if returned values is specified error value

It checks for following situations:

func Modify(f func(jsonapi.Request) jsonapi.Request) jsonapi.Middleware

Modify creates a middleware that do some magic before running handler

func Monitor(f func(jsonapi.Request, interface{}, error)) jsonapi.Middleware

Monitor creates a middleware that do some magic after running handler

func NewRequest(method, target string, data interface{}) *http.Request

NewRequest wraps httptest.NewRequest, use your data (encoded to JSON) as request body

It also sets "Content-Type" to "application/json".

type Test jsonapi.Handler

Test wraps your handler for test purpose

func (t Test) Use(data interface{}) (interface{}, error)

Use executes handler with your data

The request address will be "/" and using POST method.

func (t Test) UseRequest(req *http.Request) (interface{}, error)

UseRequest executes handler with specified request

func (t Test) With(m jsonapi.Middleware) Test

With creates new Test instance by wrapping the handler with the middleware

It executes in REVERSE ORDER:

// order: m2 > m1 > h > m1 > m2
Test(h).With(m1).With(m2).Use(data)