Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arakelian/docker-junit-rule
JUnit Rule for creating reusable Docker containers that live across JUnit test clases
https://github.com/arakelian/docker-junit-rule
apache docker java java-11 java-8 junit junit-rule unit-testing
Last synced: 2 days ago
JSON representation
JUnit Rule for creating reusable Docker containers that live across JUnit test clases
- Host: GitHub
- URL: https://github.com/arakelian/docker-junit-rule
- Owner: arakelian
- License: apache-2.0
- Created: 2017-03-21T02:13:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T17:20:50.000Z (7 months ago)
- Last Synced: 2024-09-24T20:51:04.279Z (2 days ago)
- Topics: apache, docker, java, java-11, java-8, junit, junit-rule, unit-testing
- Language: Java
- Size: 355 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```java
@ClassRule
public static RabbitMqDockerRule rabbitmq = new RabbitMqDockerRule();
```
To configure your own rule, you'll extend from `DockerRule`:
```java
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.
```java
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](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.arakelian%22%20AND%20a%3A%22docker-junit-rule%22).
### Maven
Add the following to your `pom.xml`:
```xml
central
Central Repository
http://repo.maven.apache.org/maven2
true
...
com.arakelian
docker-junit-rule
4.1.0
test
```
### Gradle
Add the following to your `build.gradle`:
```groovy
repositories {
mavenCentral()
}
dependencies {
testCompile 'com.arakelian:docker-junit-rule:4.1.0'
}
```
## Licence
Apache Version 2.0