CSHARP-3523: Split the unified test runner into 2 classes. (mongodb#511)

DmitryLukyanov · web-flow · commit 2fd7d0661e61 · 2021-04-30T18:43:04.000+03:00
diff --git a/tests/AstrolabeWorkloadExecutor/Program.cs b/tests/AstrolabeWorkloadExecutor/Program.cs
@@ -24,7 +24,6 @@
 using MongoDB.Driver;
 using MongoDB.Driver.Core;
 using MongoDB.Driver.Core.Misc;
-using MongoDB.Driver.Tests.Specifications.unified_test_format;
 using MongoDB.Driver.Tests.UnifiedTestOperations;
 
 namespace WorkloadExecutor
@@ -113,16 +112,16 @@ private static (string EventsJson, string ResultsJson) ExecuteWorkload(string co
             {
                 { "events", new AstrolabeEventFormatter() } // "events" matches to the "storeEventsAsEntities.id" in the driverWorkload document
             };
-            using (var testRunner = new UnifiedTestFormatTestRunner(
+            using (var runner = new UnifiedTestRunner(
                 allowKillSessions: false,
                 additionalArgs: additionalArgs,
                 eventFormatters: eventFormatters))
             {
                 var factory = new TestCaseFactory();
                 var testCase = factory.CreateTestCase(driverWorkload, async);
-                testRunner.Run(testCase);
+                runner.Run(testCase);
                 Console.WriteLine("dotnet ExecuteWorkload> Returning...");
-                return CreateWorkloadResult(entityMap: testRunner.EntityMap);
+                return CreateWorkloadResult(entityMap: runner.EntityMap);
             }
         }
 
diff --git a/tests/MongoDB.Driver.Tests/Specifications/change-streams/ChangeStreamUnifiedTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/change-streams/ChangeStreamUnifiedTestRunner.cs
@@ -16,18 +16,18 @@
 using System.Collections.Generic;
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.JsonDrivenTests;
-using MongoDB.Driver.Tests.Specifications.unified_test_format;
+using MongoDB.Driver.Tests.UnifiedTestOperations;
 using Xunit;
 
-namespace MongoDB.Driver.Tests.Specifications.crud.Unified
+namespace MongoDB.Driver.Tests.Specifications.change_streams
 {
     public sealed class ChangeStreamUnifiedTestRunner
     {
         [SkippableTheory]
         [ClassData(typeof(TestCaseFactory))]
         public void Run(JsonDrivenTestCase testCase)
         {
-            using (var runner = new UnifiedTestFormatTestRunner())
+            using (var runner = new UnifiedTestRunner())
             {
                 runner.Run(testCase);
             }
diff --git a/tests/MongoDB.Driver.Tests/Specifications/crud/CrudUnifiedTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/crud/CrudUnifiedTestRunner.cs
@@ -16,7 +16,7 @@
 using System.Collections.Generic;
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.JsonDrivenTests;
-using MongoDB.Driver.Tests.Specifications.unified_test_format;
+using MongoDB.Driver.Tests.UnifiedTestOperations;
 using Xunit;
 
 namespace MongoDB.Driver.Tests.Specifications.crud
@@ -27,7 +27,7 @@ public sealed class CrudUnifiedTestRunner
         [ClassData(typeof(TestCaseFactory))]
         public void Run(JsonDrivenTestCase testCase)
         {
-            using (var runner = new UnifiedTestFormatTestRunner())
+            using (var runner = new UnifiedTestRunner())
             {
                 runner.Run(testCase);
             }
diff --git a/tests/MongoDB.Driver.Tests/Specifications/unified-test-format/UnifiedTestFormatValidFailTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/unified-test-format/UnifiedTestFormatValidFailTestRunner.cs
@@ -13,31 +13,26 @@
 * limitations under the License.
 */
 
-using System;
 using System.Collections.Generic;
 using FluentAssertions;
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.JsonDrivenTests;
+using MongoDB.Driver.Tests.UnifiedTestOperations;
 using Xunit;
 
 namespace MongoDB.Driver.Tests.Specifications.unified_test_format
 {
-    public sealed class UnifiedTestFormatNegativeTestRunner : IDisposable
+    public sealed class UnifiedTestFormatValidFailTestRunner
     {
-        private readonly UnifiedTestFormatTestRunner _unifiedTestFormatTestRunner = new UnifiedTestFormatTestRunner();
-
-        public void Dispose()
-        {
-            _unifiedTestFormatTestRunner.Dispose();
-        }
-
         [Theory]
         [ClassData(typeof(TestCaseFactory))]
         public void Run(JsonDrivenTestCase testCase)
         {
-            var exception = Record.Exception(() => _unifiedTestFormatTestRunner.Run(testCase));
-
-            exception.Should().NotBeNull();
+            using (var runner = new UnifiedTestRunner())
+            {
+                var exception = Record.Exception(() => runner.Run(testCase));
+                exception.Should().NotBeNull();
+            }
         }
 
         // nested types
diff --git a/tests/MongoDB.Driver.Tests/Specifications/unified-test-format/UnifiedTestFormatValidPassTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/unified-test-format/UnifiedTestFormatValidPassTestRunner.cs
@@ -0,0 +1,59 @@
+﻿/* Copyright 2020-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.Collections.Generic;
+using System.Linq;
+using MongoDB.Bson;
+using MongoDB.Bson.TestHelpers.JsonDrivenTests;
+using MongoDB.Driver.Tests.UnifiedTestOperations;
+using Xunit;
+
+namespace MongoDB.Driver.Tests.Specifications.unified_test_format
+{
+    public sealed class UnifiedTestFormatValidPassTestRunner
+    {
+        [SkippableTheory]
+        [ClassData(typeof(TestCaseFactory))]
+        public void Run(JsonDrivenTestCase testCase)
+        {
+            using (var runner = new UnifiedTestRunner())
+            {
+                runner.Run(testCase);
+            }
+        }
+
+        // nested types
+        public class TestCaseFactory : JsonDrivenTestCaseFactory
+        {
+            // protected properties
+            protected override string PathPrefix => "MongoDB.Driver.Tests.Specifications.unified_test_format.tests.valid_pass.";
+
+            // protected methods
+            protected override IEnumerable<JsonDrivenTestCase> CreateTestCases(BsonDocument document)
+            {
+                var testCases = base.CreateTestCases(document);
+                foreach (var testCase in testCases)
+                {
+                    foreach (var async in new[] { false, true })
+                    {
+                        var name = $"{testCase.Name.Replace(PathPrefix, "")}:async={async}";
+                        var test = testCase.Test.DeepClone().AsBsonDocument.Add("async", async);
+                        yield return new JsonDrivenTestCase(name, testCase.Shared, test);
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/tests/MongoDB.Driver.Tests/Specifications/versioned-api/VersionedApiUnifiedTestRunner.cs b/tests/MongoDB.Driver.Tests/Specifications/versioned-api/VersionedApiUnifiedTestRunner.cs
@@ -16,7 +16,7 @@
 using System.Collections.Generic;
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.JsonDrivenTests;
-using MongoDB.Driver.Tests.Specifications.unified_test_format;
+using MongoDB.Driver.Tests.UnifiedTestOperations;
 using Xunit;
 
 namespace MongoDB.Driver.Tests.Specifications.versioned_api
@@ -27,7 +27,7 @@ public sealed class VersionedApiUnifiedTestRunner
         [ClassData(typeof(TestCaseFactory))]
         public void Run(JsonDrivenTestCase testCase)
         {
-            using (var runner = new UnifiedTestFormatTestRunner())
+            using (var runner = new UnifiedTestRunner())
             {
                 runner.Run(testCase);
             }
diff --git a/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedErrorMatcher.cs b/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedErrorMatcher.cs
@@ -20,7 +20,7 @@
 using MongoDB.Bson;
 using MongoDB.Bson.TestHelpers.XunitExtensions;
 
-namespace MongoDB.Driver.Tests.Specifications.unified_test_format
+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers
 {
     public class UnifiedErrorMatcher
     {
diff --git a/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedEventMatcher.cs b/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedEventMatcher.cs
@@ -22,7 +22,7 @@
 using MongoDB.Driver.Core.Events;
 using Xunit.Sdk;
 
-namespace MongoDB.Driver.Tests.Specifications.unified_test_format
+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers
 {
     public class UnifiedEventMatcher
     {
diff --git a/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedValueMatcher.cs b/tests/MongoDB.Driver.Tests/UnifiedTestOperations/Matchers/UnifiedValueMatcher.cs
@@ -20,10 +20,10 @@
 using MongoDB.Bson;
 using MongoDB.Bson.IO;
 using MongoDB.Bson.TestHelpers.XunitExtensions;
-using MongoDB.Driver.Tests.UnifiedTestOperations;
+using MongoDB.Driver;
 using Xunit.Sdk;
 
-namespace MongoDB.Driver.Tests.Specifications.unified_test_format
+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers
 {
     public class UnifiedValueMatcher
     {
diff --git a/tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedTestRunner.cs b/tests/MongoDB.Driver.Tests/UnifiedTestOperations/UnifiedTestRunner.cs
@@ -1,4 +1,4 @@
-﻿/* Copyright 2020-present MongoDB Inc.
+﻿/* Copyright 2021-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.
@@ -25,12 +25,12 @@
 using MongoDB.Driver.Core.Misc;
 using MongoDB.Driver.Core.TestHelpers;
 using MongoDB.Driver.Core.TestHelpers.XunitExtensions;
-using MongoDB.Driver.Tests.UnifiedTestOperations;
+using MongoDB.Driver.Tests.UnifiedTestOperations.Matchers;
 using Xunit;
 
-namespace MongoDB.Driver.Tests.Specifications.unified_test_format
+namespace MongoDB.Driver.Tests.UnifiedTestOperations
 {
-    public sealed class UnifiedTestFormatTestRunner : IDisposable
+    public sealed class UnifiedTestRunner : IDisposable
     {
         private readonly bool _allowKillSessions;
         private UnifiedEntityMap _entityMap;
@@ -39,7 +39,7 @@ public sealed class UnifiedTestFormatTestRunner : IDisposable
         private readonly Dictionary<string, IEventFormatter> _eventFormatters;
         private bool _runHasBeenCalled;
 
-        public UnifiedTestFormatTestRunner(
+        public UnifiedTestRunner(
             bool allowKillSessions = true, // TODO: should be removed after SERVER-54216 
             Dictionary<string, object> additionalArgs = null,
             Dictionary<string, IEventFormatter> eventFormatters = null)
@@ -52,8 +52,6 @@ public UnifiedTestFormatTestRunner(
         // public properties
         public UnifiedEntityMap EntityMap => _entityMap;
 
-        [SkippableTheory]
-        [ClassData(typeof(TestCaseFactory))]
         public void Run(JsonDrivenTestCase testCase)
         {
             // Top-level fields
@@ -324,34 +322,5 @@ private void KillOpenTransactions(IMongoClient client)
                 }
             }
         }
-
-        // nested types
-        public class TestCaseFactory : JsonDrivenTestCaseFactory
-        {
-            #region static
-            private static readonly string[] __ignoredTestNames =
-            {
-                "poc-retryable-writes.json:InsertOne fails after multiple retryable writeConcernErrors" // CSHARP-3269
-            };
-            #endregion
-
-            // protected properties
-            protected override string PathPrefix => "MongoDB.Driver.Tests.Specifications.unified_test_format.tests.valid_pass.";
-
-            // protected methods
-            protected override IEnumerable<JsonDrivenTestCase> CreateTestCases(BsonDocument document)
-            {
-                var testCases = base.CreateTestCases(document).Where(test => !__ignoredTestNames.Any(ignoredName => test.Name.EndsWith(ignoredName)));
-                foreach (var testCase in testCases)
-                {
-                    foreach (var async in new[] { false, true })
-                    {
-                        var name = $"{testCase.Name.Replace(PathPrefix, "")}:async={async}";
-                        var test = testCase.Test.DeepClone().AsBsonDocument.Add("async", async);
-                        yield return new JsonDrivenTestCase(name, testCase.Shared, test);
-                    }
-                }
-            }
-        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -16,18 +16,18 @@`
`16`	`16`	`using System.Collections.Generic;`
`17`	`17`	`using MongoDB.Bson;`
`18`	`18`	`using MongoDB.Bson.TestHelpers.JsonDrivenTests;`
`19`		`-using MongoDB.Driver.Tests.Specifications.unified_test_format;`
	`19`	`+using MongoDB.Driver.Tests.UnifiedTestOperations;`
`20`	`20`	`using Xunit;`
`21`	`21`
`22`		`-namespace MongoDB.Driver.Tests.Specifications.crud.Unified`
	`22`	`+namespace MongoDB.Driver.Tests.Specifications.change_streams`
`23`	`23`	`{`
`24`	`24`	`public sealed class ChangeStreamUnifiedTestRunner`
`25`	`25`	`{`
`26`	`26`	`[SkippableTheory]`
`27`	`27`	`[ClassData(typeof(TestCaseFactory))]`
`28`	`28`	`public void Run(JsonDrivenTestCase testCase)`
`29`	`29`	`{`
`30`		`- using (var runner = new UnifiedTestFormatTestRunner())`
	`30`	`+ using (var runner = new UnifiedTestRunner())`
`31`	`31`	`{`
`32`	`32`	`runner.Run(testCase);`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`using System.Collections.Generic;`
`17`	`17`	`using MongoDB.Bson;`
`18`	`18`	`using MongoDB.Bson.TestHelpers.JsonDrivenTests;`
`19`		`-using MongoDB.Driver.Tests.Specifications.unified_test_format;`
	`19`	`+using MongoDB.Driver.Tests.UnifiedTestOperations;`
`20`	`20`	`using Xunit;`
`21`	`21`
`22`	`22`	`namespace MongoDB.Driver.Tests.Specifications.crud`
`@@ -27,7 +27,7 @@ public sealed class CrudUnifiedTestRunner`
`27`	`27`	`[ClassData(typeof(TestCaseFactory))]`
`28`	`28`	`public void Run(JsonDrivenTestCase testCase)`
`29`	`29`	`{`
`30`		`- using (var runner = new UnifiedTestFormatTestRunner())`
	`30`	`+ using (var runner = new UnifiedTestRunner())`
`31`	`31`	`{`
`32`	`32`	`runner.Run(testCase);`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`using MongoDB.Bson;`
`21`	`21`	`using MongoDB.Bson.TestHelpers.XunitExtensions;`
`22`	`22`
`23`		`-namespace MongoDB.Driver.Tests.Specifications.unified_test_format`
	`23`	`+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers`
`24`	`24`	`{`
`25`	`25`	`public class UnifiedErrorMatcher`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`using MongoDB.Driver.Core.Events;`
`23`	`23`	`using Xunit.Sdk;`
`24`	`24`
`25`		`-namespace MongoDB.Driver.Tests.Specifications.unified_test_format`
	`25`	`+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers`
`26`	`26`	`{`
`27`	`27`	`public class UnifiedEventMatcher`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,10 @@`
`20`	`20`	`using MongoDB.Bson;`
`21`	`21`	`using MongoDB.Bson.IO;`
`22`	`22`	`using MongoDB.Bson.TestHelpers.XunitExtensions;`
`23`		`-using MongoDB.Driver.Tests.UnifiedTestOperations;`
	`23`	`+using MongoDB.Driver;`
`24`	`24`	`using Xunit.Sdk;`
`25`	`25`
`26`		`-namespace MongoDB.Driver.Tests.Specifications.unified_test_format`
	`26`	`+namespace MongoDB.Driver.Tests.UnifiedTestOperations.Matchers`
`27`	`27`	`{`
`28`	`28`	`public class UnifiedValueMatcher`
`29`	`29`	`{`