A tag to a Docker image.

Since: 0.1.0.0

Handle to a Docker image.

Since: 0.1.0.0

The image tag assigned by Docker. Uniquely identifies an Image within Docker.

Since: 0.1.0.0

A description of how to build an Image.

Since: 0.1.0.0

Get an Image from a tag.

Since: 0.1.0.0

Build the image from a build path and an optional path to the Dockerfile (default is Dockerfile)

Since: 0.1.0.0

Build the Image referred to by the argument. If the construction of the image is expensive (e.g. a call to fromBuildContext) we don't want to repeatedly build the image. Instead, build can be used to execute the underlying Docker build once and re-use the resulting Image.

Since: 0.1.0.0

Parameters for a running a Docker container.

Since: 0.1.0.0

Default ContainerRequest. Used as base for every Docker container.

Since: 0.1.0.0

Set the name of a Docker container. This is equivalent to invoking docker run with the --name parameter.

Since: 0.1.0.0

The command to execute inside the Docker container. This is the equivalent of passing the command on the docker run invocation.

Since: 0.1.0.0

Wether to remove the container once exited. This is equivalent to passing --rm to docker run. (default is True).

Since: 0.1.0.0

Set the environment for the container. This is equivalent to passing --env key=value to docker run.

Since: 0.1.0.0

Set link on the container. This is equivalent to passing --link other_container to docker run.

Since: 0.1.0.0

Set exposed ports on the container. This is equivalent to setting --publish $PORT to docker run. Docker assigns a random port for the host port. You will have to use containerIp and containerPort to connect to the published port.

  container <- run $ containerRequest redis & setExpose [ 6379 ]
  let (redisHost, redisPort) = (containerIp container, containerPort container 6379)
  print (redisHost, redisPort)

Since: 0.1.0.0

Set the waiting strategy on the container. Depending on a Docker container it can take some time until the provided service is ready. You will want to use to setWaitingFor to block until the container is ready to use.

Since: 0.1.0.0

Handle to a Docker container.

Since: 0.1.0.0

Looks up the ip address of the container.

Since: 0.1.0.0

Looks up an exposed port on the host.

Since: 0.1.0.0

Returns the internal release key used for safely shutting down the container. Use this with care. This function is considered an internal detail.

Since: 0.1.0.0

Returns the underlying image of the container.

Since: 0.1.0.0

Runs a Docker container from an Image and ContainerRequest. A finalizer is registered so that the container is aways stopped when it goes out of scope. This function is essentially docker run.

Since: 0.1.0.0

The parsed JSON output of docker inspect command.

Since: 0.1.0.0

Runs the `docker inspect` command. Memoizes the result.

Since: 0.1.0.0

Stops a Docker container. stop is essentially docker stop.

Since: 0.1.0.0

Kills a Docker container. kill is essentially docker kill.

Since: 0.1.0.0

Remove a Docker container. rm is essentially docker rm -f

Since: 0.1.0.0

Access STDOUT and STDERR of a running Docker container. This is essentially docker logs under the hood.

Since: 0.1.0.0

A strategy that describes how to asses readiness of a Container. Allows Users to plug in their definition of readiness.

Since: 0.1.0.0

waitUntilTimeout n waitUntilReady waits n seconds for the container to be ready. If the container is not ready by then a TimeoutException will be thrown.

Since: 0.1.0.0

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

Since: 0.1.0.0

A low-level primitive that allows scanning the logs for specific log lines that indicate readiness of a container.

The Handles passed to the function argument represent stdout and stderr of the container.

Since: 0.1.0.0

Waits for a specific line to occur in the logs. Throws a UnexpectedEndOfPipe exception in case the desired line can not be found on the logs.

Say you want to find "Ready to accept connections" in the logs on Stdout try:

wairForLogLine Stdout ("Ready to accept connections" `isInfixOf`)

Since: 0.1.0.0

Waits until the port of a container is ready to accept connections. This combinator should always be used with waitUntilTimeout.

Since: 0.1.0.0

Docker related functionality is parameterized over this Monad.

Since: 0.1.0.0

Configuration for defaulting behavior.

Since: 0.2.0.0

Default configuration.

Since: 0.2.0.0

Autoselect the default configuration depending on wether you use Docker For Mac or not.

Traces execution within testcontainers library.

Type representing various events during testcontainer execution.

Construct a new Tracer from a tracing function.

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

Since: 0.1.0.0

The exception thrown by waitUntilTimeout.

Since: 0.1.0.0

The exception thrown by waitForLine in case the expected log line wasn't found.

Since: 0.1.0.0

Image for Redis database.

redis = fromTag "redis:5.0"

Since: 0.1.0.0

Image for Mongo database.

mongo = Tag "mongo:4.0.17"

Since: 0.1.0.0

Convenient alias for ResourceT IO.

Unwrap a ResourceT transformer, and call all registered release actions.

Note that there is some reference counting involved due to resourceForkIO. If multiple threads are sharing the same collection of resources, only the last call to runResourceT will deallocate the resources.

NOTE Since version 1.2.0, this function will throw a ResourceCleanupException if any of the cleanup functions throw an exception.

Since: resourcet-0.3.0

& is a reverse application operator. This provides notational convenience. Its precedence is one higher than that of the forward application operator $, which allows & to be nested in $.

>>> 5 & (+1) & show
"6"

Since: base-4.8.0.0