@@ -1,36 +1,24 @@
1+{-# LANGUAGE MultiWayIf #-}
12module Servant.QuickCheck.Internal.Predicates where
23
3−import Control.Exception (catch, throw)
4−import Control.Monad (liftM2, unless, when)
4+import Control.Monad
55import Data.Aeson (Object, decode)
6−import Data.Bifunctor (first)
6+import Data.Bifunctor (Bifunctor (..))
77import qualified Data.ByteString as SBS
88import qualified Data.ByteString.Char8 as SBSC
99import qualified Data.ByteString.Lazy as LBS
10−import Data.CaseInsensitive (foldCase, foldedCase, mk)
10+import Data.CaseInsensitive (mk)
1111import Data.Either (isRight)
1212import Data.List.Split (wordsBy)
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)
13+import Data.Maybe (isJust)
14+import Data.Monoid ((<>))
15+import Data.Text (Text)
1816import GHC.Generics (Generic)
1917import Network.HTTP.Client (Manager, Request, Response, httpLbs,
20− method, parseRequest, requestHeaders,
21− responseBody, responseHeaders,
18+ method, responseBody, responseHeaders,
2219 responseStatus)
23−import Network.HTTP.Media (matchAccept)
2420import Network.HTTP.Types (methodGet, methodHead, parseMethod,
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−
21+ status401, renderStdMethod, status405, status500)
3422
3523-- | [__Best Practice__]
3624--
@@ -39,27 +27,8 @@ import Servant.QuickCheck.Internal.ErrorTypes
3927-- indication of how to proceed or what went wrong.
4028--
4129-- This function checks that the response code is not 500.
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 []
30+not500 :: ResponsePredicate Text Bool
31+not500 = ResponsePredicate "not500" (\resp -> not $ responseStatus resp == status500)
6332
6433-- | [__Best Practice__]
6534--
@@ -80,90 +49,30 @@ notLongerThan maxAllowed
8049--
8150-- * JSON Grammar: <https://tools.ietf.org/html/rfc7159#section-2 RFC 7159 Section 2>
8251-- * JSON Grammar: <https://tools.ietf.org/html/rfc4627#section-2 RFC 4627 Section 2>
83−--
84−-- /Since 0.0.0.0/
85−onlyJsonObjects :: ResponsePredicate
52+onlyJsonObjects :: ResponsePredicate Text Bool
8653onlyJsonObjects
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 ())
54+ = ResponsePredicate "onlyJsonObjects" (\resp -> case decode (responseBody resp) of
55+ Nothing -> False
56+ Just (_ :: Object) -> True)
9457
95−-- | __Optional__
96−--
97−-- When creating a new resource, it is good practice to provide a @Location@
58+{-
59+-- | When creating a new resource, it is good practice to provide a @Location@
9860-- header with a link to the created resource.
9961--
10062-- This function checks that every @201 Created@ response contains a @Location@
10163-- header, and that the link in it responds with a 2XX response code to @GET@
10264-- requests.
10365--
104−-- This is considered optional because other means of linking to the resource
105−-- (e.g. via the response body) are also acceptable; linking to the resource in
106−-- some way is considered best practice.
107−--
108−-- __References__:
109−--
110−-- * 201 Created: <https://tools.ietf.org/html/rfc7231#section-6.3.2 RFC 7231 Section 6.3.2>
111−-- * Location header: <https://tools.ietf.org/html/rfc7231#section-7.1.2 RFC 7231 Section 7.1.2>
112−--
113−-- /Since 0.0.0.0/
114−createContainsValidLocation :: RequestPredicate
66+-- References: <RFC 7231, Section 6.3.2 https://tools.ietf.org/html/rfc7231#section-6.3.2>
67+createContainsValidLocation :: ResponsePredicate Text Bool
11568createContainsValidLocation
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
160− resp <- httpLbs req mgr
161− unless (hasValidHeader "Last-Modified" isRFC822Date resp) $ do
162− throw $ PredicateFailure "getsHaveLastModifiedHeader" (Just req) resp
163− return [resp]
164− else return []
69+ = ResponsePredicate "createContainsValidLocation" (\resp ->
16570
71+getsHaveLastModifiedHeader :: ResponsePredicate Text Bool
72+getsHaveLastModifiedHeader
73+ = ResponsePredicate "getsHaveLastModifiedHeader" (\resp ->
16674
75+-}
16776
16877-- | [__RFC Compliance__]
16978--
@@ -175,61 +84,55 @@ getsHaveLastModifiedHeader
17584-- This function checks that every @405 Method Not Allowed@ response contains
17685-- an @Allow@ header with a list of standard HTTP methods.
17786--
178−-- Note that 'servant' itself does not currently set the @Allow@ headers.
179−--
18087-- __References__:
18188--
18289-- * @Allow@ header: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616 Section 14.7>
18390-- * Status 405: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html RFC 2616 Section 10.4.6>
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
91+notAllowedContainsAllowHeader :: RequestPredicate Text Bool
18892notAllowedContainsAllowHeader
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
93+ = RequestPredicate
94+ { reqPredName = name
95+ , reqResps = \req mgr -> mapM (flip httpLbs mgr)
96+ [ req { method = renderStdMethod m }
97+ | m <- [minBound .. maxBound ]
98+ , renderStdMethod m /= method req ]
99+ , reqPred = pred'
100+ }
197101 where
198− pred' (_, resp) = responseStatus resp == status405 && not (hasValidHeader "Allow" go resp)
102+ name = "notAllowedContainsAllowHeader"
103+ pred' = ResponsePredicate name (\resp ->
104+ if responseStatus resp == status405
105+ then hasValidHeader "Allow" go resp
106+ else True)
199107 where
200108 go x = all (\y -> isRight $ parseMethod $ SBSC.pack y)
201109 $ wordsBy (`elem` (", " :: [Char])) (SBSC.unpack x)
202110
203−
204−-- | [__RFC Compliance__]
205−--
206−-- When a request contains an @Accept@ header, the server must either return
111+ {-
112+-- | When a request contains an @Accept@ header, the server must either return
207113-- content in one of the requested representations, or respond with @406 Not
208114-- Acceptable@.
209115--
210116-- This function checks that every *successful* response has a @Content-Type@
211−-- header that matches the @Accept@ header. It does *not* check that the server
212−-- matches the quality descriptions of the @Accept@ header correctly.
117+-- header that matches the @Accept@ header.
213118--
214119-- __References__:
215120--
216121-- * @Accept@ header: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616 Section 14.1>
217−--
218−-- /Since 0.0.0.0/
219−honoursAcceptHeader :: RequestPredicate
122+honoursAcceptHeader :: RequestPredicate b Bool
220123honoursAcceptHeader
221− = RequestPredicate $ \req mgr -> do
124+ = RequestPredicate name (ResponsePredicate name $ \req mgr -> do
125+
222126 resp <- httpLbs req mgr
223127 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−
128+ sctype = maybeToList $ lookup "Content-Type" $ responseHeaders resp
129+ sacc = fromMaybe "*/*" $ lookup "Accept" $ requestHeaders req
130+ if 100 < scode && scode < 300
131+ then isJust matchAccept sacc sctype
132+ else True)
133+ where name = "honoursAcceptHeader"
232134
135+-}
233136-- | [__Best Practice__]
234137--
235138-- Whether or not a representation should be cached, it is good practice to
@@ -242,34 +145,33 @@ honoursAcceptHeader
242145-- __References__:
243146--
244147-- * @Cache-Control@ header: <https://tools.ietf.org/html/rfc7234#section-5.2 RFC 7234 Section 5.2>
245−--
246−-- /Since 0.0.0.0/
247−getsHaveCacheControlHeader :: RequestPredicate
148+getsHaveCacheControlHeader :: RequestPredicate Text Bool
248149getsHaveCacheControlHeader
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 []
150+ = RequestPredicate
151+ { reqPredName = name
152+ , reqResps = \req mgr -> if method req == methodGet
153+ then return <$> httpLbs req mgr
154+ else return []
155+ , reqPred = ResponsePredicate name $ \resp ->
156+ isJust $ lookup "Cache-Control" $ responseHeaders resp
157+ }
158+ where name = "getsHaveCacheControlHeader"
257159
258160-- | [__Best Practice__]
259161--
260162-- Like 'getsHaveCacheControlHeader', but for @HEAD@ requests.
261−--
262−-- /Since 0.0.0.0/
263−headsHaveCacheControlHeader :: RequestPredicate
163+headsHaveCacheControlHeader :: RequestPredicate Text Bool
264164headsHaveCacheControlHeader
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 []
165+ = RequestPredicate
166+ { reqPredName = name
167+ , reqResps = \req mgr -> if method req == methodHead
168+ then return <$> httpLbs req mgr
169+ else return []
170+ , reqPred = ResponsePredicate name $ \resp ->
171+ isJust $ lookup "Cache-Control" $ responseHeaders resp
172+ }
173+ where name = "headsHaveCacheControlHeader"
174+
273175{-
274176-- |
275177--
@@ -329,37 +231,12 @@ linkHeadersAreValid
329231-- __References__:
330232--
331233-- * @WWW-Authenticate@ header: <https://tools.ietf.org/html/rfc7235#section-4.1 RFC 7235 Section 4.1>
332−--
333−-- /Since 0.0.0.0/
334−unauthorizedContainsWWWAuthenticate :: ResponsePredicate
234+unauthorizedContainsWWWAuthenticate :: ResponsePredicate Text Bool
335235unauthorizedContainsWWWAuthenticate
336− = ResponsePredicate $ \resp ->
236+ = ResponsePredicate "unauthorizedContainsWWWAuthenticate" (\resp ->
337237 if responseStatus resp == status401
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 ()
238+ then hasValidHeader "WWW-Authenticate" (const True) resp
239+ else True)
363240
364241-- * Predicate logic
365242
@@ -369,77 +246,79 @@ htmlIncludesDoctype
369246--
370247-- Still, this is all kind of ugly.
371248
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)
249+data ResponsePredicate n r = ResponsePredicate
250+ { respPredName :: n
251+ , respPred :: Response LBS.ByteString -> r
252+ } deriving (Functor, Generic)
378253
379−instance Semigroup ResponsePredicate where
380− ResponsePredicate a <> ResponsePredicate b = ResponsePredicate $ \x -> a x >> b x
254+instance Bifunctor ResponsePredicate where
255+ first f (ResponsePredicate a b) = ResponsePredicate (f a) b
256+ second = fmap
381257
382−instance Monoid ResponsePredicate where
383− mempty = ResponsePredicate $ const $ return ()
384− mappend = (<>)
258+instance (Monoid n, Monoid r) => Monoid (ResponsePredicate n r) where
259+ mempty = ResponsePredicate mempty mempty
260+ a `mappend` b = ResponsePredicate
261+ { respPredName = respPredName a <> respPredName b
262+ , respPred = respPred a <> respPred b
263+ }
385264
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)
265+data RequestPredicate n r = RequestPredicate
266+ { reqPredName :: n
267+ , reqResps :: Request -> Manager -> IO [Response LBS.ByteString]
268+ , reqPred :: ResponsePredicate n r
269+ } deriving (Generic, Functor)
392270
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 = (<>)
271+instance Bifunctor RequestPredicate where
272+ first f (RequestPredicate a b c) = RequestPredicate (f a) b (first f c)
273+ second = fmap
397274
398275-- TODO: This isn't actually a monoid
399−instance Semigroup RequestPredicate where
400− RequestPredicate a <> RequestPredicate b = RequestPredicate $ \r mgr ->
401− liftM2 (<>) (a r mgr) (b r mgr)
402−
403−-- | A set of predicates. Construct one with 'mempty' and '<%>'.
404−data Predicates = Predicates
405− { requestPredicates :: RequestPredicate
406− , responsePredicates :: ResponsePredicate
407− } deriving (Generic)
276+instance (Monoid n, Monoid r) => Monoid (RequestPredicate n r) where
277+ mempty = RequestPredicate mempty (\r m -> return <$> httpLbs r m) mempty
278+ a `mappend` b = RequestPredicate
279+ { reqPredName = reqPredName a <> reqPredName b
280+ , reqResps = \x m -> liftM2 (<>) (reqResps a x m) (reqResps b x m)
281+ , reqPred = reqPred a <> reqPred b
282+ }
283+
284+data Predicates n r = Predicates
285+ { reqPreds :: RequestPredicate n r
286+ , respPreds :: ResponsePredicate n r
287+ } deriving (Generic, Functor)
288+
289+instance (Monoid n, Monoid r) => Monoid (Predicates n r) where
290+ mempty = Predicates mempty mempty
291+ a `mappend` b = Predicates (reqPreds a <> reqPreds b) (respPreds a <> respPreds b)
408292
409−instance Semigroup Predicates where
410− a <> b = Predicates (requestPredicates a <> requestPredicates b)
411− (responsePredicates a <> responsePredicates b)
412293
413−instance Monoid Predicates where
414− mempty = Predicates mempty mempty
415− mappend = (<>)
416294
417295class JoinPreds a where
418− joinPreds :: a -> Predicates -> Predicates
296+ joinPreds :: a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
419297
420−instance JoinPreds (RequestPredicate ) where
421− joinPreds p (Predicates x y) = Predicates (p <> x) y
298+instance JoinPreds (RequestPredicate Text Bool) where
299+ joinPreds p (Predicates x y) = Predicates (go <> x) y
300+ where go = let p' = first return p
301+ in fmap (\z -> if z then [] else reqPredName p') p'
302+
303+instance JoinPreds (ResponsePredicate Text Bool) where
304+ joinPreds p (Predicates x y) = Predicates x (go <> y)
305+ where go = let p' = first return p
306+ in fmap (\z -> if z then [] else respPredName p') p'
422307
423−instance JoinPreds (ResponsePredicate ) where
424− joinPreds p (Predicates x y) = Predicates x (p <> y)
425308
426309-- | Adds a new predicate (either `ResponsePredicate` or `RequestPredicate`) to
427310-- the existing predicates.
428311--
429312-- > not500 <%> onlyJsonObjects <%> empty
430−--
431−-- /Since 0.0.0.0/
432−(<%>) :: JoinPreds a => a -> Predicates -> Predicates
313+(<%>) :: JoinPreds a => a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
433314(<%>) = joinPreds
434315infixr 6 <%>
435316
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
317+finishPredicates :: Predicates [Text] [Text] -> Request -> Manager -> IO [Text]
318+finishPredicates p req mgr = do
319+ resps <- reqResps (reqPreds p) req mgr
320+ let preds = reqPred (reqPreds p) <> respPreds p
321+ return $ mconcat [respPred preds r | r <- resps ]
443322
444323-- * helpers
445324
@@ -447,15 +326,3 @@ hasValidHeader :: SBS.ByteString -> (SBS.ByteString -> Bool) -> Response b -> Bo
447326hasValidHeader hdr p r = case lookup (mk hdr) (responseHeaders r) of
448327 Nothing -> False
449328 Just v -> p v
450−
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