mongo 2.14.0.rc1 → 2.16.0.alpha1

data/lib/mongo/write_concern.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2015-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mongo.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -78,4 +81,27 @@ module Mongo
   module_function def clear_ocsp_cache
     Socket::OcspCache.clear
   end
+
+  # This is a user-settable list of hooks that will be invoked when any new
+  # TLS socket is connected. Each hook should be a Proc that takes
+  # an OpenSSL::SSL::SSLContext object as an argument. These hooks can be used
+  # to modify the TLS context (for example to disallow certain ciphers).
+  #
+  # @return [ Array<Proc> ] The list of procs to be invoked when a TLS socket
+  #   is connected (may be an empty Array).
+  module_function def tls_context_hooks
+    @tls_context_hooks ||= []
+  end
+
+  # Set the TLS context hooks.
+  #
+  # @param [ Array<Proc> ] hooks An Array of Procs, each of which should take
+  #   an OpenSSL::SSL::SSLContext object as an argument.
+  module_function def tls_context_hooks=(hooks)
+    unless hooks.is_a?(Array) && hooks.all? { |hook| hook.is_a?(Proc) }
+      raise ArgumentError, "TLS context hooks must be an array of Procs"
+    end
+
+    @tls_context_hooks = hooks
+  end
 end

data/mongo.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.require_paths     = ['lib']
   s.bindir            = 'bin'
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.4"
 
   s.add_dependency 'bson', '>=4.8.2', '<5.0.0'
 end

data/spec/README.md

@@ -2,6 +2,13 @@
 
 ## Quick Start
 
+The test suite requires shared tooling that is stored in a separate repository
+and is referenced as a submodule. After checking out the desired driver
+branch, check out the matching submodules:
+
+    git submodule init
+    git submodule update
+
 To run the test suite against a local MongoDB deployment listening on port
 27017, run:
 
@@ -505,13 +512,36 @@ To test compression, set the `compressors` URI option:
 
     MONGODB_URI="mongodb://localhost:27017/?compressors=zlib" rake
 
-Note that as of this writing, the driver only supports zlib compression.
+Note that as of this writing, the driver supports
+[ztsd](https://docs.mongodb.com/manual/reference/glossary/#term-zstd),
+[snappy](https://docs.mongodb.com/manual/reference/glossary/#term-snappy)
+and [zlib](https://docs.mongodb.com/manual/reference/glossary/#term-zlib)
+compression.
+
 Servers 4.2+ enable zlib by default; to test older servers, explicitly enable
 zlib compression when launching the server:
 
     mongod --dbpath /tmp/mdb --setParameter enableTestCommands=1 \
       --networkMessageCompressors snappy,zlib
 
+## Server API
+
+To specify server API parameters, use the `SERVER_API` environment variable.
+The server API parameters cannot be specified via URI options.
+
+Both YAML and JSON syntaxes are accepted:
+    
+    SERVER_API='{version: "1", strict: true}' rake
+
+    SERVER_API='{"version":"1","strict":true}' rake
+
+Note that the input must be valid YAML or JSON and the version number must
+be a string, therefore all of the following specifications are invalid:
+
+    SERVER_API='{version:"1",strict:true}' rake
+    SERVER_API='{version: 1}' rake
+    SERVER_API='{"version":1,"strict":true}' rake
+
 ## Other Options
 
 Generally, all URI options recognized by the driver may be set for a test run,

data/spec/atlas/atlas_connectivity_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'lite_spec_helper'
 
 describe 'Atlas connectivity' do

data/spec/atlas/operations_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'lite_spec_helper'
 
 describe 'Operations' do

data/spec/integration/auth_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'Auth' do
@@ -10,8 +13,12 @@ describe 'Auth' do
       authorized_client.cluster.next_primary
     end
 
+    let(:base_options) do
+      SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
+    end
+
     let(:connection) do
-      Mongo::Server::Connection.new(server, options)
+      Mongo::Server::Connection.new(server, base_options.merge(options))
     end
 
     before(:all) do
@@ -31,8 +38,9 @@ describe 'Auth' do
     context 'user mechanism not provided' do
 
       context 'user does not exist' do
-        let(:options) { SpecConfig.instance.ssl_options.merge(
-          user: 'nonexistent_user') }
+        let(:options) do
+          {user: 'nonexistent_user' }
+        end
 
         before do
           expect(connection.app_metadata.send(:document)[:saslSupportedMechs]).to eq('admin.nonexistent_user')
@@ -63,8 +71,9 @@ describe 'Auth' do
       end
 
       context 'user exists' do
-        let(:options) { SpecConfig.instance.ssl_options.merge(
-          user: 'existing_user', password: 'bogus') }
+        let(:options) do
+          {user: 'existing_user', password: 'bogus'}
+        end
 
         before do
           expect(connection.app_metadata.send(:document)[:saslSupportedMechs]).to eq("admin.existing_user")
@@ -99,8 +108,9 @@ describe 'Auth' do
       min_server_fcv '3.0'
 
       context 'scram-sha-1 requested' do
-        let(:options) { SpecConfig.instance.ssl_options.merge(
-          user: 'nonexistent_user', auth_mech: :scram) }
+        let(:options) do
+          {user: 'nonexistent_user', auth_mech: :scram}
+        end
 
         it 'indicates scram-sha-1 was requested and used' do
           expect do
@@ -112,8 +122,9 @@ describe 'Auth' do
       context 'scram-sha-256 requested' do
         min_server_fcv '4.0'
 
-        let(:options) { SpecConfig.instance.ssl_options.merge(
-          user: 'nonexistent_user', auth_mech: :scram256) }
+        let(:options) do
+          {user: 'nonexistent_user', auth_mech: :scram256}
+        end
 
         it 'indicates scram-sha-256 was requested and used' do
           expect do
@@ -124,8 +135,9 @@ describe 'Auth' do
     end
 
     context 'when authentication fails' do
-      let(:options) { SpecConfig.instance.ssl_options.merge(
-        user: 'nonexistent_user', password: 'foo') }
+      let(:options) do
+        {user: 'nonexistent_user', password: 'foo'}
+      end
 
       it 'reports which server authentication was attempted against' do
         expect do
@@ -142,8 +154,9 @@ describe 'Auth' do
       end
 
       context 'with custom auth source' do
-        let(:options) { SpecConfig.instance.ssl_options.merge(
-          user: 'nonexistent_user', password: 'foo', auth_source: 'authdb') }
+        let(:options) do
+          {user: 'nonexistent_user', password: 'foo', auth_source: 'authdb'}
+        end
 
         it 'reports auth source used' do
           expect do
@@ -240,7 +253,7 @@ describe 'Auth' do
     require_no_auth
 
     let(:client) do
-      new_local_client(SpecConfig.instance.addresses, SpecConfig.instance.ssl_options.merge(
+      new_local_client(SpecConfig.instance.addresses, SpecConfig.instance.monitoring_options.merge(
         auth_source: 'foo'))
     end
 
@@ -254,7 +267,7 @@ describe 'Auth' do
     require_x509_auth
 
     let(:client) do
-      new_local_client(SpecConfig.instance.addresses, SpecConfig.instance.ssl_options.merge(
+      new_local_client(SpecConfig.instance.addresses, base_options.merge(
         auth_mech: :mongodb_x509))
     end
 
@@ -263,4 +276,34 @@ describe 'Auth' do
       client.database.command(ping: 1)
     end
   end
+
+  context 'in lb topology' do
+    require_topology :load_balanced
+
+    context 'when authentication fails with network error' do
+      let(:server) do
+        authorized_client.cluster.next_primary
+      end
+
+      let(:base_options) do
+        SpecConfig.instance.monitoring_options.merge(connect: SpecConfig.instance.test_options[:connect])
+      end
+
+      let(:connection) do
+        Mongo::Server::Connection.new(server, base_options)
+      end
+
+      it 'includes service id in exception' do
+        expect_any_instance_of(Mongo::Server::PendingConnection).to receive(:authenticate!).and_raise(Mongo::Error::SocketError)
+
+        begin
+          connection.connect!
+        rescue Mongo::Error::SocketError => exc
+          exc.service_id.should_not be nil
+        else
+          fail 'Expected the SocketError to be raised'
+        end
+      end
+    end
+  end
 end

data/spec/integration/awaited_ismaster_spec.rb

@@ -1,24 +1,27 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
-describe 'awaited ismaster' do
+describe 'awaited hello' do
   min_server_fcv '4.4'
 
-  # If we send the consecutive ismasters to different mongoses,
+  # If we send the consecutive hello commands to different mongoses,
   # they have different process ids, and so the awaited one would return
   # immediately.
-  require_no_multi_shard
+  require_no_multi_mongos
 
   let(:client) { authorized_client }
 
   it 'waits' do
-    # Perform a regular ismaster to get topology version
-    resp = client.database.command(ismaster: 1)
+    # Perform a regular hello to get topology version
+    resp = client.database.command(hello: 1)
     doc = resp.replies.first.documents.first
     tv = Mongo::TopologyVersion.new(doc['topologyVersion'])
     tv.should be_a(BSON::Document)
 
     elapsed_time = Benchmark.realtime do
-      resp = client.database.command(ismaster: 1,
+      resp = client.database.command(hello: 1,
         topologyVersion: tv.to_doc, maxAwaitTimeMS: 500)
     end
     doc = resp.replies.first.documents.first

data/spec/integration/aws_auth_request_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'lite_spec_helper'
 require 'net/http'
 

data/spec/integration/aws_credentials_retriever_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'lite_spec_helper'
 require 'support/aws_utils'
 

data/spec/integration/bson_symbol_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'Symbol encoding to BSON' do
@@ -12,7 +15,7 @@ describe 'Symbol encoding to BSON' do
   end
 
   let(:expected) do
-    "\x12\x00\x00\x00\x0Efoo\x00\x04\x00\x00\x00foo\x00\x00".force_encoding('binary')
+    (+"\x12\x00\x00\x00\x0Efoo\x00\x04\x00\x00\x00foo\x00\x00").force_encoding('binary')
   end
 
   it 'encodes symbol to BSON symbol' do
@@ -25,8 +28,10 @@ describe 'Symbol encoding to BSON' do
   end
 
   it 'round-trips symbol values using the same byte buffer' do
-    if BSON::Environment.jruby?
-      pending 'https://jira.mongodb.org/browse/RUBY-2128'
+    if BSON::Environment.jruby? && (BSON::VERSION.split('.').map(&:to_i) <=> [4, 11, 0]) < 0
+      skip 'This test is only relevant to bson versions that increment ByteBuffer '\
+       'read and write positions separately in JRuby, as implemented in ' \
+       'bson version 4.11.0. For more information, see https://jira.mongodb.org/browse/RUBY-2128'
     end
 
     Hash.from_bson(hash.to_bson).should == hash

data/spec/integration/bulk_insert_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'Bulk insert' do

data/spec/integration/bulk_write_error_message_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'BulkWriteError message' do
+  let(:client) { authorized_client }
+  let(:collection_name) { 'bulk_write_error_message_spec' }
+  let(:collection) { client[collection_name] }
+
+  before do
+    collection.delete_many
+  end
+
+  context 'a bulk write with one error' do
+    it 'reports code name, code and message' do
+      begin
+        collection.insert_many([
+          {_id: 1},
+          {_id: 1},
+          {_id: 1},
+        ], ordered: true)
+        fail('Should have raised')
+      rescue Mongo::Error::BulkWriteError => e
+        e.message.should =~ %r,\A\[11000\]: (insertDocument :: caused by :: 11000 )?E11000 duplicate key error (collection|index):,
+      end
+    end
+  end
+
+  context 'a bulk write with multiple errors' do
+    it 'reports code name, code and message' do
+      begin
+        collection.insert_many([
+          {_id: 1},
+          {_id: 1},
+          {_id: 1},
+        ], ordered: false)
+        fail('Should have raised')
+      rescue Mongo::Error::BulkWriteError => e
+        e.message.should =~ %r,\AMultiple errors: \[11000\]: (insertDocument :: caused by :: 11000 )?E11000 duplicate key error (collection|index):.*\[11000\]: (insertDocument :: caused by :: 11000 )?E11000 duplicate key error (collection|index):,
+      end
+    end
+  end
+end

data/spec/integration/bulk_write_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'Bulk writes' do
@@ -18,7 +21,7 @@ describe 'Bulk writes' do
   end
 
   context 'when bulk write needs to be split' do
-    let(:subscriber) { EventSubscriber.new }
+    let(:subscriber) { Mrss::EventSubscriber.new }
 
     let(:max_bson_size) { Mongo::Server::ConnectionBase::DEFAULT_MAX_BSON_OBJECT_SIZE }
 

data/spec/integration/change_stream_examples_spec.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'change streams examples in Ruby' do

data/spec/integration/change_stream_spec.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe 'Change stream integration', retry: 4 do
-  only_mri
+  require_mri
   max_example_run_time 7
   min_server_fcv '3.6'
   require_topology :replica_set
@@ -50,7 +53,7 @@ describe 'Change stream integration', retry: 4 do
       it 'raises an exception and does not attempt to resume' do
         change_stream
 
-        subscriber = EventSubscriber.new
+        subscriber = Mrss::EventSubscriber.new
         authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
 
         expect do
@@ -98,7 +101,7 @@ describe 'Change stream integration', retry: 4 do
       it 'watch raises error' do
         expect do
           client['change-stream'].watch
-        end.to raise_error(Mongo::Error::OperationFailure, /Failing command due to 'failCommand' failpoint \(10107\)/)
+        end.to raise_error(Mongo::Error::OperationFailure, /10107\b.*Failing command due to 'failCommand' failpoint/)
       end
     end
 
@@ -283,7 +286,7 @@ describe 'Change stream integration', retry: 4 do
 
         expect do
           enum.next
-        end.to raise_error(Mongo::Error::OperationFailure, /Failing command due to 'failCommand' failpoint \(101\)/)
+        end.to raise_error(Mongo::Error::OperationFailure, /101\b.*Failing command due to 'failCommand' failpoint/)
       end
     end
   end
@@ -414,7 +417,7 @@ describe 'Change stream integration', retry: 4 do
 
           expect do
             enum.try_next
-          end.to raise_error(Mongo::Error::OperationFailure, /Failing command due to 'failCommand' failpoint \(10107\)/)
+          end.to raise_error(Mongo::Error::OperationFailure, /10107\b.*Failing command due to 'failCommand' failpoint/)
         end
       end
 
@@ -441,7 +444,7 @@ describe 'Change stream integration', retry: 4 do
 
           expect do
             enum.try_next
-          end.to raise_error(Mongo::Error::OperationFailure, /Failing command due to 'failCommand' failpoint \(10107\)/)
+          end.to raise_error(Mongo::Error::OperationFailure, /10107\b.*Failing command due to 'failCommand' failpoint/)
         end
       end
     end
@@ -520,7 +523,7 @@ describe 'Change stream integration', retry: 4 do
     let(:events) do
       start_after
 
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
 
@@ -579,7 +582,7 @@ describe 'Change stream integration', retry: 4 do
     let(:stream) { authorized_collection.watch }
 
     let(:events) do
-      subscriber = EventSubscriber.new
+      subscriber = Mrss::EventSubscriber.new
       authorized_client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
       use_stream
       subscriber.succeeded_events.select { |e|