Web.Scim.Server.Mock

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).

Documentation

data Mock

Tag used in the mock server.

Instances

AuthTypes Mock

Defined in Web.Scim.Server.Mock

Associated Types

type AuthData Mock

type AuthInfo Mock

GroupTypes Mock

Defined in Web.Scim.Server.Mock

Associated Types

type GroupId Mock

UserTypes Mock

Defined in Web.Scim.Server.Mock

Associated Types

type UserId Mock

type UserExtra Mock

Methods

supportedSchemas :: [Schema]

AuthDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

authCheck :: Maybe (AuthData Mock) -> ScimHandler TestServer (AuthInfo Mock)

GroupDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

getGroups :: AuthInfo Mock -> ScimHandler TestServer (ListResponse (StoredGroup Mock))

getGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer (StoredGroup Mock)

postGroup :: AuthInfo Mock -> Group -> ScimHandler TestServer (StoredGroup Mock)

putGroup :: AuthInfo Mock -> GroupId Mock -> Group -> ScimHandler TestServer (StoredGroup Mock)

patchGroup :: AuthInfo Mock -> GroupId Mock -> Value -> ScimHandler TestServer (StoredGroup Mock)

deleteGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer ()

UserDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

getUsers :: AuthInfo Mock -> Maybe Filter -> ScimHandler TestServer (ListResponse (StoredUser Mock))

getUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer (StoredUser Mock)

postUser :: AuthInfo Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock)

putUser :: AuthInfo Mock -> UserId Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock)

patchUser :: AuthInfo Mock -> UserId Mock -> PatchOp Mock -> ScimHandler TestServer (StoredUser Mock)

deleteUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer ()

type AuthData Mock

Defined in Web.Scim.Server.Mock

type AuthData Mock = Text

type AuthInfo Mock

Defined in Web.Scim.Server.Mock

type AuthInfo Mock = ()

type GroupId Mock

Defined in Web.Scim.Server.Mock

type GroupId Mock = Id

type UserId Mock

Defined in Web.Scim.Server.Mock

type UserId Mock = Id

type UserExtra Mock

Defined in Web.Scim.Server.Mock

type UserExtra Mock = NoUserExtra

newtype Id

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

Eq Id

Defined in Web.Scim.Server.Mock

Methods

(==) :: Id -> Id -> Bool

(/=) :: Id -> Id -> Bool

Ord Id

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

Show Id

Defined in Web.Scim.Server.Mock

Methods

showsPrec :: Int -> Id -> ShowS

show :: Id -> String

showList :: [Id] -> ShowS

Hashable Id

Defined in Web.Scim.Server.Mock

Methods

hashWithSalt :: Int -> Id -> Int

hash :: Id -> Int

ToJSON Id

Defined in Web.Scim.Server.Mock

Methods

toJSON :: Id -> Value

toEncoding :: Id -> Encoding

toJSONList :: [Id] -> Value

toEncodingList :: [Id] -> Encoding

FromJSON Id

Defined in Web.Scim.Server.Mock

Methods

parseJSON :: Value -> Parser Id

parseJSONList :: Value -> Parser [Id]

ToHttpApiData Id

Defined in Web.Scim.Server.Mock

Methods

toUrlPiece :: Id -> Text

toEncodedUrlPiece :: Id -> Builder

toHeader :: Id -> ByteString

toQueryParam :: Id -> Text

FromHttpApiData Id

Defined in Web.Scim.Server.Mock

Methods

parseUrlPiece :: Text -> Either Text Id

parseHeader :: ByteString -> Either Text Id

parseQueryParam :: Text -> Either Text Id

type UserStorage = Map Id (StoredUser Mock)

type GroupStorage = Map Id (StoredGroup Mock)

data TestStorage

Constructors

TestStorage

Fields

• userDB :: UserStorage
• groupDB :: GroupStorage

Instances

AuthDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

authCheck :: Maybe (AuthData Mock) -> ScimHandler TestServer (AuthInfo Mock)

GroupDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

getGroups :: AuthInfo Mock -> ScimHandler TestServer (ListResponse (StoredGroup Mock))

getGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer (StoredGroup Mock)

postGroup :: AuthInfo Mock -> Group -> ScimHandler TestServer (StoredGroup Mock)

putGroup :: AuthInfo Mock -> GroupId Mock -> Group -> ScimHandler TestServer (StoredGroup Mock)

patchGroup :: AuthInfo Mock -> GroupId Mock -> Value -> ScimHandler TestServer (StoredGroup Mock)

deleteGroup :: AuthInfo Mock -> GroupId Mock -> ScimHandler TestServer ()

UserDB Mock TestServer

Defined in Web.Scim.Server.Mock

Methods

getUsers :: AuthInfo Mock -> Maybe Filter -> ScimHandler TestServer (ListResponse (StoredUser Mock))

getUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer (StoredUser Mock)

postUser :: AuthInfo Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock)

putUser :: AuthInfo Mock -> UserId Mock -> User Mock -> ScimHandler TestServer (StoredUser Mock)

patchUser :: AuthInfo Mock -> UserId Mock -> PatchOp Mock -> ScimHandler TestServer (StoredUser Mock)

deleteUser :: AuthInfo Mock -> UserId Mock -> ScimHandler TestServer ()

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

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.