pact_broker 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df97d13a663699e7a3eb4d7f58cc7abe8a1012d2
-  data.tar.gz: 319a6de81120c2bc7d627fbc2255caf51da2e742
+  metadata.gz: 5f09781dc3499bf4830479db69b58d8d26436bea
+  data.tar.gz: 74c433ce40b144bd5e2c1cef5efa4a3d892a94f5
 SHA512:
-  metadata.gz: 0130cac31b2abaebf71905c841d136a0e6d7fcf4e00186c3e33afb2fda2a8ce4fddceb5fcfe4cd5de9b0650bf6eb8d5cec1f33c422bf17af36292f01665e253b
-  data.tar.gz: 3a7f9c3663de5c1b1143608727321f97a40af7737d3868034e9bff1b2cfbb86ec131731667963f173484057bd118c6b84f32ca41fa22101f8f2542aaa34e1e56
+  metadata.gz: 85c3c79444957b05bcfd754e5d12b69a2d8196439a45e1f6ce1edaf2d2936e850f9656bbb3396d243434bd80a11a659a257b2614b10385c52e5a07b7b14fcfa1
+  data.tar.gz: 78782d8518d1bf357c9d434b5ed40d77d6ab83f6f73745e063f22a2f5c747e61f65201af92851206c4b70cdab532d6d51a5d05a8d72cfbd25dfec0834723d80c

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+
+#### 1.11.0 (2016-08-13)
+* 18ffc4a - Add conflict guards to pact merger (Steve Pletcher, Fri Aug 5 12:31:30 2016 -0400)
+
 #### 1.10.0 (2016-08-01)
 * efdde13 - Add ability to merge pacts via PATCH requests (Steve Pletcher, Thu Jul 28 16:29:22 2016 -0400)
 

data/lib/pact_broker/api/resources/pact.rb

@@ -40,7 +40,10 @@ module PactBroker
         end
 
         def is_conflict?
-          potential_duplicate_pacticipants?(pact_params.pacticipant_names)
+          merge_conflict = request.patch? && resource_exists? &&
+            Pacts::Merger.conflict?(pact.json_content, pact_params.json_content)
+
+          potential_duplicate_pacticipants?(pact_params.pacticipant_names) || merge_conflict
         end
 
         def malformed_request?

data/lib/pact_broker/pacts/merger.rb

@@ -6,6 +6,17 @@ module PactBroker
 
       extend self
 
+      def conflict? original_json, additional_json
+        original, additional = [original_json, additional_json].map{|str| JSON.parse(str, PACT_PARSING_OPTIONS) }
+
+        additional["interactions"].any? do |new_interaction|
+          original["interactions"].any? do |original_interaction|
+            same_description_and_state?(original_interaction, new_interaction) &&
+              !same_request_properties?(original_interaction["request"], new_interaction["request"])
+          end
+        end
+      end
+
       # Accepts two hashes representing pacts, outputs a merged hash
       # Does not make any guarantees about order of interactions
       def merge_pacts original_json, additional_json
@@ -16,7 +27,7 @@ module PactBroker
         additional["interactions"].each do |new_interaction|
           # check to see if this interaction matches an existing interaction
           overwrite_index = original["interactions"].find_index do |original_interaction|
-            matching_request?(original_interaction, new_interaction)
+            same_description_and_state?(original_interaction, new_interaction)
           end
 
           # overwrite existing interaction if a match is found, otherwise appends the new interaction
@@ -32,21 +43,15 @@ module PactBroker
 
       private
 
-      def matching_request? original_interaction, new_interaction
-        same_description_and_state?(original_interaction, new_interaction) &&
-          same_request_properties?(original_interaction["request"], new_interaction["request"])
-      end
-
       def same_description_and_state? original, additional
         original["description"] == additional["description"] &&
           original["provider_state"] == additional["provider_state"]
       end
 
       def same_request_properties? original, additional
-        method_matches = original["method"] == additional["method"]
-        path_matches = original["path"] == additional["path"]
-
-        method_matches && path_matches && original["headers"] == additional["headers"]
+        attributes_match = %w(method path query body headers).all? do |attribute|
+          original[attribute] == additional[attribute]
+        end
       end
     end
   end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

data/spec/features/merge_pact_spec.rb

@@ -25,7 +25,7 @@ describe "Merging a pact" do
   end
 
   context "when a pact for this consumer version does exist" do
-    let(:existing_pact_content) { load_fixture('a_consumer-a_provider-2.json') }
+    let(:existing_pact_content) { load_fixture('a_consumer-a_provider-3.json') }
     let(:merged_pact_content) { load_fixture('a_consumer-a_provider-merged.json') }
 
     before do
@@ -43,6 +43,14 @@ describe "Merging a pact" do
     it "returns the merged pact in the response body" do
       expect(response_body_json).to contain_hash JSON.parse(merged_pact_content)
     end
+
+    context "with a conflicting request" do
+      let(:existing_pact_content) { load_fixture('a_consumer-a_provider-conflict.json') }
+
+      it "returns a 409 Conflict" do
+        expect(subject.status).to be 409
+      end
+    end
   end
 
   context "when the pacticipant names in the path do not match those in the pact" do

data/spec/fixtures/a_consumer-a_provider-3.json

@@ -0,0 +1,22 @@
+{
+  "consumer": {
+    "name": "A Consumer"
+  },
+  "provider": {
+    "name": "A Provider"
+  },
+  "interactions": [
+    {
+      "description" : "another request for something",
+      "provider_state": null,
+      "request": {
+        "method": "get",
+        "path" : "/something_else"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

data/spec/fixtures/a_consumer-a_provider-conflict.json

@@ -0,0 +1,22 @@
+{
+  "consumer": {
+    "name": "A Consumer"
+  },
+  "provider": {
+    "name": "A Provider"
+  },
+  "interactions": [
+    {
+      "description" : "a request for something",
+      "provider_state": null,
+      "request": {
+        "method": "post",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

data/spec/fixtures/a_consumer-a_provider-merged.json

@@ -10,7 +10,7 @@
       "description" : "a request for something",
       "provider_state": null,
       "request": {
-        "method": "post",
+        "method": "get",
         "path" : "/something"
       },
       "response": {
@@ -19,11 +19,11 @@
       }
     },
     {
-      "description" : "a request for something",
+      "description" : "another request for something",
       "provider_state": null,
       "request": {
         "method": "get",
-        "path" : "/something"
+        "path" : "/something_else"
       },
       "response": {
         "status": 200,

data/spec/fixtures/consumer-provider.json

@@ -11,7 +11,10 @@
       "provider_state": null,
       "request": {
         "method": "get",
-        "path" : "/something"
+        "path" : "/something",
+        "headers" : {
+          "Content-Type" : "application/json"
+        }
       },
       "response": {
         "status": 200,

data/spec/lib/pact_broker/pacts/merger_spec.rb

@@ -28,86 +28,115 @@ module PactBroker
         }
       end
 
-      before :each do
-        @pact_to_merge = load_json_fixture('consumer-provider.json')
-      end
-
-      it "merges two pacts" do
-        @pact_to_merge["interactions"] << example_interaction
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"]).to match_array(example_pact["interactions"].push(example_interaction))
-      end
-
-      it "is idempotent" do
-        @pact_to_merge["interactions"] << example_interaction
-        first_result = merge_pacts(example_pact, @pact_to_merge)
-        second_result = merge_pacts(first_result, @pact_to_merge)
-        expect(first_result).to contain_hash second_result
-      end
-
-      it "overwrites identical interactions" do
-        @pact_to_merge["interactions"][0]["response"]["body"] = "changed!"
-        result = merge_pacts(example_pact, @pact_to_merge)
-
-        expect(result["interactions"].length).to eq example_pact["interactions"].length
-        expect(result["interactions"].first["response"]["body"]).to eq "changed!"
-      end
-
-      it "appends interactions with a different provider state" do
-        @pact_to_merge["interactions"][0]["provider_state"] = "upside down"
+      describe "#merge" do
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
+        before :each do
+          @pact_to_merge = load_json_fixture('consumer-provider.json')
+        end
 
-      it "appends interactions with a different description" do
-        @pact_to_merge["interactions"][0]["description"] = "getting $$$"
+        it "merges two pacts" do
+          @pact_to_merge["interactions"] << example_interaction
+          result = merge_pacts(example_pact, @pact_to_merge)
+          expect(result["interactions"]).to match_array(example_pact["interactions"].push(example_interaction))
+        end
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
+        it "is idempotent" do
+          @pact_to_merge["interactions"] << example_interaction
+          first_result = merge_pacts(example_pact, @pact_to_merge)
+          second_result = merge_pacts(first_result, @pact_to_merge)
+          expect(first_result).to contain_hash second_result
+        end
 
-      it "appends interactions with a different request method" do
-        @pact_to_merge["interactions"][0]["request"]["method"] = "delete"
+        it "overwrites identical interactions" do
+          @pact_to_merge["interactions"][0]["response"]["body"] = "changed!"
+          result = merge_pacts(example_pact, @pact_to_merge)
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
+          expect(result["interactions"].length).to eq example_pact["interactions"].length
+          expect(result["interactions"].first["response"]["body"]).to eq "changed!"
+        end
 
-      it "appends interactions with a different request path" do
-        @pact_to_merge["interactions"][0]["request"]["path"] = "/decrypt_all_passwords"
+        it "appends interactions with a different provider state" do
+          @pact_to_merge["interactions"][0]["provider_state"] = "upside down"
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
+          result = merge_pacts(example_pact, @pact_to_merge)
+          expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+        end
 
-      it "appends interactions which have additional request headers in the new pact" do
-        @pact_to_merge["interactions"][0]["request"]["headers"] = { "Accept" => "script/javascript" }
+        it "appends interactions with a different description" do
+          @pact_to_merge["interactions"][0]["description"] = "getting $$$"
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
+          result = merge_pacts(example_pact, @pact_to_merge)
+          expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+        end
 
-      it "appends interactions with different request headers" do
-        example_pact["interactions"][0]["request"]["headers"] = { "Content-Type" => "script/javascript" }
-        @pact_to_merge["interactions"][0]["request"]["headers"] = { "Content-Type" => "ayy/lmao" }
+        # helper that lets these specs deal with hashes instead of JSON strings
+        def merge_pacts(a, b, return_hash = true)
+          result = PactBroker::Pacts::Merger.merge_pacts(a.to_json, b.to_json)
 
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+          return_hash ? JSON.parse(result) : result
+        end
       end
 
-      it "appends interactions with fewer request headers" do
-        example_pact["interactions"][0]["request"]["headers"] = { "Content-Type" => "script/javascript" }
-
-        result = merge_pacts(example_pact, @pact_to_merge)
-        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
-      end
-
-      # helper that lets these specs deal with hashes instead of JSON strings
-      def merge_pacts(a, b, return_hash = true)
-        result = PactBroker::Pacts::Merger.merge_pacts(a.to_json, b.to_json)
-
-        return_hash ? JSON.parse(result) : result
+      describe "#conflict?" do
+        before :each do
+          @pact_to_compare = load_json_fixture('consumer-provider.json')
+        end
+
+        it "returns false if interactions have different descriptions" do
+          @pact_to_compare["interactions"][0]["description"] = "something else"
+
+          expect(compare_pacts(example_pact, @pact_to_compare)).to eq false
+        end
+
+        it "returns false if interactions have different provider states" do
+          @pact_to_compare["interactions"][0]["provider_state"] = "some other thing"
+          expect(compare_pacts(example_pact, @pact_to_compare)).to eq false
+        end
+
+        context "when interactions have the same desc/state" do
+          it "returns false if request parameters are the same" do
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq false
+          end
+
+          it "returns true if requests have a different query" do
+            @pact_to_compare["interactions"][0]["request"]["query"] = "foo=bar&baz=qux"
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if requests have a different body" do
+            @pact_to_compare["interactions"][0]["request"]["body"] = { "something" => { "nested" => "deeply" } }
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if request method is different" do
+            @pact_to_compare["interactions"][0]["request"]["method"] = "post"
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if request path is different" do
+            @pact_to_compare["interactions"][0]["request"]["path"] = "/new_path"
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if request headers are different" do
+            @pact_to_compare["interactions"][0]["request"]["headers"]["Content-Type"] = "text/html"
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if request has additional headers" do
+            @pact_to_compare["interactions"][0]["request"]["headers"]["Accept"] = "text/html"
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+
+          it "returns true if request has missing headers" do
+            @pact_to_compare["interactions"][0]["request"]["headers"].delete("Content-Type")
+            expect(compare_pacts(example_pact, @pact_to_compare)).to eq true
+          end
+        end
+
+        def compare_pacts(a, b)
+          PactBroker::Pacts::Merger.conflict?(a.to_json, b.to_json)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -581,6 +581,8 @@ files:
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json
+- spec/fixtures/a_consumer-a_provider-3.json
+- spec/fixtures/a_consumer-a_provider-conflict.json
 - spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
 - spec/fixtures/consumer-provider.json
@@ -738,6 +740,8 @@ test_files:
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json
+- spec/fixtures/a_consumer-a_provider-3.json
+- spec/fixtures/a_consumer-a_provider-conflict.json
 - spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
 - spec/fixtures/consumer-provider.json