@@ -1,36 +1,27 @@
11module Servant.QuickCheck.Internal.Predicates where
22
3−import Control.Exception (catch, throw)
4−import Control.Monad (liftM2, unless, when)
3+import Control.Monad (liftM2)
54import Data.Aeson (Object, decode)
6−import Data.Bifunctor (first)
5+import Data.Bifunctor (Bifunctor (..))
76import qualified Data.ByteString as SBS
87import qualified Data.ByteString.Char8 as SBSC
98import qualified Data.ByteString.Lazy as LBS
10−import Data.CaseInsensitive (foldCase, foldedCase, mk)
9+import Data.CaseInsensitive (mk)
1110import Data.Either (isRight)
1211import Data.List.Split (wordsBy)
1312import 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.Monoid ((<>))
14+import Data.Text (Text)
1815import GHC.Generics (Generic)
1916import Network.HTTP.Client (Manager, Request, Response, httpLbs,
20− method, parseRequest, requestHeaders,
17+ method, parseUrl, requestHeaders,
2118 responseBody, responseHeaders,
2219 responseStatus)
2320import Network.HTTP.Media (matchAccept)
2421import 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−
22+ renderStdMethod, status200, status201,
23+ status300, status401, status405,
24+ status500, status100)
3425
3526-- | [__Best Practice__]
3627--
@@ -39,27 +30,8 @@ import Servant.QuickCheck.Internal.ErrorTypes
3930-- indication of how to proceed or what went wrong.
4031--
4132-- 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 []
33+not500 :: ResponsePredicate Text Bool
34+not500 = ResponsePredicate "not500" (\resp -> not $ responseStatus resp == status500)
6335
6436-- | [__Best Practice__]
6537--
@@ -80,17 +52,11 @@ notLongerThan maxAllowed
8052--
8153-- * JSON Grammar: <https://tools.ietf.org/html/rfc7159#section-2 RFC 7159 Section 2>
8254-- * JSON Grammar: <https://tools.ietf.org/html/rfc4627#section-2 RFC 4627 Section 2>
83−--
84−-- /Since 0.0.0.0/
85−onlyJsonObjects :: ResponsePredicate
55+onlyJsonObjects :: ResponsePredicate Text Bool
8656onlyJsonObjects
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 ())
57+ = ResponsePredicate "onlyJsonObjects" (\resp -> case decode (responseBody resp) of
58+ Nothing -> False
59+ Just (_ :: Object) -> True)
9460
9561-- | __Optional__
9662--
@@ -109,61 +75,29 @@ onlyJsonObjects
10975--
11076-- * 201 Created: <https://tools.ietf.org/html/rfc7231#section-6.3.2 RFC 7231 Section 6.3.2>
11177-- * 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
78+createContainsValidLocation :: RequestPredicate Text Bool
11579createContainsValidLocation
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
80+ = RequestPredicate
81+ { reqPredName = "createContainsValidLocation"
82+ , reqResps = \req mgr -> do
16083 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 []
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+ }
16594
95+{-
96+getsHaveLastModifiedHeader :: ResponsePredicate Text Bool
97+getsHaveLastModifiedHeader
98+ = ResponsePredicate "getsHaveLastModifiedHeader" (\resp ->
16699
100+-}
167101
168102-- | [__RFC Compliance__]
169103--
@@ -175,27 +109,22 @@ getsHaveLastModifiedHeader
175109-- This function checks that every @405 Method Not Allowed@ response contains
176110-- an @Allow@ header with a list of standard HTTP methods.
177111--
178−-- Note that 'servant' itself does not currently set the @Allow@ headers.
179−--
180112-- __References__:
181113--
182114-- * @Allow@ header: <https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616 Section 14.7>
183115-- * 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
116+notAllowedContainsAllowHeader :: RequestPredicate Text Bool
188117notAllowedContainsAllowHeader
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
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+ }
197126 where
198− pred' (_, resp) = responseStatus resp == status405 && not (hasValidHeader "Allow" go resp)
127+ pred' resp = responseStatus resp /= status405 || hasValidHeader "Allow" go resp
199128 where
200129 go x = all (\y -> isRight $ parseMethod $ SBSC.pack y)
201130 $ wordsBy (`elem` (", " :: [Char])) (SBSC.unpack x)
@@ -214,21 +143,19 @@ notAllowedContainsAllowHeader
214143-- __References__:
215144--
216145-- * @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
146+honoursAcceptHeader :: RequestPredicate Text Bool
220147honoursAcceptHeader
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−
148+ = RequestPredicate
149+ { reqPredName = "honoursAcceptHeader"
150+ , reqResps = \req mgr -> do
151+ resp <- httpLbs req mgr
152+ let scode = responseStatus resp
153+ sctype = lookup "Content-Type" $ responseHeaders resp
154+ sacc = fromMaybe "*/*" $ lookup "Accept" (requestHeaders req)
155+ if status100 < scode && scode < status300
156+ then return (isJust $ sctype >>= \x -> matchAccept [x] sacc, [resp])
157+ else return (True, [resp])
158+ }
232159
233160-- | [__Best Practice__]
234161--
@@ -242,34 +169,32 @@ honoursAcceptHeader
242169-- __References__:
243170--
244171-- * @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
172+getsHaveCacheControlHeader :: RequestPredicate Text Bool
248173getsHaveCacheControlHeader
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 []
174+ = RequestPredicate
175+ { reqPredName = "getsHaveCacheControlHeader"
176+ , reqResps = \req mgr -> if method req == methodGet
177+ then do
178+ resp <- httpLbs req mgr
179+ let good = isJust $ lookup "Cache-Control" $ responseHeaders resp
180+ return (good, [resp])
181+ else return (True, [])
182+ }
257183
258184-- | [__Best Practice__]
259185--
260186-- Like 'getsHaveCacheControlHeader', but for @HEAD@ requests.
261−--
262−-- /Since 0.0.0.0/
263−headsHaveCacheControlHeader :: RequestPredicate
187+headsHaveCacheControlHeader :: RequestPredicate Text Bool
264188headsHaveCacheControlHeader
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 []
189+ = RequestPredicate
190+ { reqPredName = "headsHaveCacheControlHeader"
191+ , reqResps = \req mgr -> if method req == methodHead
192+ then do
193+ resp <- httpLbs req mgr
194+ let good = hasValidHeader "Cache-Control" (const True) resp
195+ return (good, [resp])
196+ else return (True, [])
197+ }
273198{-
274199-- |
275200--
@@ -329,37 +254,12 @@ linkHeadersAreValid
329254-- __References__:
330255--
331256-- * @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
257+unauthorizedContainsWWWAuthenticate :: ResponsePredicate Text Bool
335258unauthorizedContainsWWWAuthenticate
336− = ResponsePredicate $ \resp ->
259+ = ResponsePredicate "unauthorizedContainsWWWAuthenticate" (\resp ->
337260 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 ()
261+ then hasValidHeader "WWW-Authenticate" (const True) resp
262+ else True)
363263
364264-- * Predicate logic
365265
@@ -369,77 +269,76 @@ htmlIncludesDoctype
369269--
370270-- Still, this is all kind of ugly.
371271
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)
272+data ResponsePredicate n r = ResponsePredicate
273+ { respPredName :: n
274+ , respPred :: Response LBS.ByteString -> r
275+ } deriving (Functor, Generic)
378276
379−instance Semigroup ResponsePredicate where
380− ResponsePredicate a <> ResponsePredicate b = ResponsePredicate $ \x -> a x >> b x
277+instance Bifunctor ResponsePredicate where
278+ first f (ResponsePredicate a b) = ResponsePredicate (f a) b
279+ second = fmap
381280
382−instance Monoid ResponsePredicate where
383− mempty = ResponsePredicate $ const $ return ()
384− mappend = (<>)
281+instance (Monoid n, Monoid r) => Monoid (ResponsePredicate n r) where
282+ mempty = ResponsePredicate mempty mempty
283+ a `mappend` b = ResponsePredicate
284+ { respPredName = respPredName a <> respPredName b
285+ , respPred = respPred a <> respPred b
286+ }
385287
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)
288+data RequestPredicate n r = RequestPredicate
289+ { reqPredName :: n
290+ , reqResps :: Request -> Manager -> IO (r, [Response LBS.ByteString])
291+ } deriving (Generic, Functor)
392292
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 = (<>)
293+instance Bifunctor RequestPredicate where
294+ first f (RequestPredicate a b) = RequestPredicate (f a) b
295+ second = fmap
397296
398297-- 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)
298+instance (Monoid n, Monoid r) => Monoid (RequestPredicate n r) where
299+ mempty = RequestPredicate mempty (\r m -> httpLbs r m >>= \x -> return (mempty, [x]))
300+ a `mappend` b = RequestPredicate
301+ { reqPredName = reqPredName a <> reqPredName b
302+ , reqResps = \x m -> liftM2 (<>) (reqResps a x m) (reqResps b x m)
303+ }
304+
305+data Predicates n r = Predicates
306+ { reqPreds :: RequestPredicate n r
307+ , respPreds :: ResponsePredicate n r
308+ } deriving (Generic, Functor)
309+
310+instance (Monoid n, Monoid r) => Monoid (Predicates n r) where
311+ mempty = Predicates mempty mempty
312+ a `mappend` b = Predicates (reqPreds a <> reqPreds b) (respPreds a <> respPreds b)
408313
409−instance Semigroup Predicates where
410− a <> b = Predicates (requestPredicates a <> requestPredicates b)
411− (responsePredicates a <> responsePredicates b)
412314
413−instance Monoid Predicates where
414− mempty = Predicates mempty mempty
415− mappend = (<>)
416315
417316class JoinPreds a where
418− joinPreds :: a -> Predicates -> Predicates
317+ joinPreds :: a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
419318
420−instance JoinPreds (RequestPredicate ) where
421− joinPreds p (Predicates x y) = Predicates (p <> x) y
319+instance JoinPreds (RequestPredicate Text Bool) where
320+ joinPreds p (Predicates x y) = Predicates (go <> x) y
321+ where go = let p' = first return p
322+ in fmap (\z -> if z then [] else reqPredName p') p'
323+
324+instance JoinPreds (ResponsePredicate Text Bool) where
325+ joinPreds p (Predicates x y) = Predicates x (go <> y)
326+ where go = let p' = first return p
327+ in fmap (\z -> if z then [] else respPredName p') p'
422328
423−instance JoinPreds (ResponsePredicate ) where
424− joinPreds p (Predicates x y) = Predicates x (p <> y)
425329
426330-- | Adds a new predicate (either `ResponsePredicate` or `RequestPredicate`) to
427331-- the existing predicates.
428332--
429333-- > not500 <%> onlyJsonObjects <%> empty
430−--
431−-- /Since 0.0.0.0/
432−(<%>) :: JoinPreds a => a -> Predicates -> Predicates
334+(<%>) :: JoinPreds a => a -> Predicates [Text] [Text] -> Predicates [Text] [Text]
433335(<%>) = joinPreds
434336infixr 6 <%>
435337
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
338+finishPredicates :: Predicates [Text] [Text] -> Request -> Manager -> IO [Text]
339+finishPredicates p req mgr = do
340+ (soFar, resps) <- reqResps (reqPreds p) req mgr
341+ return $ soFar <> mconcat [respPred (respPreds p) r | r <- resps]
443342
444343-- * helpers
445344
@@ -448,14 +347,5 @@ hasValidHeader hdr p r = case lookup (mk hdr) (responseHeaders r) of
448347 Nothing -> False
449348 Just v -> p v
450349
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
350+status2XX :: Response b -> Bool
351+status2XX r = status200 <= responseStatus r && responseStatus r < status300