Test.Tasty.Wai

Types and functions for testing wai endpoints using the tasty testing framework.

Types

data Sess

Data structure for carrying around the info needed to build and run a test.

Constructors

S Application TestName (Session ())

Instances

IsTest Sess

Defined in Test.Tasty.Wai

Methods

run :: OptionSet -> Sess -> (Progress -> IO ()) -> IO Result

testOptions :: Tagged Sess [OptionDescription]

Creation

testWai :: Application -> TestName -> Session () -> TestTree

Run a test case against a Application.

This module re-exports the functions from 'wai-extra' for constructing the Session that is executed against a given endpoint.

A small test case may look like:

import MyApp (app)

testWai app "List Topics" $ do
      res <- get "fudge/view"
      assertStatus' HTTP.status200 res

Helpers

get :: ByteString -> Session SResponse

Submit a GET request to the provided endpoint.

post :: ByteString -> ByteString -> Session SResponse

Submit a POST request to the given endpoint with the provided ByteString as the body content.

put :: ByteString -> ByteString -> Session SResponse

Submit a PUT request to the given endpoint with the provided ByteString as the body content.

assertStatus' :: Status -> SResponse -> Session ()

An alternative helper function for checking the status code on a response that lets you use the functions from Types as opposed to bare numbers.

Request Builders

buildRequest :: StdMethod -> ByteString -> Request

Create an empty Request using the given HTTP Method and route.

buildRequestWithBody :: StdMethod -> ByteString -> ByteString -> SRequest

As per buildRequest but requires body content.

buildRequestWithHeaders :: StdMethod -> ByteString -> ByteString -> RequestHeaders -> SRequest

As per buildRequestWithBody but allows for the setting of RequestHeaders.

module Network.Wai.Test