Test.Hspec.Wai

Have a look at the README for an example of how to use this library.

Types

data WaiSession st a

A WAI test session that carries the Application under test and some client state.

Instances

Monad (WaiSession st)

Defined in Test.Hspec.Wai.Internal

Methods

(>>=) :: WaiSession st a -> (a -> WaiSession st b) -> WaiSession st b

(>>) :: WaiSession st a -> WaiSession st b -> WaiSession st b

return :: a -> WaiSession st a

Functor (WaiSession st)

Defined in Test.Hspec.Wai.Internal

Methods

fmap :: (a -> b) -> WaiSession st a -> WaiSession st b

(<$) :: a -> WaiSession st b -> WaiSession st a

MonadFail (WaiSession st)

Defined in Test.Hspec.Wai.Internal

Methods

fail :: String -> WaiSession st a

Applicative (WaiSession st)

Defined in Test.Hspec.Wai.Internal

Methods

pure :: a -> WaiSession st a

(<*>) :: WaiSession st (a -> b) -> WaiSession st a -> WaiSession st b

liftA2 :: (a -> b -> c) -> WaiSession st a -> WaiSession st b -> WaiSession st c

(*>) :: WaiSession st a -> WaiSession st b -> WaiSession st b

(<*) :: WaiSession st a -> WaiSession st b -> WaiSession st a

MonadIO (WaiSession st)

Defined in Test.Hspec.Wai.Internal

Methods

liftIO :: IO a -> WaiSession st a

Example (WaiExpectation st)

Defined in Test.Hspec.Wai.Internal

Associated Types

type Arg (WaiExpectation st)

Methods

evaluateExample :: WaiExpectation st -> Params -> (ActionWith (Arg (WaiExpectation st)) -> IO ()) -> ProgressCallback -> IO Result

Testable (WaiExpectation st)

Defined in Test.Hspec.Wai.QuickCheck

Associated Types

type State (WaiExpectation st)

Methods

toProperty :: WaiExpectation st -> WaiProperty (State (WaiExpectation st))

type Arg (WaiExpectation st)

Defined in Test.Hspec.Wai.Internal

type Arg (WaiExpectation st) = (st, Application)

type State (WaiExpectation st)

Defined in Test.Hspec.Wai.QuickCheck

type State (WaiExpectation st) = st

type WaiExpectation st = WaiSession st ()

An expectation in the WaiSession monad. Failing expectations are communicated through exceptions (similar to Expectation and Assertion).

Performing requests

get :: ByteString -> WaiSession st SResponse

Perform a GET request to the application under test.

post :: ByteString -> ByteString -> WaiSession st SResponse

Perform a POST request to the application under test.

put :: ByteString -> ByteString -> WaiSession st SResponse

Perform a PUT request to the application under test.

patch :: ByteString -> ByteString -> WaiSession st SResponse

Perform a PATCH request to the application under test.

options :: ByteString -> WaiSession st SResponse

Perform an OPTIONS request to the application under test.

delete :: ByteString -> WaiSession st SResponse

Perform a DELETE request to the application under test.

request :: Method -> ByteString -> [Header] -> ByteString -> WaiSession st SResponse

Perform a request to the application under test, with specified HTTP method, request path, headers and body.

Posting HTML forms

postHtmlForm :: ByteString -> [(String, String)] -> WaiSession st SResponse

Perform a POST request to the application under test.

The specified list of key-value pairs is encoded as application/x-www-form-urlencoded and used as request body.

In addition the Content-Type is set to application/x-www-form-urlencoded.

Matching on the response

shouldRespondWith :: HasCallStack => WaiSession st SResponse -> ResponseMatcher -> WaiExpectation st

Set the expectation that a response matches a specified ResponseMatcher.

A ResponseMatcher matches a response if:

• the specified status matches the HTTP response status code
• the specified body (if any) matches the response body
• the response has all of the specified Header fields (the response may have arbitrary additional Header fields)

You can use ResponseMatcher's (broken) Num instance to match for a HTTP status code:

get "/" `shouldRespondWith` 200
-- matches if status is 200

You can use ResponseMatcher's IsString instance to match for a HTTP status 200 and a body:

get "/" `shouldRespondWith` "foo"
-- matches if body is "foo" and status is 200

If you want to match for a different HTTP status, you can use record update notation to specify matchStatus explicitly:

get "/" `shouldRespondWith` "foo" {matchStatus = 404}
-- matches if body is "foo" and status is 404

If you want to require a specific header field you can specify matchHeaders:

get "/" `shouldRespondWith` "foo" {matchHeaders = ["Content-Type" <:> "text/plain"]}
-- matches if body is "foo", status is 200 and there is a header field "Content-Type: text/plain"

data ResponseMatcher

Constructors

ResponseMatcher

Fields

• matchStatus :: Int
• matchHeaders :: [MatchHeader]
• matchBody :: MatchBody

Instances

Num ResponseMatcher

Defined in Test.Hspec.Wai.Matcher

Methods

(+) :: ResponseMatcher -> ResponseMatcher -> ResponseMatcher

(-) :: ResponseMatcher -> ResponseMatcher -> ResponseMatcher

(*) :: ResponseMatcher -> ResponseMatcher -> ResponseMatcher

negate :: ResponseMatcher -> ResponseMatcher

abs :: ResponseMatcher -> ResponseMatcher

signum :: ResponseMatcher -> ResponseMatcher

fromInteger :: Integer -> ResponseMatcher

IsString ResponseMatcher

Defined in Test.Hspec.Wai.Matcher

Methods

fromString :: String -> ResponseMatcher

data MatchHeader

Constructors

MatchHeader ([Header] -> Body -> Maybe String)

data MatchBody

Constructors

MatchBody ([Header] -> Body -> Maybe String)

Instances

IsString MatchBody

Defined in Test.Hspec.Wai.Matcher

Methods

fromString :: String -> MatchBody

type Body = ByteString

(<:>) :: HeaderName -> ByteString -> MatchHeader

Helpers and re-exports

liftIO :: MonadIO m => IO a -> m a

Lift a computation from the IO monad.

with :: IO Application -> SpecWith ((), Application) -> Spec

withState :: IO (st, Application) -> SpecWith (st, Application) -> Spec

getState :: WaiSession st st

pending :: WaiSession st ()

A lifted version of pending.

pendingWith :: String -> WaiSession st ()

A lifted version of pendingWith.