1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 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, hosts|
match do |cl|
def find_server(client, host)
client.cluster.servers_list.detect do |s|
if host.port
s.address.host == host.host && s.address.port == host.port
else
s.address.host == host.host
end
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
hosts.all? do |host|
server = find_server(cl, host)
server &&
match_host?(server, host) &&
match_port?(server, host) #&&
#match_address_family?(server, host)
end
end
failure_message do |client|
"With URI: #{test.uri_string}\n" +
"Expected client hosts: #{client.cluster.instance_variable_get(:@servers)} " +
"to match #{hosts}"
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
module Mongo
module ConnectionString
class Spec
attr_reader :description
# Instantiate the new spec.
#
# @param [ String ] test_path The path to the file.
#
# @since 2.0.0
def initialize(test_path)
@spec = ::Utils.load_spec_yaml_file(test_path)
@description = File.basename(test_path)
end
def tests
@tests ||= @spec['tests'].collect do |spec|
Test.new(spec)
end
end
end
class Test
include RSpec::Core::Pending
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 seeds
if @spec['seeds']
@seeds ||= (@spec['seeds'] || []).collect do |host|
Host.new(host)
end
else
nil
end
end
def expected_options
@spec['options']
end
def non_uri_options
@spec['parsed_options']
end
def client
@client ||= ClientRegistry.instance.new_local_client(@spec['uri'], monitoring_io: false)
rescue Mongo::Error::LintError => e
if e.message =~ /arbitraryButStillValid/
skip 'Test uses a read concern that fails linter'
end
end
def uri
@uri ||= Mongo::URI.get(@spec['uri'])
end
def auth
@auth ||= Auth.new(@spec['auth']) if @spec['auth']
end
def raise_error?
@spec['error']
end
def read_concern_expectation
@spec['readConcern']
end
def write_concern_expectation
@spec['writeConcern']
end
def num_seeds
@spec['numSeeds']
end
def num_hosts
@spec['numHosts']
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)
if spec.is_a?(Hash)
# Connection string spec tests
@spec = spec
@host = @spec['host']
@port = @spec['port']
else
# DNS seed list spec tests
address = Mongo::Address.new(spec)
@host = address.host
@port = address.port
end
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
module_function def adjust_expected_mongo_client_options(options)
expected = options.dup.tap do |expected|
expected.each do |k, v|
# Ruby driver downcases auth mechanism properties when
# constructing the client.
#
# Some tests give options in all lower case.
if k.downcase == 'authmechanismproperties'
expected[k] = ::Utils.downcase_keys(v)
end
end
# We omit retryReads/retryWrites=true because some tests do not
# provide those.
%w(retryReads retryWrites).each do |k, v|
if expected[k] == true
expected.delete(k)
end
end
# Fix appName case.
if expected.key?('appname') && !expected.key?('appName')
expected['appName'] = expected.delete('appname')
end
end
end
end
end
def define_connection_string_spec_tests(test_paths, spec_cls = Mongo::ConnectionString::Spec, &block)
clean_slate_for_all_if_possible
test_paths.each do |path|
spec = spec_cls.new(path)
context(spec.description) do
#include Mongo::ConnectionString
spec.tests.each_with_index do |test, index|
context "when a #{test.description} is provided" do
if test.description.downcase.include?("gssapi")
require_mongo_kerberos
end
context 'when the uri is invalid', unless: test.valid? do
it 'raises an error' do
expect do
test.uri
end.to raise_exception(Mongo::Error::InvalidURI)
end
end
context 'when the uri should warn', if: test.warn? do
before do
expect(Mongo::Logger.logger).to receive(:warn)
end
it 'warns' do
expect(test.client).to be_a(Mongo::Client)
end
end
context 'when the uri is valid', if: test.valid? do
it 'does not raise an exception' do
expect(test.uri).to be_a(Mongo::URI)
end
it 'creates a client with the correct hosts' do
expect(test.client).to have_hosts(test, test.hosts)
end
it 'creates a client with the correct authentication options' do
expect(test.client).to match_auth(test)
end
if test.expected_options
it 'creates a client with the correct options' do
mapped = Mongo::URI::OptionsMapper.new.ruby_to_smc(test.client.options)
# Connection string spec tests do not use canonical URI option names
actual = Utils.downcase_keys(mapped)
actual.delete('authsource')
expected = Mongo::ConnectionString.adjust_expected_mongo_client_options(
test.expected_options,
)
actual.should == expected
end
end
if test.read_concern_expectation
# Tests do not specify a read concern in the input and expect
# the read concern to be {); our non-specified read concern is nil.
# (But if a test used nil for the expectation, we wouldn't assert
# read concern at all.)
if test.read_concern_expectation == {}
it 'creates a client with no read concern' do
actual = Utils.camelize_hash(test.client.options[:read_concern])
expect(actual).to be nil
end
else
it 'creates a client with the correct read concern' do
actual = Utils.camelize_hash(test.client.options[:read_concern])
expect(actual).to eq(test.read_concern_expectation)
end
end
end
if test.write_concern_expectation
let(:actual_write_concern) do
Utils.camelize_hash(test.client.options[:write_concern])
end
let(:expected_write_concern) do
test.write_concern_expectation.dup.tap do |expected|
# Spec tests have expectations on the "driver API" which is
# different from what is being sent to the server. In Ruby
# the "driver API" matches what we send to the server, thus
# these expectations are rather awkward to work with.
# Convert them all to expected server fields.
j = expected.delete('journal')
unless j.nil?
expected['j'] = j
end
wtimeout = expected.delete('wtimeoutMS')
unless wtimeout.nil?
expected['wtimeout'] = wtimeout
end
end
end
if test.write_concern_expectation == {}
it 'creates a client with no write concern' do
expect(actual_write_concern).to be nil
end
else
it 'creates a client with the correct write concern' do
expect(actual_write_concern).to eq(expected_write_concern)
end
end
end
end
end
end
end
end
end
|