org.apache.beam.it.testcontainers

Class TestContainerResourceManager<T extends GenericContainer<?>>

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<T>

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager

Direct Known Subclasses:

AbstractJDBCResourceManager, CassandraResourceManager, ElasticsearchResourceManager, KafkaResourceManager, MongoDBResourceManager, Neo4jResourceManager, SplunkResourceManager

public abstract class TestContainerResourceManager<T extends GenericContainer<?>>
extends java.lang.Object
implements org.apache.beam.it.common.ResourceManager

Abstract class for managing TestContainers resources in integration tests.

Resource managers that extend this class will use TestContainers as a backend to spin up resources.

Optionally, a static resource can be specified by calling the useStaticContainer() method in the TestContainerResourceManager.Builder class. A static resource is a pre-configured database or other resource that is ready to be connected to by the resource manager. This could be a pre-existing TestContainer that has not been closed, a local database instance, a remote VM, or any other source that can be connected to. If a static container is used, the host and port must also be configured using the Builder's setHost() and setPort() methods, respectively.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestContainerResourceManager.Builder<T extends TestContainerResourceManager<?>> Builder for TestContainerResourceManager.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	HOST_IP
protected int	port

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TestContainerResourceManager(T container, B builder)
protected	TestContainerResourceManager(T container, B builder, java.util.concurrent.Callable<java.lang.Void> setup)

Method Summary

Modifier and Type	Method and Description
void	cleanupAll() Deletes all created resources (VM's, etc.) and stops the container, making the manager object unusable.
protected java.lang.String	getDockerImageName()
java.lang.String	getHost() Returns the host that the resource is running on.
protected int	getPort(int mappedPort) Returns the port that the resource is actually mapped to on the host.

Methods inherited from class java.lang.Object

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

Field Detail

HOST_IP

protected static final java.lang.String HOST_IP

port

protected int port

Constructor Detail

TestContainerResourceManager

protected TestContainerResourceManager(T container,
                                       B builder)

TestContainerResourceManager

protected TestContainerResourceManager(T container,
                                       B builder,
                                       @Nullable
                                       java.util.concurrent.Callable<java.lang.Void> setup)

Method Detail

getDockerImageName

protected java.lang.String getDockerImageName()

getHost

public java.lang.String getHost()

Returns the host that the resource is running on. If a host was specified in the builder, then this method will return that value. Otherwise, the host will default to localhost.

Returns:

the host that the resource is running on

getPort

protected int getPort(int mappedPort)

Returns the port that the resource is actually mapped to on the host. When using a non-static resource, the TestContainers framework will map the resource port to a random port on the host. This method will return the mapped port that the resource traffic is routed through.

Note: When using a static container, the port that was specified in the builder will be returned regardless of what is passed into this method as a parameter.

Parameters:

mappedPort - the port the resource was configured to listen on

Returns:

the mapped port on the host

cleanupAll

public void cleanupAll()
                throws TestContainerResourceManagerException

Deletes all created resources (VM's, etc.) and stops the container, making the manager object unusable.

Specified by:

cleanupAll in interface org.apache.beam.it.common.ResourceManager

Throws:

TestContainerResourceManagerException - if there is an error deleting the TestContainers resources.