RequestBuilder is a monad transformer that allows you to conveniently build a snap Request for testing.

A request body of type "multipart/form-data" consists of a set of named form parameters, each of which can by either a list of regular form values or a set of file uploads.

The RequestType datatype enumerates the different kinds of HTTP requests you can generate using the testing interface. Most users will prefer to use the get, postUrlEncoded, postMultipart, put, and delete convenience functions.

Runs a RequestBuilder, producing the desired Request.

N.B. please don't use the request you get here in a real Snap application; things will probably break. Don't say you weren't warned :-)

Given a web handler in the Snap monad, and a RequestBuilder defining a test request, runs the handler, producing an HTTP Response.

This function will produce almost exactly the same output as running the handler in a real server, except that chunked transfer encoding is not applied, and the "Transfer-Encoding" header is not set (this makes it easier to test response output).

Given a web handler in some arbitrary MonadSnap monad, a function specifying how to evaluate it within the context of the test monad, and a RequestBuilder defining a test request, runs the handler, producing an HTTP Response.

Given a web handler in the Snap monad, and a RequestBuilder defining a test request, runs the handler and returns the monadic value it produces.

Throws an exception if the Snap handler early-terminates with finishWith or mzero.

Given a web handler in some arbitrary MonadSnap monad, a function specifying how to evaluate it within the context of the test monad, and a RequestBuilder defining a test request, runs the handler, returning the monadic value it produces.

Throws an exception if the Snap handler early-terminates with finishWith or mzero.

Builds an HTTP "GET" request with the given query parameters.

Builds an HTTP "POST" request with the given form parameters, using the "application/x-www-form-urlencoded" MIME type.

Builds an HTTP "POST" request with the given form parameters, using the "form-data/multipart" MIME type.

Builds an HTTP "PUT" request.

Builds a "raw" HTTP "POST" request, with the given MIME type and body contents.

Builds an HTTP "DELETE" request with the given query parameters.

Adds the given header to the request being built.

Sets the request's content-type to the given MIME type.

Sets the given header in the request being built, overwriting any header with the same name already present.

Sets the test request's http version

Escapes the given parameter mapping and sets it as the request's query string.

Sets the request's query string to be the raw bytestring provided, without any escaping or other interpretation. Most users should instead choose the setQueryString function, which takes a parameter mapping.

Sets the request's path. The path provided must begin with a "/" and must not contain a query string; if you want to provide a query string in your test request, you must use setQueryString or setQueryStringRaw. Note that rqContextPath is never set by any RequestBuilder function.

Sets the type of the Request being built.

Controls whether the test request being generated appears to be an https request or not.

Given a Response, asserts that its HTTP status code is 200 (success).

Given a Response, asserts that its HTTP status code is 404 (Not Found).

Given a Response, asserts that its HTTP status code is between 300 and 399 (a redirect), and that the Location header of the Response points to the specified URI.

Given a Response, asserts that its HTTP status code is between 300 and 399 (a redirect).

Given a Response, asserts that its body matches the given regular expression.

Dumps the given response to stdout.

Converts the given response to a bytestring.