TestContainers.Docker.Reaper

Documentation

data Reaper

Reaper for safe resource cleanup. This type is exposed to allow users to create their own Reapers.

Since: 0.5.0.0

Constructors

Reaper

Fields

• register :: Text -> Text -> IO ()

  Registers a label = value pair for reaping. Reaping happens when closing/de-allocating of the Reaper through MonadResource.

• labels :: [(Text, Text)]

  Additional labels to add to any Docker resource on creation. Adding the labels is necessary in order for the Reaper to find resources for cleanup.

reaperLabels :: Reaper -> [(Text, Text)]

Additional labels to add to any Docker resource on creation. Adding the labels is necessary in order for the Reaper to find resources for cleanup.

Since: 0.5.0.0

Ryuk based reaper

ryukImageTag :: Text

Tag for the ryuk image

Since: 0.5.0.0

ryukPort :: Num a => a

Exposed port for the ryuk reaper.

Since: 0.5.0.0

newRyukReaper

Arguments

:: MonadResource m

=> Text

Host

-> Int

Port

-> m Reaper

Creates a new Reaper from a host and port.

Since: 0.5.0.0