cloud.localstack.docker.annotation

Annotation Type LocalstackDockerProperties

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Inherited
public @interface LocalstackDockerProperties

An annotation to provide parameters to the main (Docker-based) LocalstackTestRunner

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends IBindMountProvider>	bindMountProvider Used for injecting directories or files that are bind mounted into the docker container.
Class<? extends IEnvironmentVariableProvider>	environmentVariableProvider Used for injecting environment variables into the container.
Class<? extends IHostNameResolver>	hostNameResolver Used for determining the host name of the machine running the docker containers so that the containers can be addressed.
boolean	ignoreDockerRunErrors Determines if errors should be ignored when starting the Docker container.
String	imageName Use a specific image name (consisting of organisation and repository, e.g.
String	imageTag Use a specific image tag for docker container
String	initializationToken A Java Regex that is used to wait for the execution of custom init scripts
String	platform Specifies a target platform for the localstack docker image.
String	portEdge Port number for the edge service, the main entry point for all API invocations.
String	portElasticSearch Port number for the elasticsearch service.
boolean	pullNewImage Determines if a new image is pulled from the docker repo before the tests are run.
boolean	randomizePorts Deprecated.
String[]	services Determines which services should be run when the localstack starts.
boolean	useSingleDockerContainer Determines if the singleton container should be used by all test classes

Element Detail

hostNameResolver

public abstract Class<? extends IHostNameResolver> hostNameResolver

Used for determining the host name of the machine running the docker containers so that the containers can be addressed.

Default:

cloud.localstack.docker.annotation.LocalHostNameResolver.class

environmentVariableProvider

public abstract Class<? extends IEnvironmentVariableProvider> environmentVariableProvider

Used for injecting environment variables into the container. Implement a class that provides a map of the environment variables and they will be injected into the container on start-up

Default:

cloud.localstack.docker.annotation.DefaultEnvironmentVariableProvider.class

bindMountProvider

public abstract Class<? extends IBindMountProvider> bindMountProvider

Used for injecting directories or files that are bind mounted into the docker container. Implement a class that provides a map of host to container directory or file mappings, with host directories/files as keys and container directories/files as values. Remember that Docker needs absolute paths for host directories and files.

Default:

cloud.localstack.docker.annotation.IBindMountProvider.EmptyBindMountProvider.class

initializationToken

public abstract String initializationToken

A Java Regex that is used to wait for the execution of custom init scripts

Default:

""

pullNewImage

public abstract boolean pullNewImage

Determines if a new image is pulled from the docker repo before the tests are run.

Default:

false

randomizePorts

@Deprecated
public abstract boolean randomizePorts

Deprecated.

Determines if the container should expose the default local stack ports (4567-4583) or if it should expose randomized ports in order to prevent conflicts with other localstack containers running on the same machine. Deprecated, since latest LocalStack is using a single entry point (edge service)

Default:

false

services

public abstract String[] services

Determines which services should be run when the localstack starts. When empty, all the services available get up and running.

See Also:

ServiceName

Default:

{}

imageName

public abstract String imageName

Use a specific image name (consisting of organisation and repository, e.g. localstack/localstack-full for docker container

Default:

""

imageTag

public abstract String imageTag

Use a specific image tag for docker container

Default:

""

portEdge

public abstract String portEdge

Port number for the edge service, the main entry point for all API invocations. Alternatively, use the LOCALSTACK_EDGE_PORT environment variable.

Default:

"4566"

portElasticSearch

public abstract String portElasticSearch

Port number for the elasticsearch service. Alternatively, use the LOCALSTACK_ELASTICSEARCH_PORT environment variable.

Default:

"4571"

useSingleDockerContainer

public abstract boolean useSingleDockerContainer

Determines if the singleton container should be used by all test classes

Default:

false

ignoreDockerRunErrors

public abstract boolean ignoreDockerRunErrors

Determines if errors should be ignored when starting the Docker container. This can be used to run tests with an existing LocalStack container running on the host.

Default:

false

platform

public abstract String platform

Specifies a target platform for the localstack docker image. Value is used by the --platform flag in the docker run command

Default:

""