CSHARP-4152: Add createCollection and collMod spec tests for changeStreamPreAndPostImages option

BorisDog · BorisDog · commit 826d8db16bc3 · 2022-06-01T11:28:34.000-07:00
diff --git a/src/MongoDB.Driver.Core/Core/Operations/CreateCollectionOperation.cs b/src/MongoDB.Driver.Core/Core/Operations/CreateCollectionOperation.cs
@@ -69,6 +69,7 @@ CreateCollectionOperation CreateInnerCollectionOperation(string collectionName)
         // fields
         private bool? _autoIndexId;
         private bool? _capped;
+        private BsonDocument _changeStreamPreAndPostImages;
         private BsonDocument _clusteredIndex;
         private Collation _collation;
         private readonly CollectionNamespace _collectionNamespace;
@@ -128,6 +129,18 @@ public bool? Capped
             set { _capped = value; }
         }
 
+        /// <summary>
+        /// Gets or sets a change streams pre and post images options.
+        /// </summary>
+        /// <value>
+        /// change streams pre and post images options.
+        /// </value>
+        public BsonDocument ChangeStreamPreAndPostImages
+        {
+            get { return _changeStreamPreAndPostImages; }
+            set { _changeStreamPreAndPostImages = value; }
+        }
+
         /// <summary>
         /// Gets or sets the collation.
         /// </summary>
@@ -361,7 +374,8 @@ internal BsonDocument CreateCommand(ICoreSessionHandle session)
                 { "writeConcern", writeConcern, writeConcern != null },
                 { "expireAfterSeconds", () => _expireAfter.Value.TotalSeconds, _expireAfter.HasValue },
                 { "timeseries", () => _timeSeriesOptions.ToBsonDocument(), _timeSeriesOptions != null },
-                { "encryptedFields", _encryptedFields, _encryptedFields != null }
+                { "encryptedFields", _encryptedFields, _encryptedFields != null },
+                { "changeStreamPreAndPostImages", _changeStreamPreAndPostImages, _changeStreamPreAndPostImages != null }
             };
         }
 
diff --git a/src/MongoDB.Driver/ChangeStreamPreAndPostImagesOptions.cs b/src/MongoDB.Driver/ChangeStreamPreAndPostImagesOptions.cs
@@ -0,0 +1,80 @@
+/* Copyright 2010-present MongoDB Inc.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization;
+using MongoDB.Bson.Serialization.Serializers;
+
+namespace MongoDB.Driver
+{
+    /// <summary>
+    /// Change stream pre and post images options.
+    /// </summary>
+    public sealed class ChangeStreamPreAndPostImagesOptions : BsonDocumentBackedClass
+    {
+        // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChangeStreamPreAndPostImagesOptions"/> class.
+        /// </summary>
+        public ChangeStreamPreAndPostImagesOptions()
+            : base(ChangeStreamPreAndPostImagesOptionsSerializer.Instance)
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChangeStreamPreAndPostImagesOptions"/> class.
+        /// </summary>
+        public ChangeStreamPreAndPostImagesOptions(BsonDocument bsonDocument)
+            : base(bsonDocument, ChangeStreamPreAndPostImagesOptionsSerializer.Instance)
+        {
+        }
+
+        // public properties
+        /// <summary>
+        /// Gets the backing document.
+        /// </summary>
+        new public BsonDocument BackingDocument => base.BackingDocument;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether ChangeStreamPreAndPostImages is enabled.
+        /// </summary>
+        public bool Enabled
+        {
+            get
+            {
+                return GetValue(nameof(Enabled), false);
+            }
+            set
+            {
+                SetValue(nameof(Enabled), value);
+            }
+        }
+    }
+
+    internal sealed class ChangeStreamPreAndPostImagesOptionsSerializer : BsonDocumentBackedClassSerializer<ChangeStreamPreAndPostImagesOptions>
+    {
+        public static ChangeStreamPreAndPostImagesOptionsSerializer Instance { get; } = new ChangeStreamPreAndPostImagesOptionsSerializer();
+
+        // constructors
+        public ChangeStreamPreAndPostImagesOptionsSerializer()
+        {
+            RegisterMember("Enabled", "enabled", new BooleanSerializer());
+        }
+
+        // methods
+        protected override ChangeStreamPreAndPostImagesOptions CreateInstance(BsonDocument backingDocument) =>
+            new ChangeStreamPreAndPostImagesOptions(backingDocument);
+    }
+}
diff --git a/src/MongoDB.Driver/CreateCollectionOptions.cs b/src/MongoDB.Driver/CreateCollectionOptions.cs
@@ -27,6 +27,7 @@ public class CreateCollectionOptions
         // fields
         private bool? _autoIndexId;
         private bool? _capped;
+        private ChangeStreamPreAndPostImagesOptions _changeStreamPreAndPostImagesOptions;
         private Collation _collation;
         private BsonDocument _encryptedFields;
         private TimeSpan? _expireAfter;
@@ -70,6 +71,15 @@ public bool? Capped
             set { _capped = value; }
         }
 
+        /// <summary>
+        /// Gets or sets  Gets or sets a change streams pre and post images options.
+        /// </summary>
+        public ChangeStreamPreAndPostImagesOptions ChangeStreamPreAndPostImagesOptions
+        {
+            get { return _changeStreamPreAndPostImagesOptions; }
+            set { _changeStreamPreAndPostImagesOptions = value; }
+        }
+
         /// <summary>
         /// Gets or sets encrypted fields.
         /// </summary>
@@ -216,6 +226,7 @@ internal static CreateCollectionOptions<TDocument> CoercedFrom(CreateCollectionO
                     AutoIndexId = options.AutoIndexId,
                     Capped = options.Capped,
                     Collation = options.Collation,
+                    ChangeStreamPreAndPostImagesOptions = options.ChangeStreamPreAndPostImagesOptions,
                     EncryptedFields = options.EncryptedFields,
                     ExpireAfter = options.ExpireAfter,
                     IndexOptionDefaults = options.IndexOptionDefaults,
diff --git a/src/MongoDB.Driver/MongoDatabaseImpl.cs b/src/MongoDB.Driver/MongoDatabaseImpl.cs
@@ -665,6 +665,7 @@ private IWriteOperation<BsonDocument> CreateCreateCollectionOperation<TDocument>
                     cco.AutoIndexId = options.AutoIndexId;
 #pragma warning restore CS0618 // Type or member is obsolete
                     cco.Capped = options.Capped;
+                    cco.ChangeStreamPreAndPostImages = options.ChangeStreamPreAndPostImagesOptions?.BackingDocument;
                     cco.ClusteredIndex = clusteredIndex;
                     cco.Collation = options.Collation;
                     cco.ExpireAfter = options.ExpireAfter;
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/CreateCollectionOperationTests.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/CreateCollectionOperationTests.cs
@@ -87,6 +87,7 @@ public void constructor_should_initialize_subject()
             subject.AutoIndexId.Should().NotHaveValue();
 #pragma warning restore
             subject.Capped.Should().NotHaveValue();
+            subject.ChangeStreamPreAndPostImages.Should().BeNull();
             subject.ClusteredIndex.Should().BeNull();
             subject.Collation.Should().BeNull();
             subject.EncryptedFields.Should().BeNull();
@@ -172,6 +173,29 @@ public void CreateCommand_should_return_expected_result_when_Capped_is_set(
             result.Should().Be(expectedResult);
         }
 
+        [Fact]
+        public void CreateCommand_should_return_expected_result_when_ChangeStreamsPreAndPost_is_set()
+        {
+            var subject = new CreateCollectionOperation(_collectionNamespace, _messageEncoderSettings)
+            {
+                ChangeStreamPreAndPostImages = new BsonDocument()
+                {
+                    { "key", "value" }
+                }
+            };
+
+            var session = OperationTestHelper.CreateSession();
+
+            var result = subject.CreateCommand(session);
+
+            var expectedResult = new BsonDocument
+            {
+                { "create", _collectionNamespace.CollectionName },
+                { "changeStreamPreAndPostImages", new BsonDocument() { { "key", "value" } } }
+            };
+            result.Should().Be(expectedResult);
+        }
+
         [Theory]
         [ParameterAttributeData]
         public void CreateCommand_should_return_expected_result_when_ClusteredIndex_is_set(
diff --git a/tests/MongoDB.Driver.Core.Tests/Core/Operations/OperationTestBase.cs b/tests/MongoDB.Driver.Core.Tests/Core/Operations/OperationTestBase.cs
@@ -68,19 +68,13 @@ public virtual void Dispose()
         protected void CreateCollection(CollectionNamespace collectionNamespace, bool changeStreamPreAndPostImages = false)
         {
             var operation = new CreateCollectionOperation(collectionNamespace, _messageEncoderSettings);
-            ExecuteOperation(operation);
 
             if (changeStreamPreAndPostImages)
             {
-                var command = new BsonDocument()
-                {
-                    { "collMod", _collectionNamespace.CollectionName },
-                    { "changeStreamPreAndPostImages", new BsonDocument() { { "enabled", true } } }
-                };
-
-                var collModOperation = new WriteCommandOperation<BsonDocument>(_collectionNamespace.DatabaseNamespace, command, BsonDocumentSerializer.Instance, _messageEncoderSettings);
-                ExecuteOperation(collModOperation);
+                operation.ChangeStreamPreAndPostImages = new BsonDocument() { { "enabled", true } };
             }
+
+            ExecuteOperation(operation);
         }
 
         protected void Delete(BsonDocument filter)
diff --git a/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs b/tests/MongoDB.Driver.Tests/MongoDatabaseImplTests.cs
@@ -397,11 +397,14 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
             var storageEngine = new BsonDocument("awesome", true);
             var validatorDocument = BsonDocument.Parse("{ x : 1 }");
             var validatorDefinition = (FilterDefinition<BsonDocument>)validatorDocument;
+            var changeStreamPreAndPostImagesOptions = new ChangeStreamPreAndPostImagesOptions { Enabled = true };
+
 #pragma warning disable 618
             var options = new CreateCollectionOptions<BsonDocument>
             {
                 AutoIndexId = false,
                 Capped = true,
+                ChangeStreamPreAndPostImagesOptions = changeStreamPreAndPostImagesOptions,
                 ClusteredIndex = clustered ? new ClusteredIndexOptions<BsonDocument>() : null,
                 Collation = new Collation("en_US"),
                 IndexOptionDefaults = new IndexOptionDefaults { StorageEngine = new BsonDocument("x", 1) },
@@ -449,6 +452,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
             op.AutoIndexId.Should().Be(options.AutoIndexId);
 #pragma warning restore
             op.Capped.Should().Be(options.Capped);
+            op.ChangeStreamPreAndPostImages.Should().Be(options.ChangeStreamPreAndPostImagesOptions.BackingDocument);
             if (clustered)
             {
                 op.ClusteredIndex.Should().NotBeNull();
@@ -531,6 +535,7 @@ public void CreateCollection_should_execute_a_CreateCollectionOperation_when_opt
             op.AutoIndexId.Should().Be(options.AutoIndexId);
 #pragma warning restore
             op.Capped.Should().Be(options.Capped);
+            op.ChangeStreamPreAndPostImages.Should().BeNull();
             op.ClusteredIndex.Should().BeNull();
             op.Collation.Should().BeSameAs(options.Collation);
             op.IndexOptionDefaults.ToBsonDocument().Should().Be(options.IndexOptionDefaults.ToBsonDocument());
diff --git a/tests/MongoDB.Driver.Tests/Specifications/collection-management/tests/createCollection-pre_and_post_images.json b/tests/MongoDB.Driver.Tests/Specifications/collection-management/tests/createCollection-pre_and_post_images.json
@@ -0,0 +1,92 @@
+{
+  "description": "createCollection-pre_and_post_images",
+  "schemaVersion": "1.4",
+  "runOnRequirements": [
+    {
+      "minServerVersion": "6.0",
+      "serverless": "forbid"
+    }
+  ],
+  "createEntities": [
+    {
+      "client": {
+        "id": "client0",
+        "observeEvents": [
+          "commandStartedEvent"
+        ]
+      }
+    },
+    {
+      "database": {
+        "id": "database0",
+        "client": "client0",
+        "databaseName": "papi-tests"
+      }
+    },
+    {
+      "collection": {
+        "id": "collection0",
+        "database": "database0",
+        "collectionName": "test"
+      }
+    }
+  ],
+  "tests": [
+    {
+      "description": "createCollection with changeStreamPreAndPostImages enabled",
+      "operations": [
+        {
+          "name": "dropCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test"
+          }
+        },
+        {
+          "name": "createCollection",
+          "object": "database0",
+          "arguments": {
+            "collection": "test",
+            "changeStreamPreAndPostImages": {
+              "enabled": true
+            }
+          }
+        },
+        {
+          "name": "assertCollectionExists",
+          "object": "testRunner",
+          "arguments": {
+            "databaseName": "papi-tests",
+            "collectionName": "test"
+          }
+        }
+      ],
+      "expectEvents": [
+        {
+          "client": "client0",
+          "events": [
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "drop": "test"
+                },
+                "databaseName": "papi-tests"
+              }
+            },
+            {
+              "commandStartedEvent": {
+                "command": {
+                  "create": "test",
+                  "changeStreamPreAndPostImages": {
+                    "enabled": true
+                  }
+                },
+                "databaseName": "papi-tests"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
diff --git a/tests/MongoDB.Driver.Tests/Specifications/collection-management/tests/createCollection-pre_and_post_images.yml b/tests/MongoDB.Driver.Tests/Specifications/collection-management/tests/createCollection-pre_and_post_images.yml
@@ -0,0 +1,50 @@
+description: "createCollection-pre_and_post_images"
+
+schemaVersion: "1.4"
+
+runOnRequirements:
+  - minServerVersion: "6.0"
+    serverless: forbid
+
+createEntities:
+  - client:
+      id: &client0 client0
+      observeEvents: [ commandStartedEvent ]
+  - database:
+      id: &database0 database0
+      client: *client0
+      databaseName: &database0Name papi-tests
+  - collection:
+      id: &collection0 collection0
+      database: *database0
+      collectionName: &collection0Name test
+
+tests:
+  - description: "createCollection with changeStreamPreAndPostImages enabled"
+    operations:
+      - name: dropCollection
+        object: *database0
+        arguments:
+          collection: *collection0Name
+      - name: createCollection
+        object: *database0
+        arguments:
+          collection: *collection0Name
+          changeStreamPreAndPostImages: { enabled: true }
+      - name: assertCollectionExists
+        object: testRunner
+        arguments:
+          databaseName: *database0Name
+          collectionName: *collection0Name
+    expectEvents:
+      - client: *client0
+        events:
+          - commandStartedEvent:
+              command:
+                drop: *collection0Name
+              databaseName: *database0Name
+          - commandStartedEvent:
+              command:
+                create: *collection0Name
+                changeStreamPreAndPostImages: { enabled: true }
+              databaseName: *database0Name
diff --git a/tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedCreateCollectionOperation.cs b/tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedCreateCollectionOperation.cs

Original file line number	Diff line number	Diff line change
`@@ -68,19 +68,13 @@ public virtual void Dispose()`
`68`	`68`	`protected void CreateCollection(CollectionNamespace collectionNamespace, bool changeStreamPreAndPostImages = false)`
`69`	`69`	`{`
`70`	`70`	`var operation = new CreateCollectionOperation(collectionNamespace, _messageEncoderSettings);`
`71`		`- ExecuteOperation(operation);`
`72`	`71`
`73`	`72`	`if (changeStreamPreAndPostImages)`
`74`	`73`	`{`
`75`		`- var command = new BsonDocument()`
`76`		`- {`
`77`		`- { "collMod", _collectionNamespace.CollectionName },`
`78`		`- { "changeStreamPreAndPostImages", new BsonDocument() { { "enabled", true } } }`
`79`		`- };`
`80`		`-`
`81`		`- var collModOperation = new WriteCommandOperation<BsonDocument>(_collectionNamespace.DatabaseNamespace, command, BsonDocumentSerializer.Instance, _messageEncoderSettings);`
`82`		`- ExecuteOperation(collModOperation);`
	`74`	`+ operation.ChangeStreamPreAndPostImages = new BsonDocument() { { "enabled", true } };`
`83`	`75`	`}`
	`76`	`+`
	`77`	`+ ExecuteOperation(operation);`
`84`	`78`	`}`
`85`	`79`
`86`	`80`	`protected void Delete(BsonDocument filter)`