MongoSandbox - temporary and disposable MongoDB for integration tests and local debugging

MongoSandbox is a set of multiple NuGet packages wrapping the binaries of MongoDB 5, 6, 7 and 8. Each package is compatible with .NET Framework 4.7.2 up to .NET 8 and later.

The supported operating systems are Linux, macOS and Windows on their x64 architecture versions only. Each package provides access to:

• Multiple isolated MongoDB sandbox databases for tests running,
• A quick way to setup a MongoDB database for a local development environment,
• mongoimport and mongoexport tools in order to export and import collections.

This project is an actively maintained fork of ephemeral-mongo.

• Support for multiple major MongoDB versions that are copied to your build output,
• There is a separate NuGet package for each operating system and MongoDB version so it's easier to support new major versions,
• The latest MongoDB binaries are safely downloaded and verified by GitHub actions during the build or release workflow, reducing the Git repository size,
• There's less chances of memory, files and directory leaks. The startup is faster by using C# threading primitives such as ManualResetEventSlim.
• The CI tests the generated packages against .NET 4.7.2 and .NET 6 using the latest GitHub build agents for Ubuntu, macOS and Windows.

Downloads

Package	Description	Link
MongoSandbox5	All-in-one package for MongoDB 5 on Linux, macOS and Windows
MongoSandbox6	All-in-one package for MongoDB 6 on Linux, macOS and Windows
MongoSandbox7	All-in-one package for MongoDB 7 on Linux, macOS and Windows
MongoSandbox8	All-in-one package for MongoDB 8 on Linux, macOS and Windows

Usage

Use the static MongoRunner.Run() method to create a disposable instance that provides access to a MongoDB connection string, import and export tools:

// All properties below are optional. The whole "options" instance is optional too! var options = new MongoRunnerOptions { UseSingleNodeReplicaSet = true, // Default: false StandardOuputLogger = line => Console.WriteLine(line), // Default: null StandardErrorLogger = line => Console.WriteLine(line), // Default: null DataDirectory = "/path/to/data/", // Default: null BinaryDirectory = "/path/to/mongo/bin/", // Default: null ConnectionTimeout = TimeSpan.FromSeconds(10), // Default: 30 seconds ReplicaSetSetupTimeout = TimeSpan.FromSeconds(5), // Default: 10 seconds AdditionalArguments = "--quiet", // Default: null MongoPort = 27017, // Default: random available port // EXPERIMENTAL - Only works on Windows and modern .NET (netcoreapp3.1, net5.0, net6.0, net7.0, net8.0 and so on): // Ensures that all MongoDB child processes are killed when the current process is prematurely killed, // for instance when killed from the task manager or the IDE unit tests window. Processes are managed as a unit using // job objects: https://learn.microsoft.com/en-us/windows/win32/procthread/job-objects KillMongoProcessesWhenCurrentProcessExits = true // Default: false }; // Disposing the runner will kill the MongoDB process (mongod) and delete the associated data directory using (var runner = MongoRunner.Run(options)) { var database = new MongoClient(runner.ConnectionString).GetDatabase("default"); // Do something with the database database.CreateCollection("people"); // Export a collection. Full method signature: // Export(string database, string collection, string outputFilePath, string? additionalArguments = null) runner.Export("default", "people", "/path/to/default.json"); // Import a collection. Full method signature: // Import(string database, string collection, string inputFilePath, string? additionalArguments = null, bool drop = false) runner.Import("default", "people", "/path/to/default.json"); }

How it works

• At build time, the MongoDB binaries (mongod, mongoimport and mongoexport) are copied to your project output directory,
• At runtime, the library chooses the right binaries for your operating system,
• MongoRunner.Run always starts a new mongod process with a random available port,
• The resulting connection string will depend on your options (UseSingleNodeReplicaSet and AdditionalArguments),
• By default, a unique temporary data directory is used.

Importing

By default the mongoimport command called by runner.Import("default", "people", "/path/to/default.json"); will expect a single document per JSON file. If you want to import an array of documents into a single collection, you can use the optional --jsonArray argument. For example:

runner.Import("default", "people", "/path/to/default.json", "--jsonArray");

The mongoimport documentation is available here.

Reducing the download size

MongoSandbox5, 6, 7 and 8 are NuGet metapackages that reference dedicated runtime packages for both Linux, macOS and Windows. As of now, there isn't a way to optimize NuGet package downloads for a specific operating system. However, one can still avoid referencing the metapackage and directly reference the dependencies instead. Add MSBuild OS platform conditions and you'll get optimized NuGet imports for your OS and less downloads.

Instead of doing this:

<PackageReference Include="MongoSandbox8" Version="1.0.0" />

Do this:

<PackageReference Include="MongoSandbox.Core" Version="1.0.0" /> <PackageReference Include="MongoSandbox8.runtime.linux-x64" Version="1.0.0" Condition="$([MSBuild]::IsOSPlatform('Linux'))" /> <PackageReference Include="MongoSandbox8.runtime.osx-x64" Version="1.0.0" Condition="$([MSBuild]::IsOSPlatform('OSX'))" /> <PackageReference Include="MongoSandbox8.runtime.win-x64" Version="1.0.0" Condition="$([MSBuild]::IsOSPlatform('Windows'))" />

Windows Defender Firewall prompt

On Windows, you might get a Windows Defender Firewall prompt. This is because this MongoSandbox starts the mongod.exe process from your build output directory, and mongod.exe tries to open an available port.

Optimization tips

Avoid calling MongoRunner.Run concurrently, as this will create many mongod processes and make your operating system slower. Instead, try to use a single instance and reuse it - create as many databases as you need, one per test for example.