pact_broker-client 1.6.0 → 1.7.0

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

@@ -14,7 +14,7 @@ module PactBroker
         desc 'PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
         method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
         method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
-        method_option :broker_username, aliases: "-n", desc: "Pact Broker basic auth username"
+        method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
         method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
         method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
@@ -44,9 +44,9 @@ module PactBroker
 
           def publish_pacts pact_files
             PactBroker::Client::PublishPacts.call(
-              options[:broker_base_url],
+              options.broker_base_url,
               file_list(pact_files),
-              options[:consumer_app_version],
+              options.consumer_app_version,
               tags,
               pact_broker_client_options
             )
@@ -63,14 +63,16 @@ module PactBroker
           end
 
           def tags
-            [*options[:tag]].compact
+            [*options.tag].compact
           end
 
           def pact_broker_client_options
-            if options[:username]
+            if options.broker_password
               {
-                username: options[:username],
-                password: options[:password]
+                basic_auth: {
+                  username: options.broker_username,
+                  password: options.broker_password
+                }
               }
             else
               {}

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

@@ -0,0 +1,29 @@
+module PactBroker
+  module Client
+    module CLI
+      class VersionSelectorOptionsParser
+        def self.call options
+          versions = []
+          last_flag = nil
+          options.each do | option |
+            case option
+            when "--name", "-n"
+              versions << {}
+            when /^\-/
+              nil
+            else
+              case last_flag
+              when "--name", "-n"
+                versions.last[:name] = option
+              when "--version", "-a"
+                versions.last[:version] = option
+              end
+            end
+            last_flag = option if option.start_with?("-")
+          end
+          versions
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix.rb

@@ -0,0 +1,39 @@
+require_relative 'base_client'
+
+module PactBroker
+  module Client
+    class Matrix < BaseClient
+      def get selectors
+        query = {selectors: convert_selector_hashes_to_params(selectors)}
+        response = self.class.get("/matrix", query: query, headers: default_get_headers)
+        $stdout.puts("DEBUG: Response headers #{response.headers}") if verbose?
+        $stdout.puts("DEBUG: Response body #{response}") if verbose?
+        response = handle_response(response) do
+          JSON.parse(response.body, symbolize_names: true)
+        end
+      end
+
+      def handle_response response
+        if response.success?
+          yield
+        elsif response.code == 401
+          raise Error.new("Authentication failed")
+        elsif response.code == 404
+          raise Error.new("Matrix resource not found at #{base_url}/matrix. Please upgrade your broker to the latest version.")
+        else
+          error_message = nil
+          begin
+            error_message = JSON.parse(response.body)['errors'].join("\n")
+          rescue
+            raise Error.new(response.body)
+          end
+          raise Error.new(error_message)
+        end
+      end
+
+      def convert_selector_hashes_to_params(selectors)
+        selectors.collect{ |selector| "#{selector[:name]}/version/#{selector[:version]}" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'pact_broker/client/matrix/json_formatter'
+require 'pact_broker/client/matrix/text_formatter'
+
+module PactBroker
+  module Client
+    class Matrix
+      class Formatter
+        def self.call(matrix_lines, format)
+          formatter = case format
+          when 'json' then JsonFormatter
+          when 'table' then TextFormatter
+          else
+            raise PactBroker::Client::Error.new("Invalid output option '#{format}. Must be one of 'table' or 'json'.")
+          end
+          formatter.call(matrix_lines)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'table_print'
+
+module PactBroker
+  module Client
+    class Matrix
+      class JsonFormatter
+        def self.call(matrix_lines)
+          JSON.pretty_generate(matrix: matrix_lines)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'table_print'
+
+module PactBroker
+  module Client
+    class Matrix
+      class TextFormatter
+
+        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
+
+        def self.call(matrix_lines)
+          data = matrix_lines.collect do | line |
+            Line.new(
+              lookup(line, :consumer, :name),
+              lookup(line, :consumer, :version, :number),
+              lookup(line, :consumer, :name),
+              lookup(line, :provider, :version, :number),
+              lookup(line, :verificationResult, :success).to_s
+            )
+          end
+
+          printer = TablePrint::Printer.new(data)
+          printer.table_print
+        end
+
+        def self.lookup line, *keys
+          keys.reduce(line) { | line, key | line[key] }
+        rescue NoMethodError
+          "???"
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/pact_broker_client.rb

@@ -1,11 +1,9 @@
 require 'pact_broker/client/pacticipants'
 require 'pact_broker/client/versions'
 require 'pact_broker/client/pacts'
-
+require 'pact_broker/client/matrix'
 
 module PactBroker
-
-
   module Client
 
     DEFAULT_PACT_BROKER_BASE_URL = 'http://pact-broker'
@@ -30,7 +28,9 @@ module PactBroker
         PactBroker::Client::Pacts.new base_url: base_url, client_options: client_options
       end
 
+      def matrix
+        PactBroker::Client::Matrix.new base_url: base_url, client_options: client_options
+      end
     end
   end
-
-end
+end

data/lib/pact_broker/client/retry.rb

@@ -1,6 +1,18 @@
+require 'pact_broker/client/error'
+
 module PactBroker
   module Client
     class Retry
+      class RescuableError
+        UNRESCUEABLE = [PactBroker::Client::Error]
+
+        def self.===(e)
+          case e
+          when *UNRESCUEABLE then false
+          else true
+          end
+        end
+      end
 
       def self.until_true options = {}
         max_tries = options.fetch(:times, 3)
@@ -8,9 +20,9 @@ module PactBroker
         while true
           begin
             return yield
-          rescue StandardError => e
+          rescue RescuableError => e
             tries += 1
-            $stderr.puts "Error publishing pact - #{e.message}, attempt #{tries} of #{max_tries}"
+            $stderr.puts "Error making request - #{e.message}, attempt #{tries} of #{max_tries}"
             sleep options
             raise e if max_tries == tries
           end
@@ -20,7 +32,6 @@ module PactBroker
       def self.sleep options
         Kernel.sleep options.fetch(:sleep, 5)
       end
-
     end
   end
-end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.6.0'
+    VERSION = '1.7.0'
   end
 end

data/pact-broker-client.gemspec

@@ -24,12 +24,12 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'json'
   gem.add_runtime_dependency 'term-ansicolor'
+  gem.add_runtime_dependency 'table_print', '~> 1.5'
 
-  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'fakefs', '~> 0.4'
-  gem.add_development_dependency 'rspec-fire'
   gem.add_development_dependency 'appraisal'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'conventional-changelog'
   gem.add_development_dependency 'pact', '~> 1.16'
+  gem.add_development_dependency 'pry-byebug'
 end

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

@@ -0,0 +1,85 @@
+require 'pact_broker/client/can_i_deploy'
+
+module PactBroker
+  module Client
+    describe CanIDeploy do
+      let(:pact_broker_base_url) { 'http://example.org' }
+      let(:version_selectors) { [{name: "Foo", version: "1"}] }
+      let(:pact_broker_client_options) { { foo: 'bar' } }
+      let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
+      let(:matrix) { {matrix: ['foo'], summary: {compatible: true}} }
+      let(:options) { {output: 'text' } }
+
+      before do
+        allow_any_instance_of(PactBroker::Client::PactBrokerClient).to receive(:matrix).and_return(matrix_client)
+        allow(matrix_client).to receive(:get).and_return(matrix)
+        allow(Matrix::Formatter).to receive(:call).and_return('text matrix')
+      end
+
+      subject { CanIDeploy.call(pact_broker_base_url, version_selectors, options, pact_broker_client_options) }
+
+      it "retrieves the matrix from the pact broker" do
+        expect(matrix_client).to receive(:get).with(version_selectors)
+        subject
+      end
+
+      it "creates a text table out of the matrix" do
+        expect(Matrix::Formatter).to receive(:call).with(['foo'], 'text')
+        subject
+      end
+
+      context "when compatible versions are found" do
+        it "returns a success response" do
+          expect(subject.success).to be true
+        end
+
+        it "returns a success message with the text table" do
+          expect(subject.message).to include "Computer says yes"
+          expect(subject.message).to include "\n\ntext matrix"
+        end
+      end
+
+      context "when compatible versions are not found" do
+        let(:matrix) { {matrix: ['foo'], summary: {compatible: false}} }
+
+        it "returns a failure response" do
+          expect(subject.success).to be false
+        end
+
+        it "returns a failure message" do
+          expect(subject.message).to include "Computer says no"
+        end
+      end
+
+      context "when a PactBroker::Client::Error is raised" do
+        before do
+          allow(matrix_client).to receive(:get).and_raise(PactBroker::Client::Error.new('error text'))
+        end
+
+        it "returns a failure response" do
+          expect(subject.success).to be false
+        end
+
+        it "returns a failure message" do
+          expect(subject.message).to eq "error text"
+        end
+      end
+
+      context "when a StandardError is raised" do
+        before do
+          allow(Retry).to receive(:sleep).and_return(0)
+          allow($stderr).to receive(:puts)
+          allow(matrix_client).to receive(:get).and_raise(StandardError.new('error text'))
+        end
+
+        it "returns a failure response" do
+          expect(subject.success).to be false
+        end
+
+        it "returns a failure message and backtrace" do
+          expect(subject.message).to include "Error retrieving matrix. StandardError - error text\n"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'pact_broker/client/cli/broker'
+
+module PactBroker
+  module Client
+    module CLI
+      describe Broker do
+        before do
+          subject.options = OpenStruct.new(minimum_valid_options)
+          allow(VersionSelectorOptionsParser).to receive(:call).and_return(version_selectors)
+          allow(CanIDeploy).to receive(:call).and_return(result)
+          allow($stdout).to receive(:puts)
+          allow($stderr).to receive(:puts)
+        end
+
+        let(:result) { instance_double('PactBroker::Client::CanIDeploy::Result', success: success, message: message) }
+        let(:success) { true }
+        let(:message) { 'message' }
+        let(:version_selectors) { ['selector1'] }
+        let(:minimum_valid_options) do
+          {
+            broker_base_url: 'http://pact-broker',
+            output: 'table',
+            verbose: 'verbose'
+          }
+        end
+
+        let(:invoke_can_i_deploy) { subject.can_i_deploy }
+
+        it "parses the pacticipant names and versions" do
+          expect(VersionSelectorOptionsParser).to receive(:call).with(ARGV)
+          invoke_can_i_deploy
+        end
+
+        it "invokes the CanIDeploy service" do
+          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, {output: 'table'}, {verbose: 'verbose'})
+          invoke_can_i_deploy
+        end
+
+        context "with basic auth" do
+          before do
+            subject.options = OpenStruct.new(minimum_valid_options.merge(broker_username: 'foo', broker_password: 'bar'))
+          end
+
+          it "invokes the CanIDeploy service with the basic auth credentials" do
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, {basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
+            invoke_can_i_deploy
+          end
+        end
+
+        context "when successful" do
+          it "prints the message to stdout" do
+            expect($stdout).to receive(:puts).with(message)
+            invoke_can_i_deploy
+          end
+        end
+
+        context "when not successful" do
+          let(:success) { false }
+
+          it "prints the message to stderr" do
+            expect($stdout).to receive(:puts).with(message)
+            begin
+              invoke_can_i_deploy
+            rescue SystemExit
+            end
+          end
+
+          it "exits with code 1" do
+            exited_with_error = false
+            begin
+              invoke_can_i_deploy
+            rescue SystemExit
+              exited_with_error = true
+            end
+            expect(exited_with_error).to be true
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module PactBroker::Client::CLI
     describe ".broker" do
       before do
         allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(true)
-        subject.options = minimum_valid_options
+        subject.options = OpenStruct.new(minimum_valid_options)
       end
 
       let(:file_list) { ["spec/support/cli_test_pacts/foo.json"] }
@@ -64,7 +64,7 @@ module PactBroker::Client::CLI
 
       context "with a tag" do
         before do
-          subject.options = minimum_valid_options.merge(tag: ['foo'])
+          subject.options = OpenStruct.new(minimum_valid_options.merge(tag: ['foo']))
         end
 
         it "passes in the tag" do
@@ -81,7 +81,9 @@ module PactBroker::Client::CLI
 
       context "with basic auth options specified" do
         before do
-          subject.options = minimum_valid_options.merge(username: 'foo', password: 'bar')
+          subject.options = OpenStruct.new(
+            minimum_valid_options.merge(broker_username: 'foo', broker_password: 'bar')
+          )
         end
 
         it "passes in the basic auth options" do
@@ -90,7 +92,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             anything,
-            {username: 'foo', password: 'bar'}
+            hash_including({basic_auth: {username: 'foo', password: 'bar'}})
           )
           invoke_broker
         end