Replace Mongo2Go with EphemeralMongo

Author: bkoelman

Diff for: Directory.Build.props

@@ -26,11 +26,11 @@
     <BogusVersion>34.0.*</BogusVersion>
     <CSharpGuidelinesAnalyzerVersion>3.8.*</CSharpGuidelinesAnalyzerVersion>
     <CoverletVersion>6.0.*</CoverletVersion>
+    <EphemeralMongoVersion>1.1.*</EphemeralMongoVersion>
     <FluentAssertionsVersion>6.12.*</FluentAssertionsVersion>
     <GitHubActionsTestLoggerVersion>2.3.*</GitHubActionsTestLoggerVersion>
     <InheritDocVersion>1.3.*</InheritDocVersion>
     <JetBrainsAnnotationsVersion>2023.2.*</JetBrainsAnnotationsVersion>
-    <Mongo2GoVersion>3.1.3</Mongo2GoVersion>
     <SourceLinkVersion>1.1.*</SourceLinkVersion>
     <TestSdkVersion>17.7.*</TestSdkVersion>
     <XunitVersion>2.5.*</XunitVersion>

Diff for: test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/AtomicOperationsFixture.cs

@@ -8,15 +8,10 @@ namespace JsonApiDotNetCoreMongoDbTests.IntegrationTests.AtomicOperations;
 [UsedImplicitly(ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature)]
 public sealed class AtomicOperationsFixture : IAsyncLifetime
 {
-    internal IntegrationTestContext<TestableStartup, OperationsDbContext> TestContext { get; }
+    internal IntegrationTestContext<TestableStartup, OperationsDbContext> TestContext { get; } = new();
 
     public AtomicOperationsFixture()
     {
-        TestContext = new IntegrationTestContext<TestableStartup, OperationsDbContext>
-        {
-            StartMongoDbInSingleNodeReplicaSetMode = true
-        };
-
         TestContext.UseController<OperationsController>();
 
         TestContext.ConfigureServicesAfterStartup(services => services.AddSingleton<ResourceDefinitionHitCounter>());

Diff for: test/JsonApiDotNetCoreMongoDbTests/IntegrationTests/AtomicOperations/Transactions/AtomicTransactionConsistencyTests.cs

@@ -19,8 +19,6 @@ public AtomicTransactionConsistencyTests(IntegrationTestContext<TestableStartup,
 
         testContext.UseController<OperationsController>();
 
-        testContext.StartMongoDbInSingleNodeReplicaSetMode = true;
-
         testContext.ConfigureServicesAfterStartup(services =>
         {
             services.AddSingleton<ResourceDefinitionHitCounter>();

Diff for: test/TestBuildingBlocks/IntegrationTestContext.cs

@@ -1,5 +1,5 @@
-using System.Runtime.InteropServices;
 using System.Text.Json;
+using EphemeralMongo;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.MongoDb.Configuration;
@@ -11,7 +11,6 @@
 using Microsoft.AspNetCore.TestHost;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
-using Mongo2Go;
 using MongoDB.Driver;
 
 namespace TestBuildingBlocks;
@@ -32,7 +31,7 @@ public class IntegrationTestContext<TStartup, TMongoDbContextShim> : Integration
     where TStartup : class
     where TMongoDbContextShim : MongoDbContextShim
 {
-    private readonly Lazy<MongoDbRunner> _runner;
+    private readonly Lazy<IMongoRunner> _runner;
     private readonly Lazy<WebApplicationFactory<TStartup>> _lazyFactory;
     private readonly TestControllerProvider _testControllerProvider = new();
 
@@ -49,31 +48,15 @@ protected override JsonSerializerOptions SerializerOptions
 
     public WebApplicationFactory<TStartup> Factory => _lazyFactory.Value;
 
-    /// <summary>
-    /// Set this to <c>true</c> to enable transactions support in MongoDB.
-    /// </summary>
-    public bool StartMongoDbInSingleNodeReplicaSetMode { get; set; }
-
     public IntegrationTestContext()
     {
-        _runner = new Lazy<MongoDbRunner>(StartMongoDb);
+        _runner = new Lazy<IMongoRunner>(StartMongoDb);
         _lazyFactory = new Lazy<WebApplicationFactory<TStartup>>(CreateFactory);
     }
 
-    private MongoDbRunner StartMongoDb()
+    private IMongoRunner StartMongoDb()
     {
-        // Increasing maxTransactionLockRequestTimeoutMillis (default=5) as workaround for occasional
-        // "Unable to acquire lock" error when running tests locally.
-        string arguments = "--quiet --setParameter maxTransactionLockRequestTimeoutMillis=40";
-
-        if (!StartMongoDbInSingleNodeReplicaSetMode)
-        {
-            // MongoDbRunner watches console output to detect when the replica set has stabilized. So we can only fully
-            // suppress console output if not running in this mode.
-            arguments += RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? " --logappend --logpath NUL" : " --logpath /dev/null";
-        }
-
-        return MongoDbRunner.Start(singleNodeReplSet: StartMongoDbInSingleNodeReplicaSetMode, additionalMongodArguments: arguments);
+        return MongoRunnerProvider.Instance.Get();
     }
 
     public void UseController<TController>()

Diff for: test/TestBuildingBlocks/MongoRunnerProvider.cs

@@ -0,0 +1,101 @@
+using EphemeralMongo;
+
+#pragma warning disable AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
+
+namespace TestBuildingBlocks;
+
+// Based on https://gist.github.com/asimmon/612b2d54f1a0d2b4e1115590d456e0be.
+internal sealed class MongoRunnerProvider
+{
+    public static readonly MongoRunnerProvider Instance = new();
+
+    private readonly object _lockObject = new();
+    private IMongoRunner? _runner;
+    private int _useCounter;
+
+    private MongoRunnerProvider()
+    {
+    }
+
+    public IMongoRunner Get()
+    {
+        lock (_lockObject)
+        {
+            if (_runner == null)
+            {
+                var runnerOptions = new MongoRunnerOptions
+                {
+                    // Single-node replica set mode is required for transaction support in MongoDB.
+                    UseSingleNodeReplicaSet = true,
+                    KillMongoProcessesWhenCurrentProcessExits = true,
+                    AdditionalArguments = "--quiet"
+                };
+
+                _runner = MongoRunner.Run(runnerOptions);
+            }
+
+            _useCounter++;
+            return new MongoRunnerWrapper(this, _runner);
+        }
+    }
+
+    private void Detach()
+    {
+        lock (_lockObject)
+        {
+            if (_runner != null)
+            {
+                _useCounter--;
+
+                if (_useCounter == 0)
+                {
+                    _runner.Dispose();
+                    _runner = null;
+                }
+            }
+        }
+    }
+
+    private sealed class MongoRunnerWrapper : IMongoRunner
+    {
+        private readonly MongoRunnerProvider _owner;
+        private IMongoRunner? _underlyingMongoRunner;
+
+        public string ConnectionString => _underlyingMongoRunner?.ConnectionString ?? throw new ObjectDisposedException(nameof(IMongoRunner));
+
+        public MongoRunnerWrapper(MongoRunnerProvider owner, IMongoRunner underlyingMongoRunner)
+        {
+            _owner = owner;
+            _underlyingMongoRunner = underlyingMongoRunner;
+        }
+
+        public void Import(string database, string collection, string inputFilePath, string? additionalArguments = null, bool drop = false)
+        {
+            if (_underlyingMongoRunner == null)
+            {
+                throw new ObjectDisposedException(nameof(IMongoRunner));
+            }
+
+            _underlyingMongoRunner.Import(database, collection, inputFilePath, additionalArguments, drop);
+        }
+
+        public void Export(string database, string collection, string outputFilePath, string? additionalArguments = null)
+        {
+            if (_underlyingMongoRunner == null)
+            {
+                throw new ObjectDisposedException(nameof(IMongoRunner));
+            }
+
+            _underlyingMongoRunner.Export(database, collection, outputFilePath, additionalArguments);
+        }
+
+        public void Dispose()
+        {
+            if (_underlyingMongoRunner != null)
+            {
+                _underlyingMongoRunner = null;
+                _owner.Detach();
+            }
+        }
+    }
+}

Diff for: test/TestBuildingBlocks/TestBuildingBlocks.csproj

@@ -10,11 +10,14 @@
   <ItemGroup>
     <PackageReference Include="Bogus" Version="$(BogusVersion)" />
     <PackageReference Include="coverlet.collector" Version="$(CoverletVersion)" PrivateAssets="All" />
+    <PackageReference Include="EphemeralMongo.Core" Version="$(EphemeralMongoVersion)" />
+    <PackageReference Include="EphemeralMongo6.runtime.linux-x64" Version="$(EphemeralMongoVersion)" Condition="$([MSBuild]::IsOSPlatform('Linux'))" />
+    <PackageReference Include="EphemeralMongo6.runtime.osx-x64" Version="$(EphemeralMongoVersion)" Condition="$([MSBuild]::IsOSPlatform('OSX'))" />
+    <PackageReference Include="EphemeralMongo6.runtime.win-x64" Version="$(EphemeralMongoVersion)" Condition="$([MSBuild]::IsOSPlatform('Windows'))" />
     <PackageReference Include="GitHubActionsTestLogger" Version="$(GitHubActionsTestLoggerVersion)" PrivateAssets="All" />
     <PackageReference Include="FluentAssertions" Version="$(FluentAssertionsVersion)" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="$(AspNetCoreVersion)" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="$(TestSdkVersion)" />
-    <PackageReference Include="Mongo2Go" Version="$(Mongo2GoVersion)" />
     <PackageReference Include="xunit" Version="$(XunitVersion)" />
     <PackageReference Include="xunit.runner.visualstudio" Version="$(XunitVersion)" PrivateAssets="All" />
   </ItemGroup>