Web.Scim.Test.Util

Documentation

shouldRespondWith :: HasCallStack => WaiSession SResponse -> ResponseMatcher -> WaiExpectation

re-implementation of shouldRespondWith with better error reporting. FUTUREWORK: make this a PR upstream. (while we're at it, we can also patch WaiSession and request to keep track of the SRequest, and add that to the error message here with the response.)

shouldEventuallyRespondWith :: HasCallStack => WaiSession SResponse -> ResponseMatcher -> WaiExpectation

Making wai requests

post :: ByteString -> ByteString -> WaiSession SResponse

put :: ByteString -> ByteString -> WaiSession SResponse

patch :: ByteString -> ByteString -> WaiSession SResponse

data AcceptanceConfig tag

Constructors

AcceptanceConfig

Fields

• scimAppAndConfig :: IO (Application, AcceptanceQueryConfig tag)
• genUserName :: IO Text
• responsesFullyKnown :: Bool

  some acceptance tests match against a fully rendered response body, which will not work when running the test as a library user (since the response will have more and other information). if you leave this on False (default from defAcceptanceConfig), the test will only check some invariants on the response instead that must hold in all cases.

defAcceptanceConfig :: IO Application -> AcceptanceConfig tag

data AcceptanceQueryConfig tag

Constructors

AcceptanceQueryConfig

Fields

• scimPathPrefix :: ByteString
• scimAuthToken :: ByteString

defAcceptanceQueryConfig :: AcceptanceQueryConfig tag

post' :: AcceptanceQueryConfig tag -> ByteString -> ByteString -> WaiSession SResponse

put' :: AcceptanceQueryConfig tag -> ByteString -> ByteString -> WaiSession SResponse

patch' :: AcceptanceQueryConfig tag -> ByteString -> ByteString -> WaiSession SResponse

get' :: AcceptanceQueryConfig tag -> ByteString -> WaiSession SResponse

delete' :: AcceptanceQueryConfig tag -> ByteString -> ByteString -> WaiSession SResponse

(<//>) :: ByteString -> ByteString -> ByteString

avoid multiple /. (kill at most one / at the end of first arg and beginning of second arg, resp., then add one during concatenation.

>>> ["a" <//> "b", "a" <//> "/b", "a/" <//> "b", "a/" <//> "/b"]
["a/b","a/b","a/b","a/b"]

WARNING: {doctests don't work in our infrastructure](https:/github.comzinfrabackend-issuesissues/1549), so this is duplicated in the unit tests.

Request/response quasiquoter

scim :: QuasiQuoter

A response matcher and quasiquoter that should be used instead of json.

JSON parsing

newtype Field (s :: Symbol) a

A way to parse out a single value from a JSON object by specifying the field as a type-level string. Very useful when you don't want to create extra types.

Constructors

Field a

Instances

Functor (Field s)

Defined in Web.Scim.Test.Util

Methods

fmap :: (a -> b) -> Field s a -> Field s b

(<$) :: a -> Field s b -> Field s a

Eq a => Eq (Field s a)

Defined in Web.Scim.Test.Util

Methods

(==) :: Field s a -> Field s a -> Bool

(/=) :: Field s a -> Field s a -> Bool

Ord a => Ord (Field s a)

Defined in Web.Scim.Test.Util

Methods

compare :: Field s a -> Field s a -> Ordering

(<) :: Field s a -> Field s a -> Bool

(<=) :: Field s a -> Field s a -> Bool

(>) :: Field s a -> Field s a -> Bool

(>=) :: Field s a -> Field s a -> Bool

max :: Field s a -> Field s a -> Field s a

min :: Field s a -> Field s a -> Field s a

Read a => Read (Field s a)

Defined in Web.Scim.Test.Util

Methods

readsPrec :: Int -> ReadS (Field s a)

readList :: ReadS [Field s a]

readPrec :: ReadPrec (Field s a)

readListPrec :: ReadPrec [Field s a]

Show a => Show (Field s a)

Defined in Web.Scim.Test.Util

Methods

showsPrec :: Int -> Field s a -> ShowS

show :: Field s a -> String

showList :: [Field s a] -> ShowS

(KnownSymbol s, ToJSON a) => ToJSON (Field s a)

Defined in Web.Scim.Test.Util

Methods

toJSON :: Field s a -> Value

toEncoding :: Field s a -> Encoding

toJSONList :: [Field s a] -> Value

toEncodingList :: [Field s a] -> Encoding

(KnownSymbol s, FromJSON a) => FromJSON (Field s a)

Defined in Web.Scim.Test.Util

Methods

parseJSON :: Value -> Parser (Field s a)

parseJSONList :: Value -> Parser [Field s a]

getField :: Field s a -> a

Tag

data TestTag id authData authInfo userExtra

A type-level tag for UserTypes, AuthTypes, etc. that allows picking any types we might need in tests.

Instances

AuthTypes (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

Associated Types

type AuthData (TestTag id authData authInfo userExtra)

type AuthInfo (TestTag id authData authInfo userExtra)

GroupTypes (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

Associated Types

type GroupId (TestTag id authData authInfo userExtra)

UserTypes (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

Associated Types

type UserId (TestTag id authData authInfo userExtra)

type UserExtra (TestTag id authData authInfo userExtra)

Methods

supportedSchemas :: [Schema]

type AuthData (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

type AuthData (TestTag id authData authInfo userExtra) = authData

type AuthInfo (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

type AuthInfo (TestTag id authData authInfo userExtra) = authInfo

type GroupId (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

type GroupId (TestTag id authData authInfo userExtra) = id

type UserId (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

type UserId (TestTag id authData authInfo userExtra) = id

type UserExtra (TestTag id authData authInfo userExtra)

Defined in Web.Scim.Test.Util

type UserExtra (TestTag id authData authInfo userExtra) = userExtra