mockhttpclient

func HostMatcher ¶

func HostMatcher(host string) func(http.Handler) http.Handler

HostMatcher is a middleware that returns 404 if the request does not match the given host.

func MuxSafeT ¶

func MuxSafeT(orig expect.TestingT) require.TestingT

MuxSafeT wraps *testing.T to allow using the assert package (aka require package) within handler functions of the mux.Router passed to MuxClient. This is necessary because some users of http.Client behave badly when runtime.Goexit() (called by testing.T.FailNow) occurs during a request.

The documentation for testing.T.FailNow states "FailNow must be called from the goroutine running the test or benchmark function, not from other goroutines created during the test," so if the http.Client returned from MuxClient is used by a different goroutine, you should use MuxSafeT to ensure the test doesn't hang.

func New ¶

func New(urlMap map[string]MockDialogue) *http.Client

New returns a new mocked HTTPClient.

func NewMuxClient ¶

func NewMuxClient(r chi.Router) *http.Client

NewMuxClient returns an http.Client instance which sends requests to the given mux.Router.

NewMuxClient is more flexible than using httptest.NewServer because the returned client can accept requests for any scheme or host. It is more flexible than URLMock because it allows handling arbitrary URLs with arbitrary handlers. However, it is more difficult to use than URLMock when the same request URL should be handled differently on subsequent requests.

TODO(benjaminwagner): NewMuxClient does not currently support streaming responses, but does support streaming requests.

Examples:

// Mock out a URL to always respond with the same body.
r := chi.NewRouter()
r.With(SchemeMatcher("https"), HostMatcher("www.google.com")).
	Get("/", MockGetDialogue([]byte("Here's a response.")).ServeHTTP)
client := NewMuxClient(r)
res, _ := client.Get("https://www.google.com")
respBody, _ := io.ReadAll(res.Body)  // respBody == []byte("Here's a response.")

// Check that the client uses the correct ID in the request.
r.With(HostMatcher("example.com"), QueryMatcher("name", "foo", "size", "42")).
	Post("/add/{id:[a-zA-Z0-9]+}", func(w http.ResponseWriter, r *http.Request) {
	t := MuxSafeT(t)
	assert.Equal(t, chi.URLParam(r, "id"), values.Get("name"))
})

func QueryMatcher ¶

func QueryMatcher(pairs ...string) func(http.Handler) http.Handler

QueryMatcher is a middleware that returns 404 if the request does not have the given key/value pairs in the query string. For example, QueryMatcher("name", "foo", "size", "42") would match "example.com/hello?name=foo&size=42" but it wouldn't match "example.com/hello?name=bar&length=123".

func SchemeMatcher ¶

func SchemeMatcher(scheme string) func(http.Handler) http.Handler

SchemeMatcher is a middleware that returns 404 if the request does not match the given scheme.