EphemeralMongo6.runtime.win-x64
0.1.3
See the version list below for details.
dotnet add package EphemeralMongo6.runtime.win-x64 --version 0.1.3
NuGet\Install-Package EphemeralMongo6.runtime.win-x64 -Version 0.1.3
<PackageReference Include="EphemeralMongo6.runtime.win-x64" Version="0.1.3" />
paket add EphemeralMongo6.runtime.win-x64 --version 0.1.3
#r "nuget: EphemeralMongo6.runtime.win-x64, 0.1.3"
// Install EphemeralMongo6.runtime.win-x64 as a Cake Addin #addin nuget:?package=EphemeralMongo6.runtime.win-x64&version=0.1.3 // Install EphemeralMongo6.runtime.win-x64 as a Cake Tool #tool nuget:?package=EphemeralMongo6.runtime.win-x64&version=0.1.3
EphemeralMongo - temporary and disposable MongoDB for integration tests and local debugging
EphemeralMongo is a set of three NuGet packages wrapping the binaries of MongoDB 4, 5 and 6. Each package targets .NET Standard 2.0, which means you can use it with .NET Framework 4.5.2 up to .NET 6 and later.
The supported operating systems are Linux, macOS and Windows on their x64 architecture versions only. Each package provides access to:
- Multiple ephemeral and isolated MongoDB 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 very much inspired from Mongo2Go but contains several improvements:
- 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.6.2, .NET Core 3.1 and .NET 6 using the latest GitHub build agents for Ubuntu, macOS and Windows.
Downloads
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
};
// 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
andmongoexport
) are copied to your project output directory, - At runtime, the library chooses the right binaries for your operating system,
MongoRunner.Run
always starts a newmongod
process with a random available port,- The resulting connection string will depend on your options (
UseSingleNodeReplicaSet
andAdditionalArguments
), - By default, a unique temporary data directory is used.
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.
Check out this gist for an implementation of a reusable IMongoRunner
.
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on EphemeralMongo6.runtime.win-x64:
Package | Downloads |
---|---|
EphemeralMongo6
.NET native wrapper for MongoDB 6.0.9 built for .NET Standard 2.0. |
GitHub repositories (8)
Showing the top 5 popular GitHub repositories that depend on EphemeralMongo6.runtime.win-x64:
Repository | Stars |
---|---|
abpframework/abp
Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.
|
|
abpframework/abp-samples
Sample solutions built with the ABP Framework
|
|
Avanade/Liquid-Application-Framework
Liquid Application Framework documentation, useful links and sample project
|
|
EasyAbp/EShop
An abp application module group that provides basic e-shop service.
|
|
serilog-contrib/serilog-ui
Simple Serilog log viewer UI for several sinks.
|