JAVA-1040: Make BulkOperation throw IllegalStateException if executed more than once or with an empty list up updates.

Author: jyemin

src/main/com/mongodb/BulkWriteOperation.java

@@ -19,6 +19,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static org.bson.util.Assertions.isTrue;
+
 /**
  * A bulk write operation.
  *
@@ -28,6 +30,7 @@ public class BulkWriteOperation {
     private final boolean ordered;
     private final DBCollection collection;
     private final List<WriteRequest> requests = new ArrayList<WriteRequest>();
+    private boolean closed;
 
     BulkWriteOperation(final boolean ordered, final DBCollection collection) {
         this.ordered = ordered;
@@ -52,6 +55,7 @@ public boolean isOrdered() {
      * @param document the document to insert
      */
     public void insert(final DBObject document) {
+        isTrue("already executed", !closed);
         addRequest(new InsertRequest(document));
     }
 
@@ -62,6 +66,7 @@ public void insert(final DBObject document) {
      * @return a builder for a single write request
      */
     public BulkWriteRequestBuilder find(final DBObject query) {
+        isTrue("already executed", !closed);
         return new BulkWriteRequestBuilder(this, query);
     }
 
@@ -73,7 +78,13 @@ public BulkWriteRequestBuilder find(final DBObject query) {
      * @throws com.mongodb.MongoException
      */
     public BulkWriteResult execute() {
-        return collection.executeBulkWriteOperation(ordered, requests);
+        isTrue("already executed", !closed);
+
+        try {
+            return collection.executeBulkWriteOperation(ordered, requests);
+        } finally {
+            closed = true;
+        }
     }
 
     /**
@@ -86,10 +97,17 @@ public BulkWriteResult execute() {
      * @throws com.mongodb.MongoException
      */
     public BulkWriteResult execute(final WriteConcern writeConcern) {
-        return collection.executeBulkWriteOperation(ordered, requests, writeConcern);
+        isTrue("already executed", !closed);
+
+        try {
+            return collection.executeBulkWriteOperation(ordered, requests, writeConcern);
+        } finally {
+            closed = true;
+        }
     }
 
     void addRequest(final WriteRequest request) {
+        isTrue("already executed", !closed);
         requests.add(request);
     }
 

src/main/com/mongodb/DBCollectionImpl.java

@@ -42,6 +42,7 @@
 import static com.mongodb.WriteRequest.Type.UPDATE;
 import static java.lang.String.format;
 import static java.util.Arrays.asList;
+import static org.bson.util.Assertions.isTrue;
 
 class DBCollectionImpl extends DBCollection {
     private final DBApiLayer db;
@@ -121,6 +122,8 @@ public List<Cursor> parallelScan(final ParallelScanOptions options) {
     @Override
     BulkWriteResult executeBulkWriteOperation(final boolean ordered, final List<WriteRequest> writeRequests,
                                               final WriteConcern writeConcern, DBEncoder encoder) {
+        isTrue("no operations", !writeRequests.isEmpty());
+
         if (writeConcern == null) {
             throw new IllegalArgumentException("Write concern can not be null");
         }

src/test/com/mongodb/BulkWriteOperationSpecification.groovy

@@ -287,6 +287,94 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
         ex.writeErrors[1].code == 11000
     }
 
+    def 'execute should throw IllegalStateException when already executed'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+        builder.insert(new BasicDBObject('_id', 1))
+        builder.execute()
+
+        when:
+        builder.execute()
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    def 'execute with write concern should throw IllegalStateException when already executed'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+        builder.insert(new BasicDBObject('_id', 1))
+        builder.execute()
+
+        when:
+        builder.execute(WriteConcern.ACKNOWLEDGED)
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    def 'insert should throw IllegalStateException when already executed'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+        builder.insert(new BasicDBObject('_id', 1))
+        builder.execute()
+
+        when:
+        builder.insert(new BasicDBObject())
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    def 'find should throw IllegalStateException when already executed'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+        builder.insert(new BasicDBObject('_id', 1))
+        builder.execute()
+
+        when:
+        builder.find(new BasicDBObject());
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    // just need to check one case here, since the others are checked above
+    def 'should throw IllegalStateException when already executed with write concern'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+        builder.insert(new BasicDBObject('_id', 1))
+        builder.execute(WriteConcern.ACKNOWLEDGED)
+
+        when:
+        builder.execute()
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    def 'should throw IllegalStateException when executing an empty bulk operation'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+
+        when:
+        builder.execute()
+
+        then:
+        thrown(IllegalStateException)
+    }
+
+    def 'should throw IllegalStateException when executing an empty bulk operation with a write concern'() {
+        given:
+        def builder = collection.initializeOrderedBulkOperation();
+
+        when:
+        builder.execute(WriteConcern.ACKNOWLEDGED)
+
+        then:
+        thrown(IllegalStateException)
+    }
+
     private static void addWritesToBuilder(BulkWriteOperation builder) {
         builder.find(new BasicDBObject('_id', 1)).updateOne(new BasicDBObject('$set', new BasicDBObject('x', 2)))
         builder.find(new BasicDBObject('_id', 2)).updateOne(new BasicDBObject('$set', new BasicDBObject('x', 3)))
@@ -307,4 +395,5 @@ class BulkWriteOperationSpecification extends FunctionalSpecification {
          new BasicDBObject('_id', 6)
         ]
     }
+
 }