org.testcontainers.containers.localstack

Class LocalStackContainer

java.lang.Object

org.junit.rules.ExternalResource

org.testcontainers.containers.localstack.LocalStackContainer

All Implemented Interfaces:

org.junit.rules.TestRule

public class LocalStackContainer
extends org.junit.rules.ExternalResource

Container for Atlassian Labs 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 class	LocalStackContainer.Service

Constructor Summary

Constructors

Constructor and Description
LocalStackContainer()

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
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.
LocalStackContainer	withServices(LocalStackContainer.Service... services) Declare a set of simulated AWS services that should be launched by this container.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalStackContainer

public LocalStackContainer()

Method Detail

before

protected void before()
               throws java.lang.Throwable

Overrides:

before in class org.junit.rules.ExternalResource

Throws:

java.lang.Throwable

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

withServices

public LocalStackContainer withServices(LocalStackContainer.Service... 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();
     

Parameters:

service - the service that is to be accessed

Returns:

an AwsClientBuilder.EndpointConfiguration

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();
     

Returns:

an AWSCredentialsProvider