The general interface for performing requests

request takes a RequestBuilder, constructs a request, and executes it.

The RequestBuilder allows you to build up attributes of the request, like the headers, parameters, and URL of the request.

The RequestBuilder state monad constructs a URL encoded string of arguments to send with your requests. Some of the functions that run on it use the current response to analyze the forms that the server is expecting to receive.

Sets the HTTP method used by the request.

Examples

request $ do
  setMethod "POST"

import Network.HTTP.Types.Method
request $ do
  setMethod methodPut

Sets the URL used by the request.

Examples

request $ do
  setUrl HomeR

request $ do
  setUrl ("http://google.com/" :: Text)

Simple way to set HTTP request body

Examples

request $ do
  setRequestBody "foobar"

import Data.Aeson
request $ do
  setRequestBody $ encode $ object ["age" .= (1 :: Integer)]

Add a parameter with the given name and value to the query string.

Examples

{-# LANGUAGE OverloadedStrings #-}
request $ do
  addGetParam "key" "value" -- Adds ?key=value to the URL

Add a parameter with the given name and value to the request body. This function can be called multiple times to add multiple parameters, and be mixed with calls to addFile.

"Post parameter" is an informal description of what is submitted by making an HTTP POST with an HTML <form>. Like HTML <form>s, yesod-test will default to a Content-Type of application/x-www-form-urlencoded if no files are added, and switch to multipart/form-data if files are added.

Calling this function after using setRequestBody will raise an error.

Examples

{-# LANGUAGE OverloadedStrings #-}
post $ do
  addPostParam "key" "value"

Adds the given header to the request; see Network.HTTP.Types.Header for creating Headers.

Examples

import Network.HTTP.Types.Header
request $ do
  addRequestHeader (hUserAgent, "Chrome/41.0.2228.0")

Sets both Content-Type and Accept fields to application/json

Set a language for the test Request

This uses a _LANG query parameter since it's a singleton case, just to exercise that machinery.

Set the Accept-Language header to a list of raw values

This allows testing with actual quality-factors, etc.

Add a file to be posted with the current request.

Adding a file will automatically change your request content-type to be multipart/form-data.

Examples

request $ do
  addFile "profile_picture" "static/img/picture.png" "img/png"

Perform a GET request to url

Perform a POST request to url

Follow a redirect, if the last response was a redirect

Get the body of the most recent response as a byte string

Get the body of the most recent response and decode it as CSV

Get the body of the most recent response and decode it as JSON

Get the most recently provided response value, if available

Performs a given action using the last response. Use this to create response-level assertions

Assert the last response status is as expected

If the status code doesn't match, a portion of the body is also printed to aid in debugging.

Assert the given header key/value pair was returned

Assert that the given header field's value contains some particular byte string within it

Assert that the given header field's value satisfied some predicate

Assert the last response has the given text

The check is performed using the response body in full text form.

Returns the Cookies from the most recent request. If a request hasn't been made, an error is raised.

Examples

request $ do
  cookies <- getRequestCookies
  liftIO $ putStrLn $ "Cookies are: " ++ show cookies

Sets a cookie

Deletes the cookie of the given name

Clears the current cookies

State + IO

Since: yesod-test-1.6.0

A single test case, to be run with yit.

Since 1.2.0

The state used in a single test case defined using yit

Since 1.2.4

Get the foundation value used for the current test