mongo 2.6.4 → 2.7.0.rc0

data/spec/support/spec_setup.rb

@@ -0,0 +1,61 @@
+require_relative './spec_config'
+require_relative './client_registry'
+
+class SpecSetup
+  def run
+    # Create the root user administrator as the first user to be added to the
+    # database. This user will need to be authenticated in order to add any
+    # more users to any other databases.
+    begin
+      create_user(admin_unauthorized_client, SpecConfig.instance.root_user)
+    rescue Mongo::Error::OperationFailure => e
+      # When testing a cluster that requires auth, root user is already set up
+      # and it is not creatable without auth.
+      # Seems like every mongodb version has its own error message
+      # for trying to make a user when not authenticated,
+      # and prior to 4.0 or so the codes are supposedly not reliable either.
+      # In order: 4.0, 3.6, 3.4 through 2.6
+      if e.message =~ /command createUser requires authentication|there are no users authenticated|not authorized on admin to execute command.*createUser/
+        # However, if the cluster is configured to require auth but
+        # test suite has wrong credentials, then admin_authorized_test_client
+        # won't be authenticated and the following line will raise an
+        # exception
+        if admin_authorized_test_client.with(database: 'admin').database.users.info(SpecConfig.instance.root_user.name).any?
+          warn "Skipping root user creation, likely auth is enabled on cluster"
+        else
+          raise
+        end
+      else
+        raise
+      end
+    end
+    admin_unauthorized_client.close
+
+    # Adds the test user to the test database with permissions on all
+    # databases that will be used in the test suite.
+    create_user(admin_authorized_test_client, SpecConfig.instance.test_user)
+    admin_authorized_test_client.close
+  end
+
+  def create_user(client, user)
+    users = client.database.users
+    begin
+      users.create(user)
+    rescue Mongo::Error::OperationFailure => e
+      if e.message =~ /User.*already exists/
+        users.remove(user.name)
+        users.create(user)
+      else
+        raise
+      end
+    end
+  end
+
+  def admin_unauthorized_client
+    ClientRegistry.instance.global_client('admin_unauthorized')
+  end
+
+  def admin_authorized_test_client
+    ClientRegistry.instance.global_client('root_authorized')
+  end
+end

data/spec/support/transactions.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,30 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Matcher for determining if the results of the operation match the
-# test's expected results.
-#
-# @since 2.6.0
-
-# Matcher for determining if the collection's data matches the
-# test's expected collection data.
-#
-# @since 2.6.0
-RSpec::Matchers.define :match_collection_data do |test|
-
-  match do
-    test.compare_collection_data
-  end
-end
-
-RSpec::Matchers.define :match_operation_result do |test|
-
-  match do |actual|
-    test.compare_operation_result(actual)
-  end
-end
-
 require 'support/transactions/operation'
+require 'support/transactions/verifier'
 
 module Mongo
   module Transactions
@@ -65,7 +43,8 @@ module Mongo
       # @since 2.6.0
       def initialize(file)
         file = File.new(file)
-        @spec = YAML.load(ERB.new(file.read).result)
+        contents = ERB.new(file.read).result
+        @spec = YAML.load(contents)
         file.close
         @description = File.basename(file)
         @data = @spec['data']
@@ -81,9 +60,25 @@ module Mongo
       #
       # @since 2.6.0
       def tests
-        @transaction_tests.collect do |test|
-          Mongo::Transactions::TransactionsTest.new(@data, test)
-        end
+        @transaction_tests.map do |test|
+          if test['skipReason']
+            nil
+          else
+            Proc.new { Mongo::Transactions::TransactionsTest.new(@data, test, self) }
+          end
+        end.compact
+      end
+
+      def database_name
+        @spec['database_name']
+      end
+
+      def collection_name
+        @spec['collection_name']
+      end
+
+      def min_server_version
+        @spec['minServerVersion']
       end
     end
 
@@ -104,6 +99,8 @@ module Mongo
       # @since 2.6.0
       attr_reader :expectations
 
+      attr_reader :expected_results
+
       # Instantiate the new CRUDTest.
       #
       # @example Create the test.
@@ -112,14 +109,17 @@ module Mongo
       # @param [ Array<Hash> ] data The documents the collection
       # must have before the test runs.
       # @param [ Hash ] test The test specification.
+      # @param [ Hash ] spec The top level YAML specification.
       #
       # @since 2.6.0
-      def initialize(data, test)
+      def initialize(data, test, spec)
+        test = IceNine.deep_freeze(test)
+        @spec = spec
         @data = data
         @description = test['description']
         @client_options = convert_client_options(test['clientOptions'] || {})
         @session_options = snakeize_hash(test['sessionOptions'] || {})
-        @failpoint = test['failPoint']
+        @fail_point = test['failPoint']
         @operations = test['operations']
         @expectations = test['expectations']
         @outcome = test['outcome']
@@ -128,7 +128,7 @@ module Mongo
           next result unless result.class == Hash
 
           # Change maps of result ids to arrays of ids
-          result.tap do |r|
+          result.dup.tap do |r|
             r.each do |k, v|
               next unless ['insertedIds', 'upsertedIds'].include?(k)
               r[k] = v.to_a.sort_by(&:first).map(&:last)
@@ -137,6 +137,25 @@ module Mongo
         end
       end
 
+      def support_client
+        @support_client ||= ClientRegistry.instance.global_client('root_authorized').use(@spec.database_name)
+      end
+
+      def admin_support_client
+        @admin_support_client ||= support_client.use('admin')
+      end
+
+      def test_client
+        @test_client ||= ClientRegistry.instance.global_client('authorized_without_retry_writes').with(
+          @client_options.merge(
+            database: @spec.database_name,
+            app_name: 'this is used solely to force the new client to create its own cluster'))
+      end
+
+      def event_subscriber
+        @event_subscriber ||= EventSubscriber.new
+      end
+
       # Run the test.
       #
       # @example Run the test.
@@ -146,9 +165,11 @@ module Mongo
       #
       # @since 2.6.0
       def run
-        @collection.client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber.clear_events!)
+        test_client.subscribe(Mongo::Monitoring::COMMAND, event_subscriber)
 
-        results = @ops.map { |o| o.execute(@collection, @session0, @session1) }
+        results = @ops.map do |op|
+          op.execute(@collection)
+        end
 
         session0_id = @session0.session_id
         session1_id = @session1.session_id
@@ -156,7 +177,7 @@ module Mongo
         @session0.end_session
         @session1.end_session
 
-        events = EventSubscriber.started_events.map do |e|
+        events = event_subscriber.started_events.map do |e|
 
           # Convert txnNumber field from a BSON integer to an extended JSON int64
           if e.command['txnNumber']
@@ -204,7 +225,7 @@ module Mongo
 
           {
             'command_started_event' => {
-              'command' => e.command.to_a.sort,
+              'command' => order_hash(e.command),
               'command_name' => e.command_name.to_s,
               'database_name' => e.database_name
             }
@@ -214,99 +235,53 @@ module Mongo
         # Remove any events from authentication commands.
         events.reject! { |c| c['command_started_event']['command_name'].start_with?('sasl') }
 
-        if @failpoint
-          ADMIN_AUTHORIZED_TEST_CLIENT.use('admin').command(configureFailPoint: 'failCommand', mode: 'off')
+        if @fail_point
+          admin_support_client.command(configureFailPoint: 'failCommand', mode: 'off')
+        end
+
+        events.map! do |event|
+          event['command_started_event'] = order_hash(event['command_started_event'])
         end
 
         {
           results: results,
           contents: @collection.find.to_a,
-          events: events
+          events: events,
         }
       end
 
       def setup_test
-        client = ADMIN_AUTHORIZED_TEST_CLIENT.use('admin')
-
         begin
-          client.command(killAllSessions: [])
+          admin_support_client.command(killAllSessions: [])
         rescue Mongo::Error
         end
 
-        db = client.use(AUTHORIZED_CLIENT.database.name)
-        coll = db[Mongo::Transactions::Spec::COLLECTION_NAME]
+        coll = support_client[@spec.collection_name]
         coll.database.drop
         coll.with(write: { w: :majority }).drop
-        db.command(
-          { create: Mongo::Transactions::Spec::COLLECTION_NAME },
+        support_client.command(
+          { create: @spec.collection_name },
           { write_concern: { w: :majority } })
 
         coll.with(write: { w: :majority }).insert_many(@data) unless @data.empty?
-        client.command(@failpoint) if @failpoint
+        admin_support_client.command(@fail_point) if @fail_point
 
-        client.close
-
-        test_client = AUTHORIZED_CLIENT.with(
-          @client_options.merge(app_name: 'this is used solely to force the new client to create its own cluster'))
-        @collection = test_client[Mongo::Transactions::Spec::COLLECTION_NAME]
+        @collection = test_client[@spec.collection_name]
 
         @session0 = test_client.start_session(@session_options[:session0] || {})
         @session1 = test_client.start_session(@session_options[:session1] || {})
 
-        @ops = @operations.reduce([]) do |ops, op|
-          arguments = case op['arguments'] && op['arguments']['session']
-                      when 'session0'
-                        op['arguments'].merge('session' => @session0)
-                      when 'session1'
-                        op['arguments'].merge('session' => @session1)
-                      else
-                        op['arguments']
-                      end
-
-          ops << Operation.new(op.merge('arguments' => arguments))
+        @ops = @operations.map do |op|
+          Operation.new(op, @session0, @session1)
         end
       end
 
       def teardown_test
-        @collection.client.close
-      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.6.0
-      def compare_collection_data
-        if actual_collection_data.nil?
-          outcome_collection_data.nil?
-        elsif actual_collection_data.empty?
-          outcome_collection_data.empty?
-        else
-          actual_collection_data.all? do |doc|
-            outcome_collection_data.include?(doc)
-          end
+        if @admin_support_client
+          @admin_support_client.close
         end
-      end
-
-      # Compare the actual operation result to the expected operation result.
-      #
-      # @example Compare the existing and expected operation results.
-      #   test.compare_operation_result(actual_results)
-      #
-      # @params [ Object ] actual The actual test results.
-      #
-      # @return [ true, false ] The result of comparing the expected and actual operation result.
-      #
-      # @since 2.6.0
-      def compare_operation_result(actual_results)
-        return false if @expected_results.length != actual_results.length
-
-        @expected_results.zip(actual_results).all? do |expected, actual|
-          compare_result(expected, actual)
+        if @test_client
+          @test_client.close
         end
       end
 
@@ -323,6 +298,10 @@ module Mongo
         @outcome['collection']['data'] if @outcome && @outcome['collection']
       end
 
+      def order_hash(hash)
+        Hash[hash.to_a.sort]
+      end
+
       private
 
       def convert_client_options(client_options)
@@ -341,51 +320,6 @@ module Mongo
           opts.tap { |o| o[kv.first] = kv.last }
         end
       end
-
-      def compare_result(expected, actual)
-        case expected
-        when nil
-          actual.nil?
-        when Hash
-          expected.all? do |k, v|
-            case k
-            when 'errorContains'
-              actual && actual['errorContains'].include?(v)
-            when 'errorLabelsContain'
-              actual && v.all? { |label| actual['errorLabels'].include?(label) }
-            when 'errorLabelsOmit'
-              !actual || v.all? { |label| !actual['errorLabels'].include?(label) }
-            else
-              actual && (actual[k] == v || handle_upserted_id(k, v, actual[v]) ||
-                handle_inserted_ids(k, v, actual[v]))
-            end
-          end
-        else
-          expected == actual
-        end
-      end
-
-      def handle_upserted_id(field, expected_id, actual_id)
-        return true if expected_id.nil?
-        if field == 'upsertedId'
-          if expected_id.is_a?(Integer)
-            actual_id.is_a?(BSON::ObjectId) || actual_id.nil?
-          end
-        end
-      end
-
-      def handle_inserted_ids(field, expected, actual)
-        if field == 'insertedIds'
-          expected.values == actual
-        end
-      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
   end
 end

data/spec/support/transactions/operation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ module Mongo
         'startTransaction' => :start_transaction,
         'abortTransaction' => :abort_transaction,
         'commitTransaction' => :commit_transaction,
+        'withTransaction' => :with_transaction,
         'aggregate' => :aggregate,
         'deleteMany' => :delete_many,
         'deleteOne' => :delete_one,
@@ -38,7 +39,7 @@ module Mongo
         'count' => :count,
         'distinct' => :distinct,
         'find' => :find,
-        'runCommand' => :run_command
+        'runCommand' => :run_command,
       }.freeze
 
       # Map of operation options to method names.
@@ -75,10 +76,26 @@ module Mongo
       # @return [ Hash ] spec The operation spec.
       #
       # @since 2.6.0
-      def initialize(spec)
+      def initialize(spec, session0, session1, transaction_session=nil)
         @spec = spec
         @name = spec['name']
-      end
+        @session0 = session0
+        @session1 = session1
+        @arguments = case spec['arguments'] && spec['arguments']['session']
+                    when 'session0'
+                      spec['arguments'].merge('session' => @session0)
+                    when 'session1'
+                      spec['arguments'].merge('session' => @session1)
+                    else
+                      args = spec['arguments'] || {}
+                      if transaction_session
+                        args = args.merge('session' => transaction_session)
+                      end
+                      args
+                    end
+      end
+
+      attr_reader :arguments
 
       # Execute the operation.
       #
@@ -91,13 +108,13 @@ module Mongo
       # @return [ Result ] The result of executing the operation.
       #
       # @since 2.6.0
-      def execute(collection, session0, session1)
+      def execute(collection)
         # Determine which object the operation method should be called on.
         obj = case object
               when 'session0'
-                session0
+                @session0
               when 'session1'
-                session1
+                @session1
               when 'database'
                 collection.database
               else
@@ -107,19 +124,26 @@ module Mongo
                 collection
               end
 
-        send(OPERATIONS[name], obj)
+        if (op_name = OPERATIONS[name]) == :with_transaction
+          args = [collection]
+        else
+          args = []
+        end
+        send(op_name, obj, *args)
       rescue Mongo::Error::OperationFailure => e
         err_doc = e.instance_variable_get(:@result).send(:first_document)
 
         {
           'errorCodeName' => err_doc['codeName'] || err_doc['writeConcernError']['codeName'],
           'errorContains' => e.message,
-          'errorLabels' => (e.instance_variable_get(:@labels) || []) + (err_doc['errorLabels'] || [])
+          'errorLabels' => e.labels,
+          'exception' => e,
         }
       rescue Mongo::Error => e
         {
           'errorContains' => e.message,
-          'errorLabels' => e.instance_variable_get(:@labels) || []
+          'errorLabels' => e.labels,
+          'exception' => e,
         }
       end
 
@@ -137,6 +161,25 @@ module Mongo
         session.abort_transaction ; nil
       end
 
+      def with_transaction(session, collection)
+        unless callback = @spec['callback']
+          raise ArgumentError, 'with_transaction requires a callback to be present'
+        end
+
+        if @spec['transactionOptions']
+          options = snakeize_hash(@spec['transactionOptions'])
+        end
+        session.with_transaction(options) do
+          callback['operations'].each do |op_spec|
+            op = Operation.new(op_spec, @session0, @session1, session)
+            rv = op.execute(collection)
+            if rv && rv['exception']
+              raise rv['exception']
+            end
+          end
+        end
+      end
+
       def run_command(database)
         # Convert the first key (i.e. the command name) to a symbol.
         cmd = command.dup
@@ -345,10 +388,6 @@ module Mongo
         arguments['update']
       end
 
-      def arguments
-        @spec['arguments'] || {}
-      end
-
       def modifiers
         arguments['modifiers']
       end