mongo 2.13.2 → 2.15.0

data/lib/mongo/uri/srv_protocol.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2017-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -97,7 +100,7 @@ module Mongo
 
       # @return [ String ] NO_SRV_RECORDS Error message format string indicating that no SRV records
       #   were found.
-      NO_SRV_RECORDS = "The DNS query returned no SRV records at hostname (%s)".freeze
+      NO_SRV_RECORDS = "The DNS query returned no SRV records for '%s'".freeze
 
       # @return [ String ] INVALID_TXT_RECORD_OPTION Error message format string indicating that an
       #   unexpected TXT record option was found.
@@ -130,6 +133,7 @@ module Mongo
         @resolver ||= Srv::Resolver.new(
           raise_on_invalid: true,
           resolv_options: options[:resolv_options],
+          timeout: options[:connect_timeout],
         )
       end
 
@@ -220,7 +224,7 @@ module Mongo
           raise Error::InvalidTXTRecord.new(INVALID_OPTS_VALUE_DELIM) unless opt.index(URI_OPTS_VALUE_DELIM)
           key, value = opt.split(URI_OPTS_VALUE_DELIM)
           raise Error::InvalidTXTRecord.new(INVALID_TXT_RECORD_OPTION) unless VALID_TXT_OPTIONS.include?(key.downcase)
-          add_uri_option(key, value, txt_options)
+          options_mapper.add_uri_option(key, value, txt_options)
           txt_options
         end
       end

data/lib/mongo/utils.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Copyright (C) 2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
@@ -34,7 +37,7 @@ module Mongo
     # @option opts [ Logger ] :logger A custom logger to use.
     # @option opts [ String ] :log_prefix A custom log prefix to use when
     #   logging.
-    module_function def warn_monitor_exception(msg, exc, **opts)
+    module_function def warn_bg_exception(msg, exc, **opts)
       bt_excerpt = excerpt_backtrace(exc, **opts)
       logger = LocalLogger.new(**opts)
       logger.log_warn("#{msg}: #{exc.class}: #{exc}#{bt_excerpt}")
@@ -55,8 +58,61 @@ module Mongo
       end
     end
 
+    # Symbolizes the keys in the provided hash.
     module_function def shallow_symbolize_keys(hash)
       Hash[hash.map { |k, v| [k.to_sym, v] }]
     end
+
+    # Stringifies the keys in the provided hash and converts underscore
+    # style keys to camel case style keys.
+    module_function def shallow_camelize_keys(hash)
+      Hash[hash.map { |k, v| [camelize(k), v] }]
+    end
+
+    module_function def camelize(sym)
+      sym.to_s.gsub(/_(\w)/) { $1.upcase }
+    end
+
+    # @note server_api must have symbol keys or be a BSON::Document.
+    module_function def transform_server_api(server_api)
+      {}.tap do |doc|
+        if version = server_api[:version]
+          doc['apiVersion'] = version
+        end
+        unless server_api[:strict].nil?
+          doc['apiStrict'] = server_api[:strict]
+        end
+        unless server_api[:deprecation_errors].nil?
+          doc['apiDeprecationErrors'] = server_api[:deprecation_errors]
+        end
+      end
+    end
+
+    # This function should be used if you need to measure time.
+    # @example Calculate elapsed time.
+    #   starting = Utils.monotonic_time
+    #   # do something time consuming
+    #   ending = Utils.monotonic_time
+    #   puts "It took #{(ending - starting).to_i} seconds"
+    #
+    # @see https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+    #
+    # @return [Float] seconds according to monotonic clock
+    module_function def monotonic_time
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
+    # Hash#compact implementation for Ruby 2.3
+    module_function def compact_hash(hash)
+      Hash[hash.reject do |k, v|
+        v.nil?
+      end]
+    end
+
+    # Hash#compact implementation for Ruby 2.3/2.4
+    # Implementation based on activesupport 5.2.3
+    module_function def slice_hash(hash, *keys)
+      keys.each_with_object({}) { |k, res| res[k] = hash[k] if hash.key?(k) }
+    end
   end
 end

data/lib/mongo/version.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");
@@ -17,5 +20,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.13.2'.freeze
+  VERSION = '2.15.0'.freeze
 end

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/write_concern/acknowledged.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');

data/lib/mongo/write_concern/base.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');

data/lib/mongo/write_concern/unacknowledged.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');

data/spec/NOTES.aws-auth.md

@@ -145,13 +145,16 @@ problem. Below are some of the puzzling responses I encountered:
   line) but the value is otherwise completely valid. This error has no relation
   to the "session token" or "security token" as used with temporary AWS
   credentials.
-- *The security token included in the request is invalid*: this error is
-  produced when the AWS access key id, as specified in the scope part of the
-  `Authorization` header, is not a valid access key id. In the case of
-  non-temporary credentials being used for authentication, the error refers to
-  a "security token" but the authentication process does not actually use a
-  security token as this term is used in the AWS documentation describing
-  temporary credentials.
+- *The security token included in the request is invalid*: this error can be
+  produced in several circumstances:
+  - When the AWS access key id, as specified in the scope part of the
+    `Authorization` header, is not a valid access key id. In the case of
+    non-temporary credentials being used for authentication, the error refers to
+    a "security token" but the authentication process does not actually use a
+    security token as this term is used in the AWS documentation describing
+    temporary credentials.
+  - When using temporary credentials and the security token is not provided
+    in the STS request at all (x-amz-security-token header).
 - *Signature expired: 20200317T000000Z is now earlier than 20200317T222541Z
   (20200317T224041Z - 15 min.)*: This error happens when `x-amz-date` header
   value is the formatted date (`YYYYMMDD`) rather than the ISO8601 formatted
@@ -168,6 +171,8 @@ problem. Below are some of the puzzling responses I encountered:
   produced when temporary credentials are used and the credentials have
   expired.
 
+See also [AWS documentation for STS error messages](https://docs.aws.amazon.com/STS/latest/APIReference/CommonErrors.html).
+
 ### Resources
 
 Generally I found Amazon's own documentation to be the best for implementing

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:
 
@@ -107,7 +114,7 @@ other tests require a sharded cluster with more than one shard. Tests requiring
 a single shard can be run against a deployment with multiple shards by
 specifying only one mongos address in MONGODB_URI.
 
-## Note Regarding SSL/TLS Arguments
+## Note Regarding TLS/SSL Arguments
 
 MongoDB 4.2 (server and shell) added new command line options for setting TLS
 parameters. These options follow the naming of URI options used by both the
@@ -185,6 +192,51 @@ verification, run:
 Note that there are tests in the test suite that cover TLS verification, and
 they may fail if the test suite is run in this way.
 
+## OCSP
+
+There are several types of OCSP tests implemented in the test suite.
+
+OCSP unit tests are in `spec/integration/ocsp_verifier_spec.rb`. To run
+these, set `OCSP_VERIFIER=1` in the environment. There must NOT be a process
+running on the host port 8100 as that port will be used by the OCSP responder
+launched by the tests.
+
+For the remaining OCSP tests, the following environment variables must be set
+to the possible values indicated below:
+
+    OCSP_ALGORITHM=rsa|ecdsa
+    OCSP_STATUS=valid|revoked|unknown
+    OCSP_DELEGATE=0|1
+    OCSP_MUST_STAPLE=0|1
+
+These tests also require the mock OCSP responder running on the host machine
+on port 8100 with the configuration that matches the environment variables
+just described. Please refer to the Docker and Evergreen scripts in the
+driver repository for further details.
+
+Additionally, the server must be configured to use the appropriate server
+certificate and CA certificate from the respective subdirectory of
+`spec/support/ocsp`. This is easiest to achieve by using the Docker tooling
+described in `.evergreen/README.md`.
+
+OCSP connectivity tests are in `spec/integration/ocsp_connectivity.rb`.
+These test the combinations described
+[here](https://github.com/mongodb/specifications/blob/master/source/ocsp-support/tests/README.rst#integration-tests-permutations-to-be-tested).
+To run these tests, set `OCSP_CONNECTIVITY=pass` environment variable if
+the tests are expected to connect successfully or `OCSP_CONNECTIVITY=fail` if
+the tests are expected to not connect.
+Note that some of these configurations require OCSP responder to return
+the failure response; in such configurations, ONLY the OCSP connectivity tests
+may pass (since the driver may reject connections to servers when OCSP
+responder returns the failure response, or OCSP verification otherwise
+definitively fails).
+
+When not running either OCSP verifier tests or OCSP connectivity tests but
+when OCSP algorithm is configured, the test suite will execute normally
+using the provided `MONGO_URI`. This configuration may be used to exercise
+OCSP while running the full test suite. In this case, setting `OCSP_STATUS`
+to `revoked` will generally cause the test suite to fail.
+
 ## Authentication
 
 mlaunch can configure authentication on the server:
@@ -460,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,
@@ -511,6 +586,16 @@ following environment variable:
 
     FORK=1
 
+OCSP tests require Python 3 with asn1crypto, oscrypto and flask packages
+installed, and they require the drivers-evergreen-tools submodule to be
+checked out. To run these tests, set the following environment variable:
+
+    OCSP=1
+
+To check out the submodule, run:
+
+    git submodule update --init --recursive
+
 ## Debug Logging
 
 The test suite is run with the driver log level set to `WARN` by default.

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
+    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
 

data/spec/integration/awaited_ismaster_spec.rb

@@ -1,9 +1,12 @@
+# 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
@@ -11,14 +14,14 @@ describe 'awaited ismaster' do
   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