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.
<plugin>
<groupId>com.syncleus.maven.plugins</groupId>
<artifactId>maven-mongodb-plugin</artifactId>
<version>1.0.1</version>
<executions>
<execution>
<id>start</id>
<goals>
<goal>start</goal>
</goals>
<configuration>
<port>37017</port>
<!-- optional, default 27017 -->
<randomPort>true</randomPort>
<!-- optional, default is false, if true allocates a random port and
overrides embedmongo.port -->
<version>2.0.4</version>
<!-- optional, defaults to latest production release -->
<databaseDirectory>/tmp/mongotest</databaseDirectory>
<!-- optional, default is a new dir in java.io.tmpdir -->
<artifactDirectory>/tmp/mongoartifact</artifactDirectory>
<!-- optional, set directory where MongoDB artifacts are stores,
default is ~/.embedmongo -->
<logging>file</logging>
<!-- optional (file|console|none), default is console -->
<logFile>${project.build.directory}/myfile.log</logFile>
<!-- optional, can be used when logging=file, default is
./mongod.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 is 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 -->
<downloadPath>http://internal-mongo-repo/</downloadPath>
<!-- optional, default is http://fastdl.mongodb.org/ -->
<replSet>rs0</replSet>
<!-- optional, configures replication set, default is none -->
<oplogSize>1073741824</oplogSize>
<!-- optional, configures oplog size, default is automatically
determined -->
<executableNaming>user</executableNaming>
<!-- optional (user|uuid), sets the executable naming style, default
is uuid -->
<syncDelay>0</syncDelay>
<!-- optional, Sets the sync delay, 0 prevents all writing to disk,
default lets MongoDB automatically determine value -->
<wait>true</wait>
<!-- optional, blocks indefinitely after the MongoDB instance starts,
must be stopped with ctrl-c, default is false-->
<skip>false</skip>
<!-- optional, skips this plugin entirely, use on the command line
like -Dembedmongo.skip -->
<features>
<feature>sync_delay</feature>
<feature>text_search</feature>
</features>
<!-- optional, a list of MongoDB features to enable, default is
none -->
<defaultImportDatabase>test</defaultImportDatabase>
<!-- optional, name of the default database to import data -->
<parallelImport>false</parallelImport>
<!-- optional, default false, if true it launches in parallel all
imports -->
<imports>
<import>
<database>my_db</database>
<!-- optional, name of the database, if null it will
fallback to defaultImportDatabase -->
<collection>col</collection>
<!-- required, name of the collection to import data -->
<file>import_file.json</file>
<!-- required, name of the json file to import -->
<upsertOnImport>true</upsertOnImport>
<!-- optional, default true, if true it will do an upsert on
each document imported -->
<dropOnImport>false</dropOnImport>
<!-- optional, default true, if true it will do a drop the
collection before starts to import -->
<timeout>20000</timeout>
<!-- optional, default 20000, it will fail if it takes more
than this time importing a file (time in millis) -->
</import>
</imports>
<!-- optional, More imports are accepted and it will be
executed in strict order (if parallel is not set) -->
<initializations>
<initialization>
<databaseName>myDatabase</databaseName>
<!-- required, The name of the database to execute
the scripts on -->
<scripts>
<script>/home/me/stuff/scriptDirectory</script>
<script>/home/me/stuff/scriptFile.js</script>
</scripts>
<!-- required, The list of scripts to be executed can
specify individual scripts or folders. When
specifying a folder all files in folder must
be a valid script. -->
</initialization>
</initializations>
<!-- optional, Specifies a collection of initialization scripts
to be run across various databases in the MongoDB instance -->
</configuration>
</execution>
<execution>
<id>stop</id>
<goals>
<goal>stop</goal>
</goals>
</execution>
</executions>
</plugin>
- 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 Maven builds in parallel you can use
randomPort
to avoid port conflicts, the value allocated will be available to other plugins in the project as a propertyembedmongo.port
. If you're using Jenkins, you can also try the Port Allocator Plugin. - 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. - If you're having trouble with Windows firewall rules, try setting the bindIp config property to
127.0.0.1
. - If you'd like the start goal to start mongodb and wait, you can add
-Dmongodb.wait
to your Maven command line arguments