Organization Flapdoodle OSS

We are now a github organization. You are invited to participate. Starting with version 2 we are going to support only java 8 or higher. If you are looking for the older version you can find it in the 1.7 branch.

Embedded MongoDB

Embedded MongoDB will provide a platform neutral way for running mongodb in unittests.

Why?

dropping databases causing some pains (often you have to wait long time after each test)
its easy, much easier as installing right version by hand
you can change version per test

License

We use http://www.apache.org/licenses/LICENSE-2.0

We need your help?

Poll: Which MongoDB version should stay supported?

Dependencies

Build on top of

Embed Process Util de.flapdoodle.embed.process

Other ways to use Embedded MongoDB

in a Maven build using maven-mongodb-plugin or embedmongo-maven-plugin
in a Clojure/Leiningen project using lein-embongo
in a Gradle build using gradle-mongo-plugin
in a Scala/specs2 specification using specs2-embedmongo
in Scala tests using scalatest-embedmongo

Comments about Embedded MongoDB in the Wild

Other MongoDB Stuff

https://github.com/thiloplanz/jmockmongo - mongodb mocking
https://github.com/lordofthejars/nosql-unit - extended nosql unit testing
https://github.com/jirutka/embedmongo-spring - Spring Factory Bean for EmbedMongo

Backward binary compatibility and API changes

There is a report on backward binary compatibility and API changes for the library: https://abi-laboratory.pro/java/tracker/timeline/de.flapdoodle.embed.mongo/ -> thanks @lvc

Howto

Maven

Snapshots (Repository http://oss.sonatype.org/content/repositories/snapshots)

<dependency>
	<groupId>de.flapdoodle.embed</groupId>
	<artifactId>de.flapdoodle.embed.mongo</artifactId>
	<version>2.2.1-SNAPSHOT</version>
</dependency>

Gradle

Make sure you have mavenCentral() in your repositories or that your enterprise/local server proxies the maven central repository.

dependencies {
	testCompile group: "de.flapdoodle.embed", name: "de.flapdoodle.embed.mongo", version: "2.2.1-SNAPSHOT"
}

Build from source

When you fork or clone our branch you should always be able to build the library by running

mvn package

Changelog

Supported Versions

Versions: some older, a stable and a development version Support for Linux, Windows and MacOSX.

Usage

	import de.flapdoodle.embed.mongo.config.ArtifactStoreBuilder;

	...
	MongodStarter starter = MongodStarter.getDefaultInstance();

	String bindIp = "localhost";
	int port = 12345;
	IMongodConfig mongodConfig = new MongodConfigBuilder()
		.version(Version.Main.PRODUCTION)
		.net(new Net(bindIp, port, Network.localhostIsIPv6()))
		.build();

	MongodExecutable mongodExecutable = null;
	try {
		mongodExecutable = starter.prepare(mongodConfig);
		MongodProcess mongod = mongodExecutable.start();

		MongoClient mongo = new MongoClient(bindIp, port);
		DB db = mongo.getDB("test");
		DBCollection col = db.createCollection("testCol", new BasicDBObject());
		col.save(new BasicDBObject("testDoc", new Date()));

	} finally {
		if (mongodExecutable != null)
			mongodExecutable.stop();
	}

Usage - Optimization

You should make the MongodStarter instance or the RuntimeConfig instance static (per Class or per JVM). The main purpose of that is the caching of extracted executables and library files. This is done by the ArtifactStore instance configured with the RuntimeConfig instance. Each instance uses its own cache so multiple RuntimeConfig instances will use multiple ArtifactStores an multiple caches with much less cache hits:)

Usage - custom mongod filename

If you do not restrict bindId to localhost you get windows firewall dialog popups. To avoid them you can choose a stable executable name with UserTempNaming. This way the firewall dialog only popups once. See Executable Collision

	import de.flapdoodle.embed.mongo.config.ExtractedArtifactStoreBuilder;

	...

	int port = 12345;

	Command command = Command.MongoD;

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(command)
		.artifactStore(new ExtractedArtifactStoreBuilder()
			.defaults(command)
			.download(new DownloadConfigBuilder()
					.defaultsForCommand(command).build())
			.executableNaming(new UserTempNaming()))
		.build();

	IMongodConfig mongodConfig = new MongodConfigBuilder()
		.version(Version.Main.PRODUCTION)
		.net(new Net(port, Network.localhostIsIPv6()))
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);

	MongodExecutable mongodExecutable = null;
	try {
		mongodExecutable = runtime.prepare(mongodConfig);
		MongodProcess mongod = mongodExecutable.start();

		MongoClient mongo = new MongoClient("localhost", port);
		DB db = mongo.getDB("test");
		DBCollection col = db.createCollection("testCol", new BasicDBObject());
		col.save(new BasicDBObject("testDoc", new Date()));

	} finally {
		if (mongodExecutable != null)
			mongodExecutable.stop();
	}

Unit Tests

	public abstract class AbstractMongoDBTest extends TestCase {

		/**
		 * please store Starter or RuntimeConfig in a static final field
		 * if you want to use artifact store caching (or else disable caching)
		 */
		private static final MongodStarter starter = MongodStarter.getDefaultInstance();

		private MongodExecutable _mongodExe;
		private MongodProcess _mongod;

		private MongoClient _mongo;
		@Override
		protected void setUp() throws Exception {

			_mongodExe = starter.prepare(new MongodConfigBuilder()
				.version(Version.Main.PRODUCTION)
				.net(new Net("localhost", 12345, Network.localhostIsIPv6()))
				.build());
			_mongod = _mongodExe.start();

			super.setUp();

			_mongo = new MongoClient("localhost", 12345);
		}

		@Override
		protected void tearDown() throws Exception {
			super.tearDown();

			_mongod.stop();
			_mongodExe.stop();
		}

		public Mongo getMongo() {
			return _mongo;
		}

	}

... with some more help

	...
	MongodForTestsFactory factory = null;
	try {
		factory = MongodForTestsFactory.with(Version.Main.PRODUCTION);

		MongoClient mongo = factory.newMongo();
		DB db = mongo.getDB("test-" + UUID.randomUUID());
		DBCollection col = db.createCollection("testCol", new BasicDBObject());
		col.save(new BasicDBObject("testDoc", new Date()));

	} finally {
		if (factory != null)
			factory.shutdown();
	}
	...

Customize Download URL

	...
	Command command = Command.MongoD;

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(command)
		.artifactStore(new ExtractedArtifactStoreBuilder()
			.defaults(command)
			.download(new DownloadConfigBuilder()
				.defaultsForCommand(command)
				.downloadPath("http://my.custom.download.domain/")))
		.build();
	...

Customize Proxy for Download

	...
	Command command = Command.MongoD;

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(command)
		.artifactStore(new ExtractedArtifactStoreBuilder()
			.defaults(command)
			.download(new DownloadConfigBuilder()
				.defaultsForCommand(command)
				.proxyFactory(new HttpProxyFactory("fooo", 1234))))
			.build();
	...

Customize Artifact Storage

	...
	IDirectory artifactStorePath = new FixedPath(System.getProperty("user.home") + "/.embeddedMongodbCustomPath");
	ITempNaming executableNaming = new UUIDTempNaming();

	Command command = Command.MongoD;

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(command)
		.artifactStore(new ExtractedArtifactStoreBuilder()
			.defaults(command)
			.download(new DownloadConfigBuilder()
				.defaultsForCommand(command)
				.artifactStorePath(artifactStorePath))
			.executableNaming(executableNaming))
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	MongodExecutable mongodExe = runtime.prepare(mongodConfig);
	...

Usage - custom mongod process output

... to console with line prefix

	...
	ProcessOutput processOutput = new ProcessOutput(Processors.namedConsole("[mongod>]"),
			Processors.namedConsole("[MONGOD>]"), Processors.namedConsole("[console>]"));

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(Command.MongoD)
		.processOutput(processOutput)
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	...

... to file

	...
	IStreamProcessor mongodOutput = Processors.named("[mongod>]",
			new FileStreamProcessor(File.createTempFile("mongod", "log")));
	IStreamProcessor mongodError = new FileStreamProcessor(File.createTempFile("mongod-error", "log"));
	IStreamProcessor commandsOutput = Processors.namedConsole("[console>]");

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(Command.MongoD)
		.processOutput(new ProcessOutput(mongodOutput, mongodError, commandsOutput))
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	...

	...
	public class FileStreamProcessor implements IStreamProcessor {

		private FileOutputStream outputStream;

		public FileStreamProcessor(File file) throws FileNotFoundException {
			outputStream = new FileOutputStream(file);
		}

		@Override
		public void process(String block) {
			try {
				outputStream.write(block.getBytes());
			} catch (IOException e) {
				e.printStackTrace();
			}
		}

		@Override
		public void onProcessed() {
			try {
				outputStream.close();
			} catch (IOException e) {
				e.printStackTrace();
			}
		}
	}
	...

... to java logging

	...
	Logger logger = Logger.getLogger(getClass().getName());

	ProcessOutput processOutput = new ProcessOutput(Processors.logTo(logger, Level.INFO), Processors.logTo(logger,
			Level.SEVERE), Processors.named("[console>]", Processors.logTo(logger, Level.FINE)));

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaultsWithLogger(Command.MongoD,logger)
		.processOutput(processOutput)
		.artifactStore(new ExtractedArtifactStoreBuilder()
			.defaults(Command.MongoD)
			.download(new DownloadConfigBuilder()
				.defaultsForCommand(Command.MongoD)
				.progressListener(new LoggingProgressListener(logger, Level.FINE))))
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	...

... to default java logging (the easy way)

	...
	Logger logger = Logger.getLogger(getClass().getName());

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaultsWithLogger(Command.MongoD, logger)
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	...

... to null device

	...
	Logger logger = Logger.getLogger(getClass().getName());

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaultsWithLogger(Command.MongoD, logger)
		.processOutput(ProcessOutput.getDefaultInstanceSilent())
		.build();

	MongodStarter runtime = MongodStarter.getInstance(runtimeConfig);
	...

Custom Version

	...
	int port = 12345;
	IMongodConfig mongodConfig = new MongodConfigBuilder()
		.version(Versions.withFeatures(new GenericVersion("2.0.7-rc1"),Feature.SYNC_DELAY))
		.net(new Net(port, Network.localhostIsIPv6()))
		.build();

	MongodStarter runtime = MongodStarter.getDefaultInstance();
	MongodProcess mongod = null;

	MongodExecutable mongodExecutable = null;
	try {
		mongodExecutable = runtime.prepare(mongodConfig);
		mongod = mongodExecutable.start();

		...

	} finally {
		if (mongod != null) {
			mongod.stop();
		}
		if (mongodExecutable != null)
			mongodExecutable.stop();
	}
	...

Main Versions

	IVersion version = Version.V2_2_5;
	// uses latest supported 2.2.x Version
	version = Version.Main.V2_2;
	// uses latest supported production version
	version = Version.Main.PRODUCTION;
	// uses latest supported development version
	version = Version.Main.DEVELOPMENT;

Use Free Server Port

Warning: maybe not as stable, as expected.

... by hand

	...
	int port = Network.getFreeServerPort();
	...

... automagic

	...
	IMongodConfig mongodConfig = new MongodConfigBuilder().version(Version.Main.PRODUCTION).build();

	MongodStarter runtime = MongodStarter.getDefaultInstance();

	MongodExecutable mongodExecutable = null;
	MongodProcess mongod = null;
	try {
		mongodExecutable = runtime.prepare(mongodConfig);
		mongod = mongodExecutable.start();

		MongoClient mongo = new MongoClient(new ServerAddress(mongodConfig.net().getServerAddress(), mongodConfig.net().getPort()));
		...

	} finally {
		if (mongod != null) {
			mongod.stop();
		}
		if (mongodExecutable != null)
			mongodExecutable.stop();
	}
	...

... custom timeouts

	...
	IMongodConfig mongodConfig = new MongodConfigBuilder()
		.version(Version.Main.PRODUCTION)
		.timeout(new Timeout(30000))
		.build();
	...

Command Line Post Processing

	...
	ICommandLinePostProcessor postProcessor= ...

	IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
		.defaults(Command.MongoD)
		.commandLinePostProcessor(postProcessor)
		.build();
	...

Custom Command Line Options

We changed the syncDelay to 0 which turns off sync to disc. To turn on default value used defaultSyncDelay().

	IMongodConfig mongodConfig = new MongodConfigBuilder()
	.version(Version.Main.PRODUCTION)
	.cmdOptions(new MongoCmdOptionsBuilder()
		.syncDelay(10)
		.useNoPrealloc(false)
		.useSmallFiles(false)
		.useNoJournal(false)
		.enableTextSearch(true)
		.build())
	.build();
	...

Snapshot database files from temp dir

We changed the syncDelay to 0 which turns off sync to disc. To get the files to create an snapshot you must turn on default value (use defaultSyncDelay()).

	IMongodConfig mongodConfig = new MongodConfigBuilder()
	.version(Version.Main.PRODUCTION)
	.processListener(new ProcessListenerBuilder()
		.copyDbFilesBeforeStopInto(destination)
		.build())
	.cmdOptions(new MongoCmdOptionsBuilder()
		.defaultSyncDelay()
		.build())
	.build();
	...

Custom database directory

If you set a custom database directory, it will not be deleted after shutdown

	Storage replication = new Storage("/custom/databaseDir",null,0);

	IMongodConfig mongodConfig = new MongodConfigBuilder()
			.version(Version.Main.PRODUCTION)
			.replication(replication)
			.build();
	...

Start mongos with mongod instance

this is an very easy example to use mongos and mongod

	int port = 12121;
	int defaultConfigPort = 12345;
	String defaultHost = "localhost";

	MongodProcess mongod = startMongod(defaultConfigPort);

	try {
		MongosProcess mongos = startMongos(port, defaultConfigPort, defaultHost);
		try {
			MongoClient mongoClient = new MongoClient(defaultHost, defaultConfigPort);
			System.out.println("DB Names: " + mongoClient.getDatabaseNames());
		} finally {
			mongos.stop();
		}
	} finally {
		mongod.stop();
	}

	private MongosProcess startMongos(int port, int defaultConfigPort, String defaultHost) throws UnknownHostException,
			IOException {
		IMongosConfig mongosConfig = new MongosConfigBuilder()
			.version(Version.Main.PRODUCTION)
			.net(new Net(port, Network.localhostIsIPv6()))
			.configDB(defaultHost + ":" + defaultConfigPort)
			.build();

		MongosExecutable mongosExecutable = MongosStarter.getDefaultInstance().prepare(mongosConfig);
		MongosProcess mongos = mongosExecutable.start();
		return mongos;
	}

	private MongodProcess startMongod(int defaultConfigPort) throws UnknownHostException, IOException {
		IMongodConfig mongoConfigConfig = new MongodConfigBuilder()
			.version(Version.Main.PRODUCTION)
			.net(new Net(defaultConfigPort, Network.localhostIsIPv6()))
			.configServer(true)
			.build();

		MongodExecutable mongodExecutable = MongodStarter.getDefaultInstance().prepare(mongoConfigConfig);
		MongodProcess mongod = mongodExecutable.start();
		return mongod;
	}

Import JSON file with mongoimport command

    public void testStartAndStopMongoImportAndMongod() throws UnknownHostException, IOException {
        int defaultConfigPort = 12345;
        String defaultHost = "localhost";
        String database = "importTestDB";
        String collection = "importedCollection";
        String jsonFile=filePathAsString;
        MongodProcess mongod = startMongod(defaultConfigPort);

        try {
            MongoImportProcess mongoImport = startMongoImport(defaultHost, defaultConfigPort, database,collection,jsonFile,true,true,true);
            try {
                MongoClient mongoClient = new MongoClient(defaultHost, defaultConfigPort);
                System.out.println("DB Names: " + mongoClient.getDatabaseNames());
            } finally {
                mongoImport.stop();
            }
        } finally {
            mongod.stop();
        }
    }

    private MongoImportProcess startMongoImport(String bindIp, int port, String dbName, String collection, String jsonFile, Boolean jsonArray,Boolean upsert, Boolean drop)
            throws UnknownHostException, IOException {
        IMongoImportConfig mongoImportConfig = new MongoImportConfigBuilder()
                .version(Version.Main.PRODUCTION)
                .net(new Net(bindIp, port, Network.localhostIsIPv6()))
                .db(dbName)
                .collection(collection)
                .upsert(upsert)
                .dropCollection(drop)
                .jsonArray(jsonArray)
                .importFile(jsonFile)
                .build();

        MongoImportExecutable mongoImportExecutable = MongoImportStarter.getDefaultInstance().prepare(mongoImportConfig);
        MongoImportProcess mongoImport = mongoImportExecutable.start();
        return mongoImport;
    }

Executable Collision

There is a good chance of filename collisions if you use a custom naming schema for the executable (see Usage - custom mongod filename). If you got an exception, then you should make your RuntimeConfig or MongoStarter class or jvm static (static final in your test class or singleton class for all tests).

YourKit is kindly supporting open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products: YourKit Java Profiler and YourKit .NET Profiler.

Name	Latest commit message	Commit time
Failed to load latest commit information.
.mvn/wrapper	adds mvn wrapper	Dec 9, 2018
config	back to tab instead of whitespaces	Jun 27, 2012
src	fixed enum name V4_0_11 -> V4_0_12	Aug 26, 2019
.gitignore	add eclipse output directory to .gitignore	Apr 10, 2015
.travis.yml	Update .travis.yml	Dec 9, 2018
Changelog.md	Update Changelog.md	Jun 21, 2018
Jenkinsfile	jenkins	Sep 13, 2017
LICENSE	Update LICENSE	Jun 16, 2016
README.md	Update README.md	Dec 9, 2018
mvnw	adds mvn wrapper	Dec 9, 2018
mvnw.cmd	adds mvn wrapper	Dec 9, 2018
pom.xml
refreshLicense.sh	maven setup	Feb 21, 2011
release.sh	use mvn wrapper in release	Dec 9, 2018

flapdoodle-oss / de.flapdoodle.embed.mongo

Join GitHub today

Clone with HTTPS

Downloading

Launching GitHub Desktop