fix(mongodb): remove incorrect client arg-null check in mongo db collection ctor

stijnmoreels · stijnmoreels · commit 374a26f1733c · 2025-12-09T06:25:08.000+01:00
diff --git a/src/Arcus.Testing.Storage.Cosmos/TemporaryMongoDbCollection.cs b/src/Arcus.Testing.Storage.Cosmos/TemporaryMongoDbCollection.cs
@@ -238,7 +238,6 @@ private TemporaryMongoDbCollection(
             ILogger logger,
             TemporaryMongoDbCollectionOptions options)
         {
-            ArgumentNullException.ThrowIfNull(client);
             ArgumentNullException.ThrowIfNull(database);
             ArgumentNullException.ThrowIfNull(collectionName);
             ArgumentNullException.ThrowIfNull(options);
diff --git a/src/Arcus.Testing.Tests.Integration/Storage/Fixture/MongoDbTestContext.cs b/src/Arcus.Testing.Tests.Integration/Storage/Fixture/MongoDbTestContext.cs
@@ -22,7 +22,6 @@ namespace Arcus.Testing.Tests.Integration.Storage.Fixture
     /// </summary>
     public class MongoDbTestContext : IAsyncDisposable
     {
-        private readonly IMongoDatabase _database;
         private readonly Collection<string> _collectionNames = new();
         private readonly ILogger _logger;
 
@@ -36,10 +35,15 @@ private MongoDbTestContext(
             IMongoDatabase database,
             ILogger logger)
         {
-            _database = database;
             _logger = logger;
+            Database = database;
         }
 
+        /// <summary>
+        /// Gets the current database client to interact with the Mongo DB.
+        /// </summary>
+        public IMongoDatabase Database { get; }
+
         /// <summary>
         /// Creates an authenticated <see cref="MongoDbTestContext"/>.
         /// </summary>
@@ -104,7 +108,7 @@ public async Task<string> WhenCollectionNameAvailableAsync()
             _logger.LogTrace("[Test] create MongoDb collection '{CollectionName}' outside the fixture's scope", collectionName);
 
             await WhenMongoDbAvailableAsync(
-                () => _database.CreateCollectionAsync(collectionName),
+                () => Database.CreateCollectionAsync(collectionName),
                 $"[Test] cannot create MongoDb collection '{collectionName}' outside the fixture's scope, due to a high-rate failure");
 
             return collectionName;
@@ -144,15 +148,15 @@ internal static async Task<TResult> WhenMongoDbAvailableAsync<TResult>(Func<Task
         public async Task WhenCollectionDeletedAsync(string collectionName)
         {
             _logger.LogTrace("[Test] delete MongoDb collection '{CollectionName}' outside test fixture's scope", collectionName);
-            await _database.DropCollectionAsync(collectionName);
+            await Database.DropCollectionAsync(collectionName);
         }
 
         /// <summary>
         /// Provides an existing document in a MongoDb collection.
         /// </summary>
         public async Task<BsonValue> WhenDocumentAvailableAsync<T>(string collectionName, T document)
         {
-            IMongoCollection<BsonDocument> collection = _database.GetCollection<BsonDocument>(collectionName);
+            IMongoCollection<BsonDocument> collection = Database.GetCollection<BsonDocument>(collectionName);
 
             var bson = document.ToBsonDocument();
 
@@ -176,7 +180,7 @@ public async Task WhenDocumentDeletedAsync<T>(string collectionName, BsonValue i
         {
             _logger.LogTrace("[Test] delete MongoDb document '{DocId}' in collection '{CollectionName}' outside test fixture's scope", id, collectionName);
 
-            IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);
+            IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);
             FilterDefinition<T> filter = CreateIdFilter<T>(id);
 
             await collection.DeleteOneAsync(filter);
@@ -208,7 +212,7 @@ private async Task<bool> StoresCollectionNameAsync(string collectionName)
             {
                 Filter = Builders<BsonDocument>.Filter.Eq("name", collectionName)
             };
-            using IAsyncCursor<string> collectionNames = await _database.ListCollectionNamesAsync(options);
+            using IAsyncCursor<string> collectionNames = await Database.ListCollectionNamesAsync(options);
             return await collectionNames.AnyAsync();
         }
 
@@ -217,7 +221,7 @@ private async Task<bool> StoresCollectionNameAsync(string collectionName)
         /// </summary>
         public async Task ShouldStoreDocumentAsync<T>(string collectionName, BsonValue id, Action<T> assertion = null)
         {
-            IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);
+            IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);
             FilterDefinition<T> filter = CreateIdFilter<T>(id);
 
             List<T> matchingDocs = await collection.Find(filter).ToListAsync();
@@ -231,7 +235,7 @@ public async Task ShouldStoreDocumentAsync<T>(string collectionName, BsonValue i
         /// </summary>
         public async Task ShouldNotStoreDocumentAsync<T>(string collectionName, BsonValue id)
         {
-            IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);
+            IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);
             FilterDefinition<T> filter = CreateIdFilter<T>(id);
 
             List<T> matchingDocs = await collection.Find(filter).ToListAsync();
@@ -259,7 +263,7 @@ public async ValueTask DisposeAsync()
             {
                 disposables.Add(AsyncDisposable.Create(async () =>
                 {
-                    await _database.DropCollectionAsync(collectionName);
+                    await Database.DropCollectionAsync(collectionName);
                 }));
             }
         }
diff --git a/src/Arcus.Testing.Tests.Integration/Storage/TemporaryMongoDbCollectionTests.cs b/src/Arcus.Testing.Tests.Integration/Storage/TemporaryMongoDbCollectionTests.cs
@@ -26,7 +26,7 @@ public async Task CreateTempMongoDbCollection_OnNonExistingCollection_SucceedsBy
             await using MongoDbTestContext context = await GivenCosmosMongoDbAsync();
 
             string collectionName = context.WhenCollectionNameUnavailable();
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName);
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context);
 
             await context.ShouldStoreCollectionAsync(collectionName);
 
@@ -47,7 +47,7 @@ public async Task CreateTempMongoDbCollection_OnExistingCollection_SucceedsByLea
             Shipment shipment = CreateShipment();
             BsonValue existingId = await context.WhenDocumentAvailableAsync(collectionName, shipment);
 
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName);
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context);
             Shipment createdByUs = CreateShipment();
 #pragma warning disable CS0618 // Type or member is obsolete: currently still testing deprecated functionality.
             await collection.AddDocumentAsync(createdByUs);
@@ -77,7 +77,7 @@ public async Task CreateTempMongoDbCollectionWithCleanAllOnSetup_OnExistingColle
             Shipment shipment = CreateShipment();
             BsonValue existingId = await context.WhenDocumentAvailableAsync(collectionName, shipment);
 
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, options =>
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context, options =>
             {
                 options.OnSetup.CleanAllDocuments();
             });
@@ -105,7 +105,7 @@ public async Task CreateTempMongoDbCollectionWithCleanMatchingOnSetup_OnExisting
             BsonValue unmatchedId = await context.WhenDocumentAvailableAsync(collectionName, unmatched);
 
             // Act
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, options =>
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context, options =>
             {
                 options.OnSetup.CleanMatchingDocuments((Shipment s) => s.BoatId == (ObjectId) matchedId)
                                .CleanMatchingDocuments((Shipment s) => s.BoatName == matched.BoatName);
@@ -126,7 +126,7 @@ public async Task CreateTempMongoDbCollectionWithCleanAllOnTeardown_OnExistingCo
             await using MongoDbTestContext context = await GivenCosmosMongoDbAsync();
 
             string collectionName = await context.WhenCollectionNameAvailableAsync();
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, options =>
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context, options =>
             {
                 options.OnTeardown.CleanAllDocuments();
             });
@@ -151,7 +151,7 @@ public async Task CreateTempMongoDbCollectionWithCleanMatchingOnTeardown_OnExist
 
             Shipment matched = CreateShipment();
             Shipment unmatched = CreateShipment();
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, options =>
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context, options =>
             {
                 options.OnTeardown.CleanMatchingDocuments((Shipment s) => s.BoatName != unmatched.BoatName)
                                   .CleanMatchingDocuments((Shipment s) => s.BoatName == matched.BoatName);
@@ -182,7 +182,7 @@ public async Task CreateTempMongoDbCollectionWithSetupTeardown_OnExistingCollect
             BsonValue matchedOnSetupId = await context.WhenDocumentAvailableAsync(collectionName, matchedOnSetup);
             BsonValue unmatchedOnSetupId = await context.WhenDocumentAvailableAsync(collectionName, unmatchedOnSetup);
 
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, options =>
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context, options =>
             {
                 options.OnSetup.CleanMatchingDocuments((Shipment s) => s.BoatName == matchedOnSetup.BoatName);
             });
@@ -225,7 +225,7 @@ public async Task CreateTempMongoDbCollection_WhenCollectionWasDeletedOutsideFix
             await using MongoDbTestContext context = await GivenCosmosMongoDbAsync();
 
             string collectionName = context.WhenCollectionNameUnavailable();
-            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName);
+            TemporaryMongoDbCollection collection = await WhenTempCollectionCreatedAsync(collectionName, context);
             await context.WhenCollectionDeletedAsync(collectionName);
 
             // Act
@@ -235,13 +235,17 @@ public async Task CreateTempMongoDbCollection_WhenCollectionWasDeletedOutsideFix
             await context.ShouldNotStoreCollectionAsync(collectionName);
         }
 
-        private async Task<TemporaryMongoDbCollection> WhenTempCollectionCreatedAsync(string collectionName, Action<TemporaryMongoDbCollectionOptions> configureOptions = null)
+        private async Task<TemporaryMongoDbCollection> WhenTempCollectionCreatedAsync(string collectionName, MongoDbTestContext context, Action<TemporaryMongoDbCollectionOptions> configureOptions = null)
         {
             return await MongoDbTestContext.WhenMongoDbAvailableAsync(async () =>
             {
-                var collection = configureOptions is null
-                    ? await TemporaryMongoDbCollection.CreateIfNotExistsAsync(MongoDb.AccountResourceId, MongoDb.DatabaseName, collectionName, Logger)
-                    : await TemporaryMongoDbCollection.CreateIfNotExistsAsync(MongoDb.AccountResourceId, MongoDb.DatabaseName, collectionName, Logger, configureOptions);
+                var collection = (Bogus.Random.Bool(), configureOptions is null) switch
+                {
+                    (false, false) => await TemporaryMongoDbCollection.CreateIfNotExistsAsync(MongoDb.AccountResourceId, MongoDb.DatabaseName, collectionName, Logger, configureOptions),
+                    (false, true) => await TemporaryMongoDbCollection.CreateIfNotExistsAsync(MongoDb.AccountResourceId, MongoDb.DatabaseName, collectionName, Logger),
+                    (true, false) => await TemporaryMongoDbCollection.CreateIfNotExistsAsync(context.Database, collectionName, Logger, configureOptions),
+                    (true, true) => await TemporaryMongoDbCollection.CreateIfNotExistsAsync(context.Database, collectionName, Logger)
+                };
 
                 Assert.Equal(collectionName, collection.Name);
                 return collection;

Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,6 @@ private TemporaryMongoDbCollection(`
`238`	`238`	`ILogger logger,`
`239`	`239`	`TemporaryMongoDbCollectionOptions options)`
`240`	`240`	`{`
`241`		`- ArgumentNullException.ThrowIfNull(client);`
`242`	`241`	`ArgumentNullException.ThrowIfNull(database);`
`243`	`242`	`ArgumentNullException.ThrowIfNull(collectionName);`
`244`	`243`	`ArgumentNullException.ThrowIfNull(options);`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ namespace Arcus.Testing.Tests.Integration.Storage.Fixture`
`22`	`22`	`/// </summary>`
`23`	`23`	`public class MongoDbTestContext : IAsyncDisposable`
`24`	`24`	`{`
`25`		`- private readonly IMongoDatabase _database;`
`26`	`25`	`private readonly Collection<string> _collectionNames = new();`
`27`	`26`	`private readonly ILogger _logger;`
`28`	`27`
`@@ -36,10 +35,15 @@ private MongoDbTestContext(`
`36`	`35`	`IMongoDatabase database,`
`37`	`36`	`ILogger logger)`
`38`	`37`	`{`
`39`		`- _database = database;`
`40`	`38`	`_logger = logger;`
	`39`	`+ Database = database;`
`41`	`40`	`}`
`42`	`41`
	`42`	`+ /// <summary>`
	`43`	`+ /// Gets the current database client to interact with the Mongo DB.`
	`44`	`+ /// </summary>`
	`45`	`+ public IMongoDatabase Database { get; }`
	`46`	`+`
`43`	`47`	`/// <summary>`
`44`	`48`	`/// Creates an authenticated <see cref="MongoDbTestContext"/>.`
`45`	`49`	`/// </summary>`
`@@ -104,7 +108,7 @@ public async Task<string> WhenCollectionNameAvailableAsync()`
`104`	`108`	`_logger.LogTrace("[Test] create MongoDb collection '{CollectionName}' outside the fixture's scope", collectionName);`
`105`	`109`
`106`	`110`	`await WhenMongoDbAvailableAsync(`
`107`		`- () => _database.CreateCollectionAsync(collectionName),`
	`111`	`+ () => Database.CreateCollectionAsync(collectionName),`
`108`	`112`	`$"[Test] cannot create MongoDb collection '{collectionName}' outside the fixture's scope, due to a high-rate failure");`
`109`	`113`
`110`	`114`	`return collectionName;`
`@@ -144,15 +148,15 @@ internal static async Task<TResult> WhenMongoDbAvailableAsync<TResult>(Func<Task`
`144`	`148`	`public async Task WhenCollectionDeletedAsync(string collectionName)`
`145`	`149`	`{`
`146`	`150`	`_logger.LogTrace("[Test] delete MongoDb collection '{CollectionName}' outside test fixture's scope", collectionName);`
`147`		`- await _database.DropCollectionAsync(collectionName);`
	`151`	`+ await Database.DropCollectionAsync(collectionName);`
`148`	`152`	`}`
`149`	`153`
`150`	`154`	`/// <summary>`
`151`	`155`	`/// Provides an existing document in a MongoDb collection.`
`152`	`156`	`/// </summary>`
`153`	`157`	`public async Task<BsonValue> WhenDocumentAvailableAsync<T>(string collectionName, T document)`
`154`	`158`	`{`
`155`		`- IMongoCollection<BsonDocument> collection = _database.GetCollection<BsonDocument>(collectionName);`
	`159`	`+ IMongoCollection<BsonDocument> collection = Database.GetCollection<BsonDocument>(collectionName);`
`156`	`160`
`157`	`161`	`var bson = document.ToBsonDocument();`
`158`	`162`
`@@ -176,7 +180,7 @@ public async Task WhenDocumentDeletedAsync<T>(string collectionName, BsonValue i`
`176`	`180`	`{`
`177`	`181`	`_logger.LogTrace("[Test] delete MongoDb document '{DocId}' in collection '{CollectionName}' outside test fixture's scope", id, collectionName);`
`178`	`182`
`179`		`- IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);`
	`183`	`+ IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);`
`180`	`184`	`FilterDefinition<T> filter = CreateIdFilter<T>(id);`
`181`	`185`
`182`	`186`	`await collection.DeleteOneAsync(filter);`
`@@ -208,7 +212,7 @@ private async Task<bool> StoresCollectionNameAsync(string collectionName)`
`208`	`212`	`{`
`209`	`213`	`Filter = Builders<BsonDocument>.Filter.Eq("name", collectionName)`
`210`	`214`	`};`
`211`		`- using IAsyncCursor<string> collectionNames = await _database.ListCollectionNamesAsync(options);`
	`215`	`+ using IAsyncCursor<string> collectionNames = await Database.ListCollectionNamesAsync(options);`
`212`	`216`	`return await collectionNames.AnyAsync();`
`213`	`217`	`}`
`214`	`218`
`@@ -217,7 +221,7 @@ private async Task<bool> StoresCollectionNameAsync(string collectionName)`
`217`	`221`	`/// </summary>`
`218`	`222`	`public async Task ShouldStoreDocumentAsync<T>(string collectionName, BsonValue id, Action<T> assertion = null)`
`219`	`223`	`{`
`220`		`- IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);`
	`224`	`+ IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);`
`221`	`225`	`FilterDefinition<T> filter = CreateIdFilter<T>(id);`
`222`	`226`
`223`	`227`	`List<T> matchingDocs = await collection.Find(filter).ToListAsync();`
`@@ -231,7 +235,7 @@ public async Task ShouldStoreDocumentAsync<T>(string collectionName, BsonValue i`
`231`	`235`	`/// </summary>`
`232`	`236`	`public async Task ShouldNotStoreDocumentAsync<T>(string collectionName, BsonValue id)`
`233`	`237`	`{`
`234`		`- IMongoCollection<T> collection = _database.GetCollection<T>(collectionName);`
	`238`	`+ IMongoCollection<T> collection = Database.GetCollection<T>(collectionName);`
`235`	`239`	`FilterDefinition<T> filter = CreateIdFilter<T>(id);`
`236`	`240`
`237`	`241`	`List<T> matchingDocs = await collection.Find(filter).ToListAsync();`
`@@ -259,7 +263,7 @@ public async ValueTask DisposeAsync()`
`259`	`263`	`{`
`260`	`264`	`disposables.Add(AsyncDisposable.Create(async () =>`
`261`	`265`	`{`
`262`		`- await _database.DropCollectionAsync(collectionName);`
	`266`	`+ await Database.DropCollectionAsync(collectionName);`
`263`	`267`	`}));`
`264`	`268`	`}`
`265`	`269`	`}`