View Source API Reference testcontainers v1.11.6
Modules
API calls for all endpoints tagged Container.
API calls for all endpoints tagged Exec.
API calls for all endpoints tagged Image.
API calls for all endpoints tagged Network.
Handle Tesla connections for DockerEngineAPI.
Helper functions for deserializing responses into models
Address represents an IPv4 or IPv6 IP address.
Kind of change Can be one of: - 0: Modified ("C") - 1: Added ("A") - 2: Deleted ("D")
Configuration for a container that is portable between hosts. When used as ContainerConfig field in an image, ContainerConfig is an optional field containing the configuration of the container that was last committed when creating the image. Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore.
OK response to ContainerCreate operation
ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command.
A summary of the container's network settings
OK response to ContainerTop operation
OK response to ContainerUpdate operation
container waiting error, if any
OK response to ContainerWait operation
A device mapping between the host and container
A request for devices to be sent to device drivers
EndpointIPAMConfig represents an endpoint's IPAM configuration.
Configuration for a network endpoint.
Properties that can be configured to access and load balance a service.
EngineDescription provides information about an engine.
Represents an error.
Actor describes something that generates events, like a container, network, or a volume.
EventMessage represents the information an event contains.
Change in the container's filesystem.
Information about the storage driver used to store the container's and image's filesystem.
Health stores information about the container's healthcheck results.
A test to perform to check that the container is healthy.
HealthcheckResult stores information about a single run of a healthcheck probe
individual image layer information in response to ImageHistory operation
Container configuration that depends on the host we are running on
The logging configuration for this container
Response to an API call that returns just an Id
Image ID or Digest
Information about an image in the local image cache.
Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.
Information about the image's RootFS, including the layer IDs.
Optional configuration for the bind type.
MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
Optional configuration for the tmpfs type.
Optional configuration for the volume type.
Map of driver specific options
Specifies how a service should be attached to a particular network.
NetworkSettings exposes the network settings in the API
NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.
An open port on a container
PortBinding represents a binding between a host IP address and a host port.
The behavior to apply when the container exits. The default is not to restart. An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.
Helper functions for building Tesla requests
The main entry point into Testcontainers.
Provides functionality for creating and managing Cassandra container configurations.
Provides functionality for creating and managing Ceph container configurations.
Considers a container ready as soon as a command runs successfully inside it.
A struct with builder functions for creating a definition of a container.
All types of predefined containers must implement this protocol.
A behaviour implemented by database containers used by Testcontainers.Ecto
Internal docker api. Only for direct use by Testcontainers
Facilitates the creation of a Postgres or MySql container for testing with Ecto.
Provides functionality for creating and managing EMQX container configurations.
Convenient macros to run containers within ExUnit tests.
Provides functionality for creating and managing Kafka container configurations.
Considers the container as ready as soon as a specific log message is detected in the container's log stream.
Provides functionality for creating and managing Minio container configurations.
Provides functionality for creating and managing MySQL container configurations.
Considers the container as ready when it successfully accepts connections on the specified port.
Provides functionality for creating and managing Postgres container configurations.
Provides functionality for creating and managing RabbitMQ container configurations.
Provides functionality for creating and managing Redis container configurations.
Work in progress. Not stable for use yet. Not yet documented for this very reason. Can use https://github.com/stuart/elixir-webdriver for client in tests
Defines the protocol/interface for the wait strategies in Testcontainers