CSHARP-2221: Update JSON driven transaction tests.

Author: rstam

src/MongoDB.Driver.Core/Core/Operations/EndTransactionOperation.cs

@@ -77,15 +77,33 @@ public MessageEncoderSettings MessageEncoderSettings
         /// <inheritdoc />
         public BsonDocument Execute(IReadBinding binding, CancellationToken cancellationToken)
         {
-            var operation = CreateOperation();
-            return operation.Execute(binding, cancellationToken);
+            Ensure.IsNotNull(binding, nameof(binding));
+
+            using (var channelSource = binding.GetReadChannelSource(cancellationToken))
+            using (var channel = channelSource.GetChannel(cancellationToken))
+            using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
+            {
+                var operation = CreateOperation();
+                var result = operation.Execute(channelBinding, cancellationToken);
+                WriteConcernErrorHelper.ThrowIfHasWriteConcernError(channel.ConnectionDescription.ConnectionId, result);
+                return result;
+            }
         }
 
         /// <inheritdoc />
-        public Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
+        public async Task<BsonDocument> ExecuteAsync(IReadBinding binding, CancellationToken cancellationToken)
         {
-            var operation = CreateOperation();
-            return operation.ExecuteAsync(binding, cancellationToken);
+            Ensure.IsNotNull(binding, nameof(binding));
+
+            using (var channelSource = await binding.GetReadChannelSourceAsync(cancellationToken).ConfigureAwait(false))
+            using (var channel = await channelSource.GetChannelAsync(cancellationToken).ConfigureAwait(false))
+            using (var channelBinding = new ChannelReadWriteBinding(channelSource.Server, channel, binding.Session.Fork()))
+            {
+                var operation = CreateOperation();
+                var result = await operation.ExecuteAsync(channelBinding, cancellationToken).ConfigureAwait(false);
+                WriteConcernErrorHelper.ThrowIfHasWriteConcernError(channel.ConnectionDescription.ConnectionId, result);
+                return result;
+            }
         }
 
         // private methods

src/MongoDB.Driver.Core/MongoCommandException.cs

@@ -100,7 +100,7 @@ public int Code
         /// </value>
         public string CodeName
         {
-            get { return _result.GetValue("codeName", null).AsString; }
+            get { return _result.GetValue("codeName", null)?.AsString; }
         }
 
         /// <summary>

tests/MongoDB.Bson.TestHelpers/JsonDrivenTests/JsonDrivenHelper.cs

@@ -31,5 +31,18 @@ public static void EnsureAllFieldsAreValid(BsonDocument document, params string[
                 }
             }
         }
+
+        public static void EnsureFieldEquals(BsonDocument document, string name, BsonValue value)
+        {
+            if (!document.Contains(name))
+            {
+                throw new FormatException($"Missing field: \"{name}\".");
+            }
+
+            if (!document[name].Equals(value))
+            {
+                throw new FormatException($"Field \"{name}\" has an invalid value: {value.ToJson()}.");
+            }
+        }
     }
 }

tests/MongoDB.Bson.TestHelpers/JsonDrivenTests/JsonDrivenTest.cs

@@ -0,0 +1,134 @@
+/* Copyright 2018-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 System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace MongoDB.Bson.TestHelpers.JsonDrivenTests
+{
+    public abstract class JsonDrivenTest
+    {
+        // protected fields
+        protected Exception _actualException;
+        protected BsonDocument _expectedException;
+        protected BsonValue _expectedResult;
+        protected Dictionary<string, object> _objectMap;
+
+        // constructors
+        protected JsonDrivenTest(Dictionary<string, object> objectMap = null)
+        {
+            _objectMap = objectMap;
+        }
+
+        // public methods
+        public virtual void Act(CancellationToken cancellationToken)
+        {
+            try
+            {
+                CallMethod(cancellationToken);
+            }
+            catch (Exception exception)
+            {
+                _actualException = exception;
+            }
+        }
+
+        public virtual async Task ActAsync(CancellationToken cancellationToken)
+        {
+            try
+            {
+                await CallMethodAsync(cancellationToken).ConfigureAwait(false);
+            }
+            catch (Exception exception)
+            {
+                _actualException = exception;
+            }
+        }
+
+        public virtual void Arrange(BsonDocument document)
+        {
+            if (document.Contains("arguments"))
+            {
+                SetArguments(document["arguments"].AsBsonDocument);
+            }
+
+            if (document.Contains("result"))
+            {
+                ParseExpectedResult(document["result"]);
+            }
+        }
+
+        public virtual void Assert()
+        {
+            if (_expectedException == null)
+            {
+                if (_actualException != null)
+                {
+                    throw new Exception("Unexpected exception was thrown.", _actualException);
+                }
+                AssertResult();
+            }
+            else
+            {
+                if (_actualException == null)
+                {
+                    throw new Exception("Expected an exception but none was thrown.");
+                }
+                AssertException();
+            }
+        }
+
+        // protected methods
+        protected virtual void AssertException()
+        {
+            throw new NotImplementedException();
+        }
+
+        protected virtual void AssertResult()
+        {
+            throw new NotImplementedException();
+        }
+
+        protected virtual void CallMethod(CancellationToken cancellationToken)
+        {
+            throw new NotImplementedException();
+        }
+
+        protected virtual Task CallMethodAsync(CancellationToken cancellationToken)
+        {
+            throw new NotImplementedException();
+        }
+
+        protected virtual void ParseExpectedResult(BsonValue value)
+        {
+            _expectedResult = value;
+        }
+
+        protected virtual void SetArgument(string name, BsonValue value)
+        {
+            throw new FormatException($"{GetType().Name} unexpected argument: \"{name}\".");
+        }
+
+        protected virtual void SetArguments(BsonDocument arguments)
+        {
+            foreach (var argument in arguments)
+            {
+                SetArgument(argument.Name, argument.Value);
+            }
+        }
+    }
+}

tests/MongoDB.Bson.TestHelpers/MongoDB.Bson.TestHelpers.csproj

@@ -89,6 +89,7 @@
     <Compile Include="JsonDrivenTests\AspectAsserter.cs" />
     <Compile Include="JsonDrivenTests\BsonDocumentAspectAsserter.cs" />
     <Compile Include="JsonDrivenTests\JsonDrivenHelper.cs" />
+    <Compile Include="JsonDrivenTests\JsonDrivenTest.cs" />
     <Compile Include="JsonDrivenTests\JsonDrivenTestCase.cs" />
     <Compile Include="JsonDrivenTests\JsonDrivenTestCaseFactory.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />

tests/MongoDB.Driver.Tests.Dotnet/Specifications/transactions/tests/README.rst

@@ -41,9 +41,19 @@ Each YAML file has the following keys:
   - ``operations``: Array of documents, each describing an operation to be
     executed. Each document has the following fields:
 
-      - ``name``: The name of the operation.
+      - ``name``: The name of the operation on ``object``.
 
-      - ``arguments``: The names and values of arguments.
+      - ``object``: The name of the object to perform the operation on. Can be
+        "database", collection", "session0", or "session1".
+
+      - ``collectionOptions``: Optional, parameters to pass to the Collection()
+        used for this operation.
+
+      - ``command_name``: Present only when ``name`` is "runCommand". The name
+        of the command to run. Required for languages that are unable preserve
+        the order keys in the "command" argument when parsing JSON/YAML.
+
+      - ``arguments``: Optional, the names and values of arguments.
 
       - ``result``: The return value from the operation, if any. If the
         operation is expected to return an error, the ``result`` has one field,
@@ -64,12 +74,14 @@ Each YAML file has the following keys:
 Use as integration tests
 ========================
 
-Run a MongoDB replica set with a primary, two secondaries, and an arbiter,
-server version 4.0 or later. (Including two secondaries ensures that transaction
-pinning works properly. Include an arbiter to ensure no new bugs have been
-introduced related to arbiters.)
+Run a MongoDB replica set with a primary, a secondary, and an arbiter,
+server version 4.0 or later. (Including a secondary ensures that server
+selection in a transaction works properly. Including an arbiter helps ensure
+that no new bugs have been introduced related to arbiters.)
+
+Load each YAML (or JSON) file using a Canonical Extended JSON parser.
 
-For each YAML file, for each element in ``tests``:
+Then for each element in ``tests``:
 
 #. Create a MongoClient and call
    ``client.admin.runCommand({killAllSessions: []})`` to clean up any open
@@ -96,34 +108,31 @@ For each YAML file, for each element in ``tests``:
 #. For each element in ``operations``:
 
    - Enter a "try" block or your programming language's closest equivalent.
-   - If ``name`` is "startTransaction", "commitTransaction", or
-     "abortTransaction", call the named method on ``session0`` or
-     ``session1``, depending on the "session" argument. 
-   - If ``name`` is "runCommand", call the runCommand method on the database
-     specified in the test. Pass the argument named "command" to the runCommand 
-     method. Pass ``session0`` or ``session1`` to the runCommand method, depending 
-     on which session's name is in the arguments list. If ``arguments`` 
-     contains no "session", pass no explicit session to the method. If ``arguments`` 
-     includes "readPreference", also pass the read preference to the runCommand 
-     method.    
-   - Otherwise, ``name`` refers to a CRUD method, such as ``insertOne``.
-     Execute the named method on the "transactions-tests" database on the "test"
-     collection, passing the arguments listed. Pass ``session0`` or ``session1``
-     to the method, depending on which session's name is in the arguments list.
+   - Create a Database object from the MongoClient, using the ``database_name``
+     field at the top level of the test file.
+   - Create a Collection object from the Database, using the
+     ``collection_name`` field at the top level of the test file.
+     If ``collectionOptions`` is present create the Collection object with the
+     provided options. Otherwise create the object with the default options.
+   - Execute the named method on the provided ``object``, passing the
+     arguments listed. Pass ``session0`` or ``session1`` to the method,
+     depending on which session's name is in the arguments list.
      If ``arguments`` contains no "session", pass no explicit session to the
-     method. If ``arguments`` includes "readPreference", configure the specified
-     read preference in whatever manner the driver supports.
+     method.
    - If the driver throws an exception / returns an error while executing this
      series of operations, store the error message and server error code.
    - If the result document has an "errorContains" field, verify that the
      method threw an exception or returned an error, and that the value of the
-     "errorContains" field matches the error string. If the result document has
-     an "errorCodeName" field, verify that the method threw a command failed
-     exception or returned an error, and that the value of the "errorCodeName"
-     field matches the "codeName" in the server error response.
+     "errorContains" field matches the error string. "errorContains" is a
+     substring (case-insensitive) of the actual error message.
+     If the result document has an "errorCodeName" field, verify that the
+     method threw a command failed exception or returned an error, and that
+     the value of the "errorCodeName" field matches the "codeName" in the
+     server error response.
+     If the operation returns a raw command response, eg from ``runCommand``,
+     then compare only the fields present in the expected result document.
      Otherwise, compare the method's return value to ``result`` using the same
-     logic as the CRUD Spec Tests runner. key is a substring (case-insensitive)
-     of the actual error message.
+     logic as the CRUD Spec Tests runner.
 
 #. Call ``session0.endSession()`` and ``session1.endSession``.
 #. If the test includes a list of command-started events in ``expectations``,