Merge pull request #113 from thatguysimon/feat/allow-skip-writing-pact

Support not writing interactions to pact file if marked

Author: bethesque

.gitignore

@@ -29,6 +29,7 @@ log
 reports
 Gemfile.lock
 build
+.byebug_history
 
 vendor/bundle/
 spec/examples.txt

lib/pact/consumer_contract/consumer_contract_decorator.rb

@@ -32,11 +32,11 @@ def to_json(options = {})
 
     def sorted_interactions
       # Default order: chronological
-      return consumer_contract.interactions if Pact.configuration.pactfile_write_order == :chronological
+      return consumer_contract.writable_interactions if Pact.configuration.pactfile_write_order == :chronological
       # We are supporting only chronological or alphabetical order
       raise NotImplementedError if Pact.configuration.pactfile_write_order != :alphabetical
 
-      consumer_contract.interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
+      consumer_contract.writable_interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
     end
 
     def sortable_id interaction

lib/pact/consumer_contract/interaction_decorator.rb

@@ -17,6 +17,7 @@ def as_json options = {}
       hash[:providerState] = interaction.provider_state if interaction.provider_state
       hash[:request] = decorate_request.as_json(options)
       hash[:response] = decorate_response.as_json(options)
+      hash[:metadata] = interaction.metadata
       fix_all_the_things hash
     end
 

pact-mock_service.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'json'
   gem.add_runtime_dependency 'webrick', '~> 1.3'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
-  gem.add_runtime_dependency 'pact-support', '~> 1.2', '>= 1.2.1'
+  gem.add_runtime_dependency 'pact-support', '~> 1.12', '>= 1.12.0'
   gem.add_runtime_dependency 'filelock', '~> 1.1'
 
   gem.add_development_dependency 'rack-test', '~> 0.7'

spec/features/write_pact_file_spec.rb

@@ -82,6 +82,47 @@
     end
   end
 
+  context "when the expected interaction is executed but is marked to not be written to the pact file" do
+    let(:zebra_interaction) do
+      {
+        description: "a request for zebras",
+        provider_state: "zebras exist",
+        request: {
+          method: :get,
+          path: '/zebras',
+          headers: {'Accept' => 'application/zebra'}
+        },
+        response: {
+          status: 200
+        },
+        metadata: {
+          write_to_pact: false
+        }
+      }.to_json
+    end
+
+    before do
+      post "/interactions", zebra_interaction, admin_headers
+    end
+
+    it "does not include the interaction in the pact file" do
+      get "/alligators", nil, {'HTTP_ACCEPT' => 'application/alligator'}
+      get "/giraffes", nil, {'HTTP_ACCEPT' => 'application/giraffe'}
+      get "/zebras", nil, {'HTTP_ACCEPT' => 'application/zebra'}
+      post "/pact", pact_details, admin_headers
+
+      expect(pact_json['interactions']).to include(
+        include("description" => "a request for alligators")
+      )
+      expect(pact_json['interactions']).to include(
+        include("description" => "a request for giraffes")
+      )
+      expect(pact_json['interactions']).to_not include(
+        include("description" => "a request for zebras")
+      )
+    end
+  end
+
   context "when no interactions are executed" do
     it "does not create the pact file" do
       post "/pact", pact_details, admin_headers

spec/lib/pact/consumer_contract/consumer_contract_decorator_spec.rb

@@ -34,6 +34,7 @@ module Pact
       end
 
     end
+    
     describe "as_json" do
       context "with multiple interactions" do
         let(:desc_2) { 'Desc 1' }
@@ -127,7 +128,51 @@ module Pact
           end
         end
       end
-    end
 
+      context "when an interaction is marked to not be written" do
+        before do
+          Pact.configuration.pactfile_write_order = :chronological
+        end
+
+        let(:interaction_1) do
+          InteractionFactory.create(
+            provider_state: 'State 1',
+            description: 'Desc 1',
+            response: {
+              status: 201
+            })
+        end
+        let(:interaction_2) do
+          InteractionFactory.create(
+            provider_state: 'State 2',
+            description: 'Desc 2',
+            response: {
+              status: 201
+            },
+            metadata: {
+              write_to_pact: true
+            })
+        end
+        let(:interaction_3) do
+          InteractionFactory.create(
+            provider_state: 'State 3',
+            description: 'Desc 3',
+            response: {
+              status: 201
+            },
+            metadata: {
+              write_to_pact: false
+            })
+        end
+        let(:interactions) { [interaction_1, interaction_2, interaction_3] }
+
+        it "only renders writable interactions" do
+          expect(subject.as_json[:interactions]).to eq([
+            InteractionDecorator.new(interaction_1, pact_specification_version: pact_specification_version).as_json,
+            InteractionDecorator.new(interaction_2, pact_specification_version: pact_specification_version).as_json
+          ])
+        end
+      end
+    end
   end
 end