Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Scim.Server.Mock

Description

A mock server for use in our testsuite, as well as for automated compliance testing (e.g. with Runscope – see https://developer.okta.com/standards/SCIM/#step-2-test-your-scim-server).

Synopsis

data Mock
newtype Id = Id {
- unId :: Int
}
type UserStorage = Map Id (StoredUser Mock)
type GroupStorage = Map Id (StoredGroup Mock)
data TestStorage = TestStorage {
- userDB :: UserStorage
- groupDB :: GroupStorage
}
emptyTestStorage :: IO TestStorage
type TestServer = ReaderT TestStorage Handler
liftSTM :: MonadIO m => STM a -> m a
hoistSTM :: (MFunctor t, MonadIO m) => t STM a -> t m a
assertMutability :: User Mock -> StoredUser Mock -> Bool
testDate :: UTCTime
createMeta :: ResourceType -> Meta
nt :: TestStorage -> ScimHandler TestServer a -> Handler a
filterUser :: Filter -> User extra -> Either Text Bool

Documentation

data Mock Source #

Tag used in the mock server.

Instances

Instances details

AuthTypes Mock Source #
Instance details Defined in Web.Scim.Server.Mock Associated Types type AuthData Mock Source # type AuthInfo Mock Source #
GroupTypes Mock Source #
Instance details Defined in Web.Scim.Server.Mock Associated Types type GroupId Mock Source #
UserTypes Mock Source #
Instance details Defined in Web.Scim.Server.Mock Associated Types type UserId Mock Source # type UserExtra Mock Source # Methods supportedSchemas :: [Schema] Source #
AuthDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods authCheck :: Maybe (AuthData Mock) -> ScimHandler TestServer (AuthInfo Mock) Source #
GroupDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods getGroups :: AuthInfo Mock -> ScimHandler TestServer (ListResponse (StoredGroup Mock)) Source # getGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer (StoredGroup Mock) Source # postGroup :: AuthInfo Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source # putGroup :: AuthInfo Mock -> GroupId Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source # patchGroup :: AuthInfo Mock -> GroupId Mock -> Value -> ScimHandler TestServer (StoredGroup Mock) Source # deleteGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer () Source #
UserDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods getUsers :: AuthInfo Mock -> Maybe Filter -> ScimHandler TestServer (ListResponse (StoredUser Mock)) Source # getUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer (StoredUser Mock) Source # postUser :: AuthInfo Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock) Source # putUser :: AuthInfo Mock -> UserId Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock) Source # patchUser :: AuthInfo Mock -> UserId Mock -> PatchOp Mock -> ScimHandler TestServer (StoredUser Mock) Source # deleteUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer () Source #
type AuthData Mock Source #
Instance details Defined in Web.Scim.Server.Mock type AuthData Mock = Text
type AuthInfo Mock Source #
Instance details Defined in Web.Scim.Server.Mock type AuthInfo Mock = ()
type GroupId Mock Source #
Instance details Defined in Web.Scim.Server.Mock type GroupId Mock = Id
type UserExtra Mock Source #
Instance details Defined in Web.Scim.Server.Mock type UserExtra Mock = NoUserExtra
type UserId Mock Source #
Instance details Defined in Web.Scim.Server.Mock type UserId Mock = Id

newtype Id Source #

A simple ID type.

>>> eitherDecode' @Id . encode $ (Id 3)
Right (Id {unId = 3})

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

Constructors

Id
Fields unId :: Int

Instances

Instances details

FromJSON Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods parseJSON :: Value -> Parser Id # parseJSONList :: Value -> Parser [Id] #
ToJSON Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods toJSON :: Id -> Value # toEncoding :: Id -> Encoding # toJSONList :: [Id] -> Value # toEncodingList :: [Id] -> Encoding #
Show Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods showsPrec :: Int -> Id -> ShowS # show :: Id -> String # showList :: [Id] -> ShowS #
Eq Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods (==) :: Id -> Id -> Bool # (/=) :: Id -> Id -> Bool #
Ord Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods compare :: Id -> Id -> Ordering # (<) :: Id -> Id -> Bool # (<=) :: Id -> Id -> Bool # (>) :: Id -> Id -> Bool # (>=) :: Id -> Id -> Bool # max :: Id -> Id -> Id # min :: Id -> Id -> Id #
Hashable Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods hashWithSalt :: Int -> Id -> Int # hash :: Id -> Int #
FromHttpApiData Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods parseUrlPiece :: Text -> Either Text Id # parseHeader :: ByteString -> Either Text Id # parseQueryParam :: Text -> Either Text Id #
ToHttpApiData Id Source #
Instance details Defined in Web.Scim.Server.Mock Methods toUrlPiece :: Id -> Text # toEncodedUrlPiece :: Id -> Builder # toHeader :: Id -> ByteString # toQueryParam :: Id -> Text # toEncodedQueryParam :: Id -> Builder #

type UserStorage = Map Id (StoredUser Mock) Source #

type GroupStorage = Map Id (StoredGroup Mock) Source #

data TestStorage Source #

Constructors

TestStorage
Fields userDB :: UserStorage groupDB :: GroupStorage

Instances

Instances details

AuthDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods authCheck :: Maybe (AuthData Mock) -> ScimHandler TestServer (AuthInfo Mock) Source #
GroupDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods getGroups :: AuthInfo Mock -> ScimHandler TestServer (ListResponse (StoredGroup Mock)) Source # getGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer (StoredGroup Mock) Source # postGroup :: AuthInfo Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source # putGroup :: AuthInfo Mock -> GroupId Mock -> Group -> ScimHandler TestServer (StoredGroup Mock) Source # patchGroup :: AuthInfo Mock -> GroupId Mock -> Value -> ScimHandler TestServer (StoredGroup Mock) Source # deleteGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer () Source #
UserDB Mock TestServer Source #
Instance details Defined in Web.Scim.Server.Mock Methods getUsers :: AuthInfo Mock -> Maybe Filter -> ScimHandler TestServer (ListResponse (StoredUser Mock)) Source # getUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer (StoredUser Mock) Source # postUser :: AuthInfo Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock) Source # putUser :: AuthInfo Mock -> UserId Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock) Source # patchUser :: AuthInfo Mock -> UserId Mock -> PatchOp Mock -> ScimHandler TestServer (StoredUser Mock) Source # deleteUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer () Source #

emptyTestStorage :: IO TestStorage Source #

type TestServer = ReaderT TestStorage Handler Source #

liftSTM :: MonadIO m => STM a -> m a Source #

hoistSTM :: (MFunctor t, MonadIO m) => t STM a -> t m a Source #

assertMutability :: User Mock -> StoredUser Mock -> Bool Source #

testDate :: UTCTime Source #

createMeta :: ResourceType -> Meta Source #

nt :: TestStorage -> ScimHandler TestServer a -> Handler a Source #

filterUser :: Filter -> User extra -> Either Text Bool Source #

Check whether a user satisfies the filter.

Returns Left if the filter is constructed incorrectly (e.g. tries to compare a username with a boolean).

TODO(arianvp): We need to generalise filtering at some point probably.