onyx-testkit

A junit rule to run docker containers, based on: https://github.com/geowarin/docker-junit-rule

Usage

Example for rabbitMQ:

import com.rabbitmq.client.ConnectionFactory;
import org.junit.ClassRule;
import org.junit.Test;

import static org.llaith.onyx.testkit.docker.junit.GenericWaitingStrategies.waitForLog;

public class RabbitIntegrationIT {

    @ClassRule
    public static GenericResource rabbitRule =
            GenericConfig.builder()
                         .image("rabbitmq:management")
                         .ports("5672")
                         .waitFor(60, 6, 10, (wait) -> wait.addStrategy(waitForLog("Server startup complete")))
                         .build();

    @Test
    public void testConnectsToDocker() throws Exception {
        ConnectionFactory factory = new ConnectionFactory();
        factory.setHost(rabbitRule.getContainerHost());
        factory.setPort(rabbitRule.getMappedPort("5672/tcp"));
        factory.newConnection();
    }

}

The library is designed to be extended with specific instances where it makes sense, such as databases, allowing for easily accessable jdbc URL derived from the container.

Use the shipped PostgreSQL resource like so:

    // normal setup:

    @ClassRule
    public static PostgresResource pg =
            PostgresConfig.builder()
                          .image("postgres:9.6")
                          .postgresPort("5432/tcp")
                          .waitFor(60, 6, 10, (wait) -> {
                              wait.addStrategy(waitForPort("5432/tcp"));
                              wait.addStrategy(waitForSelect("SELECT 1"));
                          })
                          .build();

    // simpler setup:

    @ClassRule
    public static PostgresResource postgresSimpler =
            PostgresConfig.builderWithDefaults()
                          .databaseName("mydb")
                          .build();

    // simplest setup:

    @ClassRule
    public static PostgresResource defaultPg = PostgresResource.buildWithDefaults();

The use of the PostgreSQL specific container allows for easy integration with test code like the following:

    // example of pulling values from container:

    final HikariConfig hikariConfig = new HikariConfig();
    
    hikariConfig.setJdbcUrl(pg.getJdbcUrl());
    hikariConfig.setUsername(pg.getUsername());
    hikariConfig.setPassword(pg.getPassword());

    HikariDataSource dataSource = new HikariDataSource(hikariConfig);

    // very easy use of embedded sql execution for test code: 
            
    pg.executeSQL(sql, statement -> logger.debug("Successful execution of sql: " + sql));
            

Build

To build and run the tests, the following command must be run:

$> mvn clean install -DskipITs=false

WARNING: currently the library has an undiagnosed issue when running the tests from maven, the docker client is being closed and the tests fail, despite the tests passing when run from the IDE. Until this is resolved, it will remain an alpha release and should not be used for any production code.

Installation

It can be added to your POM like so:

Maven

Add the following to your pom.xml:

<repositories>
    <repository>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
        <id>jcenter</id>
        <name>bintray</name>
        <url>http://jcenter.bintray.com</url>
    </repository>
</repositories>

...

<dependency>
    <groupId>org.llaith.onyx</groupId>
    <artifactId>onyx-testkit</artifactId>
    <version>1.0</version>
    <scope>test</scope>
</dependency>

Principle

Uses https://github.com/spotify/docker-client to connect to the docker daemon API. More instructions on what is possible, and ideas on how to extend it further, can be found in the documentation to that project.

Licence

MIT