mongo 2.0.6 → 2.1.0

data/spec/support/connection_string.rb

@@ -0,0 +1,228 @@
+# Copyright (C) 2014-2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+RSpec::Matchers.define :have_hosts do |test|
+
+  match do |client|
+
+    def find_server(client, host)
+      client.cluster.instance_variable_get(:@servers).detect do |s|
+        s.address.host == host.host
+      end
+    end
+
+    def match_host?(server, host)
+      server.address.host == host.host
+    end
+
+    def match_port?(server, host)
+      server.address.port == host.port || !host.port
+    end
+
+    def match_address_family?(server, host)
+      address_family(server) == host.address_family
+    end
+
+    def address_family(server)
+      server.address.socket(2)
+      server.address.instance_variable_get(:@resolver).class
+    end
+
+    test.hosts.all? do |host|
+      server = find_server(client, host)
+      match_host?(server, host) &&
+          match_port?(server, host) if server #&&
+          #match_address_family?(server, host) if server
+    end
+
+    failure_message do |client|
+      "With URI: #{test.uri_string}\n" +
+          "Expected that test hosts: #{test.hosts} would match " +
+          "client hosts: #{client.cluster.instance_variable_get(:@servers)}"
+    end
+  end
+end
+
+RSpec::Matchers.define :match_auth do |test|
+
+  def match_database?(client, auth)
+    client.options[:database] == auth.database || !auth.database
+  end
+
+  def match_password?(client, auth)
+    client.options[:password] == auth.password ||
+      client.options[:password].nil? && auth.password == ''
+  end
+
+  match do |client|
+    auth = test.auth
+    return true unless auth
+    client.options[:user] == auth.username &&
+      match_password?(client, auth) &&
+        match_database?(client, auth)
+  end
+
+  failure_message do |client|
+    "With URI: #{test.uri_string}\n" +
+        "Expected that test auth: #{test.auth} would match client auth: #{client.options}"
+  end
+end
+
+RSpec::Matchers.define :match_options do |test|
+
+  match do |client|
+    options = test.options
+    return true unless options
+    options.match?(client.options)
+  end
+
+  failure_message do |client|
+    "With URI: #{test.uri_string}\n" +
+      "Expected that test options: #{test.options.options} would match client options: #{client.options}"
+  end
+end
+
+module Mongo
+  module ConnectionString
+
+    class Spec
+
+      attr_reader :description
+
+      # Instantiate the new spec.
+      #
+      # @example Create the spec.
+      #   Spec.new(file)
+      #
+      # @param [ String ] file The name of the file.
+      #
+      # @since 2.0.0
+      def initialize(file)
+        file = File.new(file)
+        @spec = YAML.load(ERB.new(file.read).result)
+        file.close
+        @description = File.basename(file)
+      end
+
+      def tests
+        @tests ||= @spec['tests'].collect do |spec|
+          Test.new(spec)
+        end
+      end
+    end
+
+    class Test
+
+      attr_reader :description
+      attr_reader :uri_string
+
+      def initialize(spec)
+        @spec = spec
+        @description = @spec['description']
+        @uri_string = @spec['uri']
+      end
+
+      def valid?
+        @spec['valid']
+      end
+
+      def warn?
+        @spec['warning']
+      end
+
+      def hosts
+        @hosts ||= @spec['hosts'].collect do |host|
+          Host.new(host)
+        end
+      end
+
+      def options
+        @options ||= Options.new(@spec['options']) if @spec['options']
+      end
+
+      def client
+        @client ||= Mongo::Client.new(@spec['uri'])
+      end
+
+      def uri
+        @uri ||= Mongo::URI.new(@spec['uri'])
+      end
+
+      def auth
+        @auth ||= Auth.new(@spec['auth']) if @spec['auth']
+      end
+    end
+
+    class Host
+
+      MAPPING = {
+          'ipv4' => Mongo::Address::IPv4,
+          'ipv6' => Mongo::Address::IPv6,
+          'unix' => Mongo::Address::Unix
+      }
+
+      attr_reader :host
+      attr_reader :port
+
+      def initialize(spec)
+        @spec = spec
+        @host = @spec['host']
+        @port = @spec['port']
+      end
+
+      def address_family
+        MAPPING[@spec['type']]
+      end
+    end
+
+    class Auth
+
+      attr_reader :username
+      attr_reader :password
+      attr_reader :database
+
+      def initialize(spec)
+        @spec = spec
+        @username = @spec['username']
+        @password = @spec['password']
+        @database = @spec['db']
+      end
+
+      def to_s
+        "username: #{username}, password: #{password}, database: #{database}"
+      end
+    end
+
+    class Options
+
+      MAPPINGS = {
+          'replicaset' => :replica_set,
+          'authmechanism' => :auth_mech
+      }
+
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def match?(opts)
+        @options.keys.all? do |k|
+          opts[MAPPINGS[k]] == @options[k] ||
+              Mongo::URI::AUTH_MECH_MAP[@options[k]] == opts[MAPPINGS[k]]
+        end
+      end
+    end
+  end
+end

data/spec/support/connection_string_tests/invalid-uris.yml

@@ -0,0 +1,193 @@
+tests:
+    -
+        description: "Empty string"
+        uri: ""
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid scheme"
+        uri: "mongo://localhost:27017"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Missing host"
+        uri: "mongodb://"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Double colon in host identifier"
+        uri: "mongodb://localhost::27017"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Double colon in host identifier and trailing slash"
+        uri: "mongodb://localhost::27017/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Double colon in host identifier with missing host and port"
+        uri: "mongodb://::"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Double colon in host identifier with missing port"
+        uri: "mongodb://localhost,localhost::"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Double colon in host identifier and second host"
+        uri: "mongodb://localhost::27017,abc"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (negative number) with hostname"
+        uri: "mongodb://localhost:-1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (zero) with hostname"
+        uri: "mongodb://localhost:0/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (positive number) with hostname"
+        uri: "mongodb://localhost:65536"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (positive number) with hostname and trailing slash"
+        uri: "mongodb://localhost:65536/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (non-numeric string) with hostname"
+        uri: "mongodb://localhost:foo"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (negative number) with IP literal"
+        uri: "mongodb://[::1]:-1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (zero) with IP literal"
+        uri: "mongodb://[::1]:0/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (positive number) with IP literal"
+        uri: "mongodb://[::1]:65536"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (positive number) with IP literal and trailing slash"
+        uri: "mongodb://[::1]:65536/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Invalid port (non-numeric string) with IP literal"
+        uri: "mongodb://[::1]:foo"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Missing delimiting slash between hosts and options"
+        uri: "mongodb://example.com?w=1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Incomplete key value pair for option"
+        uri: "mongodb://example.com/?w"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Username with password containing an unescaped colon"
+        uri: "mongodb://alice:foo:bar@127.0.0.1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Username containing an unescaped at-sign"
+        uri: "mongodb://alice@@127.0.0.1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Username with password containing an unescaped at-sign"
+        uri: "mongodb://alice@foo:bar@127.0.0.1"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~
+    -
+        description: "Host with unescaped slash"
+        uri: "mongodb:///tmp/mongodb-27017.sock/"
+        valid: false
+        warning: ~
+        hosts: ~
+        auth: ~
+        options: ~

data/spec/support/connection_string_tests/valid-auth.yml

@@ -0,0 +1,256 @@
+tests:
+    -
+        description: "User info for single IPv4 host without database"
+        uri: "mongodb://alice:foo@127.0.0.1"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "alice"
+            password: "foo"
+            db: ~
+        options: ~
+    -
+        description: "User info for single IPv4 host with database"
+        uri: "mongodb://alice:foo@127.0.0.1/test"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "alice"
+            password: "foo"
+            db: "test"
+        options: ~
+    -
+        description: "User info for single IPv4 host with database (escaped null bytes)"
+        uri: "mongodb://a%00lice:f%00oo@127.0.0.1/t%00est"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "a\0lice"
+            password: "f\0oo"
+            db: "t\0est"
+        options: ~
+    -
+        description: "User info for single IP literal host without database"
+        uri: "mongodb://bob:bar@[::1]:27018"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ip_literal"
+                host: "::1"
+                port: 27018
+        auth:
+            username: "bob"
+            password: "bar"
+            db: ~
+        options: ~
+    -
+        description: "User info for single IP literal host with database"
+        uri: "mongodb://bob:bar@[::1]:27018/admin"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ip_literal"
+                host: "::1"
+                port: 27018
+        auth:
+            username: "bob"
+            password: "bar"
+            db: "admin"
+        options: ~
+    -
+        description: "User info for single hostname without database"
+        uri: "mongodb://eve:baz@example.com"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "example.com"
+                port: ~
+        auth:
+            username: "eve"
+            password: "baz"
+            db: ~
+        options: ~
+    -
+        description: "User info for single hostname with database"
+        uri: "mongodb://eve:baz@example.com/db2"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "example.com"
+                port: ~
+        auth:
+            username: "eve"
+            password: "baz"
+            db: "db2"
+        options: ~
+    -
+        description: "User info for multiple hosts without database"
+        uri: "mongodb://alice:secret@127.0.0.1,example.com:27018"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+            -
+                type: "hostname"
+                host: "example.com"
+                port: 27018
+        auth:
+            username: "alice"
+            password: "secret"
+            db: ~
+        options: ~
+    -
+        description: "User info for multiple hosts with database"
+        uri: "mongodb://alice:secret@example.com,[::1]:27019/admin"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "example.com"
+                port: ~
+            -
+                type: "ip_literal"
+                host: "::1"
+                port: 27019
+        auth:
+            username: "alice"
+            password: "secret"
+            db: "admin"
+        options: ~
+    -
+        description: "Username without password"
+        uri: "mongodb://alice@127.0.0.1"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "alice"
+            password: ~
+            db: ~
+        options: ~
+    -
+        description: "Username with empty password"
+        uri: "mongodb://alice:@127.0.0.1"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "alice"
+            password: ""
+            db: ~
+        options: ~
+    -
+        description: "Escaped username and database without password"
+        uri: "mongodb://%40l%3Ace@example.com/my%3Ddb"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "example.com"
+                port: ~
+        auth:
+            username: "@l:ce"
+            password: ~
+            db: "my=db"
+        options: ~
+    -
+        description: "Escaped user info and database (MONGODB-CR)"
+        uri: "mongodb://%24am:f%3Azzb%40zz@127.0.0.1/admin%3F?authMechanism=MONGODB-CR"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "ipv4"
+                host: "127.0.0.1"
+                port: ~
+        auth:
+            username: "$am"
+            password: "f:zzb@zz"
+            db: "admin?"
+        options:
+            authmechanism: "MONGODB-CR"
+    -
+        description: "Escaped username (MONGODB-X509)"
+        uri: "mongodb://CN%3DmyName%2COU%3DmyOrgUnit%2CO%3DmyOrg%2CL%3DmyLocality%2CST%3DmyState%2CC%3DmyCountry@localhost/?authMechanism=MONGODB-X509"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "localhost"
+                port: ~
+        auth:
+            username: "CN=myName,OU=myOrgUnit,O=myOrg,L=myLocality,ST=myState,C=myCountry"
+            password: ~
+            db: ~
+        options:
+            authmechanism: "MONGODB-X509"
+    -
+        description: "Escaped username (GSSAPI)"
+        uri: "mongodb://user%40EXAMPLE.COM:secret@localhost/?authMechanismProperties=SERVICE_NAME:other,CANONICALIZE_HOST_NAME:true&authMechanism=GSSAPI"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "localhost"
+                port: ~
+        auth:
+            username: "user@EXAMPLE.COM"
+            password: "secret"
+            db: ~
+        options:
+            authmechanism: "GSSAPI"
+            authmechanismproperties:
+                SERVICE_NAME: "other"
+                CANONICALIZE_HOST_NAME: true
+    -
+        description: "At-signs in options aren't part of the userinfo"
+        uri: "mongodb://alice:secret@example.com/admin?replicaset=my@replicaset"
+        valid: true
+        warning: false
+        hosts:
+            -
+                type: "hostname"
+                host: "example.com"
+                port: ~
+        auth:
+            username: "alice"
+            password: "secret"
+            db: "admin"
+        options:
+            replicaset: "my@replicaset"