CSHARP-2626: Use runOn syntax to specify transaction test requirements.

Author: rstam

tests/MongoDB.Driver.Tests/Specifications/Runner/MongoClientJsonDrivenSessionsTestRunner.cs

@@ -25,7 +25,7 @@ public abstract class MongoClientJsonDrivenSessionsTestRunner : MongoClientJsonD
     {
         private const string SessionIdKeySuffix = "__ClientSessionId";
 
-        protected override string[] ExpectedTestColumns => new[] { "description", "clientOptions", "failPoint", "sessionOptions", "operations", "expectations", "outcome", "async" };
+        protected override string[] ExpectedTestColumns => new[] { "description", "clientOptions", "useMultipleMongoses", "failPoint", "sessionOptions", "operations", "expectations", "outcome", "async" };
 
         // protected methods`
         protected override void TestInitialize()

tests/MongoDB.Driver.Tests/Specifications/Runner/MongoClientJsonDrivenTestRunnerBase.cs

@@ -57,7 +57,7 @@ public abstract class MongoClientJsonDrivenTestRunnerBase
             "getnonce"
         };
 
-        private readonly string[] _expectedSharedColumns = { "_path", "database_name", "collection_name", "data", "tests", "minServerVersion" };
+        private readonly string[] _expectedSharedColumns = { "_path", "runOn", "database_name", "collection_name", "data", "tests" };
 
         private string DatabaseName { get; set; }
         private string CollectionName { get; set; }
@@ -147,12 +147,11 @@ protected virtual void AssertOutcome(BsonDocument test)
 
         protected virtual void CheckServerRequirements(BsonDocument document)
         {
-            if (document.Contains("minServerVersion"))
+            if (document.TryGetValue("runOn", out var runOn))
             {
-                var minServerVersion = document["minServerVersion"].AsString;
-                RequireServer.Check().VersionGreaterThanOrEqualTo(minServerVersion);
+                RequireServer.Check().RunOn(runOn.AsBsonArray);
             }
-        }
+       }
 
         protected virtual void ConfigureClientSettings(MongoClientSettings settings, BsonDocument test)
         {
@@ -269,14 +268,17 @@ protected void CreateCollection()
 
         protected DisposableMongoClient CreateDisposableClient(BsonDocument test, EventCapturer eventCapturer)
         {
-            return DriverTestConfiguration.CreateDisposableClient(settings =>
-            {
-                ConfigureClientSettings(settings, test);
-                if (eventCapturer != null)
+            var useMultipleShardRouters = test.GetValue("useMultipleMongoses", false).AsBoolean;
+            return DriverTestConfiguration.CreateDisposableClient(
+                settings =>
                 {
-                    settings.ClusterConfigurator = c => c.Subscribe(eventCapturer);
-                }
-            });
+                    ConfigureClientSettings(settings, test);
+                    if (eventCapturer != null)
+                    {
+                        settings.ClusterConfigurator = c => c.Subscribe(eventCapturer);
+                    }
+                },
+                useMultipleShardRouters);
         }
 
         protected void DropCollection()
@@ -354,6 +356,9 @@ private ReadPreference ReadPreferenceFromBsonValue(BsonValue value)
 
         private void SetupAndRunTest(BsonDocument shared, BsonDocument test)
         {
+            JsonDrivenHelper.EnsureAllFieldsAreValid(shared, ExpectedSharedColumns);
+            JsonDrivenHelper.EnsureAllFieldsAreValid(test, ExpectedTestColumns);
+
             if (test.Contains(SkipReasonKey))
             {
                 throw new SkipException(test[SkipReasonKey].AsString);
@@ -362,8 +367,6 @@ private void SetupAndRunTest(BsonDocument shared, BsonDocument test)
             Ensure.IsNotNullOrEmpty(DatabaseNameKey, nameof(DatabaseNameKey));
             Ensure.IsNotNullOrEmpty(CollectionNameKey, nameof(CollectionNameKey));
 
-            JsonDrivenHelper.EnsureAllFieldsAreValid(shared, ExpectedSharedColumns);
-            JsonDrivenHelper.EnsureAllFieldsAreValid(test, ExpectedTestColumns);
             CustomDataValidation(shared, test);
 
             DatabaseName = shared[DatabaseNameKey].AsString;

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/TransactionsConvenientApiTestRunner.cs

@@ -34,21 +34,6 @@ public void Run(JsonDrivenTestCase testCase)
             SetupAndRunTest(testCase);
         }
 
-        protected override void CheckServerRequirements(BsonDocument document)
-        {
-            base.CheckServerRequirements(document);
-            var clusterType = CoreTestConfiguration.Cluster.Description.Type;
-            RequireServer.Check().ClusterTypes(ClusterType.ReplicaSet, ClusterType.Sharded);
-            if (clusterType == ClusterType.ReplicaSet)
-            {
-                RequireServer.Check().Supports(Feature.Transactions);
-            }
-            else if (clusterType == ClusterType.Sharded)
-            {
-                RequireServer.Check().Supports(Feature.ShardedTransactions);
-            }
-        }
-
         protected override void RunTest(BsonDocument shared, BsonDocument test, EventCapturer eventCapturer)
         {
             using (var client = CreateDisposableClient(test, eventCapturer))

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/README.rst

@@ -28,16 +28,33 @@ Test Format
 
 Each YAML file has the following keys:
 
+- ``runOn`` (optional): An array of server version and/or topology requirements
+  for which the tests can be run. If the test environment satisfies one or more
+  of these requirements, the tests may be executed; otherwise, this file should
+  be skipped. If this field is omitted, the tests can be assumed to have no
+  particular requirements and should be executed. Each element will have some or
+  all of the following fields:
+
+  - ``minServerVersion`` (optional): The minimum server version (inclusive)
+    required to successfully run the tests. If this field is omitted, it should
+    be assumed that there is no lower bound on the required server version.
+
+  - ``maxServerVersion`` (optional): The maximum server version (inclusive)
+    against which the tests can be run successfully. If this field is omitted,
+    it should be assumed that there is no upper bound on the required server
+    version.
+
+  - ``topology`` (optional): An array of server topologies against which the
+    tests can be run successfully. Valid topologies are "single", "replicaset",
+    and "sharded". If this field is omitted, the default is all topologies (i.e.
+    ``["single", "replicaset", "sharded"]``).
+
 - ``database_name`` and ``collection_name``: The database and collection to use
   for testing.
 
 - ``data``: The data that should exist in the collection under test before each
   test run.
 
-- ``minServerVersion`` (optional): The minimum server version (inclusive)
-  required to successfully run the test. If this field is not present, it should
-  be assumed that there is no lower bound on the required server version.
-
 - ``tests``: An array of tests that are to be run independently of each other.
   Each test will have some or all of the following fields:
 
@@ -47,7 +64,13 @@ Each YAML file has the following keys:
     string value will specify a reason.
 
   - ``failPoint`` (optional): The ``configureFailPoint`` command document to run
-    to configure a fail point on the primary server.
+    to configure a fail point on the primary server. This option and
+    ``useMultipleMongoses: true`` are mutually exclusive.
+
+  - ``useMultipleMongoses`` (optional): If ``true``, the MongoClient for this
+    test should be initialized with multiple mongos seed addresses. If ``false``
+    or omitted, only a single mongos address should be specified. This field has
+    no effect for non-sharded topologies.
 
   - ``clientOptions`` (optional): Names and values of options to pass to
     ``MongoClient()``.
@@ -186,3 +209,12 @@ should be checked:
  by internally modifying the timeout value used by ``withTransaction`` with some
  private API or using a mock timer.
 
+Changelog
+=========
+
+:2019-03-01: Add top-level ``runOn`` field to denote server version and/or
+             topology requirements requirements for the test file. Removes the
+             ``minServerVersion`` top-level field, which is now expressed within
+             ``runOn`` elements.
+
+             Add top-level ``useMultipleMongoses`` field.

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-aborts.json

@@ -1,10 +1,25 @@
 {
+  "runOn": [
+    {
+      "minServerVersion": "4.0",
+      "topology": [
+        "replicaset"
+      ]
+    },
+    {
+      "minServerVersion": "4.1.8",
+      "topology": [
+        "sharded"
+      ]
+    }
+  ],
   "database_name": "withTransaction-tests",
   "collection_name": "test",
   "data": [],
   "tests": [
     {
       "description": "withTransaction succeeds if callback aborts",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",
@@ -84,6 +99,7 @@
     },
     {
       "description": "withTransaction succeeds if callback aborts with no ops",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",
@@ -109,6 +125,7 @@
     },
     {
       "description": "withTransaction still succeeds if callback aborts and runs extra op",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-aborts.yml

@@ -1,3 +1,11 @@
+runOn:
+    -
+        minServerVersion: "4.0"
+        topology: ["replicaset"]
+    -
+        minServerVersion: "4.1.8"
+        topology: ["sharded"]
+
 database_name: &database_name "withTransaction-tests"
 collection_name: &collection_name "test"
 
@@ -7,6 +15,7 @@ tests:
   -
     # Session state will be ABORTED when callback returns to withTransaction
     description: withTransaction succeeds if callback aborts
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction
@@ -61,6 +70,7 @@ tests:
   -
     # Session state will be ABORTED when callback returns to withTransaction
     description: withTransaction succeeds if callback aborts with no ops
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction
@@ -78,6 +88,7 @@ tests:
   -
     # Session state will be NO_TXN when callback returns to withTransaction
     description: withTransaction still succeeds if callback aborts and runs extra op
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-commits.json

@@ -1,10 +1,25 @@
 {
+  "runOn": [
+    {
+      "minServerVersion": "4.0",
+      "topology": [
+        "replicaset"
+      ]
+    },
+    {
+      "minServerVersion": "4.1.8",
+      "topology": [
+        "sharded"
+      ]
+    }
+  ],
   "database_name": "withTransaction-tests",
   "collection_name": "test",
   "data": [],
   "tests": [
     {
       "description": "withTransaction succeeds if callback commits",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",
@@ -127,6 +142,7 @@
     },
     {
       "description": "withTransaction still succeeds if callback commits and runs extra op",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-commits.yml

@@ -1,3 +1,11 @@
+runOn:
+    -
+        minServerVersion: "4.0"
+        topology: ["replicaset"]
+    -
+        minServerVersion: "4.1.8"
+        topology: ["sharded"]
+
 database_name: &database_name "withTransaction-tests"
 collection_name: &collection_name "test"
 
@@ -7,6 +15,7 @@ tests:
   -
     # Session state will be COMMITTED when callback returns to withTransaction
     description: withTransaction succeeds if callback commits
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction
@@ -87,6 +96,7 @@ tests:
   -
     # Session state will be NO_TXN when callback returns to withTransaction
     description: withTransaction still succeeds if callback commits and runs extra op
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-retry.json

@@ -1,4 +1,18 @@
 {
+  "runOn": [
+    {
+      "minServerVersion": "4.0",
+      "topology": [
+        "replicaset"
+      ]
+    },
+    {
+      "minServerVersion": "4.1.8",
+      "topology": [
+        "sharded"
+      ]
+    }
+  ],
   "database_name": "withTransaction-tests",
   "collection_name": "test",
   "data": [],
@@ -177,6 +191,7 @@
     },
     {
       "description": "callback is not retried after non-transient error (DuplicateKeyError)",
+      "useMultipleMongoses": true,
       "operations": [
         {
           "name": "withTransaction",

tests/MongoDB.Driver.Tests/Specifications/transactions-convenient-api/tests/callback-retry.yml

@@ -1,3 +1,11 @@
+runOn:
+    -
+        minServerVersion: "4.0"
+        topology: ["replicaset"]
+    -
+        minServerVersion: "4.1.8"
+        topology: ["sharded"]
+
 database_name: &database_name "withTransaction-tests"
 collection_name: &collection_name "test"
 
@@ -127,6 +135,7 @@ tests:
           - { _id: 1 }
   -
     description: callback is not retried after non-transient error (DuplicateKeyError)
+    useMultipleMongoses: true
     operations:
       -
         name: withTransaction