mongo 2.5.3 → 2.6.0

data/spec/mongo/server/connection_spec.rb

@@ -134,7 +134,7 @@ describe Mongo::Server::Connection do
             TEST_OPTIONS.merge(
               :user => TEST_USER.name,
               :password => TEST_USER.password,
-              :database => TEST_DB )
+              :database => TEST_USER.database )
           )
         end
 
@@ -187,7 +187,7 @@ describe Mongo::Server::Connection do
         TEST_OPTIONS.merge(
           :user => TEST_USER.name,
           :password => TEST_USER.password,
-          :database => TEST_DB )
+          :database => TEST_USER.database )
       )
     end
 
@@ -608,10 +608,10 @@ describe Mongo::Server::Connection do
     context 'when the ismaster response indicates the auth mechanism is :scram' do
 
       let(:features) do
-        Mongo::Server::Description::Features.new(0..3)
+        Mongo::Server::Description::Features.new(0..7)
       end
 
-      context 'when the server auth mechanism is scram', if: scram_sha_1_enabled? do
+      context 'when the server auth mechanism is scram', if: scram_sha_1_enabled? && !scram_sha_256_enabled? do
 
         it 'uses scram' do
           allow(Mongo::Server::Description::Features).to receive(:new).and_return(features)
@@ -636,7 +636,7 @@ describe Mongo::Server::Connection do
         Mongo::Server::Description::Features.new(0..2)
       end
 
-      context 'when the server auth mechanism is scram', if: scram_sha_1_enabled? do
+      context 'when the server auth mechanism is scram', if: scram_sha_1_enabled? && !scram_sha_256_enabled? do
 
         it 'uses scram' do
           allow(Mongo::Server::Description::Features).to receive(:new).and_return(features)

data/spec/mongo/server/description_spec.rb

@@ -42,7 +42,7 @@ describe Mongo::Server::Description do
   let(:topology) do
     double('topology')
   end
-  
+
   let(:cluster) do
     double('cluster').tap do |cl|
       allow(cl).to receive(:topology).and_return(topology)
@@ -431,19 +431,36 @@ describe Mongo::Server::Description do
         described_class.new(address, { 'ismaster' => false })
       end
 
-      it 'returns true' do
+      it 'returns false' do
         expect(description).to_not be_primary
       end
     end
 
     context 'when the server is a primary' do
 
-      let(:description) do
-        described_class.new(address, replica)
+      context 'when the hostname contains no capital letters' do
+
+        let(:description) do
+          described_class.new(address, replica)
+        end
+
+        it 'returns true' do
+          expect(description).to be_primary
+        end
       end
 
-      it 'returns false' do
-        expect(description).to be_primary
+      context 'when the hostname contains capital letters' do
+
+        let(:description) do
+          described_class.new('localhost:27017',
+                              { 'ismaster' => true,
+                                'primary' => 'LOCALHOST:27017',
+                                'setName' => 'itsASet!'})
+        end
+
+        it 'returns true' do
+          expect(description).to be_primary
+        end
       end
     end
   end

data/spec/mongo/session/server_session_spec.rb

@@ -18,7 +18,7 @@ describe Mongo::Session::ServerSession do
   describe '#next_txn_number' do
 
     it 'advances and returns the next transaction number' do
-      expect(described_class.new.next_txn_num).to be(0)
+      expect(described_class.new.next_txn_num).to be(1)
     end
 
     context 'when the method is called multiple times' do
@@ -33,7 +33,7 @@ describe Mongo::Session::ServerSession do
       end
 
       it 'advances and returns the next transaction number' do
-        expect(server_session.next_txn_num).to be(2)
+        expect(server_session.next_txn_num).to be(3)
       end
     end
   end

data/spec/mongo/session/session_pool_spec.rb

@@ -171,7 +171,7 @@ describe Mongo::Session::SessionPool, if: test_sessions? do
 
       let(:end_sessions_command) do
         pool.end_sessions
-        EventSubscriber.started_events.find { |c| c.command_name == :endSessions}
+        EventSubscriber.started_events.find { |c| c.command_name == 'endSessions'}
       end
 
       it 'sends the endSessions command with all the session ids' do
@@ -210,7 +210,7 @@ describe Mongo::Session::SessionPool, if: test_sessions? do
       end
 
       let(:end_sessions_commands) do
-        EventSubscriber.started_events.select { |c| c.command_name == :endSessions}
+        EventSubscriber.started_events.select { |c| c.command_name == 'endSessions'}
       end
 
       it 'sends the command more than once' do

data/spec/mongo/transactions_examples_spec.rb

@@ -0,0 +1,227 @@
+require 'spec_helper'
+
+describe 'transactions examples in Ruby', if: test_transactions? do
+
+  let(:hr) do
+    authorized_client.use(:hr).database
+  end
+
+  let(:reporting) do
+    authorized_client.use(:reporting).database
+  end
+
+  before(:each) do
+    hr[:employees].insert_one(employee: 3, status: 'Active')
+    reporting[:events].insert_one(employee: 3, status: { new: 'Active', old: nil})
+  end
+
+  after(:each) do
+    hr.drop
+    reporting.drop
+  end
+
+  context 'individual examples' do
+
+    let(:session) do
+      authorized_client.start_session
+    end
+
+    # Start Transactions Intro Example 1
+
+    def update_employee_info(session)
+      employees_coll = session.client.use(:hr)[:employees]
+      events_coll = session.client.use(:reporting)[:events]
+
+      session.start_transaction(read_concern: { level: :snapshot },
+                                write_concern: { w: :majority })
+      employees_coll.update_one({ employee: 3 }, { '$set' => { status: 'Inactive'} },
+                                session: session)
+      events_coll.insert_one({ employee: 3, status: { new: 'Inactive', old: 'Active' } },
+                             session: session)
+
+      loop do
+        begin
+          session.commit_transaction
+          puts 'Transaction committed.'
+          break
+        rescue Mongo::Error => e
+          if e.label?(Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL)
+            puts "#{Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL}, retrying commit operation..."
+            next
+          else
+            puts 'Error during commit ...'
+            raise
+          end
+        end
+      end
+    end
+
+    # End Transactions Intro Example  1
+
+    context 'Transactions Intro Example 1' do
+
+      let(:run_transaction) do
+        update_employee_info(session)
+      end
+
+      it 'makes the changes to the database' do
+        run_transaction
+        employee = hr[:employees].find({ employee: 3 }, limit: 1).first
+        expect(employee).to_not be_nil
+        expect(employee['status']).to eq('Inactive')
+      end
+    end
+
+    context 'Transactions Retry Example 1' do
+
+      # Start Transactions Retry Example 1
+
+      def run_transaction_with_retry(session)
+        loop do
+          begin
+            yield session # performs transaction
+            break
+          rescue Mongo::Error => e
+
+            puts 'Transaction aborted. Caught exception during transaction.'
+            raise unless e.label?(Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL)
+
+            puts "#{Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL}, retrying transaction ..."
+            next
+          end
+        end
+      end
+
+      # End Transactions Retry Example 1
+
+      let(:run_transaction) do
+        run_transaction_with_retry(session) { |s| update_employee_info(s) }
+      end
+
+      it 'makes the changes to the database' do
+        run_transaction
+        employee = hr[:employees].find({ employee: 3 }, limit: 1).first
+        expect(employee).to_not be_nil
+        expect(employee['status']).to eq('Inactive')
+      end
+    end
+
+    context 'Transactions Retry Example 2' do
+
+      # Start Transactions Retry Example 2
+
+      def commit_with_retry(session)
+        loop do
+          begin
+            session.commit_transaction
+            puts 'Transaction committed.'
+            break
+          rescue Mongo::Error=> e
+            if e.label?(Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL)
+              puts "#{Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL}, retrying commit operation..."
+              next
+            else
+              puts 'Error during commit ...'
+              raise
+            end
+          end
+        end
+      end
+
+      # End Transactions Retry Example 2
+
+      let(:run_transaction) do
+        session.start_transaction
+        hr[:employees].insert_one({ employee: 4, status: 'Active' }, session: session)
+        reporting[:events].insert_one({ employee: 4, status: { new: 'Active', old: nil } },
+                                      session: session)
+        commit_with_retry(session)
+      end
+
+      it 'makes the changes to the database' do
+        run_transaction
+        employee = hr[:employees].find({ employee: 4 }, limit: 1).first
+        expect(employee).to_not be_nil
+        expect(employee['status']).to eq('Active')
+      end
+    end
+  end
+
+  context 'Transactions Retry Example 3 (combined example)' do
+
+    let(:client) do
+      authorized_client
+    end
+
+    let(:run_transaction) do
+
+      # Start Transactions Retry Example 3
+
+      def run_transaction_with_retry(session)
+        loop do
+          begin
+            yield session # performs transaction
+            break
+          rescue Mongo::Error=> e
+            puts 'Transaction aborted. Caught exception during transaction.'
+            raise unless e.label?(Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL)
+
+            puts "#{Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL}, retrying transaction ..."
+            next
+          end
+        end
+      end
+
+      def commit_with_retry(session)
+        loop do
+          begin
+            session.commit_transaction
+            puts 'Transaction committed.'
+            break
+          rescue Mongo::Error => e
+            if e.label?(Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL)
+              puts "#{Mongo::Error::UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL}, retrying commit operation ..."
+              next
+            else
+              puts 'Error during commit ...'
+              raise
+            end
+          end
+        end
+      end
+
+      # updates two collections in a transaction
+
+      def update_employee_info(session)
+        employees_coll = session.client.use(:hr)[:employees]
+        events_coll = session.client.use(:reporting)[:events]
+
+        session.start_transaction(read_concern: { level: :snapshot },
+                                  write_concern: { w: :majority })
+        employees_coll.update_one({ employee: 3 }, { '$set' => { status: 'Inactive'} },
+                                  session: session)
+        events_coll.insert_one({ employee: 3, status: { new: 'Inactive', old: 'Active' } },
+                               session: session)
+        commit_with_retry(session)
+      end
+
+      session = client.start_session
+
+      begin
+        run_transaction_with_retry(session) { |s| update_employee_info(s) }
+      rescue StandardError => e
+        # Do something with error
+        raise
+      end
+
+      # End Transactions Retry Example 3
+    end
+
+    it 'makes the changes to the database' do
+      run_transaction
+      employee = hr[:employees].find({ employee: 3 }, limit: 1).first
+      expect(employee).to_not be_nil
+      expect(employee['status']).to eq('Inactive')
+    end
+  end
+end

data/spec/mongo/transactions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'Transactions' do
+
+  TRANSACTIONS_TESTS.sort.each do |file|
+
+    spec = Mongo::Transactions::Spec.new(file)
+
+    context(spec.description) do
+      spec.tests.each do |test|
+        context(test.description) do
+
+          before(:each) do
+            test.setup_test
+          end
+
+          let(:results) do
+            test.run
+          end
+
+          it 'returns the correct result', if: test_transactions? do
+            expect(results[:results]).to match_operation_result(test)
+          end
+
+          it 'has the correct data in the collection', if: test_transactions? && test.outcome_collection_data do
+            expect(results[:contents]).to match_collection_data(test)
+          end
+
+          it 'has the correct command_started events', if: test_transactions? && test.expectations do
+            test.expectations.each do |expectation|
+              # We convert the hashes to sorted arrays to ensure that asserting equality between
+              # the expected and actual event descriptions don't fail due to the same entries being
+              # in a different order.
+              expectation['command_started_event']['command'] = expectation['command_started_event']['command'].to_a.sort
+              expectation['command_started_event']['command'].delete_if { |_, v| v == nil }
+            end
+
+            expect(results[:events]).to eq(test.expectations)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,59 +1,93 @@
-TEST_SET = 'ruby-driver-rs'
-COVERAGE_MIN = 90
-CURRENT_PATH = File.expand_path(File.dirname(__FILE__))
-SERVER_DISCOVERY_TESTS = Dir.glob("#{CURRENT_PATH}/support/sdam/**/*.yml")
-SDAM_MONITORING_TESTS = Dir.glob("#{CURRENT_PATH}/support/sdam_monitoring/*.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")
-MAX_STALENESS_TESTS = Dir.glob("#{CURRENT_PATH}/support/max_staleness/**/*.yml")
-CRUD_TESTS = Dir.glob("#{CURRENT_PATH}/support/crud_tests/**/*.yml")
-RETRYABLE_WRITES_TESTS = Dir.glob("#{CURRENT_PATH}/support/retryable_writes_tests/**/*.yml")
-COMMAND_MONITORING_TESTS = Dir.glob("#{CURRENT_PATH}/support/command_monitoring/**/*.yml")
-CONNECTION_STRING_TESTS = Dir.glob("#{CURRENT_PATH}/support/connection_string_tests/*.yml")
-DNS_SEEDLIST_DISCOVERY_TESTS = Dir.glob("#{CURRENT_PATH}/support/dns_seedlist_discovery_tests/*.yml")
-GRIDFS_TESTS = Dir.glob("#{CURRENT_PATH}/support/gridfs_tests/*.yml")
-
-if ENV['DRIVERS_TOOLS']
-  CLIENT_CERT_PEM = ENV['DRIVER_TOOLS_CLIENT_CERT_PEM']
-  CLIENT_KEY_PEM = ENV['DRIVER_TOOLS_CLIENT_KEY_PEM']
-  CA_PEM = ENV['DRIVER_TOOLS_CA_PEM']
-  CLIENT_KEY_ENCRYPTED_PEM = ENV['DRIVER_TOOLS_CLIENT_KEY_ENCRYPTED_PEM']
-else
-  SSL_CERTS_DIR = "#{CURRENT_PATH}/support/certificates"
-  CLIENT_PEM = "#{SSL_CERTS_DIR}/client.pem"
-  CLIENT_PASSWORD_PEM = "#{SSL_CERTS_DIR}/password_protected.pem"
-  CA_PEM = "#{SSL_CERTS_DIR}/ca.pem"
-  CRL_PEM = "#{SSL_CERTS_DIR}/crl.pem"
-  CLIENT_KEY_PEM = "#{SSL_CERTS_DIR}/client_key.pem"
-  CLIENT_CERT_PEM = "#{SSL_CERTS_DIR}/client_cert.pem"
-  CLIENT_KEY_ENCRYPTED_PEM = "#{SSL_CERTS_DIR}/client_key_encrypted.pem"
-  CLIENT_KEY_PASSPHRASE = "passphrase"
-end
+# The tests run against a MongoDB cluster which is
+# configured and started externally to the test suite. This allows
+# running the entire test suite against, for example, a standalone
+# mongod as well as a replica set. The flip side to this is the
+# test suite will not work without a running mongo cluster, and
+# tests which are not applicable to or cannot be performed on the
+# running mongo cluster are skipped.
+#
+# Not only does the test suite require an externally launched cluster,
+# the test suite must also be told how the cluster is configured
+# via MONGODB_URI, TOPOLOGY, MONGODB_ADDRESSES, RS_ENABLED, RS_NAME and
+# SHARDED_ENABLED environment variables.
+#
+# The test suite does not validate that it is able to successfully connect
+# to the cluster prior to running the tests. If a connection fails entirely,
+# the clue is generally failures to invoke methods on nil.
+# However, it is also possible to establish a connection to a cluster which
+# is not quite correctly configured. The result is usually a mass of test
+# failures that are indistinguishable from legitimate failures.
+#
+# Additionally some of the tests assume that the seed list (given in
+# MONGODB_URI or MONGODB_ADDRESSES) encompasses all servers in the cluster,
+# and will fail when MONGODB_URI includes only one host of a replica set.
+# It is best to include all hosts of the cluster in MONGODB_URI and
+# MONGODB_ADDRESSES.
+#
+# The test suite seems to have issues connecting to a replica set
+# via IP addresses if the replica set hosts are defined with hostnames
+# (i.e., 127.0.0.1 vs localhost). Try to exactly match the contents of
+# MONGODB_URI and `rs.isMaster()` output, either by adjusting MONGODB_URI
+# or by reconfiguring the replica set.
+#
+# In order to run spec tests, the mongo cluster needs to have failpoints
+# enabled. This is accomplished by starting mongod with the following option:
+#   --setParameter enableTestCommands=1
+#
+# Use the following environment variables to configure the tests:
+#
+# CLIENT_DEBUG: Show debug messages from the client.
+#   CLIENT_DEBUG=1
+#
+# MONGODB_URI: Connection string to use. This must be a valid MongoDB URI;
+# mongodb:// and mongodb+srv:// are both supported.
+# RS_ENABLED and SHARDED_ENABLED are NOT honored if using MONGODB_URI -
+# specify replica set name in the URI and to specify a sharded topology
+# set TOPOLOGY=sharded_cluster environment variable.
+#   MONGODB_URI=mongodb://127.0.0.1:27001/?replicaSet=test
+#   MONGODB_URI=mongodb://127.0.0.1:27001,127.0.0.1:27002/ TOPOLOGY=sharded_cluster
+#
+# MONGODB_ADDRESSES: Specify addresses to connect to. Use RS_ENABLED,
+# RS_NAME and SHARDED_ENABLED to configure the topology.
+#   MONGODB_ADDRESSES=127.0.0.1:27017,127.0.0.1:27018
+#   MONGODB_ADDRESSES=127.0.0.1:27017,127.0.0.1:27018 RS_ENABLED=1
+#   MONGODB_ADDRESSES=127.0.0.1:27017,127.0.0.1:27018 RS_ENABLED=1 RS_NAME=test
+#   MONGODB_ADDRESSES=127.0.0.1:27017,127.0.0.1:27018 SHARDED_ENABLED=1
+#
+# RS_ENABLED: Instruct the test suite to connect to a replica set.
+# RS_ENABLED is only honored when not using MONGODB_URI; to connect to a
+# replica set with MONGODB_URI, specify the replica set name in the URI
+# (despite the Ruby driver performing topology discovery by default, it
+# doesn't do so in the test suite).
+# RS_NAME can be given to specify the replica set name; the default is
+# ruby-driver-rs.
+#   RS_ENABLED=1
+#   RS_ENABLED=1 RS_NAME=test
+#
+# SHARDED_ENABLED: Instruct the test suite to connect to the sharded cluster.
+# Set MONGODB_URI appropriately as well.
+#   SHARDED_ENABLED=1
 
-require 'mongo'
+require 'lite_spec_helper'
 
-Mongo::Logger.logger = Logger.new($stdout)
-Mongo::Logger.logger.level = Logger::INFO
-Encoding.default_external = Encoding::UTF_8
+if RUBY_PLATFORM !~ /\bjava\b/
+  require 'timeout_interrupt'
+end
+
+# Replica set name can be overridden via replicaSet parameter in MONGODB_URI
+# environment variable or by specifying RS_NAME environment variable when
+# not using MONGODB_URI.
+TEST_SET = 'ruby-driver-rs'
 
 require 'support/travis'
-require 'support/matchers'
-require 'support/event_subscriber'
 require 'support/authorization'
-require 'support/server_discovery_and_monitoring'
-require 'support/server_selection_rtt'
-require 'support/server_selection'
-require 'support/sdam_monitoring'
-require 'support/crud'
-require 'support/command_monitoring'
-require 'support/connection_string'
-require 'support/gridfs'
+require 'support/primary_socket'
+require 'support/constraints'
+require 'rspec/retry'
 
 RSpec.configure do |config|
-  config.color     = true
-  config.fail_fast = true unless ENV['CI']
-  config.formatter = 'documentation'
   config.include(Authorization)
+  config.extend(Constraints)
 
   config.before(:suite) do
     begin
@@ -157,6 +191,14 @@ def test_change_streams?
   !BSON::Environment.jruby? && change_stream_enabled? & replica_set?
 end
 
+# Whether transactions can be tested. Transactions are available on server versions 4.0 and higher
+#   and when connected to a replica set.
+#
+# @since 2.6.0
+def test_transactions?
+  transactions_enabled? && replica_set?
+end
+
 # For instances where behaviour is different on different versions, we need to
 # determine in the specs if we are 3.6 or higher.
 #
@@ -194,6 +236,17 @@ def list_command_enabled?
   $list_command_enabled ||= $mongo_client.cluster.servers.first.features.list_indexes_enabled?
 end
 
+# For instances where behavior is different on different versions, we need to
+# determine in the specs if we are 4.0 or higher.
+#
+# @since 2.6.0
+def scram_sha_256_enabled?
+  $mongo_client ||= initialize_scanned_client!
+  $scram_sha_256_enabled ||= $mongo_client.cluster.servers.first.features.scram_sha_256_enabled?
+end
+
+alias :transactions_enabled? :scram_sha_256_enabled?
+
 # Is the test suite running locally (not on Travis).
 #
 # @since 2.1.0
@@ -243,11 +296,23 @@ def auth_enabled?
     begin
       $mongo_client.use(:admin).command(getCmdLineOpts: 1).first["argv"].include?("--auth")
     rescue => e
-      e.message =~ /(not authorized)|(unauthorized)/
+      e.message =~ /(not authorized)|(unauthorized)|(no users authenticated)|(requires authentication)/
     end
   end
 end
 
+def need_to_skip_on_sharded_auth_40?
+  sharded? && auth_enabled? && scram_sha_256_enabled?
+end
+
+# Can the driver specify a write concern that won't be overridden? (mongos 4.0+ overrides the write
+# concern)
+#
+# @since 2.6.0
+def can_set_write_concern?
+  !sharded? || !scram_sha_256_enabled?
+end
+
 # Initializes a basic scanned client to do an ismaster check.
 #
 # @since 2.0.0
@@ -255,5 +320,26 @@ def initialize_scanned_client!
   Mongo::Client.new(ADDRESSES, TEST_OPTIONS.merge(database: TEST_DB))
 end
 
+# Converts a 'camelCase' string or symbol to a :snake_case symbol.
+def camel_to_snake(ident)
+  ident = ident.is_a?(String) ? ident.dup : ident.to_s
+  ident[0] = ident[0].downcase
+  ident.chars.reduce('') { |s, c| s + (/[A-Z]/ =~ c ? "_#{c.downcase}" : c) }.to_sym
+end
+
+# Creates a copy of a hash where all keys and string values are converted to snake-case symbols.
+# For example, `{ 'fooBar' => { 'baz' => 'bingBing', :x => 1 } }` converts to
+# `{ :foo_bar => { :baz => :bing_bing, :x => 1 } }`.
+def snakeize_hash(value)
+  return camel_to_snake(value) if value.is_a?(String)
+  return value unless value.is_a?(Hash)
+
+  value.reduce({}) do |hash, kv|
+    hash.tap do |h|
+      h[camel_to_snake(kv.first)] = snakeize_hash(kv.last)
+    end
+  end
+end
+
 # require all shared examples
 Dir['./spec/support/shared/*.rb'].sort.each { |file| require file }