Safe Haskell | None |
---|---|
Language | Haskell98 |
Yesod.Test is a pragmatic framework for testing web applications built using wai and persistent.
By pragmatic I may also mean dirty
. It's main goal is to encourage integration
and system testing of web applications by making everything easy to test.
Your tests are like browser sessions that keep track of cookies and the last visited page. You can perform assertions on the content of HTML responses, using css selectors to explore the document more easily.
You can also easily build requests using forms present in the current page.
This is very useful for testing web applications built in yesod for example,
were your forms may have field names generated by the framework or a randomly
generated _nonce
field.
Your database is also directly available so you can use runDBRunner to set up backend pre-conditions, or to assert that your session is having the desired effect.
- yesodSpec :: YesodDispatch site => site -> YesodSpec site -> Spec
- type YesodSpec site = Writer [YesodSpecTree site] ()
- yesodSpecWithSiteGenerator :: YesodDispatch site => IO site -> YesodSpec site -> Spec
- yesodSpecApp :: YesodDispatch site => site -> IO Application -> YesodSpec site -> Spec
- type YesodExample site = StateT (YesodExampleData site) IO
- data YesodExampleData site = YesodExampleData {
- yedApp :: !Application
- yedSite :: !site
- yedCookies :: !Cookies
- yedResponse :: !(Maybe SResponse)
- data YesodSpecTree site
- = YesodSpecGroup String [YesodSpecTree site]
- | YesodSpecItem String (YesodExample site ())
- ydescribe :: String -> YesodSpec site -> YesodSpec site
- yit :: String -> YesodExample site () -> YesodSpec site
- get :: (Yesod site, RedirectUrl site url) => url -> YesodExample site ()
- post :: (Yesod site, RedirectUrl site url) => url -> YesodExample site ()
- postBody :: (Yesod site, RedirectUrl site url) => url -> ByteString -> YesodExample site ()
- request :: Yesod site => RequestBuilder site () -> YesodExample site ()
- addRequestHeader :: Header -> RequestBuilder site ()
- setMethod :: Method -> RequestBuilder site ()
- addPostParam :: Text -> Text -> RequestBuilder site ()
- addGetParam :: Text -> Text -> RequestBuilder site ()
- addFile :: Text -> FilePath -> Text -> RequestBuilder site ()
- setRequestBody :: Yesod site => ByteString -> RequestBuilder site ()
- type RequestBuilder site = StateT (RequestBuilderData site) IO
- setUrl :: (Yesod site, RedirectUrl site url) => url -> RequestBuilder site ()
- byLabel :: Text -> Text -> RequestBuilder site ()
- fileByLabel :: Text -> FilePath -> Text -> RequestBuilder site ()
- addNonce :: RequestBuilder site ()
- addNonce_ :: Query -> RequestBuilder site ()
- assertEqual :: Eq a => String -> a -> a -> YesodExample site ()
- assertHeader :: CI ByteString -> ByteString -> YesodExample site ()
- assertNoHeader :: CI ByteString -> YesodExample site ()
- statusIs :: Int -> YesodExample site ()
- bodyEquals :: String -> YesodExample site ()
- bodyContains :: String -> YesodExample site ()
- htmlAllContain :: Query -> String -> YesodExample site ()
- htmlAnyContain :: Query -> String -> YesodExample site ()
- htmlNoneContain :: Query -> String -> YesodExample site ()
- htmlCount :: Query -> Int -> YesodExample site ()
- getTestYesod :: YesodExample site site
- getResponse :: YesodExample site (Maybe SResponse)
- printBody :: YesodExample site ()
- printMatches :: Query -> YesodExample site ()
- htmlQuery :: Query -> YesodExample site [HtmlLBS]
- parseHTML :: HtmlLBS -> Cursor
- withResponse :: (SResponse -> YesodExample site a) -> YesodExample site a
Declaring and running your test suite
type YesodSpec site = Writer [YesodSpecTree site] () Source
Corresponds to hspec's Spec
.
Since 1.2.0
yesodSpecWithSiteGenerator :: YesodDispatch site => IO site -> YesodSpec site -> Spec Source
Same as yesodSpec, but instead of taking already built site it takes an action which produces site for each test.
yesodSpecApp :: YesodDispatch site => site -> IO Application -> YesodSpec site -> Spec Source
Same as yesodSpec, but instead of taking a site it
takes an action which produces the Application
for each test.
This lets you use your middleware from makeApplication
type YesodExample site = StateT (YesodExampleData site) IO Source
A single test case, to be run with yit
.
Since 1.2.0
data YesodExampleData site Source
The state used in a single test case defined using yit
Since 1.2.4
YesodExampleData | |
|
data YesodSpecTree site Source
Internal data structure, corresponding to hspec's YesodSpecTree
.
Since 1.2.0
YesodSpecGroup String [YesodSpecTree site] | |
YesodSpecItem String (YesodExample site ()) |
ydescribe :: String -> YesodSpec site -> YesodSpec site Source
Start describing a Tests suite keeping cookies and a reference to the tested Application
and ConnectionPool
yit :: String -> YesodExample site () -> YesodSpec site Source
Describe a single test that keeps cookies, and a reference to the last response.
Making requests
To make a request you need to point to an url and pass in some parameters.
To build your parameters you will use the RequestBuilder monad that lets you add values, add files, lookup fields by label and find the current nonce value and add it to your request too.
get :: (Yesod site, RedirectUrl site url) => url -> YesodExample site () Source
Perform a GET request to url, using params
post :: (Yesod site, RedirectUrl site url) => url -> YesodExample site () Source
Perform a POST request to url
postBody :: (Yesod site, RedirectUrl site url) => url -> ByteString -> YesodExample site () Source
Perform a POST request to url with sending a body into it.
request :: Yesod site => RequestBuilder site () -> YesodExample site () Source
General interface to performing requests, allowing you to add extra headers as well as letting you specify the request method.
addRequestHeader :: Header -> RequestBuilder site () Source
setMethod :: Method -> RequestBuilder site () Source
addPostParam :: Text -> Text -> RequestBuilder site () Source
Add a parameter with the given name and value.
addGetParam :: Text -> Text -> RequestBuilder site () Source
addFile :: Text -> FilePath -> Text -> RequestBuilder site () Source
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
setRequestBody :: Yesod site => ByteString -> RequestBuilder site () Source
Simple way to set HTTP request body
type RequestBuilder site = StateT (RequestBuilderData site) IO Source
The RequestBuilder state monad constructs an 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.
setUrl :: (Yesod site, RedirectUrl site url) => url -> RequestBuilder site () Source
Yesod can auto generate field ids, so you are never sure what the argument name should be for each one of your args when constructing your requests. What you do know is the label of the field. These functions let you add parameters to your request based on currently displayed label names.
byLabel :: Text -> Text -> RequestBuilder site () Source
fileByLabel :: Text -> FilePath -> Text -> RequestBuilder site () Source
Does the current form have a _nonce? Use any of these to add it to your request parameters.
addNonce :: RequestBuilder site () Source
For responses that display a single form, just lookup the only nonce available.
addNonce_ :: Query -> RequestBuilder site () Source
Lookup a _nonce form field and add it's value to the params. Receives a CSS selector that should resolve to the form element containing the nonce.
Assertions
assertEqual :: Eq a => String -> a -> a -> YesodExample site () Source
Asserts that the two given values are equal.
assertHeader :: CI ByteString -> ByteString -> YesodExample site () Source
Assert the given header key/value pair was returned.
assertNoHeader :: CI ByteString -> YesodExample site () Source
Assert the given header was not included in the response.
statusIs :: Int -> YesodExample site () Source
Assert the last response status is as expected.
bodyEquals :: String -> YesodExample site () Source
Assert the last response is exactly equal to the given text. This is useful for testing API responses.
bodyContains :: String -> YesodExample site () Source
Assert the last response has the given text. The check is performed using the response body in full text form.
htmlAllContain :: Query -> String -> YesodExample site () Source
Queries the html using a css selector, and all matched elements must contain the given string.
htmlAnyContain :: Query -> String -> YesodExample site () Source
Queries the html using a css selector, and passes if any matched element contains the given string.
Since 0.3.5
htmlNoneContain :: Query -> String -> YesodExample site () Source
Queries the html using a css selector, and fails if any matched element contains the given string (in other words, it is the logical inverse of htmlAnyContains).
Since 1.2.2
htmlCount :: Query -> Int -> YesodExample site () Source
Performs a css query on the last response and asserts the matched elements are as many as expected.
Grab information
getTestYesod :: YesodExample site site Source
Get the foundation value used for the current test.
Since 1.2.0
getResponse :: YesodExample site (Maybe SResponse) Source
Get the most recently provided response value, if available.
Since 1.2.0
Debug output
printBody :: YesodExample site () Source
Outputs the last response body to stderr (So it doesn't get captured by HSpec)
printMatches :: Query -> YesodExample site () Source
Performs a CSS query and print the matches to stderr.
Utils for building your own assertions
Please consider generalizing and contributing the assertions you write.
htmlQuery :: Query -> YesodExample site [HtmlLBS] Source
Query the last response using css selectors, returns a list of matched fragments
parseHTML :: HtmlLBS -> Cursor Source
Use HXT to parse a value from an html tag. Check for usage examples in this module's source.
withResponse :: (SResponse -> YesodExample site a) -> YesodExample site a Source
Performs a given action using the last response. Use this to create response-level assertions