pact_broker-client 1.56.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 449848d07d065628a69bd18154f106f438cadcb51cccd11a3e5214000a17dce2
-  data.tar.gz: 187e875cee98166e6fe85f2bd76314ac642a131a8a4cd48f861694eac5daf002
+  metadata.gz: 2d919435a18e3fdcfa55f3c4e75194c950e027924b2fb274a88bb78ce04035be
+  data.tar.gz: b80790889dde8ee96a98d48b8558608ca0f240da15ece8d57cdc15d646317d42
 SHA512:
-  metadata.gz: 354fb2790242a8b7c64f568306013055f07223fd5f016d441f0fb6addb479ac1ed59467733a5d44264d5800d13500b9b652964cc7fc34341778b5472c5c7e3c0
-  data.tar.gz: 0fc195c4957214522ecce949daaa9b08f84f5024c82ceea0bc16cf197493b6fd042fb1886c1da31dec25767a2ef3fd439eaf6894cb422282b8654901e796f4f1
+  metadata.gz: 9c36cfba633f104712099c648e8ef1ccf58dfd1e3025fc44719cdaf6b3e4b47af0ba27af0da7d01074ffc8f6c01cbc4e3e0195b5d95f18e5e960bbac038c6370
+  data.tar.gz: 33526cff8acc17cd129b2521127f4abc3f73eac56b4f1c3e832fe0fb3583bdbe3a1917ae2ac9ec8796414584ad97777e89f163c5732ac5f5f4a879a6c4955be3

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<a name="v1.57.0"></a>
+### v1.57.0 (2021-11-05)
+
+#### Features
+
+* support the --branch option in the version selectors for can-i-deploy	 ([dba8ec4](/../../commit/dba8ec4))
+* show more helpful error message if pb:environments not available for pactflow	 ([1bf38e3](/../../commit/1bf38e3))
+* print out notices if returned from publish pacts request	 ([86caf7e](/../../commit/86caf7e))
+
 <a name="v1.56.0"></a>
 ### v1.56.0 (2021-10-06)
 

data/README.md

@@ -837,11 +837,13 @@ require 'pact_broker/client/tasks'
 
 PactBroker::Client::PublicationTask.new do | task |
   require 'my_consumer/version'
-  task.consumer_version = MyConsumer::VERSION
+  task.consumer_version = ENV["GIT_COMMIT"]
   task.pattern = 'custom/path/to/pacts/*.json' # optional, default value is 'spec/pacts/*.json'
   task.pact_broker_base_url = "http://pact-broker"
-  task.tag_with_git_branch = true|false # Optional but STRONGLY RECOMMENDED as it will greatly assist with your pact workflow. Result will be merged with other specified task.tags
+  task.branch = ENV["GIT_BRANCH"] # Optional but STRONGLY RECOMMENDED.
+  task.tag_with_git_branch = true|false # Superseeded by the `branch` property
   task.tags = ["dev"] # optional
+  task.build_url = ENV["CI_BUILD_URL"]
   task.pact_broker_basic_auth =  { username: 'basic_auth_user', password: 'basic_auth_pass'} # optional
   task.pact_broker_token = "1234abcd" # Bearer token
   task.write_method = :merge # optional, this will merge the published pact into an existing pact rather than overwriting it if one exists. Not recommended, as it makes a mulch of the workflow on the broker.

data/lib/pact_broker/client/cli/matrix_commands.rb

@@ -13,6 +13,7 @@ module PactBroker
             method_option :ignore, required: false, desc: "The pacticipant name to ignore. Use once for each pacticipant being ignored. A specific version can be ignored by also specifying a --version after the pacticipant name option."
             method_option :latest, required: false, aliases: "-l", banner: "[TAG]", desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
             method_option :to_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil
+            method_option :branch, required: false, desc: "The branch of the version for which you want to check the verification results", default: nil
             method_option :to, required: false, banner: "TAG", desc: "The tag that represents the branch or environment of the integrated applications for which you want to check the verification result status.", default: nil
             method_option :output, aliases: "-o", desc: "json or table", default: "table"
             method_option :retry_while_unknown, banner: "TIMES", type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
@@ -77,8 +78,8 @@ module PactBroker
               end
 
               def validate_can_i_deploy_selectors selectors
-                pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? }.collect{ |s| s[:pacticipant] }
-                raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
+                pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? && s[:branch].nil? }.collect{ |s| s[:pacticipant] }
+                raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--branch BRANCH` `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
               end
             end
           end

data/lib/pact_broker/client/cli/version_selector_options_parser.rb

@@ -31,6 +31,10 @@ module PactBroker
               when "--latest", "-l"
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:tag] = word
+              when "--branch"
+                selectors << { pacticipant: nil } if selectors.empty?
+                selectors.last[:branch] = word
+                selectors.last[:latest] = true
               when "--all"
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:tag] = word

data/lib/pact_broker/client/deployments/record_release.rb

@@ -30,7 +30,11 @@ module PactBroker
         end
 
         def not_supported_message
-          "This version of the Pact Broker does not support recording #{action}s. Please upgrade to version 2.80.0 or later."
+          if is_pactflow?
+            "This version of Pactflow does not support recording #{action}s, or you do not have the required permission to read environments. Please upgrade to the latest version if using Pactflow On-Premises, and ensure the user has the environment read permission."
+          else
+            "This version of the Pact Broker does not support recording #{action}s. Please upgrade to version 2.80.0 or later."
+          end
         end
 
         def environment_exists?

data/lib/pact_broker/client/deployments/record_undeployment.rb

@@ -108,7 +108,7 @@ module PactBroker
           potential_application_instances = currently_deployed_version_entities_for_pacticipant.collect{|e| e.applicationInstance || e.target }
 
           if application_instance
-            omit_text = potential_application_instances.include?(nil) ? "omit the application instance to undeploy from the anonymous instance" : nil
+            omit_text = potential_application_instances.include?(nil) ? "omit the application instance" : nil
             specify_text = potential_application_instances.compact.any? ? "specify one of the following application instances to record the undeployment from: #{potential_application_instances.compact.join(", ")}" : nil
             "#{pacticipant_name} is not currently deployed to application instance '#{application_instance}' in #{environment_name} environment. Please #{[omit_text, specify_text].compact.join(" or ")}."
           else

data/lib/pact_broker/client/environments/environment_command.rb

@@ -5,6 +5,7 @@ module PactBroker
     module Environments
       class EnvironmentCommand < PactBroker::Client::BaseCommand
         NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support environments. Please upgrade to version 2.80.0 or later."
+        PACTFLOW_NOT_SUPPORTED_MESSAGE = "This version of Pactflow does not support environments or you do not have the required permission to read them. Please upgrade to the latest version if using Pactflow On-Premises and ensure the user has the environment read permission."
 
         private
 
@@ -57,7 +58,11 @@ module PactBroker
 
         def check_if_command_supported
           unless index_resource.can?("pb:environments")
-            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+            if is_pactflow?
+              raise PactBroker::Client::Error.new(PACTFLOW_NOT_SUPPORTED_MESSAGE)
+            else
+              raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
+            end
           end
         end
       end

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

@@ -141,9 +141,9 @@ module PactBroker
         end
 
         def method_missing(method_name, *args, &block)
-          if @data.key?(method_name.to_s)
+          if @data.respond_to?(:key?) && @data.key?(method_name.to_s)
             @data[method_name.to_s]
-          elsif @links.key?(method_name)
+          elsif @links.respond_to?(:key?) && @links.key?(method_name)
             Link.new(@links[method_name], @client).run(*args)
           else
             nil

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

@@ -144,6 +144,10 @@ module PactBroker
             __getobj__().to_hash
           end
 
+          def header(name)
+            __getobj__()[name]
+          end
+
           def raw_body
             __getobj__().body
           end

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

@@ -86,11 +86,16 @@ module PactBroker
         private
 
         def wrap_response(href, http_response)
-          require 'pact_broker/client/hal/entity' # avoid circular reference
+          require "pact_broker/client/hal/entity" # avoid circular reference
           if http_response.success?
             Entity.new(href, http_response.body, @http_client, http_response)
           else
-            ErrorEntity.new(href, http_response.raw_body, @http_client, http_response)
+            body =  begin
+                      http_response.header("Content-Type") && http_response.header("Content-Type").include?("json") ? http_response.body : http_response.raw_body
+                    rescue
+                      http_response.raw_body
+                    end
+            ErrorEntity.new(href, body, @http_client, http_response)
           end
         end
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -86,7 +86,11 @@ module PactBroker
               "Successfully published pacts"
             end
           else
-            ::Term::ANSIColor.red(response_entity.response.body.to_s)
+            if response_entity.notices
+              PactBroker::Client::ColorizeNotices.call(response_entity.notices.collect{ |n| OpenStruct.new(n) } )
+            else
+              ::Term::ANSIColor.red(response_entity.response.raw_body)
+            end
           end
         end.join("\n")
       end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.56.0'
+    VERSION = '1.57.0'
   end
 end

data/script/can-i-deploy.sh

@@ -0,0 +1,5 @@
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.26 \
+  --branch main
+
+bundle exec bin/pact-broker can-i-deploy --pacticipant "Pact Broker Client" --branch "main"

data/script/record-deployments-and-releases.sh

@@ -6,12 +6,12 @@ bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-envi
 
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
-bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
 
-bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-2
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-2
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
 bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
-bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-1
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-1
 
 bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test

data/spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb

@@ -69,6 +69,12 @@ module PactBroker
           ],[
             ["--version", "2"],
             [{ pacticipant: nil, version: "2" }]
+          ],[
+            ["--pacticipant", "Foo", "--branch", "main"],
+            [{ pacticipant: "Foo", branch: "main", latest: true }]
+          ],[
+            ["--branch", "main"],
+            [{ pacticipant: nil, branch: "main", latest: true }]
           ]
         ]
 

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

@@ -44,8 +44,9 @@ module PactBroker
           let(:record_deployment_body_hash) do
             { "some" => "response" }
           end
+          let(:index_headers) { { "Content-Type" => "application/hal+json" } }
           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" }  )
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: index_headers  )
           end
           let!(:version_request) do
             stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 200, body: version_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
@@ -89,10 +90,20 @@ module PactBroker
                 "_links" => {}
               }
             end
+
             it "returns an error response" do
               expect(subject.success).to be false
               expect(subject.message).to include "does not support"
             end
+
+            context "when the server is Pactflow" do
+              let(:index_headers) { { "Content-Type" => "application/hal+json", "Pactflow-Something" => "foo" } }
+
+              it "returns an error response" do
+                expect(subject.message).to include "permission"
+                expect(subject.message).to include "does not support"
+              end
+            end
           end
 
           context "when the specified version does not exist" do

data/spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb

@@ -174,7 +174,7 @@ module PactBroker
 
         context "when a target is provided and there is no deployed version with a matching target" do
           let(:application_instance) { "wrong" }
-          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance to undeploy from the anonymous instance or specify one of the following application instances to record the undeployment from: customer-1." }
+          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance or specify one of the following application instances to record the undeployment from: customer-1." }
 
           its(:success) { is_expected.to be false }
           its(:message) { is_expected.to include expected_message }

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

@@ -5,6 +5,10 @@ require 'pact_broker/client/hal/http_client'
 module PactBroker::Client
   module Hal
     describe Link do
+      before do
+        allow(response).to receive(:header).with("Content-Type").and_return(content_type)
+      end
+
       let(:http_client) do
         instance_double('PactBroker::Client::Hal::HttpClient', post: response)
       end
@@ -33,6 +37,8 @@ module PactBroker::Client
         }
       end
 
+      let(:content_type) { nil }
+
       subject { Link.new(attrs, http_client) }
 
       before do
@@ -67,6 +73,15 @@ module PactBroker::Client
             expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body.to_json, http_client, response)
             do_run
           end
+
+          context "when a JSON error is returned" do
+            let(:content_type) { "application/json" }
+
+            it "parses the response body" do
+              expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body, http_client, response)
+              do_run
+            end
+          end
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.57.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -319,6 +319,7 @@ files:
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - script/approve-all.sh
+- script/can-i-deploy.sh
 - script/create-pacticipant.sh
 - script/publish-pact.sh
 - script/record-deployment.sh
@@ -430,7 +431,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.30
 signing_key: 
 specification_version: 4
 summary: See description