TestContainers.Monad

Monad

type MonadDocker m = m ~ TestContainer

Docker related functionality is parameterized over this Monad. Since 0.5.0.0 this is just a type alias for m ~ TestContainer.

Since: 0.1.0.0

data TestContainer a

The heart and soul of the testcontainers library.

Since: 0.5.0.0

Instances

MonadFix TestContainer

Defined in TestContainers.Monad

Methods

mfix :: (a -> TestContainer a) -> TestContainer a

MonadIO TestContainer

Defined in TestContainers.Monad

Methods

liftIO :: IO a -> TestContainer a

Applicative TestContainer

Defined in TestContainers.Monad

Methods

pure :: a -> TestContainer a

(<*>) :: TestContainer (a -> b) -> TestContainer a -> TestContainer b

liftA2 :: (a -> b -> c) -> TestContainer a -> TestContainer b -> TestContainer c

(*>) :: TestContainer a -> TestContainer b -> TestContainer b

(<*) :: TestContainer a -> TestContainer b -> TestContainer a

Functor TestContainer

Defined in TestContainers.Monad

Methods

fmap :: (a -> b) -> TestContainer a -> TestContainer b

(<$) :: a -> TestContainer b -> TestContainer a

Monad TestContainer

Defined in TestContainers.Monad

Methods

(>>=) :: TestContainer a -> (a -> TestContainer b) -> TestContainer b

(>>) :: TestContainer a -> TestContainer b -> TestContainer b

return :: a -> TestContainer a

MonadCatch TestContainer

Defined in TestContainers.Monad

Methods

catch :: Exception e => TestContainer a -> (e -> TestContainer a) -> TestContainer a

MonadMask TestContainer

Defined in TestContainers.Monad

Methods

mask :: ((forall a. TestContainer a -> TestContainer a) -> TestContainer b) -> TestContainer b

uninterruptibleMask :: ((forall a. TestContainer a -> TestContainer a) -> TestContainer b) -> TestContainer b

generalBracket :: TestContainer a -> (a -> ExitCase b -> TestContainer c) -> (a -> TestContainer b) -> TestContainer (b, c)

MonadThrow TestContainer

Defined in TestContainers.Monad

Methods

throwM :: Exception e => e -> TestContainer a

MonadResource TestContainer

Defined in TestContainers.Monad

Methods

liftResourceT :: ResourceT IO a -> TestContainer a

MonadUnliftIO TestContainer

Defined in TestContainers.Monad

Methods

withRunInIO :: ((forall a. TestContainer a -> IO a) -> IO b) -> TestContainer b

MonadReader Config TestContainer

Defined in TestContainers.Monad

Methods

ask :: TestContainer Config

local :: (Config -> Config) -> TestContainer a -> TestContainer a

reader :: (Config -> a) -> TestContainer a

Monoid a => Monoid (TestContainer a)

Defined in TestContainers.Monad

Methods

mempty :: TestContainer a

mappend :: TestContainer a -> TestContainer a -> TestContainer a

mconcat :: [TestContainer a] -> TestContainer a

Semigroup a => Semigroup (TestContainer a)

Defined in TestContainers.Monad

Methods

(<>) :: TestContainer a -> TestContainer a -> TestContainer a

sconcat :: NonEmpty (TestContainer a) -> TestContainer a

stimes :: Integral b => b -> TestContainer a -> TestContainer a

runTestContainer :: Config -> TestContainer a -> IO a

Run a TestContainer action. Any container spun up during the computation are guaranteed to be shutdown and cleaned up once this function returns.

Since: 0.5.0.0

Runtime configuration

data Config

Configuration for defaulting behavior.

Since: 0.2.0.0

Constructors

Config

Fields

• configDefaultWaitTimeout :: Maybe Int

  The number of seconds to maximally wait for a container to become ready. Default is `Just 60`.

  Nothing = waits indefinitely.

• configTracer :: Tracer

  Traces execution inside testcontainers library.

• configCreateReaper :: TestContainer Reaper

  How to obtain a Reaper

Instances

MonadReader Config TestContainer

Defined in TestContainers.Monad

Methods

ask :: TestContainer Config

local :: (Config -> Config) -> TestContainer a -> TestContainer a

reader :: (Config -> a) -> TestContainer a