CXX-1390 Support arrayFilters

Author: kevinAlbs

data/crud/README.rst

@@ -12,18 +12,6 @@ define and setup. Therefore, these YAML tests are in no way a replacement for
 more thorough testing. However, they can provide an initial verification of your
 implementation.
 
-Converting to JSON
-==================
-
-The tests are written in YAML because it is easier for humans to write and read,
-and because YAML includes a standard comment format. A JSONified version of each
-YAML file is included in this repository. Whenever a YAML file is modified, the
-corresponding JSON file should be regenerated. One method to convert to JSON is
-using `yamljs <https://www.npmjs.com/package/yamljs>`_::
-
-    npm install -g yamljs
-    yaml2json -s -p -r .
-
 Version
 =======
 
@@ -44,13 +32,14 @@ Each YAML file has the following keys:
 - ``data``: The data that should exist in the collection under test before each
   test run.
 
-- ``minServerVersion`` (optional): The minimum server version required to
-  successfully run the test. If this field is not present, it should be assumed
-  that there is no lower bound on the server version required.
+- ``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.
 
-- ``maxServerVersion`` (optional): The max server version against which this
-  test can run successfully. If this field is not present, it should be assumed
-  that there is no upper bound on the server version required.
+- ``maxServerVersion`` (optional): The maximum server version (exclusive)
+  against which this test can run successfully. If this field is not present,
+  it should be assumed that there is no upper 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:
@@ -68,7 +57,11 @@ Each YAML file has the following keys:
     the collection after the operation is executed. This will have some or all
     of the following fields:
 
-      - ``result``: The return value from the operation.
+        - ``result``: The return value from the operation. Note that some tests
+          specify an ``upsertedCount`` field when the server does not provide
+          one in the result document. In these cases, an ``upsertedCount`` field
+          with a value of 0 should be manually added to the document received
+          from the server to facilitate comparison.
 
       - ``collection``:
 
@@ -83,6 +76,5 @@ Use as integration tests
 
 Running these as integration tests will require a running mongod server. Each of
 these tests is valid against a standalone mongod, a replica set, and a sharded
-system for server version 3.0.0. Many of them will run against 2.4 and 2.6, but
-some will require conditional code. For instance, ``$out`` is not supported in
-an aggregation pipeline in server 2.4, so that test must be skipped.
+system for server version 3.0 and later. Many of them will run against 2.6, but
+some will require conditional code.

data/crud/read/aggregate-collation.json

@@ -35,4 +35,4 @@
       }
     }
   ]
-}
+}

data/crud/read/aggregate-out.json

@@ -65,6 +65,57 @@
           ]
         }
       }
+    },
+    {
+      "description": "Aggregate with $out and batch size of 0",
+      "operation": {
+        "name": "aggregate",
+        "arguments": {
+          "pipeline": [
+            {
+              "$sort": {
+                "x": 1
+              }
+            },
+            {
+              "$match": {
+                "_id": {
+                  "$gt": 1
+                }
+              }
+            },
+            {
+              "$out": "other_test_collection"
+            }
+          ],
+          "batchSize": 0
+        }
+      },
+      "outcome": {
+        "result": [
+          {
+            "_id": 2,
+            "x": 22
+          },
+          {
+            "_id": 3,
+            "x": 33
+          }
+        ],
+        "collection": {
+          "name": "other_test_collection",
+          "data": [
+            {
+              "_id": 2,
+              "x": 22
+            },
+            {
+              "_id": 3,
+              "x": 33
+            }
+          ]
+        }
+      }
     }
   ]
-}
+}

data/crud/read/aggregate-out.yml

@@ -26,3 +26,24 @@ tests:
                 data:
                     - {_id: 2, x: 22}
                     - {_id: 3, x: 33}
+    -
+        description: "Aggregate with $out and batch size of 0"
+        operation:
+            name: aggregate
+            arguments:
+                pipeline:
+                    - $sort: {x: 1}
+                    - $match:
+                        _id: {$gt: 1}
+                    - $out: "other_test_collection"
+                batchSize: 0
+
+        outcome:
+            result:
+                - {_id: 2, x: 22}
+                - {_id: 3, x: 33}
+            collection:
+                name: "other_test_collection"
+                data:
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}

data/crud/read/aggregate.json

@@ -50,4 +50,4 @@
       }
     }
   ]
-}
+}

data/crud/read/count-collation.json

@@ -26,4 +26,4 @@
       }
     }
   ]
-}
+}

data/crud/read/count.json

@@ -57,4 +57,4 @@
       }
     }
   ]
-}
+}

data/crud/read/distinct-collation.json

@@ -30,4 +30,4 @@
       }
     }
   ]
-}
+}

data/crud/read/distinct.json

@@ -52,4 +52,4 @@
       }
     }
   ]
-}
+}

data/crud/read/find-collation.json

@@ -31,4 +31,4 @@
       }
     }
   ]
-}
+}

data/crud/read/find.json

@@ -102,4 +102,4 @@
       }
     }
   ]
-}
+}

data/crud/test_files.txt

@@ -7,6 +7,7 @@
 ./read/distinct.json
 ./read/find-collation.json
 ./read/find.json
+./write/bulkWrite-arrayFilters.json
 ./write/deleteMany-collation.json
 ./write/deleteMany.json
 ./write/deleteOne-collation.json
@@ -17,16 +18,19 @@
 ./write/findOneAndReplace-upsert.json
 ./write/findOneAndReplace-upsert_pre_2.6.json
 ./write/findOneAndReplace.json
+./write/findOneAndUpdate-arrayFilters.json
 ./write/findOneAndUpdate-collation.json
 ./write/findOneAndUpdate.json
 ./write/insertMany.json
 ./write/insertOne.json
 ./write/replaceOne-collation.json
 ./write/replaceOne-pre_2.6.json
 ./write/replaceOne.json
+./write/updateMany-arrayFilters.json
 ./write/updateMany-collation.json
 ./write/updateMany-pre_2.6.json
 ./write/updateMany.json
+./write/updateOne-arrayFilters.json
 ./write/updateOne-collation.json
 ./write/updateOne-pre_2.6.json
 ./write/updateOne.json

data/crud/write/bulkWrite-arrayFilters.json

@@ -0,0 +1,110 @@
+{
+  "data": [
+    {
+      "_id": 1,
+      "y": [
+        {
+          "b": 3
+        },
+        {
+          "b": 1
+        }
+      ]
+    },
+    {
+      "_id": 2,
+      "y": [
+        {
+          "b": 0
+        },
+        {
+          "b": 1
+        }
+      ]
+    }
+  ],
+  "minServerVersion": "3.5.6",
+  "tests": [
+    {
+      "description": "BulkWrite with arrayFilters",
+      "operation": {
+        "arguments": {
+          "options": {
+            "ordered": true
+          },
+          "requests": [
+            {
+              "arguments": {
+                "arrayFilters": [
+                  {
+                    "i.b": 3
+                  }
+                ],
+                "filter": {},
+                "update": {
+                  "$set": {
+                    "y.$[i].b": 2
+                  }
+                }
+              },
+              "name": "updateOne"
+            },
+            {
+              "arguments": {
+                "arrayFilters": [
+                  {
+                    "i.b": 1
+                  }
+                ],
+                "filter": {},
+                "update": {
+                  "$set": {
+                    "y.$[i].b": 2
+                  }
+                }
+              },
+              "name": "updateMany"
+            }
+          ]
+        },
+        "name": "bulkWrite"
+      },
+      "outcome": {
+        "collection": {
+          "data": [
+            {
+              "_id": 1,
+              "y": [
+                {
+                  "b": 2
+                },
+                {
+                  "b": 2
+                }
+              ]
+            },
+            {
+              "_id": 2,
+              "y": [
+                {
+                  "b": 0
+                },
+                {
+                  "b": 2
+                }
+              ]
+            }
+          ]
+        },
+        "result": {
+          "deletedCount": 0,
+          "insertedIds": {},
+          "matchedCount": 3,
+          "modifiedCount": 3,
+          "upsertedCount": 0,
+          "upsertedIds": {}
+        }
+      }
+    }
+  ]
+}

data/crud/write/bulkWrite-arrayFilters.yml

@@ -0,0 +1,44 @@
+data:
+    - {_id: 1, y: [{b: 3}, {b: 1}]}
+    - {_id: 2, y: [{b: 0}, {b: 1}]}
+
+minServerVersion: '3.5.6'
+
+tests:
+    -
+        description: "BulkWrite with arrayFilters"
+        operation:
+            name: "bulkWrite"
+            arguments:
+                requests:
+                    -
+                        # UpdateOne when one document matches arrayFilters
+                        name: "updateOne"
+                        arguments:
+                            filter: {}
+                            update:
+                                $set: {"y.$[i].b": 2}
+                            arrayFilters:
+                              - {i.b: 3}
+                    -
+                        # UpdateMany when multiple documents match arrayFilters
+                        name: "updateMany"
+                        arguments:
+                            filter: {}
+                            update:
+                                $set: {"y.$[i].b": 2}
+                            arrayFilters:
+                              - {i.b: 1}
+                options: { ordered: true }
+        outcome:
+            result:
+                deletedCount: 0
+                insertedIds: {}
+                matchedCount: 3
+                modifiedCount: 3
+                upsertedCount: 0
+                upsertedIds: {}
+            collection:
+                data:
+                    - {_id: 1, y: [{b: 2}, {b: 2}]}
+                    - {_id: 2, y: [{b: 0}, {b: 2}]}

data/crud/write/deleteMany-collation.json

@@ -44,4 +44,4 @@
       }
     }
   ]
-}
+}