implement uri option spec tests

Author: saghm

lib/mongo/uri.rb

@@ -430,17 +430,19 @@ def self.uri_option(uri_key, name, extra = {})
     uri_option 'sockettimeoutms', :socket_timeout, :type => :ms_convert
     uri_option 'serverselectiontimeoutms', :server_selection_timeout, :type => :ms_convert
     uri_option 'localthresholdms', :local_threshold, :type => :ms_convert
+    uri_option 'heartbeatfrequencyms', :heartbeat_frequency, :type => :ms_convert
+    uri_option 'maxidletimems', :max_idle_time, :type => :ms_convert
 
     # Write Options
     uri_option 'w', :w, :group => :write
-    uri_option 'journal', :j, :group => :write
+    uri_option 'journal', :j, :group => :write, :type => :bool
     uri_option 'fsync', :fsync, :group => :write
-    uri_option 'wtimeoutms', :timeout, :group => :write
+    uri_option 'wtimeoutms', :timeout, :group => :write, :type => :unsigned_int
 
     # Read Options
     uri_option 'readpreference', :mode, :group => :read, :type => :read_mode
     uri_option 'readpreferencetags', :tag_sets, :group => :read, :type => :read_tags
-    uri_option 'maxstalenessseconds', :max_staleness, :group => :read
+    uri_option 'maxstalenessseconds', :max_staleness, :group => :read, :type => :max_staleness
 
     # Pool options
     uri_option 'minpoolsize', :min_pool_size
@@ -449,6 +451,13 @@ def self.uri_option(uri_key, name, extra = {})
 
     # Security Options
     uri_option 'ssl', :ssl
+    uri_option 'tls', :ssl
+    uri_option 'tlsallowinvalidcertificates', :ssl_verify, :type => :inverse_bool
+    uri_option 'tlscafilepath', :ssl_ca_cert
+    uri_option 'tlsclientcertfilepath', :ssl_cert
+    uri_option 'tlsclientkeyfilepath', :ssl_key
+    uri_option 'tlsclientkeypassword', :ssl_key_pass_phrase
+
 
     # Topology options
     uri_option 'connect', :connect
@@ -461,7 +470,9 @@ def self.uri_option(uri_key, name, extra = {})
     # Client Options
     uri_option 'appname', :app_name
     uri_option 'compressors', :compressors, :type => :array
-    uri_option 'zlibcompressionlevel', :zlib_compression_level
+    uri_option 'readconcernlevel', :read_concern
+    uri_option 'retrywrites', :retry_writes, :type => :bool
+    uri_option 'zlibcompressionlevel', :zlib_compression_level, :type => :zlib_compression_level
 
     # Casts option values that do not have a specifically provided
     # transformation to the appropriate type.
@@ -571,7 +582,7 @@ def auth_source(value)
     #
     # @return [Symbol] The transformed authentication mechanism.
     def auth_mech(value)
-      AUTH_MECH_MAP[value.upcase]
+      AUTH_MECH_MAP[value.upcase] || log_warn("#{value} is not a valid auth mechanism")
     end
 
     # Read preference mode transformation.
@@ -615,6 +626,92 @@ def auth_mech_props(value)
       properties
     end
 
+    # Parses the zlib compression level.
+    #
+    # @param value [ String ] The zlib compression level string.
+    #
+    # @return [ Integer | nil ] The compression level value if it is between -1 and 9 (inclusive),
+    #   otherwise nil (and a warning will be raised).
+    def zlib_compression_level(value)
+      if /^-?\d+$/ =~ value
+        i = value.to_i
+
+        if i >= -1 && i <= 9
+          return i
+        end
+      end
+
+      log_warn("#{value} is not a valid zlibCompressionLevel")
+      nil
+    end
+
+
+    # Parses a boolean value.
+    #
+    # @param value [ String ] The URI option value.
+    #
+    # @return [ true | false | nil ] The boolean value parsed out, otherwise nil (and a warning
+    #   will be raised).
+    def bool(value)
+      case value
+      when "true"
+        true
+      when "false"
+        false
+      else
+        log_warn("invalid boolean: #{value}")
+        nil
+      end
+    end
+
+    # Parses a boolean value and returns its inverse. This is used for options where the spec
+    # defines the boolean value semantics of enabling/disabling something in the reverse way that
+    # the driver does. For instance, the client option `ssl_verify` will disable certificate
+    # checking when the value is false, but the spec defines the option
+    # `tlsAllowInvalidCertificates`, which disables certificate checking when the value is true.
+    #
+    # @param value [ String ] The URI option.
+    #
+    # @return [ true | false | nil ] The inverse of boolean value parsed out, otherwise nil (and a
+    #   warning will be raised).
+    def inverse_bool(value)
+      !bool(value)
+    end
+
+    # Parses the max staleness value, which must be either "0" or an integer greater or equal to 90.
+    #
+    # @param value [ String ] The max staleness string.
+    #
+    # @return [ Integer | nil ] The max staleness integer parsed out if it is valid, otherwise nil
+    #   (and a warning will be raised).
+    def max_staleness(value)
+      if /^\d+$/ =~ value
+        int = value.to_i
+
+        if int == 0 || int >= 90
+          return int
+        end
+      end
+
+      log_warn("Invalid max staleness value: #{value}")
+      nil
+    end
+
+    # Parses an unsigned integer value.
+    #
+    # @param value [ String ] The URI option value.
+    #
+    # @return [ Integer | nil ] The integer parsed out, otherwise nil (and a warning will be
+    #   raised).
+    def unsigned_int(value)
+     unless /^-?\d+$/ =~ value
+        log_warn("Invalid unsigned integer value: #{value}")
+        return nil
+     end
+
+      value.to_i
+    end
+
     # Ruby's convention is to provide timeouts in seconds, not milliseconds and
     # to use fractions where more precision is necessary. The connection string
     # options are always in MS so we provide an easy conversion type.
@@ -625,6 +722,11 @@ def auth_mech_props(value)
     #
     # @since 2.0.0
     def ms_convert(value)
+      unless /^-?\d+(\.\d+)?$/ =~ value
+        log_warn("Invalid ms value: #{value}")
+        return nil
+      end
+
       value.to_f / 1000
     end
 
@@ -636,6 +738,11 @@ def ms_convert(value)
     def hash_extractor(value)
       value.split(',').reduce({}) do |set, tag|
         k, v = tag.split(':')
+        if v.nil?
+          log_warn("#{value} is not a valid URI hash")
+          return nil
+        end
+
         set.merge(decode(k).downcase.to_sym => decode(v))
       end
     end

spec/lite_spec_helper.rb

@@ -9,6 +9,7 @@
 RETRYABLE_WRITES_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/retryable_writes/**/*.yml")
 COMMAND_MONITORING_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/command_monitoring/**/*.yml")
 CONNECTION_STRING_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/connection_string/*.yml")
+URI_OPTIONS_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/uri_options/*.yml")
 DNS_SEEDLIST_DISCOVERY_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/dns_seedlist_discovery/*.yml")
 GRIDFS_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/gridfs/*.yml")
 TRANSACTIONS_TESTS = Dir.glob("#{CURRENT_PATH}/spec_tests/data/transactions/*.yml")

spec/spec_tests/data/uri_options/auth-options.yml

@@ -0,0 +1,17 @@
+tests:
+    -
+        description: "Valid auth options are parsed correctly"
+        uri: "mongodb://example.com/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:other,CANONICALIZE_HOST_NAME:true&authSource=$external"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            authmechanism: "GSSAPI"
+            authMechanismProperties:
+                SERVICE_NAME: "other"
+                CANONICALIZE_HOST_NAME: "true"
+            authSource: "$external"

spec/spec_tests/data/uri_options/compression-options.yml

@@ -0,0 +1,36 @@
+tests:
+    -
+        description: "Valid compression options are parsed correctly"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=9"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            compressors: "zlib"
+            zlibCompressionLevel: "9"
+    -
+        description: "Invalid compressors cause a warning"
+        uri: "mongodb://example.com/?compressors=jpeg"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid zlibCompressionLevel causes a warning"
+        uri: "mongodb://example.com/?compressors=zlib&zlibCompressionLevel=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}

spec/spec_tests/data/uri_options/concern-options.yml

@@ -0,0 +1,62 @@
+tests:
+    -
+        description: "Valid read and write concern are parsed correctly"
+        uri: "mongodb://example.com/?readConcernLevel=majority&w=5&wTimeoutMS=30000&journal=false"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            readConcernLevel: "majority"
+            w: "5"
+            wTimeoutMS: "30000"
+            journal: "false"
+    -
+        description: "Arbitrary string readConcernLevel does not cause a warning"
+        uri: "mongodb://example.com/?readConcernLevel=arbitraryButStillValid"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            readConcernLevel: "arbitraryButStillValid"
+    -
+        description: "Arbitrary string w doesn't cause a warning"
+        uri: "mongodb://example.com/?w=arbitraryButStillValid"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            w: "arbitraryButStillValid"
+    -
+        description: "Invalid wTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?wTimeoutMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid journal causes a warning"
+        uri: "mongodb://example.com/?journal=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}

spec/spec_tests/data/uri_options/connection-options.yml

@@ -0,0 +1,76 @@
+tests:
+    -
+        description: "Valid connection and timeout options are parsed correctly"
+        uri: "mongodb://example.com/?appname=URI-OPTIONS-SPEC-TEST&connectTimeoutMS=20000&heartbeatFrequencyMS=5000&localThresholdMS=3000&replicaSet=uri-options-spec&retryWrites=true&serverSelectionTimeoutMS=15000&socketTimeoutMS=7500"
+        valid: true
+        warning: false
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options:
+            appname: "URI-OPTIONS-SPEC-TEST"
+            connectTimeoutMS: "20000"
+            heartbeatFrequencyMS: "5000"
+            localThresholdMS: "3000"
+            maxIdleTimeMS: "50000"
+            replicaSet: "uri-options-spec"
+            retryWrites: "true"
+            serverSelectionTimeoutMS: "15000"
+            socketTimeoutMS: "7500"
+    -
+        description: "Invalid connectTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?connectTimeoutMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid heartbeatFrequencyMS causes a warning"
+        uri: "mongodb://example.com/?heartbeatFrequencyMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid localThresholdMS causes a warning"
+        uri: "mongodb://example.com/?localThresholdMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid serverSelectionTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?serverSelectionTimeoutMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}
+    -
+        description: "Invalid socketTimeoutMS causes a warning"
+        uri: "mongodb://example.com/?socketTimeoutMS=invalid"
+        valid: true
+        warning: true
+        hosts: ~
+        auth:
+            username: ~
+            password: ~
+            db: ~
+        options: {}