Clean up connection-churn yaml

prestonvasquez · prestonvasquez · commit 0e0785ce7333 · 2024-10-30T14:59:33.000-06:00
diff --git a/testdata/client-side-operations-timeout/connection-churn.json b/testdata/client-side-operations-timeout/connection-churn.json
@@ -1,5 +1,5 @@
 {
-  "description": "operation timeouts do not cause connection churn",
+  "description": "Operation timeouts do not cause connection churn",
   "schemaVersion": "1.9",
   "runOnRequirements": [
     {
@@ -57,7 +57,7 @@
   ],
   "tests": [
     {
-      "description": "write op with successful pending read",
+      "description": "Write operation with successful pending read",
       "operations": [
         {
           "name": "failPoint",
@@ -140,7 +140,7 @@
       ]
     },
     {
-      "description": "write op with unsuccessful pending read",
+      "description": "Write operation with unsuccessful pending read",
       "operations": [
         {
           "name": "failPoint",
@@ -222,7 +222,7 @@
       ]
     },
     {
-      "description": "read op with successful pending read",
+      "description": "Read operation with successful pending read",
       "operations": [
         {
           "name": "failPoint",
@@ -304,7 +304,7 @@
       ]
     },
     {
-      "description": "read op with unsuccessful pending read",
+      "description": "Read operation with unsuccessful pending read",
       "operations": [
         {
           "name": "failPoint",
diff --git a/testdata/client-side-operations-timeout/connection-churn.yml b/testdata/client-side-operations-timeout/connection-churn.yml
@@ -1,12 +1,12 @@
-description: "operation timeouts do not cause connection churn"
+description: "Operation timeouts do not cause connection churn"
 
 schemaVersion: "1.9"
 
 runOnRequirements:
   - minServerVersion: "4.4"
-    # TODO(SERVER-96344): when using failpoints mongos returns MaxTimeMSExpired 
-    # after maxTimeMS, whereas mongod returns MaxTimeMSExpired after 
-    # max(blockTimeMS, maxTimeMS). Until this ticket is resolved, these tests 
+    # TODO(SERVER-96344): When using failpoints, mongos returns MaxTimeMSExpired 
+    # after maxTimeMS, whereas mongod returns it after 
+    # max(blockTimeMS, maxTimeMS).  Until this ticket is resolved, these tests 
     # will not pass on sharded clusters.
     topologies: ["standalone", "replicaset"]
 
@@ -16,7 +16,7 @@ createEntities:
       useMultipleMongoses: false
   - client:
       id: &client client
-      uriOptions:  
+      uriOptions:
         maxPoolSize: 1
       useMultipleMongoses: false
       observeEvents:
@@ -40,9 +40,9 @@ initialData:
     documents: []
 
 tests:
-  - description: "write op with successful pending read"
+  - description: "Write operation with successful pending read"
     operations:
-      # Create a failpoint to block first op
+      # Create a failpoint to block the first operation
       - name: failPoint
         object: testRunner
         arguments:
@@ -55,7 +55,7 @@ tests:
               blockConnection: true
               blockTimeMS: 750
 
-      # Execute op with timeout < block time
+      # Execute operation with timeout less than block time
       - name: insertOne
         object: *collection
         arguments:
@@ -64,8 +64,7 @@ tests:
         expectError:
           isTimeoutError: true
 
-      # Execute a subsequent operation to complete the read when checking out 
-      # the single available connection.
+      # Execute a subsequent operation to complete the read
       - name: findOne
         object: *collection
         arguments:
@@ -80,15 +79,15 @@ tests:
               commandName: find
       - client: *client
         eventType: cmap
-        events: 
+        events:
           - connectionCheckedOutEvent: {} # insert
           - connectionCheckedInEvent: {}  # insert fails
           - connectionCheckedOutEvent: {} # find
           - connectionCheckedInEvent: {}  # find succeeds
 
-  - description: "write op with unsuccessful pending read"
+  - description: "Write operation with unsuccessful pending read"
     operations:
-      # Create a failpoint to block first op
+      # Create a failpoint to block the first operation
       - name: failPoint
         object: testRunner
         arguments:
@@ -101,7 +100,7 @@ tests:
               blockConnection: true
               blockTimeMS: 750
 
-      # Execute op with timeout < block time
+      # Execute operation with timeout less than block time
       - name: insertOne
         object: *collection
         arguments:
@@ -110,7 +109,7 @@ tests:
         expectError:
           isTimeoutError: true
 
-      # The pending read should fail.
+      # The pending read should fail
       - name: insertOne
         object: *collection
         arguments:
@@ -124,19 +123,19 @@ tests:
         events:
           - commandFailedEvent:
               commandName: insert
-          # There is not a second failed event since we T/O attempting to 
-          # check out the connection for the second operation.
+          # No second failed event since we timed out attempting to check out 
+          # the connection for the second operation
       - client: *client
         eventType: cmap
-        events: 
+        events:
           - connectionCheckedOutEvent: {} # first insert
           - connectionCheckedInEvent: {}  # first insert fails
-          - connectionClosedEvent:        # second insert T/O pending read in C/O, closes
+          - connectionClosedEvent:        # second insert times out pending read in checkout, closes
               reason: error
 
-  - description: "read op with successful pending read"
+  - description: "Read operation with successful pending read"
     operations:
-      # Create a failpoint to block first op 
+      # Create a failpoint to block the first operation
       - name: failPoint
         object: testRunner
         arguments:
@@ -149,7 +148,7 @@ tests:
               blockConnection: true
               blockTimeMS: 750
 
-      # Execute op with timeout < block time 
+      # Execute operation with timeout less than block time
       - name: findOne
         object: *collection
         arguments:
@@ -158,8 +157,7 @@ tests:
         expectError:
           isTimeoutError: true
 
-      # Execute a subsequent operation to complete the read when checking out 
-      # the single available connection.
+      # Execute a subsequent operation to complete the read
       - name: findOne
         object: *collection
         arguments:
@@ -174,15 +172,15 @@ tests:
               commandName: find
       - client: *client
         eventType: cmap
-        events: 
-          - connectionCheckedOutEvent: {} # first find 
+        events:
+          - connectionCheckedOutEvent: {} # first find
           - connectionCheckedInEvent: {}  # first find fails
           - connectionCheckedOutEvent: {} # second find
           - connectionCheckedInEvent: {}  # second find succeeds
 
-  - description: "read op with unsuccessful pending read"
+  - description: "Read operation with unsuccessful pending read"
     operations:
-      # Create a failpoint to block first op 
+      # Create a failpoint to block the first operation
       - name: failPoint
         object: testRunner
         arguments:
@@ -195,7 +193,7 @@ tests:
               blockConnection: true
               blockTimeMS: 750
 
-      # Execute op with timeout < block time 
+      # Execute operation with timeout less than block time
       - name: findOne
         object: *collection
         arguments:
@@ -204,7 +202,7 @@ tests:
         expectError:
           isTimeoutError: true
 
-      # The pending read should fail.
+      # The pending read should fail
       - name: findOne
         object: *collection
         arguments:
@@ -218,12 +216,12 @@ tests:
         events:
           - commandFailedEvent:
               commandName: find
-          # There is not a second failed event since we T/O attempting to 
-          # check out the connection for the second operation.
+          # No second failed event since we timed out attempting to check out 
+          # the connection for the second operation
       - client: *client
         eventType: cmap
-        events: 
-          - connectionCheckedOutEvent: {} # first find 
+        events:
+          - connectionCheckedOutEvent: {} # first find
           - connectionCheckedInEvent: {}  # first find fails
-          - connectionClosedEvent:        # second find T/O pending read in C/O, closes
+          - connectionClosedEvent:        # second find times out pending read in checkout, closes
               reason: error

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "description": "operation timeouts do not cause connection churn",`
	`2`	`+ "description": "Operation timeouts do not cause connection churn",`
`3`	`3`	`"schemaVersion": "1.9",`
`4`	`4`	`"runOnRequirements": [`
`5`	`5`	`{`
`@@ -57,7 +57,7 @@`
`57`	`57`	`],`
`58`	`58`	`"tests": [`
`59`	`59`	`{`
`60`		`- "description": "write op with successful pending read",`
	`60`	`+ "description": "Write operation with successful pending read",`
`61`	`61`	`"operations": [`
`62`	`62`	`{`
`63`	`63`	`"name": "failPoint",`
`@@ -140,7 +140,7 @@`
`140`	`140`	`]`
`141`	`141`	`},`
`142`	`142`	`{`
`143`		`- "description": "write op with unsuccessful pending read",`
	`143`	`+ "description": "Write operation with unsuccessful pending read",`
`144`	`144`	`"operations": [`
`145`	`145`	`{`
`146`	`146`	`"name": "failPoint",`
`@@ -222,7 +222,7 @@`
`222`	`222`	`]`
`223`	`223`	`},`
`224`	`224`	`{`
`225`		`- "description": "read op with successful pending read",`
	`225`	`+ "description": "Read operation with successful pending read",`
`226`	`226`	`"operations": [`
`227`	`227`	`{`
`228`	`228`	`"name": "failPoint",`
`@@ -304,7 +304,7 @@`
`304`	`304`	`]`
`305`	`305`	`},`
`306`	`306`	`{`
`307`		`- "description": "read op with unsuccessful pending read",`
	`307`	`+ "description": "Read operation with unsuccessful pending read",`
`308`	`308`	`"operations": [`
`309`	`309`	`{`
`310`	`310`	`"name": "failPoint",`