integration-test-rabbitmq Maven Plugin

A Maven plugin for starting/stopping RabbintMQ instances for integration testing

License	Apache License, Version 2.0
GroupId	me.kisoft
ArtifactId	integration-test-rabbitmq
Last Version	1.0.1
Release Date	Nov 20, 2020
Type	maven-plugin
Description	integration-test-rabbitmq Maven Plugin A Maven plugin for starting/stopping RabbintMQ instances for integration testing
Project URL	http://github.com/TareqK/integration-test-rabbitmq
Source Code Management	http://github.com/TareqK/integration-test-rabbitmq

Download integration-test-rabbitmq

Filename	Size
integration-test-rabbitmq-1.0.1.pom
integration-test-rabbitmq-1.0.1.jar	12 KB
integration-test-rabbitmq-1.0.1-sources.jar	3 KB
integration-test-rabbitmq-1.0.1-javadoc.jar	405 KB

How to add to project

Apache Maven

<plugin>
    <groupId>me.kisoft</groupId>
    <artifactId>integration-test-rabbitmq</artifactId>
    <version>1.0.1</version>
</plugin>

Dependencies

compile (4)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.12
com.github.docker-java : docker-java	jar	3.2.5
org.apache.maven : maven-plugin-api	jar	3.6.3
org.apache.maven : maven-project	jar	2.2.1

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.6.0

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.13

Project Modules

There are no modules declared in this project.

integration-test-rabbitmq

This Maven plugin allows you to start and stop a RabbitMQ Docker instance as part of your build. This is especially useful if you want to do integration testing, instead of mocking rabbitmq

Usage

Add this plugin definition to your pom.xml

<plugin>
    <groupId>me.kisoft</groupId>
    <artifactId>integration-test-rabbitmq</artifactId>
    <version>${LATEST_VERSION_NUMBER}</version>
    <executions>
        <execution>
            <id>start-rabbitmq</id>
            <goals>
                <goal>start-rabbitmq</goal>
            </goals>
        </execution>
        <execution>
            <id>stop-rabbitmq</id>
            <goals>
                <goal>stop-rabbitmq</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Options

Option	Description	Default Value
port	The port to bind to	5672
name	The name of the container	Random String
image	The RabbitMQ image to use	rabbitmq:3-management

Adding options

<plugin>
    <groupId>me.kisoft</groupId>
    <artifactId>integration-test-rabbitmq</artifactId>
    <version>${LATEST_VERSION_NUMBER}</version>
    <configuration>
        <port>3321</port>
        <name>jon</name>
        <image>rabbitmq:3</image>
    </configuration>
    <executions>
        <execution>
            <id>start-rabbitmq</id>
            <goals>
                <goal>start-rabbitmq</goal>
            </goals>
        </execution>
        <execution>
            <id>stop-rabbitmq</id>
            <goals>
                <goal>stop-rabbitmq</goal>
            </goals>
        </execution>
    </executions>
</plugin>

This will start RabbitMQ bound on port 3321, with the container name jon and using the image rabbitmq:3

Caveats

1. You need Docker installed on your pc - if you are using windows, im not sure how RabbitMQ docker images work there
2. If a container was was started, but the build crashes for some reason, its not cleaned up, you will need to cleanup manually
3. You need to always have both the start and stop executions, otherwise the container never stops
4. You can only have one instance/build. This is because of a shared state object

Versions

Version
1.0.1 Nov 20, 2020
1.0.0 Nov 20, 2020