scotty-0.21: test/Web/ScottySpec.hs
{-# LANGUAGE OverloadedStrings, CPP, ScopedTypeVariables #-}
module Web.ScottySpec (main, spec) where
import Test.Hspec
import Test.Hspec.Wai
import Control.Applicative
import Control.Monad
import Data.Char
import Data.String
import qualified Data.Text.Lazy as TL
import qualified Data.Text.Lazy.Encoding as TLE
import Network.HTTP.Types
import Network.Wai (Application, Request(queryString), responseLBS)
import qualified Control.Exception.Lifted as EL
import qualified Control.Exception as E
import Web.Scotty as Scotty hiding (get, post, put, patch, delete, request, options)
import qualified Web.Scotty as Scotty
import qualified Web.Scotty.Cookie as SC (getCookie, setSimpleCookie, deleteCookie)
#if !defined(mingw32_HOST_OS)
import Control.Concurrent.Async (withAsync)
import Control.Exception (bracketOnError)
import qualified Data.ByteString as BS
import Data.ByteString (ByteString)
import Network.Socket (Family(..), SockAddr(..), Socket, SocketOption(..), SocketType(..), bind, close, connect, listen, maxListenQueue, setSocketOption, socket)
import Network.Socket.ByteString (send, recv)
import System.Directory (removeFile)
#endif
main :: IO ()
main = hspec spec
availableMethods :: [StdMethod]
availableMethods = [GET, POST, HEAD, PUT, PATCH, DELETE, OPTIONS]
spec :: Spec
spec = do
let withApp = with . scottyApp
describe "ScottyM" $ do
forM_ [
("GET", Scotty.get, get)
, ("POST", Scotty.post, (`post` ""))
, ("PUT", Scotty.put, (`put` ""))
, ("PATCH", Scotty.patch, (`patch` ""))
, ("DELETE", Scotty.delete, delete)
, ("OPTIONS", Scotty.options, options)
] $ \(method, route, makeRequest) -> do
describe (map toLower method) $ do
withApp (route "/scotty" $ html "") $ do
it ("adds route for " ++ method ++ " requests") $ do
makeRequest "/scotty" `shouldRespondWith` 200
withApp (route "/scotty" $ html "") $ do
it ("properly handles extra slash routes for " ++ method ++ " requests") $ do
makeRequest "//scotty" `shouldRespondWith` 200
withApp (route "/:paramName" $ captureParam "paramName" >>= text) $ do
it ("captures route parameters for " ++ method ++ " requests with url encoded '/' in path") $ do
makeRequest "/a%2Fb" `shouldRespondWith` "a/b"
describe "addroute" $ do
forM_ availableMethods $ \method -> do
withApp (addroute method "/scotty" $ html "") $ do
it ("can be used to add route for " ++ show method ++ " requests") $ do
request (renderStdMethod method) "/scotty" [] "" `shouldRespondWith` 200
describe "matchAny" $ do
withApp (matchAny "/scotty" $ html "") $ do
forM_ ("NONSTANDARD" : fmap renderStdMethod availableMethods) $ \method -> do
it ("adds route that matches " ++ show method ++ " requests") $ do
request method "/scotty" [] "" `shouldRespondWith` 200
describe "notFound" $ do
withApp (notFound $ html "my custom not found page") $ do
it "adds handler for requests that do not match any route" $ do
get "/somewhere" `shouldRespondWith` "my custom not found page" {matchStatus = 404}
withApp (notFound $ status status400 >> html "my custom not found page") $ do
it "allows to customize the HTTP status code" $ do
get "/somewhere" `shouldRespondWith` "my custom not found page" {matchStatus = 400}
context "when not specified" $ do
withApp (return ()) $ do
it "returns 404 when no route matches" $ do
get "/" `shouldRespondWith` "<h1>404: File Not Found!</h1>" {matchStatus = 404}
describe "defaultHandler" $ do
withApp (do
let h = Handler (\(e :: E.ArithException) -> status status500 >> text (TL.pack $ show e))
defaultHandler h
Scotty.get "/" (throw E.DivideByZero)) $ do
it "sets custom exception handler" $ do
get "/" `shouldRespondWith` "divide by zero" {matchStatus = 500}
withApp (do
let h = Handler (\(_ :: E.ArithException) -> status status503)
defaultHandler h
Scotty.get "/" (liftIO $ E.throwIO E.DivideByZero)) $ do
it "allows to customize the HTTP status code" $ do
get "/" `shouldRespondWith` "" {matchStatus = 503}
withApp (do
let h = Handler (\(_ :: E.SomeException) -> setHeader "Location" "/c" >> status status500)
defaultHandler h
Scotty.get "/a" (redirect "/b")) $ do
it "should give priority to actionErrorHandlers" $ do
get "/a" `shouldRespondWith` 302 { matchHeaders = ["Location" <:> "/b"] }
context "when not specified" $ do
withApp (Scotty.get "/" $ throw E.DivideByZero) $ do
it "returns 500 on exceptions" $ do
get "/" `shouldRespondWith` "" {matchStatus = 500}
context "only applies to endpoints defined after it (#237)" $ do
withApp (do
let h = Handler (\(_ :: E.SomeException) -> status status503 >> text "ok")
Scotty.get "/a" (throw E.DivideByZero)
defaultHandler h
Scotty.get "/b" (throw E.DivideByZero)
) $ do
it "doesn't catch an exception before the handler is set" $ do
get "/a" `shouldRespondWith` 500
it "catches an exception after the handler is set" $ do
get "/b" `shouldRespondWith` "ok" {matchStatus = 503}
describe "setMaxRequestBodySize" $ do
let
large = TLE.encodeUtf8 . TL.pack . concat $ [show c | c <- ([1..4500]::[Integer])]
smol = TLE.encodeUtf8 . TL.pack . concat $ [show c | c <- ([1..50]::[Integer])]
withApp (Scotty.setMaxRequestBodySize 1 >> Scotty.matchAny "/upload" (do status status200)) $ do
it "should return 200 OK if the request body size is below 1 KB" $ do
request "POST" "/upload" [("Content-Type","multipart/form-data; boundary=--33")]
smol `shouldRespondWith` 200
it "should return 413 (Content Too Large) if the request body size is above 1 KB" $ do
request "POST" "/upload" [("Content-Type","multipart/form-data; boundary=--33")]
large `shouldRespondWith` 413
context "(counterexample)" $
withApp (Scotty.post "/" $ status status200) $ do
it "doesn't throw an uncaught exception if the body is large" $ do
request "POST" "/" [("Content-Type","multipart/form-data; boundary=--33")]
large `shouldRespondWith` 200
describe "middleware" $ do
context "can rewrite the query string (#348)" $ do
withApp (do
Scotty.middleware $ \app req sendResponse ->
app req{queryString = [("query", Just "haskell")]} sendResponse
Scotty.matchAny "/search" $ queryParam "query" >>= text
) $ do
it "returns query parameter with given name" $ do
get "/search" `shouldRespondWith` "haskell"
describe "ActionM" $ do
context "MonadBaseControl instance" $ do
withApp (Scotty.get "/" $ (undefined `EL.catch` ((\_ -> html "") :: E.SomeException -> ActionM ()))) $ do
it "catches SomeException and returns 200" $ do
get "/" `shouldRespondWith` 200
withApp (Scotty.get "/" $ EL.throwIO E.DivideByZero) $ do
it "returns 500 on uncaught exceptions" $ do
get "/" `shouldRespondWith` "" {matchStatus = 500}
context "Alternative instance" $ do
withApp (Scotty.get "/" $ empty >>= text) $
it "empty without any route following returns a 404" $
get "/" `shouldRespondWith` 404
withApp (Scotty.get "/dictionary" $ empty <|> queryParam "word1" >>= text) $
it "empty throws Next" $ do
get "/dictionary?word1=x" `shouldRespondWith` "x"
withApp (Scotty.get "/dictionary" $ queryParam "word1" <|> empty <|> queryParam "word2" >>= text) $
it "<|> skips the left route if that fails" $ do
get "/dictionary?word2=y" `shouldRespondWith` "y"
get "/dictionary?word1=a&word2=b" `shouldRespondWith` "a"
context "MonadFail instance" $ do
withApp (Scotty.get "/" $ fail "boom!") $ do
it "returns 500 if not caught" $
get "/" `shouldRespondWith` 500
withApp (Scotty.get "/" $ (fail "boom!") `catch` (\(_ :: StatusError) -> text "ok")) $
it "can catch the StatusError thrown by fail" $ do
get "/" `shouldRespondWith` 200 { matchBody = "ok"}
describe "redirect" $ do
withApp (
do
Scotty.get "/a" $ redirect "/b"
) $ do
it "Responds with a 302 Redirect" $ do
get "/a" `shouldRespondWith` 302 { matchHeaders = ["Location" <:> "/b"] }
describe "captureParam" $ do
withApp (
do
Scotty.matchAny "/search/:q" $ do
_ :: Int <- captureParam "q"
text "int"
Scotty.matchAny "/search/:q" $ do
_ :: String <- captureParam "q"
text "string"
) $ do
it "responds with 200 OK iff at least one route matches at the right type" $ do
get "/search/42" `shouldRespondWith` 200 { matchBody = "int" }
get "/search/potato" `shouldRespondWith` 200 { matchBody = "string" }
withApp (
do
Scotty.matchAny "/search/:q" $ do
v <- captureParam "q"
json (v :: Int)
) $ do
it "responds with 404 Not Found if no route matches at the right type" $ do
get "/search/potato" `shouldRespondWith` 404
withApp (
do
Scotty.matchAny "/search/:q" $ do
v <- captureParam "zzz"
json (v :: Int)
) $ do
it "responds with 500 Server Error if the parameter cannot be found in the capture" $ do
get "/search/potato" `shouldRespondWith` 500
context "recover from missing parameter exception" $ do
withApp (Scotty.get "/search/:q" $
(captureParam "z" >>= text) `catch` (\(_::ScottyException) -> text "z")
) $ do
it "catches a StatusError" $ do
get "/search/xxx" `shouldRespondWith` 200 { matchBody = "z"}
describe "queryParam" $ do
withApp (Scotty.matchAny "/search" $ queryParam "query" >>= text) $ do
it "returns query parameter with given name" $ do
get "/search?query=haskell" `shouldRespondWith` "haskell"
withApp (Scotty.matchAny "/search" (do
v <- queryParam "query"
json (v :: Int) )) $ do
it "responds with 200 OK if the query parameter can be parsed at the right type" $ do
get "/search?query=42" `shouldRespondWith` 200
it "responds with 400 Bad Request if the query parameter cannot be parsed at the right type" $ do
get "/search?query=potato" `shouldRespondWith` 400
context "recover from type mismatch parameter exception" $ do
withApp (Scotty.get "/search" $
(queryParam "z" >>= (\v -> json (v :: Int))) `catch` (\(_::ScottyException) -> text "z")
) $ do
it "catches a ScottyException" $ do
get "/search?query=potato" `shouldRespondWith` 200 { matchBody = "z"}
describe "formParam" $ do
let
postForm p bdy = request "POST" p [("Content-Type","application/x-www-form-urlencoded")] bdy
withApp (Scotty.post "/search" $ formParam "query" >>= text) $ do
it "returns form parameter with given name" $ do
postForm "/search" "query=haskell" `shouldRespondWith` "haskell"
it "replaces non UTF-8 bytes with Unicode replacement character" $ do
postForm "/search" "query=\xe9" `shouldRespondWith` "\xfffd"
withApp (Scotty.post "/search" (do
v <- formParam "query"
json (v :: Int))) $ do
it "responds with 200 OK if the form parameter can be parsed at the right type" $ do
postForm "/search" "query=42" `shouldRespondWith` 200
it "responds with 400 Bad Request if the form parameter cannot be parsed at the right type" $ do
postForm "/search" "query=potato" `shouldRespondWith` 400
withApp (do
Scotty.post "/" $ next
Scotty.post "/" $ do
p :: Int <- formParam "p"
json p
) $ do
it "preserves the body of a POST request even after 'next' (#147)" $ do
postForm "/" "p=42" `shouldRespondWith` "42"
context "recover from type mismatch parameter exception" $ do
withApp (Scotty.post "/search" $
(formParam "z" >>= (\v -> json (v :: Int))) `catch` (\(_::ScottyException) -> text "z")
) $ do
it "catches a StatusError" $ do
postForm "/search" "z=potato" `shouldRespondWith` 200 { matchBody = "z"}
describe "captureParamMaybe" $ do
withApp (
do
Scotty.get "/a/:q" $ do
mx <- captureParamMaybe "q"
case mx of
Just (_ :: Int) -> status status200
Nothing -> status status500
Scotty.get "/b/:q" $ do
mx <- captureParamMaybe "z"
case mx of
Just (_ :: TL.Text) -> text "impossible" >> status status500
Nothing -> status status200
) $ do
it "responds with 200 OK if the parameter can be parsed at the right type, 500 otherwise" $ do
get "/a/potato" `shouldRespondWith` 500
get "/a/42" `shouldRespondWith` 200
it "responds with 200 OK if the parameter is not found" $ do
get "/b/potato" `shouldRespondWith` 200
describe "text" $ do
let modernGreekText :: IsString a => a
modernGreekText = "νέα ελληνικά"
withApp (Scotty.get "/scotty" $ text modernGreekText) $ do
it "sets body to given text" $ do
get "/scotty" `shouldRespondWith` modernGreekText
it "sets Content-Type header to \"text/plain; charset=utf-8\"" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/plain; charset=utf-8"]}
withApp (Scotty.get "/scotty" $ setHeader "Content-Type" "text/somethingweird" >> text modernGreekText) $ do
it "doesn't override a previously set Content-Type header" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/somethingweird"]}
describe "html" $ do
let russianLanguageTextInHtml :: IsString a => a
russianLanguageTextInHtml = "<p>ру́сский язы́к</p>"
withApp (Scotty.get "/scotty" $ html russianLanguageTextInHtml) $ do
it "sets body to given text" $ do
get "/scotty" `shouldRespondWith` russianLanguageTextInHtml
it "sets Content-Type header to \"text/html; charset=utf-8\"" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/html; charset=utf-8"]}
withApp (Scotty.get "/scotty" $ setHeader "Content-Type" "text/somethingweird" >> html russianLanguageTextInHtml) $ do
it "doesn't override a previously set Content-Type header" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/somethingweird"]}
describe "json" $ do
withApp (Scotty.get "/scotty" $ setHeader "Content-Type" "text/somethingweird" >> json (Just (5::Int))) $ do
it "doesn't override a previously set Content-Type header" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/somethingweird"]}
describe "finish" $ do
withApp (Scotty.get "/scotty" $ finish) $ do
it "responds with 200 by default" $ do
get "/scotty" `shouldRespondWith` 200
withApp (Scotty.get "/scotty" $ status status400 >> finish >> status status200) $ do
it "stops the execution of an action" $ do
get "/scotty" `shouldRespondWith` 400
describe "setSimpleCookie" $ do
withApp (Scotty.get "/scotty" $ SC.setSimpleCookie "foo" "bar") $ do
it "responds with a Set-Cookie header" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Set-Cookie" <:> "foo=bar"]}
describe "getCookie" $ do
withApp (Scotty.get "/scotty" $ do
mt <- SC.getCookie "foo"
case mt of
Just "bar" -> Scotty.status status200
_ -> Scotty.status status400 ) $ do
it "finds the right cookie in the request headers" $ do
request "GET" "/scotty" [("Cookie", "foo=bar")] "" `shouldRespondWith` 200
describe "deleteCookie" $ do
withApp (Scotty.get "/scotty" $ SC.deleteCookie "foo") $ do
it "responds with a Set-Cookie header with expiry date Jan 1, 1970" $ do
get "/scotty" `shouldRespondWith` 200 {matchHeaders = ["Set-Cookie" <:> "foo=; Expires=Thu, 01-Jan-1970 00:00:00 GMT"]}
describe "nested" $ do
let
simpleApp :: Application
simpleApp _ respond = do
putStrLn "I've done some IO here"
respond $ responseLBS
status200
[("Content-Type", "text/plain")]
"Hello, Web!"
withApp (Scotty.get "/nested" (nested simpleApp)) $ do
it "responds with the expected simpleApp response" $ do
get "/nested" `shouldRespondWith` 200 {matchHeaders = ["Content-Type" <:> "text/plain"], matchBody = "Hello, Web!"}
-- Unix sockets not available on Windows
#if !defined(mingw32_HOST_OS)
describe "scottySocket" .
it "works with a unix socket" .
withServer (Scotty.get "/scotty" $ html "") .
E.bracket (socket AF_UNIX Stream 0) close $ \sock -> do
connect sock $ SockAddrUnix socketPath
_ <- send sock "GET /scotty HTTP/1.1\r\n\n"
r1 <- recv sock 1024
_ <- send sock "GET /four-oh-four HTTP/1.1\r\n\n"
r2 <- recv sock 1024
(BS.take (BS.length ok) r1, BS.take (BS.length no) r2) `shouldBe` (ok, no)
where ok, no :: ByteString
ok = "HTTP/1.1 200 OK"
no = "HTTP/1.1 404 Not Found"
socketPath :: FilePath
socketPath = "/tmp/scotty-test.socket"
withServer :: ScottyM () -> IO a -> IO a
withServer actions inner = E.bracket
(listenOn socketPath)
(\sock -> close sock >> removeFile socketPath)
(\sock -> withAsync (Scotty.scottySocket defaultOptions sock actions) $ const inner)
-- See https://github.com/haskell/network/issues/318
listenOn :: String -> IO Socket
listenOn path =
bracketOnError
(socket AF_UNIX Stream 0)
close
(\sock -> do
setSocketOption sock ReuseAddr 1
bind sock (SockAddrUnix path)
listen sock maxListenQueue
return sock
)
#endif