pact 0.1.28 → 1.3.3

data/spec/lib/pact/{request_spec.rb → consumer_contract/request_spec.rb}

@@ -1,70 +1,61 @@
 require 'spec_helper'
-require 'pact/request'
+require 'pact/consumer_contract/request'
+require 'pact/consumer/request'
+require 'support/shared_examples_for_request'
 
-shared_examples "a request" do
-  describe "building from a hash" do
+module Pact
+
+  describe Request::Expected do
+    it_behaves_like "a request"
 
     let(:raw_request) do
       {
         'method' => 'get',
-        'path' => '/mallory',
-        'headers' => {
-          'Content-Type' => 'application/json'
-        },
-        'body' => 'hello mallory'
+        'path' => '/mallory'
       }
     end
 
-    subject { described_class.from_hash(raw_request) }
-
-    its(:method) { should == 'get' }
-    its(:path) { should == '/mallory' }
-    its(:body) { should == 'hello mallory' }
-    its(:query) { should eq Pact::Request::NullExpectation.new }
-
-    it "blows up if method is absent" do
-      raw_request.delete 'method'
-      expect { described_class.from_hash(raw_request) }.to raise_error
-    end
-
-    it "blows up if path is absent" do
-      raw_request.delete 'path'
-      expect { described_class.from_hash(raw_request) }.to raise_error
+    describe "from_hash" do
+      context "when optional field are not defined" do
+        subject { described_class.from_hash(raw_request) }
+        it "sets their values to NullExpectation" do
+          expect(subject.body).to be_instance_of(Pact::NullExpectation)
+          expect(subject.query).to be_instance_of(Pact::NullExpectation)
+          expect(subject.headers).to be_instance_of(Pact::NullExpectation)
+        end
+      end
     end
 
-    it "does not blow up if body is missing" do
-      raw_request.delete 'body'
-      expect { described_class.from_hash(raw_request) }.to_not raise_error
+    describe "as_json" do
+      subject { Request::Expected.new(:get, '/path', {:header => 'value'}, {:body => 'yeah'}, "query", {some: 'options'}) }
+      context "with options" do
+        it "does not include the options because they are a temporary hack and should leave no trace of themselves in the pact file" do
+          expect(subject.as_json.key?(:options)).to be false
+        end
+      end
     end
 
-  end
-end
-
-module Pact
-
-  describe Request::Expected do
-    it_behaves_like "a request"
-
     describe "matching to actual requests" do
 
-      subject { Request::Expected.new(expected_method, expected_path, expected_headers, expected_body, expected_query) }
+      subject { Request::Expected.new(expected_method, expected_path, expected_headers, expected_body, expected_query, options) }
+      let(:options) { {} }
 
       let(:expected_method) { 'get' }
       let(:expected_path) { '/foo' }
-      let(:expected_headers) { nil }
-      let(:expected_body) { nil }
+      let(:expected_headers) { Pact::NullExpectation.new }
+      let(:expected_body) { Pact::NullExpectation.new }
       let(:expected_query) { '' }
 
-      let(:actual_request) { Request::Actual.new(actual_method, actual_path, actual_headers, actual_body, actual_query) }
+      let(:actual_request) { Consumer::Request::Actual.new(actual_method, actual_path, actual_headers, actual_body, actual_query) }
 
       let(:actual_method) { 'get' }
       let(:actual_path) { '/foo' }
-      let(:actual_headers) { nil }
-      let(:actual_body) { nil }
+      let(:actual_headers) { {} }
+      let(:actual_body) { '' }
       let(:actual_query) { '' }
 
       it "matches identical requests" do
-        expect(subject.match actual_request).to be_true
+        expect(subject.matches? actual_request).to be true
       end
 
       context "when the methods are the same but one is symbolized" do
@@ -72,7 +63,7 @@ module Pact
         let(:actual_method) { 'get' }
 
         it "matches" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -81,7 +72,16 @@ module Pact
         let(:actual_method) { 'post' }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
+        end
+      end
+
+      context "when the methods are the same but different case" do
+        let(:expected_method) { 'get' }
+        let(:actual_method) { 'GET' }
+
+        it "matches" do
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -90,7 +90,7 @@ module Pact
         let(:actual_path) { '/bar' }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
@@ -99,7 +99,7 @@ module Pact
         let(:actual_path) { '/foo/' }
 
         it "matches" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -108,16 +108,16 @@ module Pact
         let(:actual_body) { '' }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
       context "when the expected body has no expectation and the actual body is empty" do
-        let(:expected_body) { Request::NullExpectation.new }
+        let(:expected_body) { Pact::NullExpectation.new }
         let(:actual_body) { '' }
 
         it "matches" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -131,7 +131,7 @@ module Pact
         let(:actual_body) { nil }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
@@ -140,7 +140,7 @@ module Pact
         let(:actual_body) { 'bar' }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
@@ -160,7 +160,7 @@ module Pact
         end
 
         it "matches" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -180,7 +180,7 @@ module Pact
         end
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
@@ -188,7 +188,7 @@ module Pact
         let(:expected_body) do
           {
             name: 'Bob',
-            customer_id: Term.new(matcher: /CN.*/)
+            customer_id: Term.new(matcher: /CN.*/, generate: 'CN789')
           }
         end
 
@@ -200,7 +200,7 @@ module Pact
         end
 
         it "matches" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -208,7 +208,7 @@ module Pact
         let(:expected_body) do
           {
             name: 'Bob',
-            customer_id: Term.new(matcher: /foo/)
+            customer_id: Term.new(matcher: /foo/, generate: 'fooool')
           }
         end
 
@@ -220,7 +220,7 @@ module Pact
         end
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
@@ -240,7 +240,7 @@ module Pact
         end
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
       context "when the expected body contains non-matching hash where one field contains a substring of the other" do
@@ -257,7 +257,7 @@ module Pact
           end
 
           it "does not match" do
-            expect(subject.match actual_request).to be_false
+            expect(subject.matches? actual_request).to be false
           end
       end
 
@@ -277,7 +277,7 @@ module Pact
         end
 
         it "does not match" do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -286,16 +286,16 @@ module Pact
         let(:actual_query) { 'bar' }
 
         it "does not match" do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
 
       context 'when there is no query expectation' do
-        let(:expected_query) { Request::NullExpectation.new }
+        let(:expected_query) { Pact::NullExpectation.new }
         let(:actual_query) { 'bar' }
 
         it 'matches' do
-          expect(subject.match actual_request).to be_true
+          expect(subject.matches? actual_request).to be true
         end
       end
 
@@ -304,13 +304,26 @@ module Pact
         let(:expected_body) { { thing: "123" } }
 
         it 'does not match' do
-          expect(subject.match actual_request).to be_false
+          expect(subject.matches? actual_request).to be false
         end
       end
-    end
-  end
 
-  describe Request::Actual do
-    it_behaves_like "a request"
+      context "when unexpected keys are found in the body" do
+        let(:expected_body) { {a: 1} }
+        let(:actual_body) { {a: 1, b: 2} }
+        context "when allowing unexpected keys" do
+          let(:options) { {'allow_unexpected_keys_in_body' => true} } #From json, these will be strings
+          it "matches" do
+            expect(subject.matches? actual_request).to be true
+          end
+        end
+        context "when not allowing unexpected keys" do
+          let(:options) { {'allow_unexpected_keys_in_body' => false} }
+          it "does not match" do
+            expect(subject.matches? actual_request).to be false
+          end
+        end
+      end
+    end
   end
 end

data/spec/lib/pact/doc/generator_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'pact/doc/generator'
+require 'fileutils'
+
+module Pact
+  module Doc
+    describe Generator do
+
+      let(:doc_dir) { './tmp/doc' }
+      let(:pact_dir) { './tmp/pacts' }
+      let(:file_name) { "Some Consumer - Some Provider#{file_extension}" }
+      let(:consumer_contract_renderer) { double("ConsumerContractRenderer", :call => doc_content) }
+      let(:doc_content) { "doc_content" }
+      let(:index_content) { "index_content" }
+      let(:expected_doc_path) { "#{doc_dir}/#{doc_type}/#{file_name}" }
+      let(:expected_index_path) { "#{doc_dir}/#{doc_type}/#{index_name}#{file_extension}" }
+      let(:doc_type) { 'markdown' }
+      let(:file_extension) { ".md" }
+      let(:actual_file_contents) { File.read(expected_doc_path) }
+      let(:actual_index_contents) { File.read(expected_index_path)}
+      let(:index_renderer) { double("IndexRenderer", :call => index_content)}
+      let(:index_name) { 'README' }
+      let(:after_hook) { double("hook", :call => nil)}
+
+      before do
+        FileUtils.rm_rf doc_dir
+        FileUtils.rm_rf pact_dir
+        FileUtils.mkdir_p doc_dir
+        FileUtils.mkdir_p pact_dir
+        FileUtils.cp './spec/support/markdown_pact.json', pact_dir
+      end
+
+      let(:options) { { consumer_contract_renderer: consumer_contract_renderer, doc_type: doc_type, file_extension: file_extension, index_renderer: index_renderer, index_name: index_name } }
+
+      subject { Generator.new(pact_dir, doc_dir, options) }
+
+      context "when there are existing files" do
+        let(:existing_doc_file_path) { File.join(doc_dir, doc_type, "leftover") }
+
+        before do
+          FileUtils.mkdir_p File.dirname(existing_doc_file_path)
+          FileUtils.touch existing_doc_file_path
+        end
+
+        it "clears the existing files" do
+          expect(File.exist?(existing_doc_file_path)).to be true
+          subject.call
+          expect(File.exist?(existing_doc_file_path)).to be false
+        end
+      end
+
+
+      it "creates an index" do
+        expect(index_renderer).to receive(:call).with("Some Consumer", {"Some Provider"=>"Some Consumer - Some Provider.md"})
+        subject.call
+        expect(actual_index_contents).to eq(index_content)
+      end
+
+      it "creates documentation" do
+        subject.call
+        expect(actual_file_contents).to eq(doc_content)
+      end
+
+      context "with an after hook specified" do
+
+        subject { Generator.new(pact_dir, doc_dir, options.merge(:after => after_hook)) }
+
+        it "executes the hook" do
+          expect(after_hook).to receive(:call).with(pact_dir, "#{doc_dir}/#{doc_type}", instance_of(Array))
+          subject.call
+        end
+
+        it "passes in the consumer_contracts" do
+          expect(after_hook).to receive(:call) do | _, _, consumer_contracts |
+            expect(consumer_contracts.first).to be_instance_of(Pact::ConsumerContract)
+          end
+          subject.call
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/pact/doc/interaction_view_model_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'pact/doc/interaction_view_model'
+
+module Pact
+  module Doc
+    describe InteractionViewModel do
+
+      let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model.json'}
+
+      let(:interaction_with_request_with_body_and_headers) { consumer_contract.find_interaction description: "a request with a body and headers" }
+      let(:interaction_with_request_without_body_and_headers) { consumer_contract.find_interaction description: "a request with an empty body and empty headers" }
+      let(:interaction_with_response_with_body_and_headers) { consumer_contract.find_interaction description: "a response with a body and headers" }
+      let(:interaction_with_response_without_body_and_headers) { consumer_contract.find_interaction description: "a response with an empty body and empty headers" }
+
+
+      subject { InteractionViewModel.new interaction, consumer_contract}
+
+      describe "request" do
+
+        let(:interaction) { interaction_with_request_with_body_and_headers }
+
+        it "includes the method" do
+          expect(subject.request).to include('"method"')
+          expect(subject.request).to include('"get"')
+        end
+
+        it "includes the body" do
+          expect(subject.request).to include('"body"')
+          expect(subject.request).to include('"a body"')
+        end
+
+        it "includes the headers" do
+          expect(subject.request).to include('"headers"')
+          expect(subject.request).to include('"a header"')
+        end
+
+        it "includes the query" do
+          expect(subject.request).to include('"query"')
+          expect(subject.request).to include('"some=thing"')
+        end
+
+        it "includes the path" do
+          expect(subject.request).to include('"path"')
+          expect(subject.request).to include('"/path"')
+        end
+
+        it "renders the keys in a meaningful order" do
+          expect(subject.request).to match /"method".*"path".*"query".*"headers".*"body"/m
+        end
+
+        context "when the body hash is empty" do
+
+          let(:interaction) { interaction_with_request_without_body_and_headers }
+
+          it "includes the body" do
+            expect(subject.request).to include("body")
+          end
+        end
+        context "when the headers hash is empty" do
+
+          let(:interaction) { interaction_with_request_without_body_and_headers }
+
+          it "does not include the headers" do
+            expect(subject.request).to_not include("headers")
+          end
+        end
+
+        context "when a Pact::Term is present" do
+          let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model_with_terms.json'}
+          let(:interaction) { consumer_contract.interactions.first }
+
+          it "uses the generated value" do
+            expect(subject.request).to_not include("Term")
+            expect(subject.request).to include("sunny")
+          end
+        end
+      end
+
+      describe "response" do
+
+        let(:interaction) { interaction_with_response_with_body_and_headers }
+
+        it "includes the status" do
+          expect(subject.response).to include('"status"')
+        end
+
+        it "includes the body" do
+          expect(subject.response).to include('"body"')
+          expect(subject.response).to include('"a body"')
+        end
+        it "includes the headers" do
+          expect(subject.response).to include('"headers"')
+          expect(subject.response).to include('"a header"')
+        end
+
+        it "renders the keys in a meaningful order" do
+          expect(subject.response).to match /"status".*"headers".*"body"/m
+        end
+
+        context "when the body hash is empty" do
+
+          let(:interaction) { interaction_with_response_without_body_and_headers }
+
+          it "does not include the body" do
+            expect(subject.response).to_not include("body")
+          end
+        end
+
+        context "when the headers hash is empty" do
+
+          let(:interaction) { interaction_with_response_without_body_and_headers }
+
+          it "does not include the headers" do
+            expect(subject.response).to_not include("headers")
+          end
+        end
+
+        context "when a Pact::Term is present" do
+          let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model_with_terms.json'}
+          let(:interaction) { consumer_contract.interactions.first }
+
+          it "uses the generated value" do
+            expect(subject.response).to_not include("Term")
+            expect(subject.response).to include("rainy")
+          end
+        end
+      end
+
+
+    end
+  end
+end

data/spec/lib/pact/doc/markdown/consumer_contract_renderer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'pact/doc/markdown/consumer_contract_renderer'
+
+module Pact
+  module Doc
+    module Markdown
+      describe ConsumerContractRenderer do
+
+        subject { ConsumerContractRenderer.new(consumer_contract) }
+        let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/markdown_pact.json' }
+
+        let(:expected_output) { File.read("./spec/support/generated_markdown.md") }
+
+        describe "#call" do
+          it "renders an interaction" do
+            expect(subject.call).to eq(expected_output)
+          end
+        end
+
+        describe ".call" do
+          it "renders an interaction" do
+            expect(ConsumerContractRenderer.call consumer_contract).to eq(expected_output)
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/lib/pact/doc/markdown/index_renderer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'pact/doc/markdown/index_renderer'
+
+module Pact
+  module Doc
+    module Markdown
+      describe IndexRenderer do
+
+        let(:consumer_name) { "Some Consumer" }
+        let(:docs) {  {"Some Provider" => "Some Provider.md", "Some other provider" => "Some other provider.md"} }
+        let(:subject) { IndexRenderer.new(consumer_name, docs) }
+        let(:expected_content) { File.read('./spec/support/generated_index.md')}
+
+        describe "#call" do
+          it "renders the index" do
+            expect(subject.call).to eq expected_content
+          end
+        end
+
+        describe ".call" do
+          it "renders the index" do
+            expect(IndexRenderer.call(consumer_name, docs) ).to eq expected_content
+          end
+        end
+
+      end
+    end
+  end
+end