org.testcontainers.containers

Class ExecInContainerPattern

java.lang.Object

org.testcontainers.containers.ExecInContainerPattern

public final class ExecInContainerPattern
extends java.lang.Object

Provides utility methods for executing commands in containers

Method Summary

Modifier and Type	Method and Description
static Container.ExecResult	execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.nio.charset.Charset outputCharset, java.lang.String... command) Run a command inside a running container, as though using "docker exec".
static Container.ExecResult	execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.lang.String... command) Run a command inside a running container, as though using "docker exec", and interpreting the output as UTF8.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

execInContainer

public static Container.ExecResult execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo,
                                                   java.lang.String... command)
                                            throws java.lang.UnsupportedOperationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec", and interpreting the output as UTF8.

Parameters:

containerInfo - the container info

command - the command to execute

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

execInContainer(InspectContainerResponse, Charset, String...)

execInContainer

public static Container.ExecResult execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo,
                                                   java.nio.charset.Charset outputCharset,
                                                   java.lang.String... command)
                                            throws java.lang.UnsupportedOperationException,
                                                   java.io.IOException,
                                                   java.lang.InterruptedException

Run a command inside a running container, as though using "docker exec".

This functionality is not available on a docker daemon running the older "lxc" execution driver. At the time of writing, CircleCI was using this driver.

Parameters:

containerInfo - the container info

outputCharset - the character set used to interpret the output.

command - the parts of the command to run

Returns:

the result of execution

Throws:

java.io.IOException - if there's an issue communicating with Docker

java.lang.InterruptedException - if the thread waiting for the response is interrupted

java.lang.UnsupportedOperationException - if the docker daemon you're connecting to doesn't support "exec".