cloud.localstack.docker

Class Container

java.lang.Object

cloud.localstack.docker.Container

public class Container
extends Object

An abstraction of the LocalStack docker container. Provides port mappings, a way to poll the logs until a specified token appears, and the ability to stop the container.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCALSTACK_EXTERNAL_HOSTNAME

Method Summary

Modifier and Type	Method and Description
static Container	createLocalstackContainer(String externalHostName, boolean pullNewImage, boolean randomizePorts, String imageName, String imageTag, String portEdge, String portElasticSearch, Map<String,String> environmentVariables, Map<Integer,Integer> portMappings, Map<String,String> bindMounts, String platform) It creates a container using the hostname given and the set of environment variables provided
String	executeCommand(List<String> command) Run a command on the container via docker exec
int	getExternalPortFor(int internalPort) Given an internal port, retrieve the publicly addressable port that maps to it
static Container	getRunningLocalstackContainer()
static Container	getRunningLocalstackContainer(String containerId)
boolean	isRunning()
void	stop() Stop the container
void	waitForAllPorts(String ip)
void	waitForLogToken(Pattern pattern) Poll the docker logs until a specific token appears, then return.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALSTACK_EXTERNAL_HOSTNAME

public static final String LOCALSTACK_EXTERNAL_HOSTNAME

See Also:

Constant Field Values

Method Detail

createLocalstackContainer

public static Container createLocalstackContainer(String externalHostName,
                                                  boolean pullNewImage,
                                                  boolean randomizePorts,
                                                  String imageName,
                                                  String imageTag,
                                                  String portEdge,
                                                  String portElasticSearch,
                                                  Map<String,String> environmentVariables,
                                                  Map<Integer,Integer> portMappings,
                                                  Map<String,String> bindMounts,
                                                  String platform)

It creates a container using the hostname given and the set of environment variables provided

Parameters:

externalHostName - hostname to be used by localstack

pullNewImage - determines if docker pull should be run to update to the latest image of the container

randomizePorts - determines if the container should expose the default local stack ports or if it should expose randomized ports in order to prevent conflicts with other localstack containers running on the same machine

imageName - the name of the image defaults to if null

imageTag - the tag of the image to pull, defaults to if null

environmentVariables - map of environment variables to be passed to the docker container

portMappings -

bindMounts - Docker host to container volume mapping like /host/dir:/container/dir, be aware that the host directory must be an absolute path

platform - target platform for the localstack docker image

getRunningLocalstackContainer

public static Container getRunningLocalstackContainer()

getRunningLocalstackContainer

public static Container getRunningLocalstackContainer(String containerId)

getExternalPortFor

public int getExternalPortFor(int internalPort)

Given an internal port, retrieve the publicly addressable port that maps to it

waitForAllPorts

public void waitForAllPorts(String ip)

isRunning

public boolean isRunning()

waitForLogToken

public void waitForLogToken(Pattern pattern)

Poll the docker logs until a specific token appears, then return. Primarily used to look for the "Ready." token in the LocalStack logs.

stop

public void stop()

Stop the container

executeCommand

public String executeCommand(List<String> command)

Run a command on the container via docker exec