webmock 1.21.0 → 1.22.1

data/spec/acceptance/manticore/manticore_spec_helper.rb

@@ -0,0 +1,31 @@
+module ManticoreSpecHelper
+  def http_request(method, uri, options = {})
+    client = Manticore::Client.new
+    response = client.http(method, uri, options)
+
+    OpenStruct.new({
+      :body => response.body || '',
+      :headers => WebMock::Util::Headers.normalize_headers(join_array_values(response.headers)),
+      :status => response.code.to_s
+    })
+  end
+
+  def join_array_values(hash)
+    hash.reduce({}) do |h, (k,v)|
+      v = v.join(', ') if v.is_a?(Array)
+      h.merge(k => v)
+    end
+  end
+
+  def client_timeout_exception_class
+    Manticore::ConnectTimeout
+  end
+
+  def connection_refused_exception_class
+    Manticore::SocketException
+  end
+
+  def http_library
+    :manticore
+  end
+end

data/spec/acceptance/net_http/net_http_spec.rb

@@ -9,7 +9,7 @@ include NetHTTPSpecHelper
 describe "Net:HTTP" do
   include_examples "with WebMock"
 
-  let(:port){ WebMockServer.instance.port }
+  let(:port) { WebMockServer.instance.port }
 
   describe "marshalling" do
     class TestMarshalingInWebMockNetHTTP
@@ -106,6 +106,28 @@ describe "Net:HTTP" do
     expect(Net::HTTP.start("www.example.com") { |query| query.get("/") }.body).to eq("abc"*100000)
   end
 
+  it "raises an ArgumentError if passed headers as symbols" do
+    uri = URI.parse("http://google.com/")
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Get.new(uri.request_uri)
+
+    # Net::HTTP calls downcase on header keys assigned with []=
+    # In Ruby 1.8.7 symbols do not respond to downcase
+    #
+    # Meaning you can not assign header keys as symbols in ruby 1.8.7 using []=
+    if :symbol.respond_to?(:downcase)
+      request[:InvalidHeaderSinceItsASymbol] = "this will not be valid"
+    else
+      request.instance_eval do
+        @header = request.to_hash.merge({:InvalidHeaderSinceItsASymbol => "this will not be valid"})
+      end
+    end
+
+    expect do
+      http.request(request)
+    end.to raise_error ArgumentError, "Net:HTTP does not accept headers as symbols"
+  end
+
   it "should handle multiple values for the same response header" do
     stub_http_request(:get, "www.example.com").to_return(:headers => { 'Set-Cookie' => ['foo=bar', 'bar=bazz'] })
     response = Net::HTTP.get_response(URI.parse("http://www.example.com/"))
@@ -169,6 +191,7 @@ describe "Net:HTTP" do
       @http.use_ssl = true
       @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
+
     describe "when net http is allowed" do
       it "should not connect to the server until the request", :net_connect => true do
         WebMock.allow_net_connect!

data/spec/acceptance/shared/request_expectations.rb

@@ -31,7 +31,7 @@ shared_context "request expectations" do |*adapter_info|
         expect {
           http_request(:get, "http://www.example.com/")
           expect(a_request(:get, "http://www.example.com")).not_to have_been_made
-        }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+        }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
       end
 
       it "should fail resulting with failure with a message and executed requests listed" do
@@ -626,7 +626,7 @@ shared_context "request expectations" do |*adapter_info|
           expect {
             http_request(:post, "http://www.example.com/", :body => "wadus")
             expect(a_request(:post, "www.example.com").with { |req| req.body == "wadus" }).not_to have_been_made
-          }.to fail_with(%r(The request POST http://www.example.com/ with given block was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request POST http://www.example.com/ with given block was not expected to execute but it executed 1 time))
         end
       end
 
@@ -692,7 +692,7 @@ shared_context "request expectations" do |*adapter_info|
           expect {
             http_request(:get, "http://www.example.com/")
             expect(WebMock).not_to have_requested(:get, "http://www.example.com")
-          }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
         end
 
         it "should satisfy expectation if request was executed and expectation had block which evaluated to true" do
@@ -713,7 +713,7 @@ shared_context "request expectations" do |*adapter_info|
           expect {
             http_request(:post, "http://www.example.com/", :body => "wadus")
             expect(WebMock).not_to have_requested(:post, "www.example.com").with { |req| req.body == "wadus" }
-          }.to fail_with(%r(The request POST http://www.example.com/ with given block was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request POST http://www.example.com/ with given block was not expected to execute but it executed 1 time))
         end
       end
 
@@ -737,14 +737,14 @@ shared_context "request expectations" do |*adapter_info|
           expect {
             http_request(:get, "http://www.example.com/")
             assert_not_requested(:get, "http://www.example.com")
-          }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
         end
 
         it "should fail if request expected not to be made was made and expectation block evaluated to true" do
           expect {
             http_request(:post, "http://www.example.com/", :body => "wadus")
             assert_not_requested(:post, "www.example.com") { |req| req.body == "wadus" }
-          }.to fail_with(%r(The request POST http://www.example.com/ with given block was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request POST http://www.example.com/ with given block was not expected to execute but it executed 1 time))
         end
 
         it "should satisfy expectation if request was made and expectation block evaluated to true" do
@@ -777,7 +777,7 @@ shared_context "request expectations" do |*adapter_info|
           expect {
             http_request(:get, "http://www.example.com/")
             assert_not_requested(stub_http)
-          }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+          }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
         end
       end
     end
@@ -809,7 +809,7 @@ shared_context "request expectations" do |*adapter_info|
           stub = stub_request(:get, "http://www.example.com")
           http_request(:get, "http://www.example.com/")
           expect(stub).not_to have_been_requested
-        }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+        }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
       end
 
       it "should fail request not expected to be made was made and expectation block evaluated to true" do
@@ -817,7 +817,7 @@ shared_context "request expectations" do |*adapter_info|
           stub = stub_request(:post, "www.example.com").with { |req| req.body == "wadus" }
           http_request(:post, "http://www.example.com/", :body => "wadus")
           expect(stub).not_to have_been_requested
-        }.to fail_with(%r(The request POST http://www.example.com/ with given block was expected to execute 0 times but it executed 1 time))
+        }.to fail_with(%r(The request POST http://www.example.com/ with given block was not expected to execute but it executed 1 time))
       end
 
       it "should satisfy expectation if request was made and expectation block evaluated to true" do
@@ -852,7 +852,7 @@ shared_context "request expectations" do |*adapter_info|
         expect {
           http_request(:get, "http://www.example.com/")
           expect(a_request(:get, "http://www.example.com")).not_to have_been_made
-        }.to fail_with(%r(The request GET http://www.example.com/ was expected to execute 0 times but it executed 1 time))
+        }.to fail_with(%r(The request GET http://www.example.com/ was not expected to execute but it executed 1 time))
       end
     end
   end

data/spec/spec_helper.rb

@@ -6,6 +6,9 @@ unless RUBY_PLATFORM =~ /java/
   require 'em-http'
   require 'typhoeus'
 end
+if RUBY_PLATFORM =~ /java/
+  require 'manticore'
+end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -45,6 +48,7 @@ RSpec.configure do |config|
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
 end
+RSpec::Expectations.configuration.warn_about_potential_false_positives = false
 
 def fail()
   raise_error(RSpec::Expectations::ExpectationNotMetError)

data/spec/unit/errors_spec.rb

@@ -21,6 +21,7 @@ describe "errors" do
         allow(WebMock::RequestStub).to receive(:from_request_signature).and_return(request_stub)
         allow(WebMock::StubRequestSnippet).to receive(:new).
            with(request_stub).and_return(stub_result)
+        allow_any_instance_of(WebMock::RequestBodyDiff).to receive(:body_diff).and_return({})
 
         expected =  \
           "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
@@ -48,6 +49,44 @@ describe "errors" do
         end.to raise_exception exception
       end
 
+      it "should print body diff if available" do
+        allow(WebMock::StubRegistry.instance).to receive(:request_stubs).and_return([request_stub])
+        allow(WebMock::RequestStub).to receive(:from_request_signature).and_return(request_stub)
+        allow(WebMock::StubRequestSnippet).to receive(:new).
+           with(request_stub).and_return(stub_result)
+        allow_any_instance_of(WebMock::RequestBodyDiff).to receive(:body_diff).and_return(body_diff)
+        expected =  \
+          "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+          "\n\nYou can stub this request with the following snippet:" \
+          "\n\n#{stub_result}" \
+          "\n\nregistered request stubs:" \
+          "\n\n#{stub_result}" \
+          "\n\nBody diff:\n [[\"+\", \"test\", \"test2\"], [\"-\", \"test3\"], [\"~\", \"test5\", \"test6\"]]" \
+          "\n\n\n============================================================"
+        expect(WebMock::NetConnectNotAllowedError.new(request_signature).message).to eq(expected)
+      end
+
+      context "WebMock.show_body_diff? is false" do
+        before do
+          WebMock.hide_body_diff!
+        end
+        it "should not show body diff" do
+          allow(WebMock::StubRegistry.instance).to receive(:request_stubs).and_return([request_stub])
+          allow(WebMock::RequestStub).to receive(:from_request_signature).and_return(request_stub)
+          allow(WebMock::StubRequestSnippet).to receive(:new).
+             with(request_stub).and_return(stub_result)
+          expect_any_instance_of(WebMock::RequestBodyDiff).to_not receive(:body_diff)
+          expected =  \
+            "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
+            "\n\nYou can stub this request with the following snippet:" \
+            "\n\n#{stub_result}" \
+            "\n\nregistered request stubs:" \
+            "\n\n#{stub_result}" \
+            "\n\n============================================================"
+          expect(WebMock::NetConnectNotAllowedError.new(request_signature).message).to eq(expected)
+        end
+      end
+
       context "WebMock.show_stubbing_instructions? is false" do
         before do
           WebMock.hide_stubbing_instructions!
@@ -69,6 +108,7 @@ describe "errors" do
           allow(WebMock::RequestStub).to receive(:from_request_signature).and_return(request_stub)
           allow(WebMock::StubRequestSnippet).to receive(:new).
             with(request_stub).and_return(stub_result)
+          allow(request_stub).to receive(:request_pattern).and_return(body_pattern)
 
           expected =  \
             "Real HTTP connections are disabled. Unregistered request: #{request_signature}" \
@@ -80,9 +120,10 @@ describe "errors" do
       end
     end
 
-    let(:request_signature) { double(:to_s => rand(10**20).to_s) }
-    let(:stub_result)       { double(:to_s => rand(10**20).to_s) }
-    let(:request_stub)      { double }
-
+    let(:request_signature) { double(:request_signature, :to_s => rand(10**20).to_s) }
+    let(:stub_result)       { double(:stub_result, :to_s => rand(10**20).to_s) }
+    let(:request_stub)      { double(:request_stub) }
+    let(:body_pattern)      { double(:body_pattern, :body_pattern => nil)}
+    let(:body_diff)         { [["+", "test", "test2"], ["-", "test3"], ["~", "test5", "test6"]] }
   end
 end

data/spec/unit/request_body_diff_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+RSpec.describe WebMock::RequestBodyDiff do
+  subject { WebMock::RequestBodyDiff.new(request_signature, request_stub) }
+
+  let(:uri) { "http://example.com" }
+  let(:method) { "GET" }
+
+  let(:request_stub) { WebMock::RequestStub.new(method, uri) }
+  let(:request_signature) { WebMock::RequestSignature.new(method, uri) }
+
+  let(:request_stub_body) { { "key" => "value"} }
+  let(:request_signature_body) { {"key" => "different value"}.to_json }
+
+  let(:request_pattern) {
+    WebMock::RequestPattern.new(
+      method, uri, {:body => request_stub_body}
+    )
+  }
+
+  before :each do
+    request_stub.request_pattern = request_pattern
+    request_signature.headers = {"Content-Type" => "application/json"}
+    request_signature.body = request_signature_body
+  end
+
+  describe "#body_diff" do
+    context "request signature is unparseable json" do
+      let(:request_signature_body) { "youcan'tparsethis!" }
+
+      it "returns an empty hash" do
+        expect(subject.body_diff).to eq({})
+      end
+    end
+
+    context "request stub body as unparseable json" do
+      let(:request_stub_body) { "youcan'tparsethis!" }
+
+      it "returns an empty hash" do
+        expect(subject.body_diff).to eq({})
+      end
+    end
+
+    context "request stub body pattern is hash" do
+      let(:request_stub_body) { { "key" => "value"} }
+
+      it "generates a diff" do
+        expect(subject.body_diff).to eq(
+          [["~", "key", "different value", "value"]]
+        )
+      end
+    end
+
+    context "request signature doesn't have json headers" do
+      before :each do
+        request_signature.headers = {"Content-Type" => "application/xml"}
+      end
+
+      it "returns an empty hash" do
+        expect(subject.body_diff).to eq({})
+      end
+    end
+
+    context "request stub body pattern is a string" do
+      let(:request_stub_body) { { "key" => "value"}.to_json }
+
+      it "generates a diff" do
+        expect(subject.body_diff).to eq(
+          [["~", "key", "different value", "value"]]
+        )
+      end
+    end
+
+    context "stub request has no request pattern" do
+      let(:request_signature_body) { nil }
+
+      it "returns an empty hash" do
+        expect(subject.body_diff).to eq({})
+      end
+    end
+
+    context "stub request has no body pattern" do
+      let(:request_stub_body) { nil }
+
+      it "returns an empty hash" do
+        expect(subject.body_diff).to eq({})
+      end
+    end
+  end
+end

data/spec/unit/request_execution_verifier_spec.rb

@@ -9,10 +9,47 @@ describe WebMock::RequestExecutionVerifier do
     @executed_requests_info = "\n\nThe following requests were made:\n\nexecuted requests\n" + "="*60
   end
 
+  describe "description" do
+
+    it "reports the description" do
+      @verifier.expected_times_executed = 2
+      expect(@verifier.description).to eq "request www.example.com 2 times"
+    end
+
+    it "reports description correctly when expectation is 1 time" do
+      @verifier.expected_times_executed = 1
+      expect(@verifier.description).to eq "request www.example.com 1 time"
+    end
+
+    context "at_least_times_executed is set" do
+      it "reports description correctly when expectation at least 2 times" do
+        @verifier.at_least_times_executed = 2
+        expect(@verifier.description).to eq "request www.example.com at least 2 times"
+      end
+
+      it "reports description correctly when expectation is at least 3 times" do
+        @verifier.at_least_times_executed = 3
+        expect(@verifier.description).to eq "request www.example.com at least 3 times"
+      end
+    end
+
+    context "at_most_times_executed is set" do
+      it "reports description correctly when expectation is at most 2 times" do
+        @verifier.at_most_times_executed = 2
+        expect(@verifier.description).to eq "request www.example.com at most 2 times"
+      end
+
+      it "reports description correctly when expectation is at most 1 time" do
+        @verifier.at_most_times_executed = 1
+        expect(@verifier.description).to eq "request www.example.com at most 1 time"
+      end
+    end
+
+  end
 
   describe "failure message" do
 
-    it "should report failure message" do
+    it "reports the failure message" do
       @verifier.times_executed = 0
       @verifier.expected_times_executed = 2
       expected_text = "The request www.example.com was expected to execute 2 times but it executed 0 times"
@@ -20,7 +57,7 @@ describe WebMock::RequestExecutionVerifier do
       expect(@verifier.failure_message).to eq(expected_text)
     end
 
-    it "should report failure message correctly when executed times is one" do
+    it "reports failure message correctly when executed times is one" do
       @verifier.times_executed = 1
       @verifier.expected_times_executed = 1
       expected_text = "The request www.example.com was expected to execute 1 time but it executed 1 time"
@@ -67,7 +104,7 @@ describe WebMock::RequestExecutionVerifier do
 
   describe "negative failure message" do
 
-    it "should report failure message if it executed number of times specified" do
+    it "reports failure message if it executed number of times specified" do
       @verifier.times_executed = 2
       @verifier.expected_times_executed = 2
       expected_text = "The request www.example.com was not expected to execute 2 times but it executed 2 times"
@@ -75,9 +112,9 @@ describe WebMock::RequestExecutionVerifier do
       expect(@verifier.failure_message_when_negated).to eq(expected_text)
     end
 
-    it "should report failure message when not expected request but it executed" do
+    it "reports failure message when not expected request but it executed" do
       @verifier.times_executed = 1
-      expected_text = "The request www.example.com was expected to execute 0 times but it executed 1 time"
+      expected_text = "The request www.example.com was not expected to execute but it executed 1 time"
       expected_text << @executed_requests_info
       expect(@verifier.failure_message_when_negated).to eq(expected_text)
     end
@@ -122,14 +159,14 @@ describe WebMock::RequestExecutionVerifier do
 
   describe "matches?" do
 
-    it "should succeed if request was executed expected number of times" do
+    it "succeeds if request was executed expected number of times" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(10)
       @verifier.expected_times_executed = 10
       expect(@verifier.matches?).to be_truthy
     end
 
-    it "should fail if request was not executed expected number of times" do
+    it "fails if request was not executed expected number of times" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(10)
       @verifier.expected_times_executed = 5
@@ -140,26 +177,26 @@ describe WebMock::RequestExecutionVerifier do
 
   describe "does_not_match?" do
 
-    it "should fail if request executed expected number of times" do
+    it "fails if request executed expected number of times" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(10)
       @verifier.expected_times_executed = 10
       expect(@verifier.does_not_match?).to be_falsey
     end
 
-    it "should succeed if request was not executed at all and expected number of times was not set" do
+    it "succeeds if request was not executed at all and expected number of times was not set" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(0)
       expect(@verifier.does_not_match?).to be_truthy
     end
 
-    it "should fail if request was executed and expected number of times was not set" do
+    it "fails if request was executed and expected number of times was not set" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(1)
       expect(@verifier.does_not_match?).to be_falsey
     end
 
-    it "should succeed if request was not executed expected number of times" do
+    it "succeeds if request was not executed expected number of times" do
       expect(WebMock::RequestRegistry.instance).
         to receive(:times_executed).with(@request_pattern).and_return(10)
       @verifier.expected_times_executed = 5