CSHARP-797: Prohibit Find and Insert on a bulk write operation after Execute.

Author: rstam

MongoDB.Driver/Operations/BulkWriteOperation.cs

@@ -27,7 +27,7 @@ public sealed class BulkWriteOperation
         private readonly MongoCollection _collection;
         private readonly bool _isOrdered;
         private readonly List<WriteRequest> _requests = new List<WriteRequest>();
-        private bool _hasAlreadyBeenExecuted;
+        private bool _hasBeenExecuted;
 
         // constructors
         internal BulkWriteOperation(MongoCollection collection, bool isOrdered)
@@ -43,18 +43,7 @@ internal BulkWriteOperation(MongoCollection collection, bool isOrdered)
         /// <returns>A BulkWriteResult.</returns>
         public BulkWriteResult Execute()
         {
-            if (_hasAlreadyBeenExecuted)
-            {
-                throw new InvalidOperationException("A bulk write operation can only be executed once.");
-            }
-            _hasAlreadyBeenExecuted = true;
-
-            var args = new BulkWriteArgs
-            {
-                IsOrdered = _isOrdered,
-                Requests = _requests
-            };
-            return _collection.BulkWrite(args);
+            return ExecuteHelper(null);
         }
 
         /// <summary>
@@ -68,13 +57,7 @@ public BulkWriteResult Execute(WriteConcern writeConcern)
             {
                 throw new ArgumentNullException("writeConcern");
             }
-            var args = new BulkWriteArgs
-            {
-                IsOrdered = _isOrdered,
-                WriteConcern = writeConcern,
-                Requests = _requests
-            };
-            return _collection.BulkWrite(args);
+            return ExecuteHelper(writeConcern);
         }
 
         /// <summary>
@@ -88,6 +71,10 @@ public BulkWriteRequestBuilder Find(IMongoQuery query)
             {
                 throw new ArgumentNullException("query");
             }
+            if (_hasBeenExecuted)
+            {
+                throw new InvalidOperationException("The bulk write operation has already been executed.");
+            }
             return new BulkWriteRequestBuilder(AddRequest, query);
         }
 
@@ -109,7 +96,28 @@ public void Insert<TDocument>(TDocument document)
         // private methods
         private void AddRequest(WriteRequest request)
         {
+            if (_hasBeenExecuted)
+            {
+                throw new InvalidOperationException("The bulk write operation has already been executed.");
+            }
             _requests.Add(request);
         }
+
+        private BulkWriteResult ExecuteHelper(WriteConcern writeConcern)
+        {
+            if (_hasBeenExecuted)
+            {
+                throw new InvalidOperationException("The bulk write operation has already been executed.");
+            }
+            _hasBeenExecuted = true;
+
+            var args = new BulkWriteArgs
+            {
+                IsOrdered = _isOrdered,
+                WriteConcern = writeConcern,
+                Requests = _requests
+            };
+            return _collection.BulkWrite(args);
+        }
     }
 }

MongoDB.DriverUnitTests/MongoCollectionTests.cs

@@ -246,23 +246,6 @@ public void TestBulkDelete()
             Assert.AreEqual(2, _collection.FindOne()["x"].ToInt32());
         }
 
-        [Test]
-        public void TestBulkEmpty()
-        {
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            Assert.Throws<InvalidOperationException>(() => bulk.Execute());
-        }
-
-        [Test]
-        public void TestBulkExecuteTwice()
-        {
-            _collection.Drop();
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Insert(new BsonDocument());
-            bulk.Execute();
-            Assert.Throws<InvalidOperationException>(() => bulk.Execute());
-        }
-
         [Test]
         public void TestBulkInsert()
         {
@@ -1261,114 +1244,6 @@ public void TestFindWithMaxTime()
             }
         }
 
-        [Test]
-        public void TestFluentBulkDelete()
-        {
-            _collection.Drop();
-            _collection.Insert(new BsonDocument("x", 1));
-            _collection.Insert(new BsonDocument("x", 2));
-            _collection.Insert(new BsonDocument("x", 3));
-
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Find(Query.EQ("x", 1)).RemoveOne();
-            bulk.Find(Query.EQ("x", 3)).RemoveOne();
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(1, _collection.Count());
-            Assert.AreEqual(2, _collection.FindOne()["x"].ToInt32());
-        }
-
-        [Test]
-        public void TestFluentBulkDeleteMissingQuery()
-        {
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            Assert.Throws<ArgumentNullException>(() => bulk.Find(null));
-        }
-
-        [Test]
-        public void TestFluentBulkInsert()
-        {
-            _collection.Drop();
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Insert(new BsonDocument("x", 1));
-            bulk.Insert(new BsonDocument("x", 2));
-            bulk.Insert(new BsonDocument("x", 3));
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(3, _collection.Count());
-        }
-
-        [Test]
-        public void TestFluentBulkUpdate()
-        {
-            _collection.Drop();
-            _collection.Insert(new BsonDocument("x", 1));
-            _collection.Insert(new BsonDocument("x", 2));
-            _collection.Insert(new BsonDocument("x", 3));
-
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Find(Query.GT("x", 0)).Update(Update.Set("z", 1));
-            bulk.Find(Query.EQ("x", 3)).UpdateOne(Update.Set("z", 3));
-            bulk.Find(Query.EQ("x", 4)).Upsert().UpdateOne(Update.Set("z", 4));
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(4, _collection.Count());
-            foreach (var document in _collection.FindAll())
-            {
-                var x = document["x"].ToInt32();
-                var z = document["z"].ToInt32();
-                var expected = (x == 2) ? 1 : x;
-                Assert.AreEqual(expected, z);
-            }
-        }
-
-        [Test]
-        public void TestFluentBulkWrite()
-        {
-            _collection.Drop();
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Insert(new BsonDocument("x", 1));
-            bulk.Insert(new BsonDocument("x", 2));
-            bulk.Insert(new BsonDocument("x", 3));
-            bulk.Insert(new BsonDocument("x", 4));
-            bulk.Find(Query.GT("x", 2)).Update(Update.Inc("x", 10));
-            bulk.Find(Query.EQ("x", 13)).RemoveOne();
-            bulk.Find(Query.EQ("x", 14)).RemoveOne();
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(2, _collection.Count());
-        }
-
-        [Test]
-        public void TestBulkFluentWriteOrdered()
-        {
-            _collection.Drop();
-            var bulk = _collection.InitializeOrderedBulkOperation();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            bulk.Find(Query.EQ("x", 1)).RemoveOne();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            bulk.Find(Query.EQ("x", 1)).RemoveOne();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(1, _collection.Count());
-        }
-
-        [Test]
-        public void TestFluentBulkWriteUnordered()
-        {
-            _collection.Drop();
-            var bulk = _collection.InitializeUnorderedBulkOperation();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            bulk.Find(Query.EQ("x", 1)).RemoveOne();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            bulk.Find(Query.EQ("x", 1)).RemoveOne();
-            bulk.Find(Query.EQ("x", 1)).Upsert().UpdateOne(Update.Set("y", 1));
-            var result = bulk.Execute(WriteConcern.Acknowledged);
-
-            Assert.AreEqual(0, _collection.Count());
-        }
-
 #pragma warning disable 649 // never assigned to
         private class Place
         {

MongoDB.DriverUnitTests/MongoDB.DriverUnitTests.csproj

@@ -145,6 +145,7 @@
     <Compile Include="MongoClientSettingsTests.cs" />
     <Compile Include="MongoServerBuildInfoTests.cs" />
     <Compile Include="Operations\BulkWriteBatchResultCombinerTests.cs" />
+    <Compile Include="Operations\BulkWriteOperationTests.cs" />
     <Compile Include="Operations\DeleteCommandEmulatorTests.cs" />
     <Compile Include="ReadPreferenceTests.cs" />
     <Compile Include="MongoCollectionSettingsTests.cs" />