pact_broker-client 1.58.0 → 1.61.0

data/lib/pact_broker/client/merge_pacts.rb

@@ -18,29 +18,40 @@ module PactBroker
       def merge original, additional
         new_pact = JSON.parse(original.to_json, symbolize_names: true)
 
-        additional[:interactions].each do |new_interaction|
+        merge_interactions_or_messages(new_pact, original, additional, :interactions)
+        merge_interactions_or_messages(new_pact, original, additional, :messages)
+
+        new_pact
+      end
+
+      private
+
+      def merge_interactions_or_messages(new_pact, original, additional, key)
+        return unless additional[key] || original[key]
+
+        additional_messages_or_interactions = additional[key] || []
+        original_messages_or_interactions = original[key] || []
+        new_pact[key] ||= []
+
+        additional_messages_or_interactions.each do |new_interaction|
           # check to see if this interaction matches an existing interaction
-          overwrite_index = original[:interactions].find_index do |original_interaction|
+          overwrite_index = original_messages_or_interactions.find_index do |original_interaction|
             same_description_and_state?(original_interaction, new_interaction)
           end
 
           # overwrite existing interaction if a match is found, otherwise appends the new interaction
           if overwrite_index
-            if new_interaction == original[:interactions][overwrite_index]
-              new_pact[:interactions][overwrite_index] = new_interaction
+            if new_interaction == original_messages_or_interactions[overwrite_index]
+              new_pact[key][overwrite_index] = new_interaction
             else
-              raise PactMergeError, almost_duplicate_message(original[:interactions][overwrite_index], new_interaction)
+              raise PactMergeError, almost_duplicate_message(original_messages_or_interactions[overwrite_index], new_interaction)
             end
           else
-            new_pact[:interactions] << new_interaction
+            new_pact[key] << new_interaction
           end
         end
-
-        new_pact
       end
 
-      private
-
       def almost_duplicate_message(original, new_interaction)
         "Two interactions have been found with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response. " +
           "Please use a different description or provider state, or hard-code any random data.\n\n" +

data/lib/pact_broker/client/pacticipants/create.rb

@@ -30,7 +30,7 @@ module PactBroker
           if json_output?
             response_entity.response.raw_body
           else
-            green(message = "Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
+            green("Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
           end
         end
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -3,6 +3,7 @@ require 'pact_broker/client/hal_client_methods'
 require 'base64'
 require 'pact_broker/client/publish_pacts_the_old_way'
 require 'pact_broker/client/colorize_notices'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.58.0'
+    VERSION = '1.61.0'
   end
 end

data/lib/pact_broker/client/versions/create.rb

@@ -0,0 +1,111 @@
+require "pact_broker/client/base_client"
+require "pact_broker/client/base_command"
+
+module PactBroker
+  module Client
+    class Versions < BaseClient # need to retire the old base client code
+      class Create < PactBroker::Client::BaseCommand
+
+        def do_call
+          if branch_name
+            if branch_versions_supported?
+              create_branch_version
+            else
+              raise PactBroker::Client::Error.new("This version of #{pact_broker_name} does not support branch versions,or you do not have the required permissions to create one. Please ensure you have upgraded to version 2.82.0 or later for branch support.")
+            end
+          end
+
+          if tags
+            create_version_tags
+          end
+
+          if !branch_name && !tags.any?
+            create_version
+          end
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        private
+
+        def pacticipant_name
+          params.fetch(:pacticipant_name)
+        end
+
+        def version_number
+          params.fetch(:version_number)
+        end
+
+        def branch_name
+          params[:branch_name]
+        end
+
+        def tags
+          params[:tags] || []
+        end
+
+        def branch_versions_supported?
+          index_resource._link("pb:pacticipant-branch-version")
+        end
+
+        def create_branch_version
+          branch_params = {
+            "pacticipant" => pacticipant_name,
+            "version" => version_number,
+            "branch" => branch_name
+          }
+          branch_version_entity = index_resource
+                                ._link("pb:pacticipant-branch-version")
+                                .expand(branch_params)
+                                .put!
+        end
+
+        def create_version_tags
+          tags.each do | tag |
+            tag_params = {
+              "pacticipant" => pacticipant_name,
+              "version" => version_number,
+              "tag" => tag
+            }
+            index_resource
+              ._link("pb:pacticipant-version-tag")
+              .expand(tag_params)
+              .put!
+          end
+        end
+
+        def create_version
+          @version_resource ||= expanded_version_relation.put!
+        end
+
+        def expanded_version_relation
+          version_params = {
+            "pacticipant" => pacticipant_name,
+            "version" => version_number
+          }
+          index_resource
+            ._link("pb:pacticipant-version")
+            .expand(version_params)
+        end
+
+        def result_message
+          if json_output?
+            (@version_resource || expanded_version_relation.get).response.raw_body
+          else
+            message = "Created/updated pacticipant version #{version_number}"
+            if branch_name && tags.any?
+              message = message + " with branch #{branch_name} and tag(s) #{tags.join(", ")}"
+            elsif branch_name
+              message = message + " with branch #{branch_name}"
+            elsif tags.any?
+              message = message + " with tag(s) #{tags.join(", ")}"
+            end
+
+            message = message + " in #{pact_broker_name}"
+            green(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/versions.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/describe'
+require 'pact_broker/client/versions/create'
 
 # Old code
 require 'pact_broker/client/pacts'

data/lib/pact_broker/client/webhooks/create.rb

@@ -4,11 +4,14 @@ require 'ostruct'
 require 'json'
 require 'pact_broker/client/command_result'
 require "pact_broker/client/backports"
+require "pact_broker/client/hash_refinements"
 
 module PactBroker
   module Client
     module Webhooks
       class Create
+        using PactBroker::Client::HashRefinements
+
         WEBHOOKS_WITH_OPTIONAL_PACTICICPANTS_NOT_SUPPORTED = "This version of the Pact Broker requires that both consumer and provider are specified for a webhook. Please upgrade your broker to >= 2.22.0 to create a webhook with optional consumer and provider."
         CREATING_WEBHOOK_WITH_UUID_NOT_SUPPORTED = "This version of the Pact Broker does not support creating webhooks with a specified UUID. Please upgrade your broker to >= 2.49.0 or use the create-webhook command."
 
@@ -50,7 +53,7 @@ module PactBroker
               return error_result(CREATING_WEBHOOK_WITH_UUID_NOT_SUPPORTED)
             end
           else
-            webhook_entity = index_entity._link("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
+            webhook_entity = index_entity._link!("pb:webhooks").post(request_body_with_optional_consumer_and_provider)
           end
 
           if webhook_entity.response.status == 405

data/pact-broker-client.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |gem|
   gem.name          = "pact_broker-client"
   gem.version       = PactBroker::Client::VERSION
   gem.authors       = ["Beth Skurrie"]
-  gem.email         = ["bskurrie@dius.com.au"]
-  gem.description   = %q{Client for the Pact Broker. Publish, retrieve and query pacts and verification results.}
+  gem.email         = ["beth@bethesque.com"]
+  gem.description   = %q{Client for the Pact Broker. Publish, retrieve and query pacts and verification results. Manage webhooks and environments.}
   gem.summary       = %q{See description}
-  gem.homepage      = "https://github.com/bethesque/pact_broker-client.git"
+  gem.homepage      = "https://github.com/pact-foundation/pact_broker-client.git"
 
   gem.required_ruby_version = '>= 2.0'
 
@@ -33,6 +33,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'conventional-changelog', '~>1.3'
   gem.add_development_dependency 'pact', '~> 1.16'
   gem.add_development_dependency 'pact-support', '~> 1.16'
-  gem.add_development_dependency 'approvals', '>=0.0.24', '<1.0.0'
+  gem.add_development_dependency 'approvals', '0.0.24'
   gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/script/record-undeployment.sh

@@ -1,4 +1,4 @@
 bundle exec bin/pact-broker record-undeployment \
-   --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292 --output json --verbose
+   --pacticipant foo-consumer --environment production --broker-base-url http://localhost:9292 --output json --verbose
 
 

data/script/update-cli-usage-in-readme.rb

@@ -58,7 +58,7 @@ def generate_thor_docs
       ["Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
       ["Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
       ["Tags", %w[create-version-tag]],
-      ["Versions", %w[describe-version]],
+      ["Versions", %w[describe-version create-or-update-version]],
       ["Miscellaneous", %w[generate-uuid]]
     ]
 
@@ -137,8 +137,12 @@ def reformat_docs(generated_thor_docs)
     else
       lines
     end
-    # line
-  end.flatten.join("\n").gsub("/go/", "/").gsub(File.basename(__FILE__), "pact-broker")
+  end
+    .flatten
+    .collect { | line | line.gsub(/\s+$/, "") }
+    .join("\n")
+    .gsub("/go/", "/")
+    .gsub(File.basename(__FILE__), "pact-broker")
 end
 
 def update_readme(usage_docs)

data/spec/lib/pact_broker/client/hal/entity_spec.rb

@@ -112,7 +112,7 @@ module PactBroker::Client
 
         context 'when the key does not exist' do
           it 'raises an error' do
-            expect { subject._link!('foo') }.to raise_error RelationNotFoundError, "Could not find relation 'foo' in resource at http://pact"
+            expect { subject._link!('foo') }.to raise_error RelationNotFoundError, /Could not find relation 'foo' in resource at http:\/\/pact/
           end
         end
       end

data/spec/lib/pact_broker/client/merge_pacts_spec.rb

@@ -4,63 +4,166 @@ module PactBroker
   module Client
     describe MergePacts do
       describe ".call" do
-        let(:pact_hash_1) do
-          {
-            other: 'info',
-            interactions: [
-              {providerState: 1, description: 1, foo: 'bar' }
-            ]
-          }
-        end
+        describe "with a pact with interactions" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              interactions: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
 
-        let(:pact_hash_2) do
-          {
-            interactions: [
-              {providerState: 2, description: 2, foo: 'wiffle' }
-            ]
-          }
-        end
+          let(:pact_hash_2) do
+            {
+              interactions: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
 
-        let(:pact_hash_3) do
-          {
-            interactions: [
-              {providerState: 3, description: 3, foo: 'meep' },
-              {providerState: 1, description: 1, foo: 'bar' }
-            ]
-          }
-        end
+          let(:pact_hash_3) do
+            {
+              interactions: [
+                { providerState: 3, description: 3, foo: 'meep' },
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
 
-        let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
-
-        let(:expected_merge) do
-          {
-            other: 'info',
-            interactions: [
-              {providerState: 1, description: 1, foo: 'bar' },
-              {providerState: 2, description: 2, foo: 'wiffle' },
-              {providerState: 3, description: 3, foo: 'meep' }
-            ]
-          }
-        end
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              interactions: [
+                { providerState: 1, description: 1, foo: 'bar' },
+                { providerState: 2, description: 2, foo: 'wiffle' },
+                { providerState: 3, description: 3, foo: 'meep' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
 
-        subject { MergePacts.call(pact_hashes) }
+          it "merges the interactions by consumer/provider" do
+            expect(subject).to eq expected_merge
+          end
+
+          context "when an interaction is found with the same state and description but has a difference elsewhere" do
+            let(:pact_hash_3) do
+              {
+                interactions: [
+                  { providerState: 3, description: 3, foo: 'meep' },
+                  { providerState: 1, description: 1, foo: 'different' }
+                ]
+              }
+            end
 
-        it "merges the interactions by consumer/provider" do
-          expect(subject).to eq expected_merge
+            it "raises an error" do
+              expect { subject }.to raise_error PactMergeError, /foo.*different/
+            end
+          end
         end
 
-        context "when an interaction is found with the same state and description but has a difference elsewhere" do
+        describe "with a pact with messages" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hash_2) do
+            {
+              messages: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
+
           let(:pact_hash_3) do
+            {
+              messages: [
+                { providerState: 3, description: 3, foo: 'meep' },
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2, pact_hash_3] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' },
+                { providerState: 2, description: 2, foo: 'wiffle' },
+                { providerState: 3, description: 3, foo: 'meep' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
+
+          it "merges the messages by consumer/provider" do
+            expect(subject).to eq expected_merge
+          end
+
+          context "when an interaction is found with the same state and description but has a difference elsewhere" do
+            let(:pact_hash_3) do
+              {
+                messages: [
+                  { providerState: 3, description: 3, foo: 'meep' },
+                  { providerState: 1, description: 1, foo: 'different' }
+                ]
+              }
+            end
+
+            it "raises an error" do
+              expect { subject }.to raise_error PactMergeError, /foo.*different/
+            end
+          end
+        end
+
+        describe "with a pact with messages and a pact with interactions" do
+          let(:pact_hash_1) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ]
+            }
+          end
+
+          let(:pact_hash_2) do
             {
               interactions: [
-                {providerState: 3, description: 3, foo: 'meep' },
-                {providerState: 1, description: 1, foo: 'different' }
+                { providerState: 2, description: 2, foo: 'wiffle' }
               ]
             }
           end
 
-          it "raises an error" do
-            expect { subject }.to raise_error PactMergeError, /foo.*different/
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2] }
+
+          let(:expected_merge) do
+            {
+              other: 'info',
+              messages: [
+                { providerState: 1, description: 1, foo: 'bar' }
+              ],
+              interactions: [
+                { providerState: 2, description: 2, foo: 'wiffle' }
+              ]
+            }
+          end
+
+          subject { MergePacts.call(pact_hashes) }
+
+          it "merges the messages by consumer/provider" do
+            expect(subject).to eq expected_merge
           end
         end
       end

data/spec/lib/pact_broker/client/versions/create_spec.rb

@@ -0,0 +1,174 @@
+require "pact_broker/client/versions/create"
+
+module PactBroker
+  module Client
+    describe Versions::Create do
+      describe "#call" do
+        let(:index_body) do
+          {
+            "_links" => {
+              "pb:pacticipant-branch-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/branches/{branch}/versions/{version}"
+              },
+              "pb:pacticipant-version-tag" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}/tags/{tag}"
+              },
+              "pb:pacticipant-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}"
+              }
+            }
+          }
+        end
+
+        let!(:index_request) do
+          stub_request(:get, "http://broker").to_return(status: 200, body: index_body.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:branch_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/branches/main/versions/1").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:tag_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1/tags/dev").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:create_version_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "created" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:get_version_request) do
+          stub_request(:get, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "got" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let(:params) do
+          {
+            pacticipant_name: "Foo",
+            version_number: "1",
+            branch_name: branch_name,
+            tags: tags
+          }
+        end
+
+        let(:branch_name) { "main" }
+        let(:tags) { ["dev"] }
+
+        let(:options) do
+          {
+            verbose: "verbose",
+            output: output
+          }
+        end
+
+        let(:output) { "text" }
+
+        let(:pact_broker_client_options) do
+          {
+            token: "token",
+            pact_broker_base_url: "http://broker"
+          }
+        end
+
+        subject { PactBroker::Client::Versions::Create.call(params, options, pact_broker_client_options)}
+
+        context "with a branch and tags" do
+          it "creates a branch version" do
+            subject
+            expect(branch_request).to have_been_made
+          end
+
+          it "creates the tag" do
+            subject
+            expect(tag_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main and tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only tags" do
+          let(:branch_name) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only a branch" do
+          let(:tags) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with no branch or tags" do
+          let(:tags) { nil }
+          let(:branch_name) { nil }
+
+          it "creates a version" do
+            subject
+            expect(create_version_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "created" }.to_json)
+            end
+          end
+        end
+
+        context "when the Pact Broker does not support branch versions" do
+          before do
+            index_body["_links"].delete("pb:pacticipant-branch-version")
+          end
+
+          let(:index_body) do
+            {
+              "_links" => {}
+            }
+          end
+
+          it "returns an error" do
+            expect(subject.message).to include "does not support branch versions"
+            expect(subject.success).to be false
+          end
+        end
+      end
+    end
+  end
+end