Index
All Classes and Interfaces|All Packages
A
- addApplicationPort(int) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Add a single application port which will be used inside the container and exposed outside of the container by mapping to a port inside the range specified with
DockerResource.Builder.setExposedPortsRange(String)
or a random port. - addDeleteIndex(String) - Method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource.Builder
-
Add an additional index to delete when calling
ElasticSearchDockerResource.deleteIndices()
. - addEnvironmentVariable(String, String) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Add an additional environment variable for the container.
- additionalContainerConfig(ContainerConfig) - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Subclasses can override this method in order to apply additional configuration to the container itself.
- additionalHostConfig(HostConfig) - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource
-
Adds Cassandra specific host configuration to default configuration from
DockerResource
. - additionalHostConfig(HostConfig) - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Subclasses can override this method in order to apply additional configuration to the host inside the container.
- additionalHostConfig(HostConfig) - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource
-
Adds MariaDB specific host configuration to default configuration from
DockerResource
. - after() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Teardown DockerResource after executing tests.
- applicationPorts - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
B
- before() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Initialize DockerResource before executing tests.
- before() - Method in class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper
- build() - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource.Builder
-
Build a configured CassandraDockerResource.
- build() - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Build a configured DockerResource.
- build() - Method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource.Builder
-
Build a configured ElasticSearchDockerResource.
- build() - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource.Builder
-
Build a configured MariaDBDockerResource.
- build() - Method in class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper.Builder
-
Build a
SingletonDockerResourceWrapper
instance wrapping anotherDockerResource
. - builder() - Static method in class no.mnemonic.commons.junit.docker.CassandraDockerResource
-
Create builder for CassandraDockerResource.
- builder() - Static method in class no.mnemonic.commons.junit.docker.DockerResource
-
Create builder for DockerResource.
- builder() - Static method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource
-
Create builder for ElasticSearchDockerResource.
- builder() - Static method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource
-
Create builder for MariaDBDockerResource.
- builder() - Static method in class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper
-
Create builder for
SingletonDockerResourceWrapper
. - Builder() - Constructor for class no.mnemonic.commons.junit.docker.CassandraDockerResource.Builder
- Builder() - Constructor for class no.mnemonic.commons.junit.docker.DockerResource.Builder
- Builder() - Constructor for class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource.Builder
- Builder() - Constructor for class no.mnemonic.commons.junit.docker.MariaDBDockerResource.Builder
- Builder() - Constructor for class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper.Builder
C
- CassandraDockerResource - Class in no.mnemonic.commons.junit.docker
-
CassandraDockerResource is a JUnit resource which can be used to write integration tests against a Cassandra server executed inside an isolated Docker container.
- CassandraDockerResource.Builder - Class in no.mnemonic.commons.junit.docker
-
Builder to create a CassandraDockerResource which extends
DockerResource.Builder
.
D
- deleteIndices() - Method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource
-
Truncate data indexed into ElasticSearch by deleting the indices specified when constructing the resource.
- dockerClientResolver - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
- DockerResource - Class in no.mnemonic.commons.junit.docker
-
DockerResource is a JUnit resource which starts up an isolated Docker container in a unit test, for example for integration tests against an external database.
- DockerResource(String, Set<Integer>, String, int, boolean, boolean, Supplier<DockerClient>, Map<String, String>) - Constructor for class no.mnemonic.commons.junit.docker.DockerResource
-
Constructor to override by subclasses.
- DockerResource.Builder<T extends DockerResource.Builder<?>> - Class in no.mnemonic.commons.junit.docker
-
Builder to create a DockerResource.
- DockerTestUtils - Class in no.mnemonic.commons.junit.docker
-
Utility class for working with Docker environments during unit tests.
E
- ElasticSearchDockerResource - Class in no.mnemonic.commons.junit.docker
-
ElasticSearchDockerResource is a JUnit resource which can be used to write integration tests against an ElasticSearch server executed inside an isolated Docker container.
- ElasticSearchDockerResource.Builder - Class in no.mnemonic.commons.junit.docker
-
Builder to create an ElasticSearchDockerResource which extends
DockerResource.Builder
. - environmentVariables - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
- exposedPortsRange - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
G
- getContainerID() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Expose containerID of the started container to subclasses.
- getDockerClient() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Expose DockerClient used by DockerResource to subclasses.
- getDockerHost() - Static method in class no.mnemonic.commons.junit.docker.DockerTestUtils
-
Return the hostname extracted from the DOCKER_HOST environment variable.
- getDockerHostVariable() - Static method in class no.mnemonic.commons.junit.docker.DockerTestUtils
-
Return the value of the DOCKER_HOST environment variable.
- getDockerResource() - Method in class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper
-
Return wrapped
DockerResource
. - getExposedHost() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Returns the host where the started Docker container is available.
- getExposedHostPort(int) - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
DockerResource will map the application ports, which are the ports applications listen to inside the container, to random ports on the host machine, which can be used to communicate with the applications.
I
- imageName - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
- isContainerReachable() - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource
-
Verifies that Cassandra is reachable by issuing a simple cqlsh command inside the Cassandra Docker container.
- isContainerReachable() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Subclasses can override this method in order to implement a check to determine if a container is reachable.
- isContainerReachable() - Method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource
-
Verifies that ElasticSearch is reachable by querying the cluster status from inside the Docker container.
- isContainerReachable() - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource
-
Verifies that MariaDB is reachable by issuing a simple mysqladmin command inside the MariaDB Docker container.
M
- MariaDBDockerResource - Class in no.mnemonic.commons.junit.docker
-
MariaDBDockerResource is a JUnit resource which can be used to write integration tests against a MariaDB server executed inside an isolated Docker container.
- MariaDBDockerResource.Builder - Class in no.mnemonic.commons.junit.docker
-
Builder to create
MariaDBDockerResource
which extendsDockerResource.Builder
N
- no.mnemonic.commons.junit.docker - package no.mnemonic.commons.junit.docker
P
- prepareContainer() - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource
-
Initializes Cassandra by executing the set up CQL script.
- prepareContainer() - Method in class no.mnemonic.commons.junit.docker.DockerResource
-
Subclasses can override this method in order to prepare a container once before tests are executed, for example by initializing a database with a schema or inserting some application data into a database.
- prepareContainer() - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource
-
Initializes MariaDB by executing the set up SQL script.
R
- reachabilityTimeout - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
S
- setApplicationPorts(Set<Integer>) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Set application ports which will be used inside the container and exposed outside of the container by mapping to ports inside the range specified with
DockerResource.Builder.setExposedPortsRange(String)
or random ports. - setDeleteIndices(Set<String>) - Method in class no.mnemonic.commons.junit.docker.ElasticSearchDockerResource.Builder
-
Set indices to delete when calling
ElasticSearchDockerResource.deleteIndices()
. - setDockerClientResolver(Supplier<DockerClient>) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Override the default behaviour of how a DockerClient will be created by providing a custom resolver function.
- setDockerResource(T) - Method in class no.mnemonic.commons.junit.docker.SingletonDockerResourceWrapper.Builder
-
Set
DockerResource
which will be wrapped as a singleton. - setEnvironmentVariables(MapUtils.Pair<String, String>...) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Set multiple environment variables for the container.
- setExposedPortsRange(String) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Set port range which will be used for exposing ports inside the container to the outside of the container.
- setImageName(String) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Set image name of container to use.
- setReachabilityTimeout(int) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Set timeout in seconds until test for container reachability stops.
- setSetupScript(String) - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource.Builder
-
Set file name of CQL start up script.
- setSetupScript(String) - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource.Builder
-
Set file name of SQL start up script.
- setSkipPullDockerImage(boolean) - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Skip pulling the image if set to true.
- setTruncateScript(String) - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource.Builder
-
Set file name of CQL truncate script.
- setTruncateScript(String) - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource.Builder
-
Set file name of SQL truncate script.
- SingletonDockerResourceWrapper<T extends DockerResource> - Class in no.mnemonic.commons.junit.docker
-
DockerResource
is created with intention to be used as aClassRule
. - SingletonDockerResourceWrapper.Builder<T extends DockerResource> - Class in no.mnemonic.commons.junit.docker
-
Builder to create a
SingletonDockerResourceWrapper
. - skipPullDockerImage - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
- skipReachabilityCheck - Variable in class no.mnemonic.commons.junit.docker.DockerResource.Builder
- skipReachabilityCheck() - Method in class no.mnemonic.commons.junit.docker.DockerResource.Builder
-
Configure DockerResource to skip test for container reachability.
T
- truncate() - Method in class no.mnemonic.commons.junit.docker.CassandraDockerResource
-
Truncate data stored inside Cassandra by executing the truncate CQL script.
- truncate() - Method in class no.mnemonic.commons.junit.docker.MariaDBDockerResource
-
Truncate data stored inside the database by executing the truncate SQL script.
All Classes and Interfaces|All Packages