@@ -1,27 +1,36 @@
11module Servant.QuickCheck.Internal.Predicates where
22
3−import Control.Monad
3+import Control.Exception (catch, throw)
4+import Control.Monad (liftM2, unless, when)
45import Data.Aeson (Object, decode)
5−import Data.Bifunctor (Bifunctor (..))
6+import Data.Bifunctor (first)
67import qualified Data.ByteString as SBS
78import qualified Data.ByteString.Char8 as SBSC
89import qualified Data.ByteString.Lazy as LBS
9−import Data.CaseInsensitive (mk)
10+import Data.CaseInsensitive (foldCase, foldedCase, mk)
1011import Data.Either (isRight)
1112import Data.List.Split (wordsBy)
12−import Data.Maybe (fromMaybe, isJust, maybeToList)
13−import Data.Monoid ((<>))
14−import Data.Text (Text)
13+import Data.Maybe (fromMaybe, isJust)
14+import Data.Semigroup (Semigroup (..))
15+import qualified Data.Text as T
16+import Data.Time (UTCTime, defaultTimeLocale, parseTimeM,
17+ rfc822DateFormat)
1518import GHC.Generics (Generic)
1619import Network.HTTP.Client (Manager, Request, Response, httpLbs,
17− method, parseUrl, requestHeaders,
20+ method, parseRequest, requestHeaders,
1821 responseBody, responseHeaders,
1922 responseStatus)
2023import Network.HTTP.Media (matchAccept)
2124import Network.HTTP.Types (methodGet, methodHead, parseMethod,
22− renderStdMethod, status200, status201,
23− status300, status401, status405,
24− status500)
25+ renderStdMethod, status100, status200,
26+ status201, status300, status401,
27+ status405, status500)
28+import Prelude.Compat
29+import System.Clock (Clock (Monotonic), diffTimeSpec,
30+ getTime, toNanoSecs)
31+
32+import Servant.QuickCheck.Internal.ErrorTypes
33+
2534
2635-- | [__Best Practice__]
2736--
@@ -30,8 +39,27 @@ import Network.HTTP.Types (methodGet, methodHead, parseMethod,
3039-- indication of how to proceed or what went wrong.
3140--
3241-- This function checks that the response code is not 500.
33−not500 :: ResponsePredicate Text Bool
34−not500 = ResponsePredicate "not500" (\resp -> not $ responseStatus resp == status500)
42+--
43+-- /Since 0.0.0.0/
44+not500 :: ResponsePredicate
45+not500 = ResponsePredicate $ \resp ->
46+ when (responseStatus resp == status500) $ throw $ PredicateFailure "not500" Nothing resp
47+
48+-- | [__Optional__]
49+--
50+-- This function checks that the response from the server does not take longer
51+-- than the specified number of nanoseconds.
52+--
53+-- /Since 0.0.2.1/
54+notLongerThan :: Integer -> RequestPredicate
55+notLongerThan maxAllowed
56+ = RequestPredicate $ \req mgr -> do
57+ start <- getTime Monotonic
58+ resp <- httpLbs req mgr
59+ end <- getTime Monotonic
60+ when (toNanoSecs (end `diffTimeSpec` start) > maxAllowed) $
61+ throw $ PredicateFailure "notLongerThan" (Just req) resp
62+ return []
3563
3664-- | [__Best Practice__]
3765--
@@ -52,11 +80,17 @@ not500 = ResponsePredicate "not500" (\resp -> not $ responseStatus resp == statu
5280--
5381-- * JSON Grammar: <https://tools.ietf.org/html/rfc7159#section-2 RFC 7159 Section 2>
5482-- * JSON Grammar: <https://tools.ietf.org/html/rfc4627#section-2 RFC 4627 Section 2>
55−onlyJsonObjects :: ResponsePredicate Text Bool
83+--
84+-- /Since 0.0.0.0/
85+onlyJsonObjects :: ResponsePredicate
5686onlyJsonObjects
57− = ResponsePredicate "onlyJsonObjects" (\resp -> case decode (responseBody resp) of
58− Nothing -> False
59− Just (_ :: Object) -> True)
87+ = ResponsePredicate (\resp -> do
88+ case lookup "content-type" (first foldedCase <$> responseHeaders resp) of
89+ Nothing -> return ()
90+ Just ctype -> when ("application/json" `SBS.isPrefixOf` ctype) $ do
91+ case (decode (responseBody resp) :: Maybe Object) of
92+ Nothing -> throw $ PredicateFailure "onlyJsonObjects" Nothing resp
93+ Just _ -> return ())
6094
6195-- | __Optional__
6296--
@@ -75,29 +109,61 @@ onlyJsonObjects
75109--
76110-- * 201 Created: <https://tools.ietf.org/html/rfc7231#section-6.3.2 RFC 7231 Section 6.3.2>
77111-- * Location header: <https://tools.ietf.org/html/rfc7231#section-7.1.2 RFC 7231 Section 7.1.2>
78−createContainsValidLocation :: RequestPredicate Text Bool
112+--
113+-- /Since 0.0.0.0/
114+createContainsValidLocation :: RequestPredicate
79115createContainsValidLocation
80− = RequestPredicate
81− { reqPredName = "createContainsValidLocation"
82− , reqResps = \req mgr -> do
116+ = RequestPredicate $ \req mgr -> do
117+ let n = "createContainsValidLocation"
118+ resp <- httpLbs req mgr
119+ if responseStatus resp == status201
120+ then case lookup "Location" $ responseHeaders resp of
121+ Nothing -> throw $ PredicateFailure n (Just req) resp
122+ Just l -> case parseRequest $ SBSC.unpack l of
123+ Nothing -> throw $ PredicateFailure n (Just req) resp
124+ Just x -> do
125+ resp2 <- httpLbs x mgr
126+ status2XX (Just req) resp2 n
127+ return [resp, resp2]
128+ else return [resp]
129+
130+-- | [__Optional__]
131+--
132+-- The @Last-Modified@ header represents the time a resource was last
133+-- modified. It is used to drive caching and conditional requests.
134+--
135+-- When using this mechanism, the server adds the @Last-Modified@ header to
136+-- responses. Clients may then make requests with the @If-Modified-Since@
137+-- header to conditionally request resources. If the resource has not
138+-- changed since that date, the server responds with a status code of 304
139+-- (@Not Modified@) without a response body.
140+--
141+-- The @Last-Modified@ header can also be used in conjunction with the
142+-- @If-Unmodified-Since@ header to drive optimistic concurrency.
143+--
144+-- The @Last-Modified@ date must be in RFC 822 format.
145+--
146+-- __References__:
147+--
148+-- * 304 Not Modified: <https://tools.ietf.org/html/rfc7232#section-4.1 RFC 7232 Section 4.1>
149+-- * Last-Modified header: <https://tools.ietf.org/html/rfc7232#section-2.2 RFC 7232 Section 2.2>
150+-- * If-Modified-Since header: <https://tools.ietf.org/html/rfc7232#section-3.3 RFC 7232 Section 3.3>
151+-- * If-Unmodified-Since header: <https://tools.ietf.org/html/rfc7232#section-3.4 RFC 7232 Section 3.4>
152+-- * Date format: <https://tools.ietf.org/html/rfc2616#section-3.3 RFC 2616 Section 3.3>
153+--
154+-- /Since 0.0.2.1/
155+getsHaveLastModifiedHeader :: RequestPredicate
156+getsHaveLastModifiedHeader
157+ = RequestPredicate $ \req mgr ->
158+ if (method req == methodGet)
159+ then do
83160 resp <- httpLbs req mgr
84− if responseStatus resp == status201
85− then case lookup "Location" $ responseHeaders resp of
86− Nothing -> return (False, [resp])
87− Just l -> case parseUrl $ SBSC.unpack l of
88− Nothing -> return (False, [resp])
89− Just x -> do
90− resp2 <- httpLbs x mgr
91− return (status2XX resp2, [resp, resp2])
92− else return (True, [resp])
93− }
161+ unless (hasValidHeader "Last-Modified" isRFC822Date resp) $ do
162+ throw $ PredicateFailure "getsHaveLastModifiedHeader" (Just req) resp
163+ return [resp]
164+ else return []
94165
95−{-
96−getsHaveLastModifiedHeader :: ResponsePredicate Text Bool
97−getsHaveLastModifiedHeader
98− = ResponsePredicate "getsHaveLastModifiedHeader" (\resp ->
99166
100−-}
101167
102168-- | [__RFC Compliance__]
103169--
@@ -109,26 +175,32 @@ getsHaveLastModifiedHeader
109175-- This function checks that every @405 Method Not Allowed@ response contains
110176-- an @Allow@ header with a list of standard HTTP methods.
111177--
178+-- Note that 'servant' itself does not currently set the @Allow@ headers.
179+--
112180-- __References__:
113181--
114182-- * @Allow@ header: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616 Section 14.7>
115183-- * Status 405: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html RFC 2616 Section 10.4.6>
116−notAllowedContainsAllowHeader :: RequestPredicate Text Bool
184+-- * Servant Allow header issue: <https://github.com/haskell-servant/servant/issues/489 Issue #489>
185+--
186+-- /Since 0.0.0.0/
187+notAllowedContainsAllowHeader :: RequestPredicate
117188notAllowedContainsAllowHeader
118− = RequestPredicate
119− { reqPredName = "notAllowedContainsAllowHeader"
120− , reqResps = \req mgr -> do
121− resp <- mapM (flip httpLbs mgr) $ [ req { method = renderStdMethod m }
122− | m <- [minBound .. maxBound ]
123− , renderStdMethod m /= method req ]
124− return (all pred' resp, resp)
125− }
189+ = RequestPredicate $ \req mgr -> do
190+ let reqs = [ req { method = renderStdMethod m } | m <- [minBound .. maxBound]
191+ , renderStdMethod m /= method req ]
192+ resp <- mapM (flip httpLbs mgr) reqs
193+
194+ case filter pred' (zip reqs resp) of
195+ (x:_) -> throw $ PredicateFailure "notAllowedContainsAllowHeader" (Just $ fst x) (snd x)
196+ [] -> return resp
126197 where
127− pred' resp = responseStatus resp /= status405 || hasValidHeader "Allow" go resp
198+ pred' (_, resp) = responseStatus resp == status405 && not (hasValidHeader "Allow" go resp)
128199 where
129200 go x = all (\y -> isRight $ parseMethod $ SBSC.pack y)
130201 $ wordsBy (`elem` (", " :: [Char])) (SBSC.unpack x)
131202
203+
132204-- | [__RFC Compliance__]
133205--
134206-- When a request contains an @Accept@ header, the server must either return
@@ -136,24 +208,27 @@ notAllowedContainsAllowHeader
136208-- Acceptable@.
137209--
138210-- This function checks that every *successful* response has a @Content-Type@
139−-- header that matches the @Accept@ header.
211+-- header that matches the @Accept@ header. It does *not* check that the server
212+-- matches the quality descriptions of the @Accept@ header correctly.
140213--
141214-- __References__:
142215--
143216-- * @Accept@ header: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616 Section 14.1>
144−honoursAcceptHeader :: RequestPredicate b Bool
217+--
218+-- /Since 0.0.0.0/
219+honoursAcceptHeader :: RequestPredicate
145220honoursAcceptHeader
146− = RequestPredicate
147− { reqPredName = "honoursAcceptHeader"
148− , reqResps = \req mgr -> do
149− resp <- httpLbs req mgr
150− let scode = responseStatus resp
151− sctype = lookup "Content-Type" $ responseHeaders resp
152− sacc = fromMaybe "*/*" $ lookup "Accept" (requestHeaders req)
153− if 100 < scode && scode < 300
154− then return (isJust $ sctype >>= \x -> matchAccept x sacc, [resp])
155− else return (True, [resp])
156− }
221+ = RequestPredicate $ \req mgr -> do
222+ resp <- httpLbs req mgr
223+ let scode = responseStatus resp
224+ sctype = lookup "Content-Type" $ responseHeaders resp
225+ sacc = fromMaybe "*/*" $ lookup "Accept" (requestHeaders req)
226+ if status100 < scode && scode < status300
227+ then if isJust $ sctype >>= \x -> matchAccept [x] sacc
228+ then throw $ PredicateFailure "honoursAcceptHeader" (Just req) resp
229+ else return [resp]
230+ else return [resp]
231+
157232
158233-- | [__Best Practice__]
159234--
@@ -167,32 +242,34 @@ honoursAcceptHeader
167242-- __References__:
168243--
169244-- * @Cache-Control@ header: <https://tools.ietf.org/html/rfc7234#section-5.2 RFC 7234 Section 5.2>
170−getsHaveCacheControlHeader :: RequestPredicate Text Bool
245+--
246+-- /Since 0.0.0.0/
247+getsHaveCacheControlHeader :: RequestPredicate
171248getsHaveCacheControlHeader
172− = RequestPredicate
173− { reqPredName = "getsHaveCacheControlHeader"
174− , reqResps = \req mgr -> if method req == methodGet
175− then do
176− resp <- httpLbs req mgr
177− let good = isJust $ lookup "Cache-Control" $ responseHeaders resp
178− return (good, [resp])
179− else return (True, [])
180− }
249+ = RequestPredicate $ \req mgr ->
250+ if (method req == methodGet)
251+ then do
252+ resp <- httpLbs req mgr
253+ unless (hasValidHeader "Cache-Control" (const True) resp) $ do
254+ throw $ PredicateFailure "getsHaveCacheControlHeader" (Just req) resp
255+ return [resp]
256+ else return []
181257
182258-- | [__Best Practice__]
183259--
184260-- Like 'getsHaveCacheControlHeader', but for @HEAD@ requests.
185−headsHaveCacheControlHeader :: RequestPredicate Text Bool
261+--
262+-- /Since 0.0.0.0/
263+headsHaveCacheControlHeader :: RequestPredicate
186264headsHaveCacheControlHeader
187− = RequestPredicate
188− { reqPredName = "headsHaveCacheControlHeader"
189− , reqResps = \req mgr -> if method req == methodHead
190− then do
191− resp <- httpLbs req mgr
192− let good = hasValidHeader "Cache-Control" (const True) resp
193− return (good, [resp])
194− else return (True, [])
195− }
265+ = RequestPredicate $ \req mgr ->
266+ if (method req == methodHead)
267+ then do
268+ resp <- httpLbs req mgr
269+ unless (hasValidHeader "Cache-Control" (const True) resp) $
270+ throw $ PredicateFailure "headsHaveCacheControlHeader" (Just req) resp
271+ return [resp]
272+ else return []
196273{-
197274-- |
198275--
@@ -252,12 +329,37 @@ linkHeadersAreValid
252329-- __References__:
253330--
254331-- * @WWW-Authenticate@ header: <https://tools.ietf.org/html/rfc7235#section-4.1 RFC 7235 Section 4.1>
255−unauthorizedContainsWWWAuthenticate :: ResponsePredicate Text Bool
332+--
333+-- /Since 0.0.0.0/
334+unauthorizedContainsWWWAuthenticate :: ResponsePredicate
256335unauthorizedContainsWWWAuthenticate
257− = ResponsePredicate "unauthorizedContainsWWWAuthenticate" (\resp ->
336+ = ResponsePredicate $ \resp ->
258337 if responseStatus resp == status401
259− then hasValidHeader "WWW-Authenticate" (const True) resp
260− else True)
338+ then unless (hasValidHeader "WWW-Authenticate" (const True) resp) $
339+ throw $ PredicateFailure "unauthorizedContainsWWWAuthenticate" Nothing resp
340+ else return ()
341+
342+
343+-- | [__RFC Compliance__]
344+--
345+-- [An HTML] document will start with exactly this string: <!DOCTYPE html>
346+--
347+-- This function checks that HTML documents (those with `Content-Type: text/html...`)
348+-- include a DOCTYPE declaration at the top. We do not enforce capital case for the string `DOCTYPE`.
349+--
350+-- __References__:
351+--
352+-- * HTML5 Doctype: <https://tools.ietf.org/html/rfc7992#section-6.1 RFC 7992 Section 6.1>
353+-- /Since 0.3.0.0/
354+htmlIncludesDoctype :: ResponsePredicate
355+htmlIncludesDoctype
356+ = ResponsePredicate $ \resp ->
357+ if hasValidHeader "Content-Type" (SBS.isPrefixOf . foldCase $ "text/html") resp
358+ then do
359+ let htmlContent = foldCase . LBS.take 20 $ responseBody resp
360+ unless (LBS.isPrefixOf (foldCase "<!doctype html>") htmlContent) $
361+ throw $ PredicateFailure "htmlIncludesDoctype" Nothing resp
362+ else return ()
261363
262364-- * Predicate logic
263365
@@ -267,76 +369,77 @@ unauthorizedContainsWWWAuthenticate
267369--
268370-- Still, this is all kind of ugly.
269371
270−data ResponsePredicate n r = ResponsePredicate
271− { respPredName :: n
272− , respPred :: Response LBS.ByteString -> r
273− } deriving (Functor, Generic)
372+-- | A predicate that depends only on the response.
373+--
374+-- /Since 0.0.0.0/
375+newtype ResponsePredicate = ResponsePredicate
376+ { getResponsePredicate :: Response LBS.ByteString -> IO ()
377+ } deriving (Generic)
274378
275−instance Bifunctor ResponsePredicate where
276− first f (ResponsePredicate a b) = ResponsePredicate (f a) b
277− second = fmap
379+instance Semigroup ResponsePredicate where
380+ ResponsePredicate a <> ResponsePredicate b = ResponsePredicate $ \x -> a x >> b x
278381
279−instance (Monoid n, Monoid r) => Monoid (ResponsePredicate n r) where
280− mempty = ResponsePredicate mempty mempty
281− a `mappend` b = ResponsePredicate
282− { respPredName = respPredName a <> respPredName b
283− , respPred = respPred a <> respPred b
284− }
382+instance Monoid ResponsePredicate where
383+ mempty = ResponsePredicate $ const $ return ()
384+ mappend = (<>)
285385
286−data RequestPredicate n r = RequestPredicate
287− { reqPredName :: n
288− , reqResps :: Request -> Manager -> IO (r, [Response LBS.ByteString])
289− } deriving (Generic, Functor)
386+-- | A predicate that depends on both the request and the response.
387+--
388+-- /Since 0.0.0.0/
389+newtype RequestPredicate = RequestPredicate
390+ { getRequestPredicate :: Request -> Manager -> IO [Response LBS.ByteString]
391+ } deriving (Generic)
290392
291−instance Bifunctor RequestPredicate where
292− first f (RequestPredicate a b) = RequestPredicate (f a) b
293− second = fmap
393+-- TODO: This isn't actually a monoid
394+instance Monoid RequestPredicate where
395+ mempty = RequestPredicate (\r m -> httpLbs r m >>= \x -> return ([x]))
396+ mappend = (<>)
294397
295398-- TODO: This isn't actually a monoid
296−instance (Monoid n, Monoid r) => Monoid (RequestPredicate n r) where
297− mempty = RequestPredicate mempty (\r m -> httpLbs r m >>= \x -> return (mempty, [x]))
298− a `mappend` b = RequestPredicate
299− { reqPredName = reqPredName a <> reqPredName b
300− , reqResps = \x m -> liftM2 (<>) (reqResps a x m) (reqResps b x m)
301− }
302−
303−data Predicates n r = Predicates
304− { reqPreds :: RequestPredicate n r
305− , respPreds :: ResponsePredicate n r
306− } deriving (Generic, Functor)
307−
308−instance (Monoid n, Monoid r) => Monoid (Predicates n r) where
309− mempty = Predicates mempty mempty
310− a `mappend` b = Predicates (reqPreds a <> reqPreds b) (respPreds a <> respPreds b)
399+instance Semigroup RequestPredicate where
400+ RequestPredicate a <> RequestPredicate b = RequestPredicate $ \r mgr ->
401+ liftM2 (<>) (a r mgr) (b r mgr)
311402
403+-- | A set of predicates. Construct one with 'mempty' and '<%>'.
404+data Predicates = Predicates
405+ { requestPredicates :: RequestPredicate
406+ , responsePredicates :: ResponsePredicate
407+ } deriving (Generic)
312408
409+instance Semigroup Predicates where
410+ a <> b = Predicates (requestPredicates a <> requestPredicates b)
411+ (responsePredicates a <> responsePredicates b)
313412
314−class JoinPreds a where
315− joinPreds :: a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
413+instance Monoid Predicates where
414+ mempty = Predicates mempty mempty
415+ mappend = (<>)
316416
317−instance JoinPreds (RequestPredicate Text Bool) where
318− joinPreds p (Predicates x y) = Predicates (go <> x) y
319− where go = let p' = first return p
320− in fmap (\z -> if z then [] else reqPredName p') p'
417+class JoinPreds a where
418+ joinPreds :: a -> Predicates -> Predicates
321419
322−instance JoinPreds (ResponsePredicate Text Bool) where
323− joinPreds p (Predicates x y) = Predicates x (go <> y)
324− where go = let p' = first return p
325− in fmap (\z -> if z then [] else respPredName p') p'
420+instance JoinPreds (RequestPredicate ) where
421+ joinPreds p (Predicates x y) = Predicates (p <> x) y
326422
423+instance JoinPreds (ResponsePredicate ) where
424+ joinPreds p (Predicates x y) = Predicates x (p <> y)
327425
328426-- | Adds a new predicate (either `ResponsePredicate` or `RequestPredicate`) to
329427-- the existing predicates.
330428--
331429-- > not500 <%> onlyJsonObjects <%> empty
332−(<%>) :: JoinPreds a => a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
430+--
431+-- /Since 0.0.0.0/
432+(<%>) :: JoinPreds a => a -> Predicates -> Predicates
333433(<%>) = joinPreds
334434infixr 6 <%>
335435
336−finishPredicates :: Predicates [Text] [Text] -> Request -> Manager -> IO [Text]
337−finishPredicates p req mgr = do
338− (soFar, resps) <- reqResps (reqPreds p) req mgr
339− return $ soFar <> mconcat [respPred (respPreds p) r | r <- resps]
436+finishPredicates :: Predicates -> Request -> Manager -> IO (Maybe PredicateFailure)
437+finishPredicates p req mgr = go `catch` \(e :: PredicateFailure) -> return $ Just e
438+ where
439+ go = do
440+ resps <- getRequestPredicate (requestPredicates p) req mgr
441+ mapM_ (getResponsePredicate $ responsePredicates p) resps
442+ return Nothing
340443
341444-- * helpers
342445
@@ -345,5 +448,14 @@ hasValidHeader hdr p r = case lookup (mk hdr) (responseHeaders r) of
345448 Nothing -> False
346449 Just v -> p v
347450
348−status2XX :: Response b -> Bool
349−status2XX r = status200 <= responseStatus r && responseStatus r < status300
451+isRFC822Date :: SBS.ByteString -> Bool
452+isRFC822Date s
453+ = case parseTimeM True defaultTimeLocale rfc822DateFormat (SBSC.unpack s) of
454+ Nothing -> False
455+ Just (_ :: UTCTime) -> True
456+
457+status2XX :: Monad m => Maybe Request -> Response LBS.ByteString -> T.Text -> m ()
458+status2XX mreq resp t
459+ | status200 <= responseStatus resp && responseStatus resp < status300
460+ = return ()
461+ | otherwise = throw $ PredicateFailure t mreq resp