org.testcontainers.containers.localstack

Class LocalStackContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<LocalStackContainer>

org.testcontainers.containers.localstack.LocalStackContainer

All Implemented Interfaces:

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

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

Container for LocalStack, 'A fully functional local AWS cloud stack'.

withServices(Service...) should be used to select which services are to be launched. See LocalStackContainer.Service for available choices. It is advised that getEndpointConfiguration(Service) and getDefaultCredentialsProvider() be used to obtain compatible endpoint configuration and credentials, respectively.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocalStackContainer.EnabledService
static class	LocalStackContainer.Service

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

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION Deprecated.

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
LocalStackContainer() Deprecated. use LocalStackContainer(DockerImageName) instead
LocalStackContainer(org.testcontainers.utility.DockerImageName dockerImageName)
LocalStackContainer(org.testcontainers.utility.DockerImageName dockerImageName, boolean useLegacyMode)
LocalStackContainer(java.lang.String version) Deprecated. use LocalStackContainer(DockerImageName) instead

Method Summary

Modifier and Type	Method and Description
protected void	configure()
java.lang.String	getAccessKey() Provides a default access key that is preconfigured to communicate with a given simulated service.
com.amazonaws.auth.AWSCredentialsProvider	getDefaultCredentialsProvider() Provides a AWSCredentialsProvider that is preconfigured to communicate with a given simulated service.
com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration	getEndpointConfiguration(LocalStackContainer.Service service) Provides an endpoint configuration that is preconfigured to communicate with a given simulated service.
java.net.URI	getEndpointOverride(LocalStackContainer.EnabledService service) Provides an endpoint override that is preconfigured to communicate with a given simulated service.
java.net.URI	getEndpointOverride(LocalStackContainer.Service service)
java.lang.String	getRegion() Provides a default region that is preconfigured to communicate with a given simulated service.
java.lang.String	getSecretKey() Provides a default secret key that is preconfigured to communicate with a given simulated service.
LocalStackContainer	withServices(LocalStackContainer.EnabledService... services) Declare a set of simulated AWS services that should be launched by this container.
LocalStackContainer	withServices(LocalStackContainer.Service... services)

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, 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

Field Detail

VERSION

@Deprecated
public static final java.lang.String VERSION

Deprecated.

See Also:

Constant Field Values

Constructor Detail

LocalStackContainer

@Deprecated
public LocalStackContainer()

Deprecated. use LocalStackContainer(DockerImageName) instead

LocalStackContainer

@Deprecated
public LocalStackContainer(java.lang.String version)

Deprecated. use LocalStackContainer(DockerImageName) instead

LocalStackContainer

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

Parameters:

dockerImageName - image name to use for Localstack

LocalStackContainer

public LocalStackContainer(org.testcontainers.utility.DockerImageName dockerImageName,
                           boolean useLegacyMode)

Parameters:

dockerImageName - image name to use for Localstack

useLegacyMode - if true, each AWS service is exposed on a different port

Method Detail

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<LocalStackContainer>

withServices

public LocalStackContainer withServices(LocalStackContainer.Service... services)

withServices

public LocalStackContainer withServices(LocalStackContainer.EnabledService... services)

Declare a set of simulated AWS services that should be launched by this container.

Parameters:

services - one or more service names

Returns:

this container object

getEndpointConfiguration

public com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration getEndpointConfiguration(LocalStackContainer.Service service)

Provides an endpoint configuration that is preconfigured to communicate with a given simulated service. The provided endpoint configuration should be set in the AWS Java SDK when building a client, e.g.:

AmazonS3 s3 = AmazonS3ClientBuilder
            .standard()
            .withEndpointConfiguration(localstack.getEndpointConfiguration(S3))
            .withCredentials(localstack.getDefaultCredentialsProvider())
            .build();
     

or for AWS SDK v2

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
                localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
     

Please note that this method is only intended to be used for configuring AWS SDK clients that are running on the test host. If other containers need to call this one, they should be configured specifically to do so using a Docker network and appropriate addressing.

Parameters:

service - the service that is to be accessed

Returns:

an AwsClientBuilder.EndpointConfiguration

getEndpointOverride

public java.net.URI getEndpointOverride(LocalStackContainer.Service service)

getEndpointOverride

public java.net.URI getEndpointOverride(LocalStackContainer.EnabledService service)

Provides an endpoint override that is preconfigured to communicate with a given simulated service. The provided endpoint override should be set in the AWS Java SDK v2 when building a client, e.g.:

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
             localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
             

Please note that this method is only intended to be used for configuring AWS SDK clients that are running on the test host. If other containers need to call this one, they should be configured specifically to do so using a Docker network and appropriate addressing.

Parameters:

service - the service that is to be accessed

Returns:

an URI endpoint override

getDefaultCredentialsProvider

public com.amazonaws.auth.AWSCredentialsProvider getDefaultCredentialsProvider()

Provides a AWSCredentialsProvider that is preconfigured to communicate with a given simulated service. The credentials provider should be set in the AWS Java SDK when building a client, e.g.:

AmazonS3 s3 = AmazonS3ClientBuilder
            .standard()
            .withEndpointConfiguration(localstack.getEndpointConfiguration(S3))
            .withCredentials(localstack.getDefaultCredentialsProvider())
            .build();
     

or for AWS SDK v2 you can use getAccessKey(), getSecretKey() directly:

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
             localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
     

Returns:

an AWSCredentialsProvider

getAccessKey

public java.lang.String getAccessKey()

Provides a default access key that is preconfigured to communicate with a given simulated service. The access key can be used to construct AWS SDK v2 clients:

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
             localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
     

Returns:

a default access key

getSecretKey

public java.lang.String getSecretKey()

Provides a default secret key that is preconfigured to communicate with a given simulated service. The secret key can be used to construct AWS SDK v2 clients:

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
             localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
     

Returns:

a default secret key

getRegion

public java.lang.String getRegion()

Provides a default region that is preconfigured to communicate with a given simulated service. The region can be used to construct AWS SDK v2 clients:

S3Client s3 = S3Client
             .builder()
             .endpointOverride(localstack.getEndpointOverride(LocalStackContainer.Service.S3))
             .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(
             localstack.getAccessKey(), localstack.getSecretKey()
             )))
             .region(Region.of(localstack.getRegion()))
             .build()
     

Returns:

a default region