Safe Haskell	Safe-Inferred
Language	GHC2021

Testlib.Cannon

Synopsis

data WebSocket = WebSocket {
- wsConnect :: WSConnect
- wsChan :: TChan Value
- wsCloseLatch :: MVar ()
- wsAppThread :: Async ()
}
data WSConnect = WSConnect {
- user :: String
- domain :: String
- client :: Maybe String
- conn :: Maybe String
}
class ToWSConnect a where
- toWSConnect :: HasCallStack => a -> App WSConnect
data AwaitResult = AwaitResult {
- success :: Bool
- nMatchesExpected :: Int
- matches :: [Value]
- nonMatches :: [Value]
}
withWebSocket :: (HasCallStack, ToWSConnect w) => w -> (WebSocket -> App a) -> App a
withWebSockets :: forall a w. (HasCallStack, ToWSConnect w) => [w] -> ([WebSocket] -> App a) -> App a
awaitNMatchesResult :: HasCallStack => Int -> (Value -> App Bool) -> WebSocket -> App AwaitResult
awaitNMatches :: HasCallStack => Int -> (Value -> App Bool) -> WebSocket -> App [Value]
awaitMatch :: HasCallStack => (Value -> App Bool) -> WebSocket -> App Value
awaitAnyEvent :: Int -> WebSocket -> App (Maybe Value)
awaitAtLeastNMatchesResult :: HasCallStack => Int -> (Value -> App Bool) -> WebSocket -> App AwaitAtLeastResult
awaitAtLeastNMatches :: HasCallStack => Int -> (Value -> App Bool) -> WebSocket -> App [Value]
awaitNToMMatchesResult :: HasCallStack => Int -> Int -> (Value -> App Bool) -> WebSocket -> App AwaitAtLeastResult
awaitNToMMatches :: HasCallStack => Int -> Int -> (Value -> App Bool) -> WebSocket -> App [Value]
assertAwaitResult :: HasCallStack => AwaitResult -> App [Value]
nPayload :: MakesValue a => a -> App Value
printAwaitResult :: AwaitResult -> App ()
printAwaitAtLeastResult :: AwaitAtLeastResult -> App ()
waitForResponse :: HasCallStack => App Response -> (Response -> App r) -> App r
assertNoEvent :: HasCallStack => Int -> WebSocket -> App ()

Documentation

data WebSocket Source #

Constructors

WebSocket
Fields wsConnect :: WSConnect wsChan :: TChan Value wsCloseLatch :: MVar () wsAppThread :: Async ()

Instances

Instances details

HasField "user" WebSocket Value Source #
Instance details Defined in Testlib.Cannon Methods getField :: WebSocket -> Value #
HasField "client" WebSocket (Maybe ClientIdentity) Source #
Instance details Defined in Testlib.Cannon Methods getField :: WebSocket -> Maybe ClientIdentity #

data WSConnect Source #

Constructors

WSConnect
Fields user :: String domain :: String client :: Maybe String conn :: Maybe String If this is Nothing then a random Z-Connection will be used

Instances

Instances details

ToWSConnect WSConnect Source #
Instance details Defined in Testlib.Cannon Methods toWSConnect :: WSConnect -> App WSConnect Source #

class ToWSConnect a where Source #

Methods

toWSConnect :: HasCallStack => a -> App WSConnect Source #

Instances

Instances details

ToWSConnect WSConnect Source #
Instance details Defined in Testlib.Cannon Methods toWSConnect :: WSConnect -> App WSConnect Source #
MakesValue user => ToWSConnect user Source #
Instance details Defined in Testlib.Cannon Methods toWSConnect :: user -> App WSConnect Source #
(MakesValue user, MakesValue conn) => ToWSConnect (user, conn) Source #
Instance details Defined in Testlib.Cannon Methods toWSConnect :: (user, conn) -> App WSConnect Source #
(MakesValue user, MakesValue conn, MakesValue client) => ToWSConnect (user, conn, client) Source #
Instance details Defined in Testlib.Cannon Methods toWSConnect :: (user, conn, client) -> App WSConnect Source #

data AwaitResult Source #

Constructors

AwaitResult
Fields success :: Bool nMatchesExpected :: Int matches :: [Value] nonMatches :: [Value]

withWebSocket :: (HasCallStack, ToWSConnect w) => w -> (WebSocket -> App a) -> App a Source #

withWebSockets :: forall a w. (HasCallStack, ToWSConnect w) => [w] -> ([WebSocket] -> App a) -> App a Source #

awaitNMatchesResult Source #

Arguments

:: HasCallStack
=> Int	Number of matches
-> (Value -> App Bool)	Selection function. Exceptions are not caught.
-> WebSocket
-> App AwaitResult

await an expected number of notification events on the websocket that satisfy the provided predicate. If there isn't any new event (matching or non-matching) for a tSecs seconds then AwaitResult is a failure. This function will never terminate if there is a constant stream of events received. When this functions returns it will push any non-matching events back to the websocket.

awaitNMatches Source #

Arguments

:: HasCallStack
=> Int	Number of matches
-> (Value -> App Bool)	Selection function. Should not throw any exceptions
-> WebSocket
-> App [Value]

awaitMatch Source #

Arguments

:: HasCallStack
=> (Value -> App Bool)	Selection function. Should not throw any exceptions
-> WebSocket
-> App Value

awaitAnyEvent :: Int -> WebSocket -> App (Maybe Value) Source #

awaitAtLeastNMatchesResult Source #

Arguments

:: HasCallStack
=> Int	Minimum number of matches
-> (Value -> App Bool)	Selection function. Exceptions are not caught.
-> WebSocket
-> App AwaitAtLeastResult

awaitAtLeastNMatches Source #

Arguments

:: HasCallStack
=> Int	Minumum number of matches
-> (Value -> App Bool)	Selection function. Should not throw any exceptions
-> WebSocket
-> App [Value]

awaitNToMMatchesResult Source #

Arguments

:: HasCallStack
=> Int	Minimum number of matches
-> Int	Maximum number of matches
-> (Value -> App Bool)	Selection function. Exceptions are not caught.
-> WebSocket
-> App AwaitAtLeastResult

awaitNToMMatches Source #

Arguments

:: HasCallStack
=> Int	Minimum Number of matches
-> Int	Maximum Number of matches
-> (Value -> App Bool)	Selection function. Should not throw any exceptions
-> WebSocket
-> App [Value]

assertAwaitResult :: HasCallStack => AwaitResult -> App [Value] Source #

nPayload :: MakesValue a => a -> App Value Source #

printAwaitResult :: AwaitResult -> App () Source #

printAwaitAtLeastResult :: AwaitAtLeastResult -> App () Source #

waitForResponse :: HasCallStack => App Response -> (Response -> App r) -> App r Source #

waits for an http response to satisfy a predicate

assertNoEvent :: HasCallStack => Int -> WebSocket -> App () Source #