Maven plugin wrapper for the flapdoodle.de embedded MongoDB API.
This plugin lets you start and stop an instance of MongoDB during a Maven build, e.g. for integration testing. The Mongo instance isn't strictly embedded (it's not running within the JVM of your application), but it is a managed instance that exists only for the lifetime of your build.
Usage
<plugin>
<groupId>com.github.joelittlejohn.embedmongo</groupId>
<artifactId>embedmongo-maven-plugin</artifactId>
<version>0.1.7</version>
<executions>
<execution>
<id>start</id>
<goals>
<goal>start</goal>
</goals>
<configuration>
<port>37017</port> <!-- optional, default 27017 -->
<version>2.0.4</version> <!-- optional, default 2.2.1 -->
<databaseDirectory>/tmp/mongotest</databaseDirectory> <!-- optional, default is a new dir in java.io.tmpdir -->
<logging>file</logging> <!-- optional (file|console|none), default console -->
<logFile>${project.build.directory}/myfile.log</logFile> <!-- optional, can be used when logging=file, default is ./embedmongo.log -->
<logFileEncoding>utf-8</logFileEncoding> <!-- optional, can be used when logging=file, default is utf-8 -->
<proxyHost>myproxy.company.com</proxyHost> <!-- optional, default is none -->
<proxyPort>8080</proxyPort> <!-- optional, default 80 -->
<proxyUser>joebloggs</proxyUser> <!-- optional, default is none -->
<proxyPassword>pa55w0rd</proxyPassword> <!-- optional, default is none -->
<bindIp>127.0.0.1</bindIp> <!-- optional, default is to listen on all interfaces -->
</configuration>
</execution>
<execution>
<id>stop</id>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
Notes
- By default, the
start
goal is bound topre-integration-test
, thestop
goal is bound topost-integration-test
. You can of course bind to different phases if required. - If you omit/forget the
stop
goal, any Mongo process spawned by thestart
goal will be stopped when the JVM terminates. - If you want to run many Maven builds in parallel using Jenkins, try the Port Allocator Plugin to avoid port conflicts.
- If you need to use a proxy to download MongoDB then you can either use
-Dhttp.proxyHost
and-Dhttp.proxyPort
as additional Maven arguments (this will affect the entire build) or instruct the plugin to use a proxy when downloading Mongo by adding theproxyHost
andproxyPort
configuration properties. - Using the
file
logging mode results in a new log file created at./embedmongo.log
unless you specify via<logFile>
(where.
means the curent working directory, usually the same as${basedir}
). - If you'd like the start goal to start mongodb and wait, you can add
-Dembedmongo.wait
to your Maven command line arguments