embedmongo-maven-plugin

KO | EN

gitlite — search

#python #hacktoberfest #react #ai #android #rust #linux #macos #nodejs #windows #kubernetes #vue #security #openai

embedmongo-maven-plugin

(★ 91)

Maven plugin wrapper for the flapdoodle.de embedded MongoDB API

embedmongo-maven-plugin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# embedmongo-maven-plugin [![Build Status](https://travis-ci.org/joelittlejohn/embedmongo-maven-plugin.png)](https://travis-ci.org/joelittlejohn/embedmongo-maven-plugin) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.joelittlejohn.embedmongo/embedmongo-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.joelittlejohn.embedmongo/embedmongo-maven-plugin)

Maven plugin wrapper for the [flapdoodle.de embedded MongoDB API](http://github.com/flapdoodle-oss/embedmongo.flapdoodle.de).

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.

## Versions

* For Java 8 and later: `<version>0.4.1</version>`
* For Java 6/7: `<version>0.3.5</version>`

## Usage

```xml
<plugin>
  <groupId>com.github.joelittlejohn.embedmongo</groupId>
  <artifactId>embedmongo-maven-plugin</artifactId>
  <version>0.4.1</version>
  <executions>
    <execution>
      <id>start</id>
      <goals>
        <goal>start</goal>
      </goals>
      <configuration>
        <port>37017</port>
        
        
        <randomPort>true</randomPort>
        
        
        <version>2.0.4</version>
        
        
        <features>ONLY_WITH_SSL, ONLY_WINDOWS_2008_SERVER, NO_HTTP_INTERFACE_ARG</features>
        
        
        <databaseDirectory>/tmp/mongotest</databaseDirectory>
        
        
        <logging>file</logging>
        
        
        <logFile>${project.build.directory}/myfile.log</logFile>
        
        
        <logFileEncoding>utf-8</logFileEncoding>
        
        
        <bindIp>127.0.0.1</bindIp>
        
        
        <downloadPath>http://internal-mongo-repo/</downloadPath>

<unixSocketPrefix>${user.home}/.embedmongo</unixSocketPrefix>
        
        
        <storageEngine>wiredTiger</storageEngine>
        
        
        <skip>false</skip>
        
        
      </configuration>
    </execution>
    <execution>
      <id>mongo-scripts</id>
      <goals>
        <goal>mongo-scripts</goal>
      </goals>
      <configuration>
        <version>2.0.4</version>

<scriptsDirectory>...</scriptsDirectory>
        
        
        <scriptCharsetEncoding>UTF-8</scriptCharsetEncoding>
        
        
        <databaseName>mydb</databaseName>
        
        
      </configuration>
    </execution>
    <execution>
      <id>mongo-import</id>
      <goals>
        <goal>mongo-import</goal>
      </goals>
      <configuration>
        <version>2.0.4</version>

<defaultImportDatabase>test</defaultImportDatabase>
        
        
        <parallel>false</parallel>
        
        
        <wait>false</wait>
        
        
        <imports>
          <import>
            <database>my_db</database>
            
            
            <collection>col</collection>
            
            
            <file>import_file.json</file>
            
            
            <upsertOnImport>true</upsertOnImport>
            
            
            <dropOnImport>false</dropOnImport>
            
            
            <timeout>20000</timeout>
            
            
          </import>
          
        </imports>
      </configuration>
    </execution>
    <execution>
      <id>stop</id>
      <goals>
        <goal>stop</goal>
      </goals>
    </execution>
  </executions>
</plugin>
```

## Notes

* By default, the `start` goal is bound to `pre-integration-test`, the `stop` goal is bound to `post-integration-test`. You can of course bind to different phases if required.
* If you omit/forget the `stop` goal, any Mongo process spawned by the `start` 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 property `embedmongo.port`.
  If you're using Jenkins, you can also try the [Port Allocator Plugin](https://wiki.jenkins-ci.org/display/JENKINS/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 [add proxy settings to your settings.xml](https://maven.apache.org/settings.html#Proxies).
* 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 `-Dembedmongo.wait` to your Maven command line arguments or `-Dembedmongo.import.wait` if you want the imports
* If you are using a charset encoding to load scripts, refer to the [IANA Charset Registry](http://www.iana.org/assignments/character-sets/character-sets.xhtml).  Accepted charsets are found in the __Preferred MIME Name__ column.

embedmongo-maven-plugin

embedmongo-maven-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

embedmongo-maven-plugin

embedmongo-maven-plugin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README