Safe Haskell	Trustworthy
Language	Haskell2010

Test.Marionette.Client

Synopsis

data SocketClosed = SocketClosed
newtype DecodeError = DecodeError String
incoming :: (MonadUnliftIO m, MonadThrow m, Binary a) => Socket -> m (TQueue a)
connect :: MonadUnliftIO m => HostName -> ServiceName -> ((Socket, SockAddr) -> m a) -> m a
newtype MarionetteTimeout = MarionetteTimeout MarionetteMessage
newtype UnexpectedResult = UnexpectedResult Result
data CommandWithCallback = CommandWithCallback Command (TMVar Result)
newtype MarionetteT (m :: Type -> Type) a = MarionetteT (ReaderT (TQueue CommandWithCallback) m a)
runMarionetteT :: (MonadUnliftIO m, MonadMask m) => MarionetteT m a -> m a

Documentation

data SocketClosed Source #

Constructors

SocketClosed

Instances

Instances details

Exception SocketClosed Source #
Instance details Defined in Test.Marionette.Client Methods toException :: SocketClosed -> SomeException # fromException :: SomeException -> Maybe SocketClosed # displayException :: SocketClosed -> String # backtraceDesired :: SocketClosed -> Bool #
Show SocketClosed Source #
Instance details Defined in Test.Marionette.Client Methods showsPrec :: Int -> SocketClosed -> ShowS # show :: SocketClosed -> String # showList :: [SocketClosed] -> ShowS #

newtype DecodeError Source #

Constructors

DecodeError String

Instances

Instances details

Exception DecodeError Source #
Instance details Defined in Test.Marionette.Client Methods toException :: DecodeError -> SomeException # fromException :: SomeException -> Maybe DecodeError # displayException :: DecodeError -> String # backtraceDesired :: DecodeError -> Bool #
Show DecodeError Source #
Instance details Defined in Test.Marionette.Client Methods showsPrec :: Int -> DecodeError -> ShowS # show :: DecodeError -> String # showList :: [DecodeError] -> ShowS #

incoming :: (MonadUnliftIO m, MonadThrow m, Binary a) => Socket -> m (TQueue a) Source #

connect :: MonadUnliftIO m => HostName -> ServiceName -> ((Socket, SockAddr) -> m a) -> m a Source #

newtype MarionetteTimeout Source #

Constructors

MarionetteTimeout MarionetteMessage

Instances

Instances details

Exception MarionetteTimeout Source #
Instance details Defined in Test.Marionette.Client Methods toException :: MarionetteTimeout -> SomeException # fromException :: SomeException -> Maybe MarionetteTimeout # displayException :: MarionetteTimeout -> String # backtraceDesired :: MarionetteTimeout -> Bool #
Show MarionetteTimeout Source #
Instance details Defined in Test.Marionette.Client Methods showsPrec :: Int -> MarionetteTimeout -> ShowS # show :: MarionetteTimeout -> String # showList :: [MarionetteTimeout] -> ShowS #

newtype UnexpectedResult Source #

Constructors

UnexpectedResult Result

Instances

Instances details

Exception UnexpectedResult Source #
Instance details Defined in Test.Marionette.Client Methods toException :: UnexpectedResult -> SomeException # fromException :: SomeException -> Maybe UnexpectedResult # displayException :: UnexpectedResult -> String # backtraceDesired :: UnexpectedResult -> Bool #
Show UnexpectedResult Source #
Instance details Defined in Test.Marionette.Client Methods showsPrec :: Int -> UnexpectedResult -> ShowS # show :: UnexpectedResult -> String # showList :: [UnexpectedResult] -> ShowS #

data CommandWithCallback Source #

Constructors

CommandWithCallback Command (TMVar Result)

Instances

Instances details

Monad m => MonadReader (TQueue CommandWithCallback) (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods ask :: MarionetteT m (TQueue CommandWithCallback) # local :: (TQueue CommandWithCallback -> TQueue CommandWithCallback) -> MarionetteT m a -> MarionetteT m a # reader :: (TQueue CommandWithCallback -> a) -> MarionetteT m a #

newtype MarionetteT (m :: Type -> Type) a Source #

A monad transformer that speaks the Marionette wire protocol over a TCP socket. Run it with runMarionetteT.

Constructors

MarionetteT (ReaderT (TQueue CommandWithCallback) m a)

Instances

Instances details

(MonadThrow m, MonadCatch m) => MonadError Error (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods throwError :: Error -> MarionetteT m a # catchError :: MarionetteT m a -> (Error -> MarionetteT m a) -> MarionetteT m a #
MonadIO m => MonadIO (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods liftIO :: IO a -> MarionetteT m a #
MonadCatch m => MonadCatch (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods catch :: (HasCallStack, Exception e) => MarionetteT m a -> (e -> MarionetteT m a) -> MarionetteT m a #
MonadMask m => MonadMask (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods mask :: HasCallStack => ((forall a. MarionetteT m a -> MarionetteT m a) -> MarionetteT m b) -> MarionetteT m b # uninterruptibleMask :: HasCallStack => ((forall a. MarionetteT m a -> MarionetteT m a) -> MarionetteT m b) -> MarionetteT m b # generalBracket :: HasCallStack => MarionetteT m a -> (a -> ExitCase b -> MarionetteT m c) -> (a -> MarionetteT m b) -> MarionetteT m (b, c) #
MonadThrow m => MonadThrow (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods throwM :: (HasCallStack, Exception e) => e -> MarionetteT m a #
Applicative m => Applicative (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods pure :: a -> MarionetteT m a # (<>) :: MarionetteT m (a -> b) -> MarionetteT m a -> MarionetteT m b # liftA2 :: (a -> b -> c) -> MarionetteT m a -> MarionetteT m b -> MarionetteT m c # (>) :: MarionetteT m a -> MarionetteT m b -> MarionetteT m b # (<*) :: MarionetteT m a -> MarionetteT m b -> MarionetteT m a #
Functor m => Functor (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods fmap :: (a -> b) -> MarionetteT m a -> MarionetteT m b # (<$) :: a -> MarionetteT m b -> MarionetteT m a #
Monad m => Monad (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods (>>=) :: MarionetteT m a -> (a -> MarionetteT m b) -> MarionetteT m b # (>>) :: MarionetteT m a -> MarionetteT m b -> MarionetteT m b # return :: a -> MarionetteT m a #
(MonadUnliftIO m, MonadThrow m, MonadCatch m) => Marionette (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods sendCommand :: (HasCallStack, FromJSON a) => Command -> MarionetteT m a Source # sendCommands :: (HasCallStack, Traversable t, FromJSON a) => t Command -> MarionetteT m (t a) Source #
MonadUnliftIO m => MonadUnliftIO (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods withRunInIO :: ((forall a. MarionetteT m a -> IO a) -> IO b) -> MarionetteT m b #
Monad m => MonadReader (TQueue CommandWithCallback) (MarionetteT m) Source #
Instance details Defined in Test.Marionette.Client Methods ask :: MarionetteT m (TQueue CommandWithCallback) # local :: (TQueue CommandWithCallback -> TQueue CommandWithCallback) -> MarionetteT m a -> MarionetteT m a # reader :: (TQueue CommandWithCallback -> a) -> MarionetteT m a #

runMarionetteT :: (MonadUnliftIO m, MonadMask m) => MarionetteT m a -> m a Source #

Connect to a Marionette server listening on localhost:2828 (started by launching Firefox with the --marionette flag), and run the given action against it.