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 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
|
require 'cgi'
NET_CONNECT_NOT_ALLOWED_ERROR = /An HTTP request has been made that VCR does not know how to handle/
shared_examples_for "a hook into an HTTP library" do |library_hook_name, library, *other|
include HeaderDowncaser
include VCRStubHelpers
unless adapter_module = HTTP_LIBRARY_ADAPTERS[library]
raise ArgumentError.new("No http library adapter module could be found for #{library}")
end
http_lib_unsupported = (RUBY_INTERPRETER != :mri && library =~ /(typhoeus|curb|patron|em-http)/)
describe "using #{adapter_module.http_library_name}", :unless => http_lib_unsupported do
include adapter_module
# Necessary for ruby 1.9.2. On 1.9.2 we get an error when we use super,
# so this gives us another alias we can use for the original method.
alias make_request make_http_request
1.upto(2) do |header_count|
describe "making an HTTP request that responds with #{header_count} Set-Cookie header(s)" do
define_method :get_set_cookie_header do
VCR.use_cassette('header_test', :record => :once) do
get_header 'Set-Cookie', make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/set-cookie-headers/#{header_count}")
end
end
it 'returns the same header value when recording and replaying' do
expect((recorded_val = get_set_cookie_header)).not_to be_nil
replayed_val = get_set_cookie_header
expect(replayed_val).to eq(recorded_val)
end
end
end
def self.test_record_and_playback(description, query)
describe "a request to a URL #{description}" do
define_method :get_body do
VCR.use_cassette('record_and_playback', :record => :once) do
get_body_string make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/record-and-playback?#{query}")
end
end
it "properly records and playsback a request with a URL #{description}" do
recorded_body = get_body
played_back_body = get_body
expect(played_back_body).to eq(recorded_body)
end
end
end
test_record_and_playback "with spaces encoded as +", "q=a+b"
test_record_and_playback "with spaces encoded as %20", "q=a%20b"
test_record_and_playback "with a complex escaped query param", "q=#{CGI.escape("A&(! 234k !@ kasdj232\#$ kjw35")}"
it 'plays back an empty body response exactly as it was recorded (e.g. nil vs empty string)' do
skip "Faraday 0.8 may return nil bodies" if library_hook_name == :faraday && !defined?(::Faraday::RackBuilder)
get_body = lambda do
VCR.use_cassette('empty_body', :record => :once) do
get_body_object make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/204")
end
end
recorded = get_body.call
played_back = get_body.call
expect(played_back).to eq(recorded)
end
describe 'making an HTTP request' do
let(:status) { VCR::ResponseStatus.new(200, 'OK') }
let(:interaction) { VCR::HTTPInteraction.new(request, response) }
let(:response_body) { "The response body" }
before(:each) do
stub_requests([interaction], [:method, :uri])
end
context "when the the stubbed request and response has no headers" do
let(:request) { VCR::Request.new(:get, 'http://example.com:80/') }
let(:response) { VCR::Response.new(status, nil, response_body, '1.1') }
it 'returns the response for a matching request' do
expect(get_body_string(make_http_request(:get, 'http://example.com/'))).to eq(response_body)
end
end
def self.test_playback(description, url)
context "when a URL #{description} has been stubbed" do
let(:request) { VCR::Request.new(:get, url) }
let(:response) { VCR::Response.new(status, nil, response_body, '1.1') }
it 'returns the expected response for the same request' do
expect(get_body_string(make_http_request(:get, url))).to eq(response_body)
end
end
end
test_playback "using https and no explicit port", "https://example.com/foo"
test_playback "using https and port 443", "https://example.com:443/foo"
test_playback "using https and some other port", "https://example.com:5190/foo"
test_playback "that has query params", "http://example.com/search?q=param"
test_playback "with an encoded ampersand", "http://example.com:80/search?q=#{CGI.escape("Q&A")}"
end
it 'does not query the http interaction list excessively' do
call_count = 0
[:has_interaction_matching?, :response_for].each do |method_name|
orig_meth = VCR.http_interactions.method(method_name)
allow(VCR.http_interactions).to receive(method_name) do |*args|
call_count += 1
orig_meth.call(*args)
end
end
VCR.insert_cassette('foo')
make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/foo")
expect(call_count).to eq(1)
end
describe "using the library's stubbing/disconnection APIs" do
let!(:request_url) { "http://localhost:#{VCR::SinatraApp.port}/foo" }
if method_defined?(:disable_real_connections)
it 'can make a real request when VCR is turned off' do
enable_real_connections
VCR.turn_off!
expect(get_body_string(make_http_request(:get, request_url))).to eq("FOO!")
end
it 'does not mess with VCR when real connections are disabled' do
VCR.insert_cassette('example')
disable_real_connections
expect(VCR).to receive(:record_http_interaction) do |interaction|
expect(interaction.request.uri).to eq(request_url)
end
make_http_request(:get, request_url)
end
it 'can disable real connections when VCR is turned off' do
VCR.turn_off!
expected_error = disable_real_connections
expect {
make_http_request(:get, request_url)
}.to raise_error(expected_error)
end
end
if method_defined?(:directly_stub_request)
it 'can directly stub the request when VCR is turned off' do
VCR.turn_off!
directly_stub_request(:get, request_url, "stubbed response")
expect(get_body_string(make_http_request(:get, request_url))).to eq("stubbed response")
end
it 'can directly stub the request when VCR is turned on and no cassette is in use' do
directly_stub_request(:get, request_url, "stubbed response")
expect(get_body_string(make_http_request(:get, request_url))).to eq("stubbed response")
end
it 'can directly stub the request when VCR is turned on and a cassette is in use' do
VCR.use_cassette("temp") do
directly_stub_request(:get, request_url, "stubbed response")
expect(get_body_string(make_http_request(:get, request_url))).to eq("stubbed response")
end
end
it 'does not record requests that are directly stubbed' do
expect(VCR).to respond_to(:record_http_interaction)
expect(VCR).not_to receive(:record_http_interaction)
VCR.use_cassette("temp") do
directly_stub_request(:get, request_url, "stubbed response")
expect(get_body_string(make_http_request(:get, request_url))).to eq("stubbed response")
end
end
end
end
describe "request hooks" do
context 'when there is an around_http_request hook' do
let(:request_url) { "http://localhost:#{VCR::SinatraApp.port}/foo" }
it 'yields the request to the block' do
yielded_request = nil
VCR.configuration.around_http_request do |request|
yielded_request = request
request.proceed
end
VCR.use_cassette('new_cassette') do
make_http_request(:get, request_url)
end
expect(yielded_request.method).to eq(:get)
expect(yielded_request.uri).to eq(request_url)
end
it 'returns the response from request.proceed' do
response = nil
VCR.configuration.around_http_request do |request|
response = request.proceed
end
VCR.use_cassette('new_cassette') do
make_http_request(:get, request_url)
end
expect(response.body).to eq("FOO!")
end
it 'can be used to use a cassette for a request' do
VCR.configuration.around_http_request do |request|
VCR.use_cassette('new_cassette', &request)
end
expect(VCR).to receive(:record_http_interaction) do
expect(VCR.current_cassette.name).to eq('new_cassette')
end
expect(VCR.current_cassette).to be_nil
make_http_request(:get, request_url)
expect(VCR.current_cassette).to be_nil
end
it 'nests them inside each other, making the first declared hook the outermost' do
order = []
VCR.configure do |c|
c.ignore_request { |r| true }
c.around_http_request do |request|
order << :before_1
request.proceed
order << :after_1
end
c.around_http_request do |request|
order << :before_2
request.proceed
order << :after_2
end
end
make_http_request(:get, request_url)
expect(order).to eq([:before_1, :before_2, :after_2, :after_1])
end
it 'raises an appropriate error if the hook does not call request.proceed' do
VCR.configuration.ignore_request { |r| true }
hook_declaration = "#{__FILE__}:#{__LINE__ + 1}"
VCR.configuration.around_http_request { |r| }
expect {
make_http_request(:get, request_url)
}.to raise_error { |error|
expect(error.message).to include('must call #proceed on the yielded request')
expect(error.message).to include(hook_declaration)
}
end
it 'does not get a dead fiber error when multiple requests are made' do
VCR.configuration.around_http_request do |request|
VCR.use_cassette('new_cassette', &request)
end
3.times { make_http_request(:get, request_url) }
end
it 'allows the hook to be filtered' do
order = []
VCR.configure do |c|
c.ignore_request { |r| true }
c.around_http_request(lambda { |r| r.uri =~ /foo/}) do |request|
order << :before_foo
request.proceed
order << :after_foo
end
c.around_http_request(lambda { |r| r.uri !~ /foo/}) do |request|
order << :before_not_foo
request.proceed
order << :after_not_foo
end
end
make_http_request(:get, request_url)
expect(order).to eq([:before_foo, :after_foo])
end
it 'ensures that both around/before are invoked or neither' do
order = []
allow_1, allow_2 = false, true
VCR.configure do |c|
c.ignore_request { |r| true }
c.around_http_request(lambda { |r| allow_1 = !allow_1 }) do |request|
order << :before_1
request.proceed
order << :after_1
end
c.around_http_request(lambda { |r| allow_2 = !allow_2 }) do |request|
order << :before_2
request.proceed
order << :after_2
end
end
make_http_request(:get, request_url)
expect(order).to eq([:before_1, :after_1])
end
end if RUBY_VERSION >= '1.9'
it 'correctly assigns the correct type to both before and after request hooks, even if they are different' do
before_type = after_type = nil
VCR.configuration.before_http_request do |request|
before_type = request.type
VCR.insert_cassette('example')
end
VCR.configuration.after_http_request do |request|
after_type = request.type
VCR.eject_cassette
end
make_http_request(:get, "http://localhost:#{VCR::SinatraApp.port}/foo")
expect(before_type).to be(:unhandled)
expect(after_type).to be(:recordable)
end
context "when the request is ignored" do
before(:each) do
VCR.configuration.ignore_request { |r| true }
end
it_behaves_like "request hooks", library_hook_name, :ignored
end
context "when the request is directly stubbed" do
before(:each) do
directly_stub_request(:get, request_url, "FOO!")
end
it_behaves_like "request hooks", library_hook_name, :externally_stubbed
end if method_defined?(:directly_stub_request)
context 'when the request is recorded' do
let!(:inserted_cassette) { VCR.insert_cassette('new_cassette') }
it_behaves_like "request hooks", library_hook_name, :recordable do
let(:string_in_cassette) { 'example.com get response 1 with path=foo' }
it 'plays back the cassette when a request is made' do
VCR.eject_cassette
VCR.configure do |c|
c.cassette_library_dir = File.join(VCR::SPEC_ROOT, 'fixtures')
c.before_http_request do |request|
VCR.insert_cassette('fake_example_responses', :record => :none)
end
end
expect(get_body_string(make_http_request(:get, 'http://example.com/foo'))).to eq(string_in_cassette)
end
specify 'the after_http_request hook can be used to eject a cassette after the request is recorded' do
VCR.configuration.after_http_request { |request| VCR.eject_cassette }
expect(VCR).to receive(:record_http_interaction) do |interaction|
expect(VCR.current_cassette).to be(inserted_cassette)
end
make_request
expect(VCR.current_cassette).to be_nil
end
end
end
context 'when a stubbed response is played back for the request' do
before(:each) do
stub_requests([http_interaction(request_url)], [:method, :uri])
end
it_behaves_like "request hooks", library_hook_name, :stubbed_by_vcr
end
context 'when the request is not allowed' do
it_behaves_like "request hooks", library_hook_name, :unhandled do
undef assert_expected_response
def assert_expected_response(response)
expect(response).to be_nil
end
undef make_request
def make_request(disabled = false)
if disabled
make_http_request(:get, request_url)
else
expect { make_http_request(:get, request_url) }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
end
end
end
end
end
describe '.stub_requests using specific match_attributes' do
before(:each) { allow(VCR).to receive(:real_http_connections_allowed?).and_return(false) }
let(:interactions) { interactions_from('match_requests_on.yml') }
let(:normalized_interactions) do
interactions.each do |i|
i.request.headers = normalize_request_headers(i.request.headers)
end
interactions
end
def self.matching_on(attribute, valid, invalid, &block)
describe ":#{attribute}" do
let(:perform_stubbing) { stub_requests(normalized_interactions, [attribute]) }
before(:each) { perform_stubbing }
module_eval(&block)
valid.each do |val, response|
it "returns the expected response for a #{val.inspect} request" do
expect(get_body_string(make_http_request(val))).to eq(response)
end
end
it "raises an error for a request with a different #{attribute}" do
expect { make_http_request(invalid) }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
end
end
end
matching_on :method, { :get => "get method response", :post => "post method response" }, :put do
def make_http_request(http_method)
make_request(http_method, 'http://some-wrong-domain.com/', nil, {})
end
end
matching_on :host, { 'example1.com' => 'example1.com host response', 'example2.com' => 'example2.com host response' }, 'example3.com' do
def make_http_request(host)
make_request(:get, "http://#{host}/some/wrong/path", nil, {})
end
end
matching_on :path, { '/path1' => 'path1 response', '/path2' => 'path2 response' }, '/path3' do
def make_http_request(path)
make_request(:get, "http://some.wrong.domain.com#{path}?p=q", nil, {})
end
end
matching_on :uri, { 'http://example.com/uri1' => 'uri1 response', 'http://example.com/uri2' => 'uri2 response' }, 'http://example.com/uri3' do
def make_http_request(uri)
make_request(:get, uri, nil, {})
end
end
matching_on :body, { 'param=val1' => 'val1 body response', 'param=val2' => 'val2 body response' }, 'param=val3' do
def make_http_request(body)
make_request(:put, "http://wrong-domain.com/wrong/path", body, {})
end
end
matching_on :headers, {{ 'X-Http-Header1' => 'val1' } => 'val1 header response', { 'X-Http-Header1' => 'val2' } => 'val2 header response' }, { 'X-Http-Header1' => 'val3' } do
def make_http_request(headers)
make_request(:get, "http://wrong-domain.com/wrong/path", nil, headers)
end
end
end
def self.test_real_http_request(http_allowed, *other)
let(:url) { "http://localhost:#{VCR::SinatraApp.port}/foo" }
if http_allowed
it 'allows real http requests' do
expect(get_body_string(make_http_request(:get, url))).to eq('FOO!')
end
describe 'recording new http requests' do
let(:recorded_interaction) do
interaction = nil
expect(VCR).to receive(:record_http_interaction) { |i| interaction = i }
make_http_request(:post, url, "the body", { 'X-Http-Foo' => 'bar' })
interaction
end
it 'does not record the request if the hook is disabled' do
VCR.library_hooks.exclusively_enabled :something_else do
expect(VCR).not_to receive(:record_http_interaction)
make_http_request(:get, url)
end
end
it 'records the request uri' do
expect(recorded_interaction.request.uri).to eq(url)
end
it 'records the request method' do
expect(recorded_interaction.request.method).to eq(:post)
end
it 'records the request body' do
expect(recorded_interaction.request.body).to eq("the body")
end
it 'records the request headers' do
headers = downcase_headers(recorded_interaction.request.headers)
expect(headers).to include('x-http-foo' => ['bar'])
end
it 'records the response status code' do
expect(recorded_interaction.response.status.code).to eq(200)
end
it 'records the response status message' do
expect(recorded_interaction.response.status.message.strip).to eq('OK')
end unless other.include?(:status_message_not_exposed)
it 'records the response body' do
expect(recorded_interaction.response.body).to eq('FOO!')
end
it 'records the response headers' do
headers = downcase_headers(recorded_interaction.response.headers)
expect(headers).to include('content-type' => ["text/html;charset=utf-8"])
end
end
else
it 'does not allow real HTTP requests or record them' do
expect(VCR).to receive(:record_http_interaction).never
expect { make_http_request(:get, url) }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
end
end
end
[true, false].each do |http_allowed|
context "when VCR.real_http_connections_allowed? is returning #{http_allowed}" do
before(:each) { allow(VCR).to receive(:real_http_connections_allowed?).and_return(http_allowed) }
test_real_http_request(http_allowed, *other)
unless http_allowed
localhost_response = "Localhost response"
context 'when ignore_hosts is configured to "127.0.0.1", "localhost"' do
before(:each) do
VCR.configure { |c| c.ignore_hosts "127.0.0.1", "localhost" }
end
%w[ 127.0.0.1 localhost ].each do |localhost_alias|
it "allows requests to #{localhost_alias}" do
expect(get_body_string(make_http_request(:get, "http://#{localhost_alias}:#{VCR::SinatraApp.port}/localhost_test"))).to eq(localhost_response)
end
end
it 'does not allow requests to 0.0.0.0' do
expect { make_http_request(:get, "http://0.0.0.0:#{VCR::SinatraApp.port}/localhost_test") }.to raise_error(NET_CONNECT_NOT_ALLOWED_ERROR)
end
end
end
context 'when some requests are stubbed' do
let(:interactions) { interactions_from('fake_example_responses.yml') }
before(:each) do
stub_requests(interactions, VCR::RequestMatcherRegistry::DEFAULT_MATCHERS)
end
it 'gets the stubbed responses when requests are made to http://example.com/foo, and does not record them' do
expect(VCR).to receive(:record_http_interaction).never
expect(get_body_string(make_http_request(:get, 'http://example.com/foo'))).to match(/example\.com get response \d with path=foo/)
end
it 'rotates through multiple responses for the same request' do
expect(get_body_string(make_http_request(:get, 'http://example.com/foo'))).to eq('example.com get response 1 with path=foo')
expect(get_body_string(make_http_request(:get, 'http://example.com/foo'))).to eq('example.com get response 2 with path=foo')
end unless other.include?(:does_not_support_rotating_responses)
it "correctly handles stubbing multiple values for the same header" do
header = get_header('Set-Cookie', make_http_request(:get, 'http://example.com/two_set_cookie_headers'))
header = header.split(', ') if header.respond_to?(:split)
expect(header).to match_array ['bar=bazz', 'foo=bar']
end
end
end
end
end
end
|