JarCasting
JarCasting JarCasting

arakelian-docker-junit

null

License

License
Categories

Categories

Docker Container Virtualization Tools JUnit Unit Testing
GroupId

GroupId

com.arakelian
ArtifactId

ArtifactId

arakelian-docker-junit
Last Version

Last Version

1.0.1
Release Date

Release Date
Type

Type

jar
Description

Description

arakelian-docker-junit
null
Project URL

Project URL

https://github.com/garakelian/docker-junit
Source Code Management

Source Code Management

https://github.com/garakelian/docker-junit.git

Download arakelian-docker-junit

Filename Size
arakelian-docker-junit-1.0.1.pom
arakelian-docker-junit-1.0.1.jar 17 KB
arakelian-docker-junit-1.0.1-tests.jar 3 KB
arakelian-docker-junit-1.0.1-sources.jar 8 KB
arakelian-docker-junit-1.0.1-javadoc.jar 28 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.arakelian/arakelian-docker-junit/ -->
<dependency>
    <groupId>com.arakelian</groupId>
    <artifactId>arakelian-docker-junit</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/com.arakelian/arakelian-docker-junit/
implementation 'com.arakelian:arakelian-docker-junit:1.0.1'
// https://jarcasting.com/artifacts/com.arakelian/arakelian-docker-junit/
implementation ("com.arakelian:arakelian-docker-junit:1.0.1")
'com.arakelian:arakelian-docker-junit:jar:1.0.1'
<dependency org="com.arakelian" name="arakelian-docker-junit" rev="1.0.1">
  <artifact name="arakelian-docker-junit" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.arakelian', module='arakelian-docker-junit', version='1.0.1')
)
libraryDependencies += "com.arakelian" % "arakelian-docker-junit" % "1.0.1"
[com.arakelian/arakelian-docker-junit "1.0.1"]

Dependencies

compile (4)

Group / Artifact Type Version
junit : junit jar 4.12
com.spotify : docker-client jar 6.1.1
org.glassfish.jersey.core : jersey-client jar 2.25
org.slf4j : slf4j-api jar 1.7.24

test (7)

Group / Artifact Type Version
org.apache.logging.log4j : log4j-api jar 2.8.1
org.apache.logging.log4j : log4j-core jar 2.8.1
org.apache.logging.log4j : log4j-slf4j-impl jar 2.8.1
org.slf4j : jcl-over-slf4j jar 1.7.24
org.slf4j : jul-to-slf4j jar 1.7.24
com.github.rholder : guava-retrying jar 2.0.0
com.rabbitmq : amqp-client jar 4.1.0

Project Modules

There are no modules declared in this project.

docker-junit-rule

A junit rule to run docker containers.

Features

  • DockerRule will automatically start and stop your Docker container.
  • DockerRule will share your container across multiple JUnit tests; it will not start and stop your container for each test, allowing your test suites to run much faster.

Requirements

  • Compatible with Java 8+

Usage

Starting a Docker container as part of your unit test is as simple as including a ClassRule that looks like this:

@ClassRule
public static RabbitMqDockerRule rabbitmq = new RabbitMqDockerRule();

To configure your own rule, you'll extend from DockerRule:

public class RabbitDockerRule extends DockerRule {
    public RabbitDockerRule() {
        super(ImmutableDockerConfig.builder() //
                .name("docker-test") //
                .image("rabbitmq:management") //
                .ports("5672") //
                .addStartedListener(container -> {
                    container.waitForPort("5672/tcp");
                    container.waitForLog("Server startup complete");
                }).build());
    }
}

A couple of things to note:

  • Your custom ClassRule will extend from DockerRule
  • Your constructor will provide DockerRule with an immutable configuration that describes the Docker container that needs to be created.
  • The configuration you provide includes a user-defined callback for determining when the container has started. A few helper methods are provided to help you do this.

Customizing Docker Container

DockerRule provides two callback for customizing the Docker container, addHostConfigurer and addContainerConfigurer. In the example below we'll use these callback to configure an Elasticsearch container.

public class ElasticDockerRule extends DockerRule {
    public ElasticDockerRule() {
        super(ImmutableDockerConfig.builder() //
                .name(name) //
                .image(image) //
                .ports("9200") //
                .addHostConfigurer(HostConfigurers.noUlimits()) //
                .addContainerConfigurer(builder -> {
                    builder.env(
                            "http.host=0.0.0.0", //
                            "transport.host=127.0.0.1", //
                            "xpack.security.enabled=false", //
                            "xpack.monitoring.enabled=false", //
                            "xpack.graph.enabled=false", //
                            "xpack.watcher.enabled=false", //
                            "ES_JAVA_OPTS=-Xms512m -Xmx512m");
                }) //
                .build());
    }
}

Notice that we used addHostConfigurer to remove ulimits and addContainerConfigurer to set environment variables.

Installation

The library is available on Maven Central.

Maven

Add the following to your pom.xml:

<repositories>
    <repository>
        <id>central</id>
        <name>Central Repository</name>
        <url>http://repo.maven.apache.org/maven2</url>
        <releases>
            <enabled>true</enabled>
        </releases>
    </repository>
</repositories>

...

<dependency>
    <groupId>com.arakelian</groupId>
    <artifactId>docker-junit-rule</artifactId>
    <version>4.1.0</version>
    <scope>test</scope>
</dependency>

Gradle

Add the following to your build.gradle:

repositories {
  mavenCentral()
}

dependencies {
  testCompile 'com.arakelian:docker-junit-rule:4.1.0'
}

Licence

Apache Version 2.0

Versions

Version
1.0.1
1.0.0