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.DockerClient dockerClient, com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.nio.charset.Charset outputCharset, ExecConfig execConfig) Run a command inside a running container as a given user, as using "docker exec -u user".
static Container.ExecResult	execInContainer(com.github.dockerjava.api.DockerClient dockerClient, 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", and interpreting the output as UTF8.
static Container.ExecResult	execInContainer(com.github.dockerjava.api.DockerClient dockerClient, com.github.dockerjava.api.command.InspectContainerResponse containerInfo, ExecConfig execConfig) Run a command inside a running container as a given user, as using "docker exec -u user".
static Container.ExecResult	execInContainer(com.github.dockerjava.api.DockerClient dockerClient, 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.
static Container.ExecResult	execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.nio.charset.Charset outputCharset, java.lang.String... command) Deprecated. use execInContainer(DockerClient, InspectContainerResponse, Charset, String...)
static Container.ExecResult	execInContainer(com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.lang.String... command) Deprecated. use execInContainer(DockerClient, InspectContainerResponse, String...)
static Container.ExecResult	execInContainerWithUser(com.github.dockerjava.api.DockerClient dockerClient, com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.nio.charset.Charset outputCharset, java.lang.String user, java.lang.String... command) Deprecated. use execInContainer(DockerClient, InspectContainerResponse, Charset, ExecConfig)
static Container.ExecResult	execInContainerWithUser(com.github.dockerjava.api.DockerClient dockerClient, com.github.dockerjava.api.command.InspectContainerResponse containerInfo, java.lang.String user, java.lang.String... command) Deprecated. use execInContainer(DockerClient, InspectContainerResponse, ExecConfig)

Methods inherited from class java.lang.Object

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

Method Detail

execInContainer

@Deprecated
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

Deprecated. use execInContainer(DockerClient, InspectContainerResponse, String...)

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

execInContainer

@Deprecated
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

Deprecated. use execInContainer(DockerClient, InspectContainerResponse, Charset, String...)

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

execInContainer

public static Container.ExecResult execInContainer(com.github.dockerjava.api.DockerClient dockerClient,
                                                   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:

dockerClient - the DockerClient

containerInfo - the container info

command - the command to execute

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

execInContainerWithUser(DockerClient, InspectContainerResponse, String, String...)

execInContainer

public static Container.ExecResult execInContainer(com.github.dockerjava.api.DockerClient dockerClient,
                                                   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", and interpreting the output as UTF8.

Parameters:

dockerClient - the DockerClient

containerInfo - the container info

outputCharset - the character set used to interpret the output.

command - the command to execute

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

execInContainerWithUser(DockerClient, InspectContainerResponse, Charset, String, String...)

execInContainerWithUser

@Deprecated
public static Container.ExecResult execInContainerWithUser(com.github.dockerjava.api.DockerClient dockerClient,
                                                                       com.github.dockerjava.api.command.InspectContainerResponse containerInfo,
                                                                       java.lang.String user,
                                                                       java.lang.String... command)
                                                                throws java.lang.UnsupportedOperationException,
                                                                       java.io.IOException,
                                                                       java.lang.InterruptedException

Deprecated. use execInContainer(DockerClient, InspectContainerResponse, ExecConfig)

Run a command inside a running container as a given user, as using "docker exec -u user" and interpreting the output as UTF8.

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:

dockerClient - the DockerClient

containerInfo - the container info

user - the user to run the command with, optional

command - the command to execute

Throws:

java.lang.UnsupportedOperationException

java.io.IOException

java.lang.InterruptedException

See Also:

execInContainerWithUser(DockerClient, InspectContainerResponse, Charset, String, String...)

execInContainerWithUser

@Deprecated
public static Container.ExecResult execInContainerWithUser(com.github.dockerjava.api.DockerClient dockerClient,
                                                                       com.github.dockerjava.api.command.InspectContainerResponse containerInfo,
                                                                       java.nio.charset.Charset outputCharset,
                                                                       java.lang.String user,
                                                                       java.lang.String... command)
                                                                throws java.lang.UnsupportedOperationException,
                                                                       java.io.IOException,
                                                                       java.lang.InterruptedException

Deprecated. use execInContainer(DockerClient, InspectContainerResponse, Charset, ExecConfig)

Run a command inside a running container as a given user, as using "docker exec -u user".

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:

dockerClient - the DockerClient

containerInfo - the container info

outputCharset - the character set used to interpret the output.

user - the user to run the command with, optional

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".

execInContainer

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

Run a command inside a running container as a given user, as using "docker exec -u user".

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:

dockerClient - the DockerClient

containerInfo - the container info

execConfig - the exec configuration

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".

execInContainer

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

Run a command inside a running container as a given user, as using "docker exec -u user".

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:

dockerClient - the DockerClient

containerInfo - the container info

outputCharset - the character set used to interpret the output.

execConfig - the exec configuration

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".