mongo 1.12.5 → 2.0.0

data/spec/support/crud.rb

@@ -0,0 +1,203 @@
+# Copyright (C) 2014-2015 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.
+
+# Matcher for determining if the results of the opeartion match the
+# test's expected results.
+#
+# @since 2.0.0
+
+# Matcher for determining if the collection's data matches the
+# test's expected collection data.
+#
+# @since 2.0.0
+RSpec::Matchers.define :match_collection_data do |test|
+
+  match do |actual|
+    test.compare_collection_data
+  end
+end
+
+require 'support/crud/read'
+require 'support/crud/write'
+
+module Mongo
+  module CRUD
+
+    # Represents a CRUD specification test.
+    #
+    # @since 2.0.0
+    class Spec
+
+      # @return [ String ] description The spec description.
+      #
+      # @since 2.0.0
+      attr_reader :description
+
+      # Instantiate the new spec.
+      #
+      # @example Create the spec.
+      #   Spec.new(file)
+      #
+      # @param [ String ] file The name of the file.
+      #
+      # @since 2.0.0
+      def initialize(file)
+        @spec = YAML.load(ERB.new(File.new(file).read).result)
+        @description = File.basename(file)
+        @data = @spec['data']
+        @crud_tests = @spec['tests']
+      end
+
+      # Get a list of CRUDTests for each test definition.
+      #
+      # @example Get the list of CRUDTests.
+      #   spec.tests
+      #
+      # @return [ Array<CRUDTest> ] The list of CRUDTests.
+      #
+      # @since 2.0.0
+      def tests
+        @crud_tests.collect do |test|
+          Mongo::CRUD::CRUDTest.new(@data, test)
+        end
+      end
+    end
+
+    # Represents a single CRUD test.
+    #
+    # @since 2.0.0
+    class CRUDTest
+
+      # The test description.
+      #
+      # @return [ String ] description The test description.
+      #
+      # @since 2.0.0
+      attr_reader :description
+
+      # Instantiate the new CRUDTest.
+      #
+      # @example Create the test.
+      #   CRUDTest.new(data, test)
+      #
+      # @param [ Array<Hash> ] data The documents the collection
+      # must have before the test runs.
+      # @param [ Hash ] test The test specification.
+      #
+      # @since 2.0.0
+      def initialize(data, test)
+        @data = data
+        @description = test['description']
+        @operation = Operation.get(test['operation'])
+        @outcome = test['outcome']
+      end
+
+      # Run the test.
+      #
+      # @example Run the test.
+      #   test.run(collection)
+      #
+      # @param [ Collection ] collection The collection the test
+      #   should be run on.
+      #
+      # @return [ Result, Array<Hash> ] The result(s) of running the test.
+      #
+      # @since 2.0.0
+      def run(collection)
+        @collection = collection
+        @collection.insert_many(@data)
+        @operation.execute(collection)
+      end
+
+      # The expected result of running the test.
+      #
+      # @example Get the expected result of running the test.
+      #   test.result
+      #
+      # @return [ Array<Hash> ] The expected result of running the test.
+      #
+      # @since 2.0.0
+      def result
+        @operation.has_results? ? @outcome['result'] : []
+      end
+
+      # Compare the existing collection data and the expected collection data.
+      #
+      # @example Compare the existing and expected collection data.
+      #   test.compare_collection_data
+      #
+      # @return [ true, false ] The result of comparing the existing and expected
+      #  collection data.
+      #
+      # @since 2.0.0
+      def compare_collection_data
+        actual_collection_data == outcome_collection_data
+      end
+
+      # Whether this test requires server version >= 2.6 for its results to match
+      # the expected results.
+      #
+      # @example If this test requires >= 2.6.
+      #   test.requires_2_6?(collection)
+      #
+      # @param [ true, false ] If write commands are enabled on the server.
+      # @param [ Collection ] The collection the test is run on.
+      #
+      # @return [ true, false ] Whether the test requires server >= 2.6.
+      #
+      # @since 2.0.0
+      def requires_2_6?(write_command_enabled, collection)
+        !write_command_enabled && @operation.requires_2_6?(collection)
+      end
+
+      private
+
+      def outcome_collection_data
+        @outcome['collection']['data'] if @outcome['collection']
+      end
+
+      def actual_collection_data
+        if @outcome['collection']
+          collection_name = @outcome['collection']['name'] || @collection.name
+          @collection.database[collection_name].find.to_a
+        end
+      end
+    end
+
+    # Helper module for instantiating either a Read or Write test operation.
+    #
+    # @since 2.0.0
+    module Operation
+      extend self
+
+      # Get a new Operation.
+      #
+      # @example Get the operation.
+      #   Operation.get(spec)
+      #
+      # @param [ Hash ] spec The operation specification.
+      #
+      # @return [ Operation::Write, Operation::Read ] The Operation object.
+      #
+      # @since 2.0.0
+      def get(spec)
+        if Write::OPERATIONS.keys.include?(spec['name'])
+          Write.new(spec)
+        else
+          Read.new(spec)
+        end
+      end
+    end
+  end
+end

data/spec/support/crud_tests/read/aggregate.yml

@@ -0,0 +1,43 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "Aggregate with multiple stages"
+        operation:
+            name: aggregate
+            arguments:
+                pipeline:
+                    - $sort: {x: 1}
+                    - $match: 
+                        _id: {$gt: 1}
+                batchSize: 2
+
+        outcome:
+            result:
+                - {_id: 2, x: 22}
+                - {_id: 3, x: 33}
+    -
+        description: "Aggregate with $out"
+        operation:
+            name: aggregate
+            arguments:
+                pipeline: 
+                    - $sort: {x: 1}
+                    - $match:
+                        _id: {$gt: 1}
+                    - $out: "other_test_collection"
+                batchSize: 2
+
+        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/spec/support/crud_tests/read/count.yml

@@ -0,0 +1,37 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "Count without a filter"
+        operation:
+            name: count
+            arguments:
+                filter: { }
+
+        outcome:
+            result: 3
+    -
+        description: "Count with a filter"
+        operation:
+            name: count
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+
+        outcome:
+            result: 2
+    -
+        description: "Count with skip and limit"
+        operation:
+            name: count
+            arguments:
+                filter: {}
+                skip: 1
+                limit: 3
+
+        outcome:
+            result: 2
+  

data/spec/support/crud_tests/read/distinct.yml

@@ -0,0 +1,33 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "Distinct without a filter"
+        operation:
+            name: distinct
+            arguments:
+                fieldName: "x"
+                filter: {}
+
+        outcome:
+            result: 
+                - 11
+                - 22
+                - 33
+    -
+        description: "Distinct with a filter"
+        operation:
+            name: distinct
+            arguments:
+                fieldName: "x"
+                filter: 
+                    _id: {$gt: 1}
+
+        outcome:
+            result: 
+                - 22
+                - 33
+  

data/spec/support/crud_tests/read/find.yml

@@ -0,0 +1,50 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+    - {_id: 4, x: 44}
+    - {_id: 5, x: 55}
+
+tests:
+    -
+        description: "Find with filter"
+        operation:
+            name: "find"
+            arguments:
+                filter: {_id: 1}
+
+        outcome:
+            result:
+                - {_id: 1, x: 11}
+
+    - 
+        description: "Find with filter, sort, skip, and limit"
+        operation: 
+            name: "find"
+            arguments:
+                filter: 
+                    _id: {$gt: 2}
+                sort: {_id: 1}
+                skip: 2
+                limit: 2
+
+        outcome:
+            result:
+                - {_id: 5, x: 55}
+    -
+        description: "Find with limit, sort, and batchsize"
+        operation: 
+            name: "find"
+            arguments:
+                filter: {}
+                sort: {_id: 1}
+                limit: 4
+                batchSize: 2
+
+        outcome:
+            result:
+                - {_id: 1, x: 11}
+                - {_id: 2, x: 22}
+                - {_id: 3, x: 33}
+                - {_id: 4, x: 44}
+  

data/spec/support/crud_tests/write/deleteMany.yml

@@ -0,0 +1,36 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "DeleteMany when many documents match"
+        operation:
+            name: "deleteMany"
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+
+        outcome:
+            result:
+                deletedCount: 2
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+    -
+        description: "DeleteMany when no document matches"
+        operation:
+            name: "deleteMany"
+            arguments:
+                filter: {_id: 4}
+
+        outcome:
+            result:
+                deletedCount: 0
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+  

data/spec/support/crud_tests/write/deleteOne.yml

@@ -0,0 +1,49 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "DeleteOne when many documents match"
+        operation:
+            name: "deleteOne"
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+
+        outcome:
+            result:
+                deletedCount: 1
+            # can't verify collection because we don't have a way
+            # of knowing which document gets deleted.
+    -
+        description: "DeleteOne when one document matches"
+        operation:
+            name: "deleteOne"
+            arguments:
+                filter: {_id: 2}
+
+        outcome:
+            result:
+                deletedCount: 1
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 3, x: 33}
+    -
+        description: "DeleteOne when no documents match"
+        operation:
+            name: "deleteOne"
+            arguments:
+                filter: {_id: 4}
+
+        outcome:
+            result:
+                deletedCount: 0
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+  

data/spec/support/crud_tests/write/findOneAndDelete.yml

@@ -0,0 +1,54 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "FindOneAndDelete when many documents match"
+        operation:
+            name: findOneAndDelete
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 22}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndDelete when one document matches"
+        operation:
+            name: findOneAndDelete
+            arguments:
+                filter: {_id: 2}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 22}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndDelete when no documents match"
+        operation:
+            name: findOneAndDelete
+            arguments:
+                filter: {_id: 4}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: null
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+  

data/spec/support/crud_tests/write/findOneAndReplace.yml

@@ -0,0 +1,153 @@
+data:
+    - {_id: 1, x: 11}
+    - {_id: 2, x: 22}
+    - {_id: 3, x: 33}
+
+tests:
+    -
+        description: "FindOneAndReplace when many documents match returning the document before modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+                replacement: {x: 32}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 22}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 32}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when many documents match returning the document after modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: 
+                    _id: {$gt: 1}
+                replacement: {x: 32}
+                projection: {x: 1, _id: 0}
+                returnDocument: After
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 32}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 32}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when one document matches returning the document before modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 2}
+                replacement: {x: 32}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 22}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 32}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when one document matches returning the document after modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 2}
+                replacement: {x: 32}
+                projection: {x: 1, _id: 0}
+                returnDocument: After
+                sort: {x: 1}
+
+        outcome:
+            result: {x: 32}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 32}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when no documents match returning the document before modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 4}
+                replacement: {x: 44}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+
+        outcome:
+            result: null
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when no documents match with upsert returning the document before modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 4}
+                replacement: {x: 44}
+                projection: {x: 1, _id: 0}
+                sort: {x: 1}
+                upsert: true
+
+        outcome:
+            result: null
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+                    - {_id: 4, x: 44}
+    -
+        description: "FindOneAndReplace when no documents match returning the document after modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 4}
+                replacement: {x: 44}
+                projection: {x: 1, _id: 0}
+                returnDocument: After
+                sort: {x: 1}
+
+        outcome:
+            result: null
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+    -
+        description: "FindOneAndReplace when no documents match with upsert returning the document after modification"
+        operation:
+            name: findOneAndReplace
+            arguments:
+                filter: {_id: 4}
+                replacement: {x: 44}
+                projection: {x: 1, _id: 0}
+                returnDocument: After
+                sort: {x: 1}
+                upsert: true
+
+        outcome:
+            result: {x: 44}
+            collection:
+                data:
+                    - {_id: 1, x: 11}
+                    - {_id: 2, x: 22}
+                    - {_id: 3, x: 33}
+                    - {_id: 4, x: 44}
+