Instance Constructors

1.  new ContainerConfig(image: String, registry: Option[String] = None, ports: Seq[DockerPort], name: Option[String] = None, env: ContainerEnvironment = ContainerEnvironment.empty, userTags: Map[String, String] = Map.empty, cmd: Seq[String] = Seq.empty, entrypoint: Seq[String] = Seq.empty, cwd: Option[String] = None, user: Option[String] = None, mounts: Seq[Mount] = Seq.empty, networks: Set[ContainerNetwork[_]] = Set.empty, reuse: DockerReusePolicy = DockerReusePolicy.ReuseEnabled, autoRemove: Boolean = true, platform: Option[String] = None, healthCheckInterval: FiniteDuration = FiniteDuration(1, TimeUnit.SECONDS), healthCheckMaxAttempts: Int = 120, pullTimeout: FiniteDuration = FiniteDuration(120, TimeUnit.SECONDS), pullAttempts: Int = 15, pullAttemptInitialSleep: FiniteDuration = FiniteDuration(1, TimeUnit.SECONDS), pullAttemptMaxSleep: FiniteDuration = FiniteDuration(15, TimeUnit.SECONDS), healthCheck: ContainerHealthCheck = ContainerHealthCheck.portCheck, portProbeTimeout: FiniteDuration = FiniteDuration(200, TimeUnit.MILLISECONDS), autoPull: Boolean = true)
   image

   Docker Image to use

   registry

   Default Docker registry to use. If not specified will use Docker Hub Registry.

   ports

   Ports to map on the docker container

   name

   Name of the container, if left at None Docker will generate a random name

   env

   Setup environment variables visible inside docker container

   userTags

   User defined container labels that used to differentiate between containers with the same name but with different configs

   cmd

   Entrypoint command to use

   entrypoint

   Docker entrypoint to use

   cwd

   Working directory to use inside the docker container

   mounts

   Host paths mounted to Volumes inside the docker container

   networks

   Docker networks to connect this container to

   reuse

   If true and ClientConfig#globalReuse is also true, keeps container alive after tests. If false, the container will be shut down. default: true

   autoRemove

   Enable autoremove flag (--rm) for spawned docker image, ensures prompt pruning of containers running to completion. Note: must be disabled if you want to use ContainerHealthCheck.exitCodeCheck

   healthCheckInterval

   Sleep interval between healthChecks default: 1 second

   pullTimeout

   Maximum amount of time to wait for docker pull to download the image default: 120 seconds

   pullAttempts

   Maximum number of attempts for docker pull. If pull unexpectedly failed will try again after exponential backoff sleep. default: 15

   pullAttemptInitialSleep

   Initial exponential backoff sleep duration after failed attempt to download the image with docker pull. default: 1 seconds

   pullAttemptMaxSleep

   Max exponential backoff sleep duration after failed attempt to download the image with docker pull. default: 15 seconds

   healthCheck

   The function to use to test if a container has started already, by default probes to check if all ports are open and proceeds if so.

   portProbeTimeout

   Sleep interval between port probes in the default healthCheck default: 200 milliseconds

   autoPull

   Pull the image if it does not exists before starting the container. default: true, should only be disabled if you absolutely must manage the image manually.