pact_broker-client 1.28.4 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460518f5eadcc793db6674bd2d080743a01aefe7b3c7956e6b7cd39d703c07cd
-  data.tar.gz: 04aba16e6627945f082461844b0a26d4c758b24bf27ceb75ebbb7b7db97a56e6
+  metadata.gz: 9fc996a2d95d7c3755d063cd244b273fa5924f6956cf18b26ebe9531fa59e304
+  data.tar.gz: '018d1d764a83f040d57d6ef504a6b4229f34f3fff38cf938c8c3f2202e03cc7a'
 SHA512:
-  metadata.gz: 946cd6045077c72decc890ec527f3b327ee835f3fe7898db0b9ae03d0959329e6409744ce718f7868389daee733d57605560b0dc6cf55886c37847c4674c8a6f
-  data.tar.gz: 1dca9a3b97c207dce94e4a1e6a69739623e1897222fbf4e696e883d720ad6b36e8508431d69e011d597357f61e2c349352814d63af7b7891066cadc02d0d600b
+  metadata.gz: 95944c92c42aa29803c5bd37b5b4c8526359cb910c4a983123379ac2f0482483aae75fc9179d2e6341e1931019c3f1588e1d7a385ffa628c203fd829d3137bfb
+  data.tar.gz: 5391400fa12118608718161c3ea286ffe1b3b7aebbe1eca074b999b1903b25f6a3f15e257459e35240e30faf768949d45c45a052616378507b0eaf970590ee1b

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+<a name="v1.32.0"></a>
+### v1.32.0 (2020-10-26)
+
+#### Features
+
+* Improve HTTP errors handling (#76)	 ([d8eaf16](/../../commit/d8eaf16))
+
+#### Bug Fixes
+
+* **list-latest-pact-versions**
+  * correct json output	 ([cf77666](/../../commit/cf77666))
+
+<a name="v1.31.0"></a>
+### v1.31.0 (2020-10-22)
+
+#### Features
+
+* update thor dependancy (#75)	 ([2078f31](/../../commit/2078f31))
+
+<a name="v1.30.0"></a>
+### v1.30.0 (2020-10-09)
+
+#### Features
+
+* remove outdated comment from pact publishing output	 ([251b4df](/../../commit/251b4df))
+
+<a name="v1.29.1"></a>
+### v1.29.1 (2020-08-07)
+
+#### Bug Fixes
+
+* explicitly set the CA file and path from SSL_CERT_FILE and SSL_CERT_DIR for the pact-ruby-standalone	 ([27a0fe6](/../../commit/27a0fe6))
+
+<a name="v1.29.0"></a>
+### v1.29.0 (2020-08-05)
+
+#### Features
+
+* print out helpful error message for 403	 ([5d5a18a](/../../commit/5d5a18a))
+* support publishing pacts for multiple consumers at the same time	 ([573e97c](/../../commit/573e97c))
+
 <a name="v1.28.4"></a>
 ### v1.28.4 (2020-07-31)
 

data/Gemfile

@@ -6,10 +6,6 @@ gemspec
 # even thought it's in the development dependencies. Trying it here.
 gem 'rake', '~> 13.0'
 
-group :release do
-  gem 'bump', git: 'https://github.com/bethesque/bump.git'
-end
-
 if ENV['X_PACT_DEVELOPMENT'] == 'true'
   gem 'pact-mock_service', path: '../pact-mock_service'
   gem 'pact-support', path: '../pact-support'

data/README.md

@@ -153,7 +153,7 @@ Can I deploy the latest version of the application Foo that has the tag "test" t
 
 If you are unable to use tags, or there is some other limitation that stops you from using the recommended approach, you can specify one or more of the dependencies explictly. You must also do this if you want to use the `--all TAG` option for any of the pacticipants.
 
-You can specify as many application versions as you like, and you can even specify multiple versions of the same application (repeat the `--pacticipant` name and supply a different version.)
+You can specify as many application versions as you like, and you can even specify multiple versions of the same application (repeat the `--pacticipant` name and supply a different version). If you have a monorepo and you deploy a group of applications together, you can either call `can-i-deploy` once for each application, or you can group them all together by specifying a `--pacticipant` and `--version` for each sub-application.
 
 You can use explictly declared dependencies with or without the `--to ENVIRONMENT`. For example, if you declare two (or more) application versions with no `--to ENVIRONMENT`, then only the applications you specify will be taken into account when determining if it is safe to deploy. If you declare two (or more) application versions _as well as_ a `--to ENVIRONMENT`, then the Pact Broker will work out what integrations your declared applications will have in that environment when determining if it safe to deploy. When using this script for a production release, and you are using tags, it is always the most future-proof option to use the `--to` if possible, as it will catch any newly added consumers or providers.
 
@@ -182,6 +182,13 @@ Can I deploy the latest version of Foo with tag "master" and the latest version
                                --pacticipant Bar --latest master \
                                --broker-base-url BROKER_BASE_URL
 
+Can I deploy all the applications in my monorepo to prod?
+
+    $ pact-broker can-i-deploy --pacticipant A --version a7e28207 \
+                               --pacticipant B --version a7e28207 \
+                               --pacticipant C --version a7e28207 \
+                               --to prod \
+                               --broker-base-url BROKER_BASE_URL                               
 
 Mobile provider use case - can I deploy version b80e7b1b of Bar, all versions of Foo with tag "prod", and the latest version tagged "prod" of any other automatically calculated dependencies together? (Eg. where Bar is a provider and Foo is a mobile consumer with multiple versions in production, and Bar also has its own providers it needs to be compatible with.)
 

data/lib/pact_broker/client/base_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'httparty'
 require 'pact_broker/client/error'
@@ -30,6 +32,12 @@ module PactBroker
     end
 
     class BaseClient
+      ERROR_CODE_MAPPING = {
+        401 => "Authentication failed",
+        403 => "Authorization failed (insufficient permissions)",
+        409 => "Potential duplicate pacticipants"
+      }.freeze
+
       include UrlHelpers
       include HTTParty
       include StringToSymbol
@@ -69,8 +77,8 @@ module PactBroker
           yield response
         elsif response.code == 404
           nil
-        elsif response.code == 401
-          message = "Authentication failed"
+        elsif ERROR_CODE_MAPPING.key?(response.code)
+          message = ERROR_CODE_MAPPING.fetch(response.code)
           if response.body && response.body.size > 0
             message = message + ": #{response.body}"
           end
@@ -87,7 +95,7 @@ module PactBroker
               response.body
             end
           rescue
-            raise Error.new(response.body)
+            raise Error.new("status=#{response.code} #{response.body}")
           end
           raise Error.new(error_message)
         end

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

@@ -57,6 +57,11 @@ module PactBroker
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
             http.set_debug_output(output_stream) if verbose
             http.use_ssl = (uri.scheme == 'https')
+            # Need to manually set the ca_file and ca_path for the pact-ruby-standalone.
+            # The env vars seem to be picked up automatically in later Ruby versions.
+            # See https://github.com/pact-foundation/pact-ruby-standalone/issues/57
+            http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
+            http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
             http.start do |http|
               http.request request
             end

data/lib/pact_broker/client/matrix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_client'
 require 'pact_broker/client/matrix/resource'
 
@@ -39,7 +41,7 @@ module PactBroker
               response.body
             end
           rescue
-            raise Error.new(response.body)
+            raise Error.new("status=#{response.code} #{response.body}")
           end
           raise Error.new(error_message)
         end

data/lib/pact_broker/client/pacts/list_latest_versions.rb

@@ -20,7 +20,7 @@ module PactBroker
 
         def call
           message = if output == 'json'
-            versions_resource.response.body
+            versions_resource.response.raw_body
           else
             to_text(versions)
           end

data/lib/pact_broker/client/publish_pacts.rb

@@ -52,6 +52,10 @@ module PactBroker
         @pact_files ||= pact_file_paths.collect{ |pact_file_path| PactFile.new(pact_file_path) }
       end
 
+      def consumer_names
+        pact_files.collect(&:consumer_name).uniq
+      end
+
       def publish_pact pact
         begin
           $stdout.puts "Publishing #{pact.pact_name} to pact broker at #{pact_broker_base_url}"
@@ -72,12 +76,14 @@ module PactBroker
       def tag_consumer_version tag
         versions = pact_broker_client.pacticipants.versions
         Retry.while_error do
-          $stdout.puts "Tagging version #{consumer_version} of #{consumer_name} as #{tag.inspect}"
-          versions.tag(pacticipant: consumer_name, version: consumer_version, tag: tag)
-          true
+          consumer_names.collect do | consumer_name |
+            versions.tag(pacticipant: consumer_name, version: consumer_version, tag: tag)
+            $stdout.puts "Tagged version #{consumer_version} of #{consumer_name} as #{tag.inspect}"
+            true
+          end
         end
       rescue => e
-        $stderr.puts "Failed to tag version #{consumer_version} of #{consumer_name} due to error: #{e.class} - #{e}}"
+        $stderr.puts "Failed to tag version due to error: #{e.class} - #{e}"
         false
       end
 
@@ -89,15 +95,11 @@ module PactBroker
           end
 
           latest_pact_url = pacts.publish(pact_hash: pact, consumer_version: consumer_version)
-          $stdout.puts "The latest version of this pact can be accessed at the following URL (use this to configure the provider verification):\n#{latest_pact_url}"
+          $stdout.puts "The latest version of this pact can be accessed at the following URL:\n#{latest_pact_url}"
           true
         end
       end
 
-      def consumer_name
-        pact_files.first.consumer_name
-      end
-
       def validate
         raise PactBroker::Client::Error.new("Please specify the consumer_version") unless (consumer_version && consumer_version.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("Please specify the pact_broker_base_url") unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.28.4'
+    VERSION = '1.32.0'
   end
 end

data/pact-broker-client.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'httparty', '~>0.18'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.7'
   gem.add_runtime_dependency 'table_print', '~> 1.5'
-  gem.add_runtime_dependency 'thor', '~> 0.20'
+  gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
 
   gem.add_development_dependency 'fakefs', '~> 0.4'

data/script/create-pacticipant.sh

@@ -0,0 +1,2 @@
+bundle exec bin/pact-broker create-or-update-pacticipant --name Bethtest
+

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

@@ -2,10 +2,11 @@ require 'pact_broker/client/base_client'
 module PactBroker
   module Client
     describe BaseClient do
-      describe '#initialize' do
-        subject { BaseClient.new(base_url: base_url) }
+      subject { BaseClient.new(base_url: base_url) }
+
+      let(:base_url) { 'http://pact_broker_base_url'}
 
-        let(:base_url) { 'http://pact_broker_base_url'}
+      describe '#initialize' do
         let(:username) { 'pact_repo_username'}
         let(:password) { 'pact_repo_password'}
         let(:token) { '123456789' }
@@ -119,6 +120,63 @@ module PactBroker
           end
         end
       end
+
+      describe '#handle_response' do
+        let(:response) { double('Response', success?: true) }
+
+        it 'yields response object' do
+          expect { |block| subject.handle_response(response, &block) }.to yield_with_args(response)
+        end
+
+        context 'with 404 response' do
+          let(:response) { double('Response', success?: false, code: 404) }
+          it 'returns nil' do
+            expect(subject.handle_response(response)).to be_nil
+          end
+        end
+
+        context 'with 401 response' do
+          let(:response) { double('Response', success?: false, code: 401, body: 'body') }
+          it 'raise an exception with meaningful message' do
+            expect { subject.handle_response(response) }
+              .to raise_error(PactBroker::Client::Error, "Authentication failed: body")
+          end
+        end
+
+        context 'with 403 response' do
+          let(:response) { double('Response', success?: false, code: 403, body: 'body') }
+          it 'raise an exception with meaningful message' do
+            expect { subject.handle_response(response) }
+              .to raise_error(PactBroker::Client::Error, "Authorization failed (insufficient permissions): body")
+          end
+        end
+
+        context 'with 409 response' do
+          let(:response) { double('Response', success?: false, code: 409, body: 'body') }
+          it 'raise an exception with meaningful message' do
+            expect { subject.handle_response(response) }
+              .to raise_error(PactBroker::Client::Error, "Potential duplicate pacticipants: body")
+          end
+        end
+
+        context 'with unsuccessful JSON response' do
+          let(:response) do
+            double('Response', success?: false, code: 500, body: '{"errors": ["Internal server error"]}')
+          end
+          it 'raise an exception with meaningful message' do
+            expect { subject.handle_response(response) }
+              .to raise_error(PactBroker::Client::Error, "Internal server error")
+          end
+        end
+
+        context 'with unsucessful nono-JSON response ' do
+          let(:response) { double('Response', success?: false, code: 500, body: 'Internal server error') }
+          it 'raise an exception with meaningful message' do
+            expect { subject.handle_response(response) }
+              .to raise_error(PactBroker::Client::Error, "status=500 Internal server error")
+          end
+        end
+      end
     end
   end
-end
+end

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

@@ -81,6 +81,25 @@ module PactBroker
           end
         end
 
+        context "when publishing multiple files with different consumers" do
+          let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/foo-bar.json']}
+          let(:tags) { ['dev'] }
+
+          it "tags each consumer" do
+            expect(pact_versions_client).to receive(:tag).with(
+              pacticipant: "Consumer",
+              version: consumer_version,
+              tag: "dev"
+            )
+            expect(pact_versions_client).to receive(:tag).with(
+              pacticipant: "Foo",
+              version: consumer_version,
+              tag: "dev"
+            )
+            subject.call
+          end
+        end
+
         context "when publishing one or more pacts fails" do
           let(:pact_file_paths) { ['spec/pacts/consumer-provider.json','spec/pacts/foo-bar.json']}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.28.4
+  version: 1.32.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -56,16 +56,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +222,7 @@ files:
 - lib/pact_broker/client/webhooks/test.rb
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
+- script/create-pacticipant.sh
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
 - script/release.sh