pact_broker-client 1.36.0 → 1.37.0

data/lib/pact_broker/client/git.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/error'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 
@@ -21,6 +22,8 @@ BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/var
 module PactBroker
   module Client
     module Git
+      using PactBroker::Client::HashRefinements
+
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
       BRANCH_ENV_VAR_NAMES = %w{BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
       COMMIT_ENV_VAR_NAMES = %w{BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}

data/lib/pact_broker/client/hal/entity.rb

@@ -1,6 +1,7 @@
 require 'erb'
 require 'delegate'
 require 'pact_broker/client/hal/link'
+require 'pact_broker/client/hal/links'
 
 module PactBroker
   module Client
@@ -51,10 +52,27 @@ module PactBroker
           end
         end
 
+        def _links(key)
+          if @links[key] && @links[key].is_a?(Array)
+            link_collection = @links[key].collect do | hash |
+              Link.new(hash, @client)
+            end
+            Links.new(@href, key, link_collection)
+          elsif @links[key].is_a?(Hash)
+            Links.new(@href, key, [Link.new(@links[key], @client)])
+          else
+            nil
+          end
+        end
+
         def _link!(key)
           _link(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
         end
 
+        def _links!(key)
+          _links(key) or raise RelationNotFoundError.new("Could not find relation '#{key}' in resource at #{@href}")
+        end
+
         def success?
           true
         end
@@ -85,7 +103,7 @@ module PactBroker
           @data.key?(method_name) || @links.key?(method_name)
         end
 
-        def assert_success!
+        def assert_success!(_ignored = nil)
           self
         end
       end
@@ -107,8 +125,14 @@ module PactBroker
           false
         end
 
-        def assert_success!
-          raise ErrorResponseReturned.new("Error retrieving #{@href} status=#{response ? response.code: nil} #{response ? response.raw_body : ''}")
+        def assert_success!(messages = {})
+          default_message = "Error retrieving #{@href} status=#{response ? response.status: nil} #{response ? response.raw_body : ''}".strip
+          message = if response && messages[response.status]
+            (messages[response.status] || "") + " (#{default_message})"
+          else
+            default_message
+          end
+          raise ErrorResponseReturned.new(message)
         end
       end
     end

data/lib/pact_broker/client/hal/http_client.rb

@@ -83,6 +83,10 @@ module PactBroker
             end
           end
 
+          def headers
+            __getobj__().to_hash
+          end
+
           def raw_body
             __getobj__().body
           end

data/lib/pact_broker/client/hal/links.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'delegate'
+
+module PactBroker
+  module Client
+    module Hal
+      class Links
+        def initialize(href, key, links)
+          @href = href
+          @key = key
+          @links = links
+        end
+
+        def names
+          @names ||= links.collect(&:name).compact.uniq
+        end
+
+        def find!(name, not_found_message = nil)
+          link = find(name)
+          if link
+            link
+          else
+            message = not_found_message || "Could not find relation '#{key}' with name '#{name}' in resource at #{href}."
+            available_options = names.any? ? names.join(", ") : "<none found>"
+            raise RelationNotFoundError.new(message.chomp(".") + ". Available options: #{available_options}")
+          end
+        end
+
+        def find(name)
+          links.find{ | link | link.name == name }
+        end
+
+        private
+
+        attr_reader :links, :key, :href
+      end
+    end
+  end
+end

data/lib/pact_broker/client/hal_client_methods.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/client/hal'
+require 'pact_broker/client/retry'
 
 module PactBroker
   module Client
@@ -10,6 +11,16 @@ module PactBroker
       def create_http_client(pact_broker_client_options)
         PactBroker::Client::Hal::HttpClient.new(pact_broker_client_options.merge(pact_broker_client_options[:basic_auth] || {}))
       end
+
+      def index_entry_point
+        @index_entry_point ||= create_index_entry_point(pact_broker_base_url, pact_broker_client_options)
+      end
+
+      def index_resource
+        @index_resource ||= Retry.while_error do
+          index_entry_point.get!
+        end
+      end
     end
   end
 end

data/lib/pact_broker/client/hash_refinements.rb

@@ -0,0 +1,19 @@
+module PactBroker
+  module Client
+    module HashRefinements
+      refine Hash do
+        def compact
+          h = {}
+          each do |key, value|
+            h[key] = value unless value == nil
+          end
+          h
+        end unless Hash.method_defined? :compact
+
+        def compact!
+          reject! {|_key, value| value == nil}
+        end unless Hash.method_defined? :compact!
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix/text_formatter.rb

@@ -1,10 +1,12 @@
 require 'table_print'
 require 'dig_rb'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     class Matrix
       class TextFormatter
+        using PactBroker::Client::HashRefinements
 
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -5,11 +5,12 @@ require 'pact_broker/client/pact_file'
 require 'pact_broker/client/pact_hash'
 require 'pact_broker/client/merge_pacts'
 require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     class PublishPacts
-
+      using PactBroker::Client::HashRefinements
       include HalClientMethods
 
       def self.call(pact_broker_base_url, pact_file_paths, consumer_version_params, pact_broker_client_options={})

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -1,5 +1,6 @@
 require 'rake/tasklib'
 require 'pact_broker/client/git'
+require 'pact_broker/client/hash_refinements'
 
 =begin
 require pact_broker/client/tasks
@@ -17,6 +18,7 @@ end
 module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
+      using PactBroker::Client::HashRefinements
 
       attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
       attr_reader :auto_detect_version_properties, :branch, :build_url

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.36.0'
+    VERSION = '1.37.0'
   end
 end

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

@@ -0,0 +1,109 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+
+module PactBroker
+  module Client
+    class Versions
+      class RecordDeployment
+        include PactBroker::Client::HalClientMethods
+
+        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. Please upgrade to version 2.80.0 or later."
+
+        def self.call(params, pact_broker_base_url, pact_broker_client_options)
+          new(params, pact_broker_base_url, pact_broker_client_options).call
+        end
+
+        def initialize(params, pact_broker_base_url, pact_broker_client_options)
+          @pact_broker_base_url = pact_broker_base_url
+          @pacticipant_name = params.fetch(:pacticipant_name)
+          @version_number = params.fetch(:version_number)
+          @environment_name = params.fetch(:environment_name)
+          @replaced_previous_deployed_version = params.fetch(:replaced_previous_deployed_version)
+          @output = params.fetch(:output)
+          @pact_broker_client_options = pact_broker_client_options
+        end
+
+        def call
+          check_if_command_supported
+          record_deployment
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        rescue PactBroker::Client::Error => e
+          PactBroker::Client::CommandResult.new(false, e.message)
+        end
+
+        private
+
+        attr_reader :pact_broker_base_url, :pact_broker_client_options
+        attr_reader :pacticipant_name, :version_number, :environment_name, :replaced_previous_deployed_version, :output
+        attr_reader :deployed_version_resource
+
+        def check_environment_exists
+          index_resource
+            ._link!("pb:environments")
+            .get!
+            ._links("pb:environments")
+            .find!(environment_name, "No environment found with name '#{environment_name}'")
+        end
+
+        def record_deployment
+          @deployed_version_resource =
+            get_record_deployment_relation
+            .post(record_deployment_request_body)
+            .assert_success!
+        end
+
+        def get_record_deployment_relation
+          record_deployment_links = get_pacticipant_version._links!("pb:record-deployment")
+          link_for_environment = record_deployment_links.find(environment_name)
+          if link_for_environment
+            link_for_environment
+          else
+            check_environment_exists
+            # Force the exception to be raised
+            record_deployment_links.find!(environment_name, "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}.")
+          end
+        end
+
+        def get_pacticipant_version
+          index_resource
+            ._link!("pb:pacticipant-version")
+            .expand(pacticipant: pacticipant_name, version: version_number)
+            .get
+            .assert_success!(404 => "#{pacticipant_name} version #{version_number} not found")
+        end
+
+        def record_deployment_request_body
+          { replacedPreviousDeployedVersion: replaced_previous_deployed_version }
+        end
+
+        def result_message
+          if output == "text"
+            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
+            suffix = replaced_previous_deployed_version ? " Marked previous deployed version as undeployed." : ""
+            message + suffix
+          elsif output == "json"
+            deployed_version_resource.response.raw_body
+          else
+            ""
+          end
+        end
+
+        def pact_broker_name
+          is_pactflow? ? "Pactflow" : "the Pact Broker"
+        end
+
+        def is_pactflow?
+          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:environments")
+            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+          end
+        end
+      end
+    end
+  end
+end

data/script/trigger-release.sh

@@ -19,7 +19,7 @@ output=$(curl -v -X POST https://api.github.com/repos/${repository_slug}/dispatc
       -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
       -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
 
-if  ! echo "${output}" | grep "HTTP\/1.1 204" > /dev/null; then
+if  ! echo "${output}" | grep "HTTP\/.* 204" > /dev/null; then
   echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
   echo "Failed to trigger release"
   exit 1

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

@@ -9,8 +9,9 @@ module PactBroker::Client
       end
 
       let(:provider_response) do
-        double('response', body: provider_hash, success?: true)
+        double('response', body: provider_hash, success?: true, status: status)
       end
+      let(:status) { 200 }
 
       let(:provider_hash) do
         {
@@ -72,12 +73,12 @@ module PactBroker::Client
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client) }
 
           it "raises an error" do
-            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status= "
+            expect { entity.assert_success! }.to raise_error ErrorResponseReturned, "Error retrieving http://pact status="
           end
         end
 
         context "when the response is not successful and there is a response" do
-          let(:response) { double('response', code: 200, raw_body: "body") }
+          let(:response) { double('response', status: 200, raw_body: "body") }
 
           subject(:entity) { ErrorEntity.new("http://pact", pact_hash, http_client, response) }
 

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

@@ -5,7 +5,6 @@ module PactBroker
     class Versions
       describe Describe do
         describe ".call" do
-
           let(:versions_client) do
             instance_double('PactBroker::Client::Versions', latest: version_hash)
           end

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

@@ -0,0 +1,82 @@
+require 'pact_broker/client/versions/record_deployment'
+
+module PactBroker
+  module Client
+    class Versions
+      describe RecordDeployment do
+        describe ".call" do
+          let(:broker_base_url) { "http://broker" }
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+          let!(:index_request) do
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let(:replaced_previous_deployed_version) { true }
+
+          let(:params) do
+            {
+              pacticipant_name: "Foo",
+              version_number: "1",
+              environment_name: "test",
+              replaced_previous_deployed_version: replaced_previous_deployed_version,
+              output: "text"
+            }
+          end
+
+          let(:pact_broker_client_options) { {} }
+
+          subject { RecordDeployment.call(params, broker_base_url, pact_broker_client_options) }
+
+          context "when the pb:environments relation does not exist" do
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the response headers contain Pactflow" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:deployed_version_resource).and_return(deployed_version_resource)
+            end
+
+            let(:response_headers) { { "X-Pactflow-Sha" => "abc" } }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "indicates the API was Pactflow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test in Pactflow"
+            end
+          end
+
+          context "when replaced_previous_deployed_version is false" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_deployment)
+              allow_any_instance_of(RecordDeployment).to receive(:pact_broker_name).and_return("")
+            end
+
+            let(:replaced_previous_deployed_version) { false }
+
+            let(:deployed_version_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "does not include the message about marking the previous version as undeployed" do
+              expect(subject.message).to_not include "undeployed"
+            end
+          end
+        end
+      end
+    end
+  end
+end