pact_broker-client 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b12cd2f4a46260bb9c9642e5ae8c402f36e99e876409eb5f5a5718c24ff705e7
-  data.tar.gz: 79a2e1cea4055116b3b11017b8ee877f496a6b911107cdde0551a2eff944fd0b
+  metadata.gz: c23dc5746d9c229a4e357c8fe96273902ba48eb009a23feba13ec82e176bbb30
+  data.tar.gz: 482f212c6ed800809fe09ac51cc42b4bddf726fc0a1d37d9ad271cdbb12378d4
 SHA512:
-  metadata.gz: d7488d1136e7153157c411c671a7c82309f1f1c1bd33afe1fbb1dc315bed1ddda5759b9b78363d2a8c1c6dcdc1b126d50a729fab23cf6744a122fb2264b864c0
-  data.tar.gz: ab8cd8cb2f6ce39b9138440a1a065eb81b10c90cf926d557b5852f6aa1e677348b42491d02e1f601a08027b49990e4710dd3da979568ae0a6cd5978397f5c2ce
+  metadata.gz: b5dc6e9ffc7ee3d88711cc0a606d2616e00c826e6681bc84a652e37f18a944f8e402b7265a828a4ddbd16a7d5591fd9e40f8938761112411f58a08c2cc1cc3c6
+  data.tar.gz: c28296e8fc790b329061809abaa58af206765061fdb5d07bf2c1d60861408184b304f20c725faf2b3a4ebb59ca3e8cf23f8d8d992f9069da63b55ba60826b13d

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v1.25.0"></a>
+### v1.25.0 (2020-02-18)
+
+
+#### Features
+
+* **cli**
+  * print any response body from the Pact Broker when authentication fails	 ([116f0d9](/../../commit/116f0d9))
+  * raise error if both basic auth credentials and bearer token are set	 ([163f56b](/../../commit/163f56b))
+
+
 <a name="v1.24.0"></a>
 ### v1.24.0 (2020-02-13)
 

data/lib/pact_broker/client/base_client.rb

@@ -70,7 +70,11 @@ module PactBroker
         elsif response.code == 404
           nil
         elsif response.code == 401
-          raise Error.new("Authentication failed")
+          message = "Authentication failed"
+          if response.body && response.body.size > 0
+            message = message + ": #{response.body}"
+          end
+          raise Error.new(message)
         else
           error_message = nil
           begin

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

@@ -1,13 +1,5 @@
-require 'pact_broker/client/version'
-require 'pact_broker/client/can_i_deploy'
-require 'pact_broker/client/git'
-require 'pact_broker/client/cli/version_selector_options_parser'
 require 'pact_broker/client/cli/custom_thor'
-require 'pact_broker/client/publish_pacts'
-require 'rake/file_list'
 require 'thor/error'
-require 'pact_broker/client/create_tag'
-require 'pact_broker/client/versions/describe'
 
 module PactBroker
   module Client
@@ -15,6 +7,7 @@ module PactBroker
       # Thor::Error will have its backtrace hidden
       class PactPublicationError < ::Thor::Error; end
       class WebhookCreationError < ::Thor::Error; end
+      class AuthError < ::Thor::Error; end
 
       class Broker < CustomThor
         desc 'can-i-deploy', ''
@@ -36,6 +29,10 @@ module PactBroker
         method_option :limit, hide: true
 
         def can_i_deploy(*ignored_but_necessary)
+          require 'pact_broker/client/cli/version_selector_options_parser'
+          require 'pact_broker/client/can_i_deploy'
+
+          validate_credentials
           selectors = VersionSelectorOptionsParser.call(ARGV)
           validate_can_i_deploy_selectors(selectors)
           can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval }
@@ -55,6 +52,7 @@ module PactBroker
         method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
         def publish(*pact_files)
+          validate_credentials
           validate_pact_files(pact_files)
           success = publish_pacts(pact_files)
           raise PactPublicationError, "One or more pacts failed to be published" unless success
@@ -74,6 +72,9 @@ module PactBroker
         method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
         def create_version_tag
+          require 'pact_broker/client/create_tag'
+
+          validate_credentials
           PactBroker::Client::CreateTag.call(
             options.broker_base_url,
             options.pacticipant,
@@ -94,6 +95,9 @@ module PactBroker
 
         desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
         def describe_version
+          require 'pact_broker/client/versions/describe'
+
+          validate_credentials
           latest = !options.latest.nil? || (options.latest.nil? && options.version.nil?)
           params = {
             pacticipant: options.pacticipant,
@@ -130,11 +134,15 @@ module PactBroker
         desc 'generate-uuid', 'Generate a UUID for use when calling create-or-update-webhook'
         def generate_uuid
           require 'securerandom'
+
           puts SecureRandom.uuid
         end
 
+        ignored_and_hidden_potential_options_from_environment_variables
         desc 'version', "Show the pact_broker-client gem version"
         def version
+          require 'pact_broker/client/version'
+
           $stdout.puts PactBroker::Client::VERSION
         end
 
@@ -144,6 +152,12 @@ module PactBroker
             true
           end
 
+          def validate_credentials
+            if options.broker_username && options.broker_token
+              raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
+            end
+          end
+
           def validate_pact_files pact_files
             unless pact_files && pact_files.any?
               raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
@@ -156,6 +170,8 @@ module PactBroker
           end
 
           def publish_pacts pact_files
+            require 'pact_broker/client/publish_pacts'
+
             PactBroker::Client::PublishPacts.call(
               options.broker_base_url,
               file_list(pact_files),
@@ -166,6 +182,8 @@ module PactBroker
           end
 
           def file_list pact_files
+            require 'rake/file_list'
+
             correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
             Rake::FileList[correctly_separated_pact_files].collect do | path |
               if File.directory?(path)
@@ -177,13 +195,16 @@ module PactBroker
           end
 
           def tags
+            require 'pact_broker/client/git'
+
             t = [*options.tag]
             t << PactBroker::Client::Git.branch if options.tag_with_git_branch
             t.compact.uniq
           end
 
           def pact_broker_client_options
-            client_options = { verbose: options.verbose, token: options.broker_token }
+            client_options = { verbose: options.verbose }
+            client_options[:token] =  options.broker_token if options.broker_token
             if options.broker_username
               client_options[:basic_auth] = {
                   username: options.broker_username,
@@ -243,6 +264,8 @@ module PactBroker
 
           def run_webhook_commands webhook_url
             require 'pact_broker/client/webhooks/create'
+
+            validate_credentials
             result = PactBroker::Client::Webhooks::Create.call(parse_webhook_options(webhook_url), options.broker_base_url, pact_broker_client_options)
             $stdout.puts result.message
             exit(1) unless result.success

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

@@ -20,7 +20,7 @@ module PactBroker
           end
 
           def self.add_broker_config_from_environment_variables argv
-            return argv if argv[0] == 'version' || argv[0] == 'help'
+            return argv if argv[0] == 'help'
 
             new_argv = add_option_from_environment_variable(argv, 'broker-base-url', 'b', 'PACT_BROKER_BASE_URL')
             new_argv = add_option_from_environment_variable(new_argv, 'broker-username', 'u', 'PACT_BROKER_USERNAME')

data/lib/pact_broker/client/matrix.rb

@@ -20,7 +20,11 @@ module PactBroker
         if response.success?
           yield
         elsif response.code == 401
-          raise Error.new("Authentication failed")
+          message = "Authentication failed"
+          if response.body && response.body.size > 0
+            message = message + ": #{response.body}"
+          end
+          raise Error.new(message)
         elsif response.code == 404
           raise Error.new("Matrix resource not found at #{base_url}/matrix. Please upgrade your Broker to the latest version.")
         else

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.24.0'
+    VERSION = '1.25.0'
   end
 end

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

@@ -10,7 +10,7 @@ module PactBroker
         let(:password) { 'pact_repo_password'}
         let(:token) { '123456789' }
         let(:client_options) do
-          { 
+          {
             basic_auth: {
               username: username,
               password: password
@@ -18,7 +18,7 @@ module PactBroker
             token: token
           }
         end
-        
+
         context 'with basic url' do
           it 'sets the base url' do
             base_client = BaseClient.new(base_url: base_url)

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

@@ -20,7 +20,6 @@ module PactBroker
           {
             broker_base_url: 'http://pact-broker',
             output: 'table',
-            broker_token: 'token',
             verbose: 'verbose',
             retry_while_unknown: 1,
             retry_interval: 2,
@@ -36,7 +35,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {to_tag: nil, limit: 1000}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {token: 'token', verbose: 'verbose'})
+          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {to_tag: nil, limit: 1000}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {verbose: 'verbose'})
           invoke_can_i_deploy
         end
 
@@ -66,7 +65,18 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {basic_auth: {username: "foo", password: "bar"}, token: 'token', verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
+            invoke_can_i_deploy
+          end
+        end
+
+        context "with a bearer token" do
+          before do
+            subject.options.broker_token = "some token"
+          end
+
+          it "invokes the CanIDeploy service with the basic auth credentials" do
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {token: "some token", verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end

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

@@ -1,4 +1,6 @@
 require 'pact_broker/client/cli/broker'
+require 'pact_broker/client/publish_pacts'
+require 'pact_broker/client/git'
 
 module PactBroker::Client::CLI
   describe Broker do
@@ -27,7 +29,7 @@ module PactBroker::Client::CLI
             ["spec/support/cli_test_pacts/foo.json"],
             "1.2.3",
             [],
-            {token: nil, verbose: nil}
+            {verbose: nil}
           )
           invoke_broker
         end
@@ -138,6 +140,18 @@ module PactBroker::Client::CLI
         end
       end
 
+      context "with basic auth and a token specified" do
+        before do
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(broker_username: 'foo', broker_password: 'bar', broker_token: 'foo')
+          )
+        end
+
+        it "raises an error" do
+          expect { invoke_broker }.to raise_error AuthError, /both/
+        end
+      end
+
       context "when no pact files are specified" do
         let(:file_list) { [] }
 

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

@@ -31,7 +31,6 @@ module PactBroker
               broker_base_url: "http://broker",
               broker_username: "username",
               broker_password: "password",
-              broker_token: "token",
               contract_content_changed: true,
               verbose: true
             }
@@ -65,7 +64,7 @@ module PactBroker
           it "calls PactBroker::Client::Webhooks::Create with pact broker details" do
             expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, broker_base_url, pact_broker_client_options |
               expect(broker_base_url).to eq "http://broker"
-              expect(pact_broker_client_options).to eq(basic_auth: { username: "username", password: "password"}, token: "token", verbose: true)
+              expect(pact_broker_client_options).to eq(basic_auth: { username: "username", password: "password"}, verbose: true)
               command_result
             end
             subject
@@ -91,7 +90,25 @@ module PactBroker
 
             it "calls Webhooks::Create without basic auth" do
               expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
-                expect(pact_broker_client_options).to eq(token: "token", verbose: true)
+                expect(pact_broker_client_options).to eq(verbose: true)
+                command_result
+              end
+              subject
+            end
+          end
+
+          context "with a bearer token" do
+            before do
+              options_hash.delete(:broker_username)
+              options_hash.delete(:broker_password)
+              options_hash[:broker_token] = "token"
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "calls Webhooks::Create without basic auth" do
+
+              expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
+                expect(pact_broker_client_options).to eq(verbose: true, token: "token")
                 command_result
               end
               subject

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty