org.testcontainers.containers

Class ToxiproxyContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<ToxiproxyContainer>

org.testcontainers.containers.ToxiproxyContainer

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<ToxiproxyContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class ToxiproxyContainer
extends org.testcontainers.containers.GenericContainer<ToxiproxyContainer>

Container for resiliency testing using Toxiproxy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToxiproxyContainer.ContainerProxy

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
ToxiproxyContainer() Deprecated. use ToxiproxyContainer(DockerImageName) instead
ToxiproxyContainer(org.testcontainers.utility.DockerImageName dockerImageName)
ToxiproxyContainer(java.lang.String dockerImageName)

Method Summary

Modifier and Type	Method and Description
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
int	getControlPort()
ToxiproxyContainer.ContainerProxy	getProxy(org.testcontainers.containers.GenericContainer<?> container, int port) Obtain a ToxiproxyContainer.ContainerProxy instance for target container that is managed by Testcontainers.
ToxiproxyContainer.ContainerProxy	getProxy(java.lang.String hostname, int port) Obtain a ToxiproxyContainer.ContainerProxy instance for a specific hostname and port, which can be for any host that is routable from this ToxiproxyContainer instance (e.g.

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, waitUntilContainerStarted, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

ToxiproxyContainer

@Deprecated
public ToxiproxyContainer()

Deprecated. use ToxiproxyContainer(DockerImageName) instead

ToxiproxyContainer

public ToxiproxyContainer(java.lang.String dockerImageName)

ToxiproxyContainer

public ToxiproxyContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

containerIsStarted

protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

Overrides:

containerIsStarted in class org.testcontainers.containers.GenericContainer<ToxiproxyContainer>

getControlPort

public int getControlPort()

Returns:

Publicly exposed Toxiproxy HTTP API control port.

getProxy

public ToxiproxyContainer.ContainerProxy getProxy(org.testcontainers.containers.GenericContainer<?> container,
                                                  int port)

Obtain a ToxiproxyContainer.ContainerProxy instance for target container that is managed by Testcontainers. The target container should be routable from this from this ToxiproxyContainer instance (e.g. on the same Docker Network).

Parameters:

container - target container

port - port number on the target service that should be proxied

Returns:

a ToxiproxyContainer.ContainerProxy instance

getProxy

public ToxiproxyContainer.ContainerProxy getProxy(java.lang.String hostname,
                                                  int port)

Obtain a ToxiproxyContainer.ContainerProxy instance for a specific hostname and port, which can be for any host that is routable from this ToxiproxyContainer instance (e.g. on the same Docker Network or on routable from the Docker host).

It is expected that getProxy(GenericContainer, int) will be more useful in most scenarios, but this method is present to allow use of Toxiproxy in front of containers or external servers that are not managed by Testcontainers.

Parameters:

hostname - hostname of target server to be proxied

port - port number on the target server that should be proxied

Returns:

a ToxiproxyContainer.ContainerProxy instance