TestContainers.Docker.Internal

Documentation

data DockerException

Failing to interact with Docker results in this exception being thrown.

Since: 0.1.0.0

Constructors

DockerException

Fields

• exitCode :: ExitCode

  Exit code of the underlying Docker process.

• args :: [Text]

  Arguments that were passed to Docker.

• stderr :: Text

  Docker's STDERR output.

InspectUnknownContainerId

Fields

• id :: ContainerId

  Id of the Container that we tried to lookup the port mapping.

InspectOutputInvalidJSON

Fields

• id :: ContainerId

  Id of the Container that we tried to lookup the port mapping.

InspectOutputMissingNetwork

Fields

• id :: ContainerId

  Id of the Container that we tried to lookup the port mapping.

InspectOutputUnexpected

Fields

• id :: ContainerId

  Id of the Container that we tried to lookup the port mapping.

UnknownPortMapping

Fields

• id :: ContainerId

  Id of the Container that we tried to lookup the port mapping.

• port :: Text

  Textual representation of port mapping we were trying to look up.

Instances

Exception DockerException

Defined in TestContainers.Docker.Internal

Methods

toException :: DockerException -> SomeException

fromException :: SomeException -> Maybe DockerException

displayException :: DockerException -> String

Show DockerException

Defined in TestContainers.Docker.Internal

Methods

showsPrec :: Int -> DockerException -> ShowS

show :: DockerException -> String

showList :: [DockerException] -> ShowS

Eq DockerException

Defined in TestContainers.Docker.Internal

Methods

(==) :: DockerException -> DockerException -> Bool

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

Container related stuff

type ContainerId = Text

Identifies a container within the Docker runtime. Assigned by docker run.

Since: 0.1.0.0

type InspectOutput = Value

The parsed JSON output of docker inspect command.

Since: 0.1.0.0

Network related stuff

type NetworkId = Text

Identifies a network within the Docker runtime. Assigned by docker network create

Since: 0.5.0.0

Running docker

docker :: MonadIO m => Tracer -> [Text] -> m String

Internal function that runs Docker. Takes care of throwing an exception in case of failure.

Since: 0.1.0.0

dockerWithStdin :: MonadIO m => Tracer -> [Text] -> Text -> m String

Internal function that runs Docker. Takes care of throwing an exception in case of failure.

Since: 0.1.0.0

Following logs

data Pipe

A data type indicating which pipe to scan for a specific log line.

Since: 0.1.0.0

Constructors

Stdout

Refer to logs on STDOUT.

Stderr

Refer to logs on STDERR.

Instances

Show Pipe

Defined in TestContainers.Docker.Internal

Methods

showsPrec :: Int -> Pipe -> ShowS

show :: Pipe -> String

showList :: [Pipe] -> ShowS

Eq Pipe

Defined in TestContainers.Docker.Internal

Methods

(==) :: Pipe -> Pipe -> Bool

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

Ord Pipe

Defined in TestContainers.Docker.Internal

Methods

compare :: Pipe -> Pipe -> Ordering

(<) :: Pipe -> Pipe -> Bool

(<=) :: Pipe -> Pipe -> Bool

(>) :: Pipe -> Pipe -> Bool

(>=) :: Pipe -> Pipe -> Bool

max :: Pipe -> Pipe -> Pipe

min :: Pipe -> Pipe -> Pipe

type LogConsumer = Pipe -> ByteString -> IO ()

An abstraction for forwarding logs.

Since: 0.5.0.0

consoleLogConsumer :: LogConsumer

A simple LogConsumer that writes log lines to stdout and stderr respectively.

Since: 0.5.0.0

dockerFollowLogs :: MonadResource m => Tracer -> ContainerId -> LogConsumer -> m ()

Forwards container logs to a LogConsumer. This is equivalent of calling docker logs containerId --follow

Since: 0.5.0.0

Common abstractions for Docker resources

class WithoutReaper request where

Shared property between Docker resources.

Methods

withoutReaper :: request -> request

Do not register the docker resource (container, register, etc.) with the resource reaper. Careful, doing this will make your container leak on shutdown if not explicitly stopped.

Since: 0.5.1.0

Instances

WithoutReaper ContainerRequest

Defined in TestContainers.Docker

Methods

withoutReaper :: ContainerRequest -> ContainerRequest

WithoutReaper NetworkRequest

Defined in TestContainers.Docker.Network

Methods

withoutReaper :: NetworkRequest -> NetworkRequest