Merge pull request #590 from estolfo/crud-tests

RUBY-873 Implement CRUD YAML tests

Author: durran

spec/mongo/crud_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'CRUD' do
+
+  CRUD_TESTS.each do |file|
+
+    spec = Mongo::CRUD::Spec.new(file)
+
+    context(spec.description) do
+
+      spec.tests.each do |test|
+
+        context(test.description) do
+
+          before(:each) do
+            authorized_collection.find.delete_many
+          end
+
+          after(:each) do
+            authorized_collection.find.delete_many
+          end
+
+          let(:results) do
+            test.run(authorized_collection)
+          end
+
+          it "returns the correct result" do
+            skip 'Test results only match with server version >= 2.6' if test.requires_2_6?(write_command_enabled?,
+                                                                                            authorized_collection)
+            expect(results).to eq(test.result)
+          end
+
+          it 'has the correct data in the collection' do
+            skip 'Test results only match with server version >= 2.6' if test.requires_2_6?(write_command_enabled?,
+                                                                                            authorized_collection)
+            expect(test.run(authorized_collection)).to match_collection_data(test)
+          end
+        end
+      end
+    end
+  end
+end

spec/spec_helper.rb

@@ -25,6 +25,7 @@
 require 'support/server_discovery_and_monitoring'
 require 'support/server_selection_rtt'
 require 'support/server_selection'
+require 'support/crud'
 
 Mongo::Logger.logger = Logger.new($stdout)
 Mongo::Logger.logger.level = Logger::INFO
@@ -66,6 +67,7 @@
 SERVER_DISCOVERY_TESTS = Dir.glob("#{CURRENT_PATH}/support/sdam/**/*.yml")
 SERVER_SELECTION_RTT_TESTS = Dir.glob("#{CURRENT_PATH}/support/server_selection/rtt/*.yml")
 SERVER_SELECTION_TESTS = Dir.glob("#{CURRENT_PATH}/support/server_selection/selection/**/*.yml")
+CRUD_TESTS = Dir.glob("#{CURRENT_PATH}/support/crud_tests/**/*.yml")
 
 # Determine whether the test clients are connecting to a standlone.
 #

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