Servant.QuickCheck.Internal.HasGenRequest

Documentation

runGenRequest :: HasGenRequest a => Proxy a -> Gen (BaseUrl -> Request)

This function returns a QuickCheck `Gen a` when passed a servant API value, typically a `Proxy API`. The generator returned is a function that accepts a BaseUrl and returns a Request, which can then be used to issue network requests. This Gen type makes it easier to compare distinct APIs across different BaseUrls.

class HasGenRequest a where

This is the core Servant-Quickcheck generator, which, when given a `Proxy API` will return a pair of Int and `Gen a`, where a is a function from BaseUrl to a Request. The Int is a weight for the QuickCheck frequency function which ensures a random distribution across all endpoints in an API.

Methods

genRequest :: Proxy a -> (Int, Gen (BaseUrl -> Request))

Instances

HasGenRequest EmptyAPI

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy EmptyAPI -> (Int, Gen (BaseUrl -> Request))

(HasGenRequest a, HasGenRequest b) => HasGenRequest (a :<|> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (a :<|> b) -> (Int, Gen (BaseUrl -> Request))

ReflectMethod method => HasGenRequest (NoContentVerb method :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (NoContentVerb method) -> (Int, Gen (BaseUrl -> Request))

(KnownSymbol path, HasGenRequest b) => HasGenRequest (path :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (path :> b) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (HttpVersion :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (HttpVersion :> a) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (BasicAuth x y :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (BasicAuth x y :> a) -> (Int, Gen (BaseUrl -> Request))

(Arbitrary c, HasGenRequest b, ToHttpApiData c) => HasGenRequest (Capture' mods x c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (Capture' mods x c :> b) -> (Int, Gen (BaseUrl -> Request))

(Arbitrary c, HasGenRequest b, ToHttpApiData c) => HasGenRequest (CaptureAll x c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (CaptureAll x c :> b) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (Fragment v :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (Fragment v :> a) -> (Int, Gen (BaseUrl -> Request))

(Arbitrary c, KnownSymbol h, HasGenRequest b, ToHttpApiData c) => HasGenRequest (Header' mods h c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (Header' mods h c :> b) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (IsSecure :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (IsSecure :> a) -> (Int, Gen (BaseUrl -> Request))

(KnownSymbol x, HasGenRequest b) => HasGenRequest (QueryFlag x :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (QueryFlag x :> b) -> (Int, Gen (BaseUrl -> Request))

(KnownSymbol x, Arbitrary c, ToHttpApiData c, HasGenRequest b) => HasGenRequest (QueryParam' mods x c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (QueryParam' mods x c :> b) -> (Int, Gen (BaseUrl -> Request))

(KnownSymbol x, Arbitrary c, ToHttpApiData c, HasGenRequest b) => HasGenRequest (QueryParams x c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (QueryParams x c :> b) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (RemoteHost :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (RemoteHost :> a) -> (Int, Gen (BaseUrl -> Request))

(AllMimeRender x c, Arbitrary c, HasGenRequest b) => HasGenRequest (ReqBody' mods x c :> b :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (ReqBody' mods x c :> b) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (Vault :> a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (Vault :> a) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest api => HasGenRequest (f d :> api :: Type)

capture all path pieces that do not have semantics relevant to HasGenRequest; this is to maintain backwards compatibility without having to introduce CPP for every new URL piece that basically is irrelevant for this class

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (f d :> api) -> (Int, Gen (BaseUrl -> Request))

HasGenRequest a => HasGenRequest (WithNamedContext x y a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (WithNamedContext x y a) -> (Int, Gen (BaseUrl -> Request))

ReflectMethod method => HasGenRequest (Verb method status cts a :: Type)

Defined in Servant.QuickCheck.Internal.HasGenRequest

Methods

genRequest :: Proxy (Verb method status cts a) -> (Int, Gen (BaseUrl -> Request))