pact_broker-client 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06c73ab8a4906ce7f19c0239159954dc0dabafe8
-  data.tar.gz: bfb34a47d2bdad5ce202fd87a8ceb9528744a2af
+  metadata.gz: ca92e53e6aab9983ef939c9582e6ac0359ca8259
+  data.tar.gz: 4497c279c270dd495633134a1203a5ff84caeb30
 SHA512:
-  metadata.gz: 1c26067119ce4860e20625220ac490e02456d8f60816b12ba59857dd1f89778fa1b8e009e82adf57b5f213ad535357ce781b32c41b892120ba15067e24c6d1e7
-  data.tar.gz: fbcb42c1b2ad4794e9f82e5dbea3703b816e62d4a2019c2e4d41f7d7b974e9afc3419fb17184ce49fec1bb3ba63c89aa33bdc3a7497947fc3c9694f4c1684c9e
+  metadata.gz: 24a2de802420ad8fbd99085b3a12ac34666334991bfc379f968a055f2b4072892cec8ca12a09fcf7536eaf64310f57a727328542c8ae9fde3063f020f31d7731
+  data.tar.gz: 44faf6be7105518d0432f09834c610a9ab77e55d0b760c2eb8f8b983661b435ffb5dc9198b8ad665b0034439f2284e67838008da67430e576f18d286aa5b6373

data/.travis.yml

@@ -1,22 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.8
   - 2.2.4
   - 2.3.1
   - 2.4.1
-gemfile:
-  - gemfiles/default.gemfile
-  - gemfiles/ruby_under_22.gemfile
-matrix:
-  exclude:
-    # rack 2.0 and activesupport 5.0 no longer support ruby under 2.2.
-    - rvm: 2.0.0
-      gemfile: gemfiles/default.gemfile
-    - rvm: 2.1.8
-      gemfile: gemfiles/default.gemfile
-    - rvm: 2.2.4
-      gemfile: gemfiles/ruby_under_22.gemfile
-    - rvm: 2.3.1
-      gemfile: gemfiles/ruby_under_22.gemfile
-    - rvm: jruby-9.0.5.0
-      gemfile: gemfiles/ruby_under_22.gemfile

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+<a name="v1.9.0"></a>
+### v1.9.0 (2017-10-30)
+
+
+#### Features
+
+* **cli**
+  * add option to --tag-with-git-branch when publishing pacts	 ([484d5b8](/../../commit/484d5b8))
+
+* **can-i-deploy**
+  * raise error when no --version is supplied for a --pacticipant	 ([0f3bfea](/../../commit/0f3bfea))
+  * change --name to --pacticipant	 ([d5d23bc](/../../commit/d5d23bc))
+  * include full response body in json output	 ([216bfdc](/../../commit/216bfdc))
+  * use array of query params for matrix	 ([314e2e2](/../../commit/314e2e2))
+
+* **what-can-i-deploy**
+  * add success param to matrix query	 ([40adb2e](/../../commit/40adb2e))
+
+* handle hash of errors in response	 ([fff32c2](/../../commit/fff32c2))
+* change query params for matrix to use pacticipant[]=? and version[]=?	 ([003e305](/../../commit/003e305))
+
+
+#### Bug Fixes
+
+* **can-i-deploy**
+  * correct provider name in text output	 ([bfd0882](/../../commit/bfd0882))
+
+
 <a name="v1.8.0"></a>
 ### v1.8.0 (2017-10-19)
 

data/RELEASING.md

@@ -1,16 +1,5 @@
 # Releasing
 
-1. Increment the version in `lib/pact_broker/client/version.rb`
-2. `bundle exec appraisal update`
-3. Update the `CHANGELOG.md` using:
-
-      $ bundle exec rake generate_changelog
-
-4. Add files to git
-
-      $ git add CHANGELOG.md lib/pact_broker/client/version.rb gemfiles
-      $ git commit -m "Releasing version $(ruby -r ./lib/pact_broker/client/version.rb -e "puts PactBroker::Client::VERSION")"
-
-5. Release:
-
-      $ bundle exec rake release
+1. Check status of https://travis-ci.org/pact-foundation/pact_broker-client
+2. Increment the version in `lib/pact_broker/client/version.rb`
+3. Run script/release.sh

data/Rakefile

@@ -12,7 +12,12 @@ RSpec::Core::RakeTask.new('spec:providers') do | task |
   task.rspec_opts = "--pattern spec/service_providers/**/*_spec.rb"
 end
 
-task :default => [:spec, 'spec:providers']
+# Must be run after spec:providers because it relies on the generated pact
+RSpec::Core::RakeTask.new('spec:integration') do | task |
+  task.rspec_opts = "--pattern spec/integration/**/*_spec.rb"
+end
+
+task :default => [:spec, 'spec:providers', 'spec:integration']
 
 task :generate_changelog do
   require 'pact_broker/client/version'

data/lib/pact_broker/client/base_client.rb

@@ -1,6 +1,7 @@
 require 'erb'
 require 'httparty'
 require 'pact_broker/client/error'
+require 'cgi'
 
 module PactBroker
   module Client
@@ -11,6 +12,10 @@ module PactBroker
       def encode_param param
         ERB::Util.url_encode param
       end
+
+      def encode_query_param param
+        CGI::escape param
+      end
     end
 
     module StringToSymbol
@@ -65,7 +70,14 @@ module PactBroker
         else
           error_message = nil
           begin
-            error_message = JSON.parse(response.body)['errors'].join("\n")
+            errors = JSON.parse(response.body)['errors']
+            error_message = if errors.is_a?(Array)
+              errors.join("\n")
+            elsif errors.is_a?(Hash)
+              errors.collect{ |key, value| "#{key}: #{value}" }.join("\n")
+            else
+              response.body
+            end
           rescue
             raise Error.new(response.body)
           end

data/lib/pact_broker/client/can_i_deploy.rb

@@ -3,7 +3,6 @@ require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/retry'
 require 'pact_broker/client/matrix/formatter'
 
-
 module PactBroker
   module Client
     class CanIDeploy
@@ -45,7 +44,7 @@ module PactBroker
       attr_reader :pact_broker_base_url, :version_selectors, :options, :pact_broker_client_options
 
       def success_message(matrix)
-        message = format_matrix(matrix[:matrix])
+        message = format_matrix(matrix)
         if format != 'json'
           message = 'Computer says yes \o/' + "\n\n" + message
         end
@@ -53,7 +52,7 @@ module PactBroker
       end
 
       def failure_message(matrix)
-        message = format_matrix(matrix[:matrix])
+        message = format_matrix(matrix)
         if format != 'json'
           message = 'Computer says no ¯\_(ツ)_/¯' + "\n\n" + message
         end

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

@@ -1,9 +1,11 @@
-require 'pact_broker/client/can_i_deploy'
 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'
 
 module PactBroker
   module Client
@@ -14,16 +16,17 @@ module PactBroker
       class Broker < CustomThor
         desc 'can-i-deploy', "Returns exit code 0 or 1, indicating whether or not the specified application versions are compatible."
 
-        method_option :name, required: true, aliases: "-n", desc: "The application name. Use once for each pacticipant being checked."
-        method_option :version, required: true, aliases: "-a", desc: "The application version. Must be entered after a --name."
+        method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
+        method_option :version, required: true, aliases: "-e", desc: "The application version. Must be entered after the --pacticipant that it relates to."
         method_option :broker_base_url, required: true, aliases: "-b", desc: "The base URL of the Pact Broker"
         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 :output, aliases: "-o", desc: "json or table", default: 'table'
-        method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
+        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
-        def can_i_deploy
+        def can_i_deploy(*ignored_but_necessary)
           selectors = VersionSelectorOptionsParser.call(ARGV)
+          validate_can_i_deploy_selectors(selectors)
           result = CanIDeploy.call(options.broker_base_url, selectors, {output: options.output}, pact_broker_client_options)
           $stdout.puts result.message
           exit(1) unless result.success
@@ -35,7 +38,8 @@ module PactBroker
         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
+        method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
+        method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
         def publish(*pact_files)
           validate_pact_files(pact_files)
@@ -58,10 +62,15 @@ module PactBroker
 
           def validate_pact_files pact_files
             unless pact_files && pact_files.any?
-              raise RequiredArgumentMissingError, "No value provided for required pact_files"
+              raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
             end
           end
 
+          def validate_can_i_deploy_selectors selectors
+            pacticipants_without_versions = selectors.select{ |s| s[:version].nil? }.collect{ |s| s[:pacticipant] }
+            raise ::Thor::RequiredArgumentMissingError, "No --version provided for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
+          end
+
           def publish_pacts pact_files
             PactBroker::Client::PublishPacts.call(
               options.broker_base_url,
@@ -83,7 +92,9 @@ module PactBroker
           end
 
           def tags
-            [*options.tag].compact
+            t = [*options.tag]
+            t << PactBroker::Client::Git.branch if options.tag_with_git_branch
+            t.compact.uniq
           end
 
           def pact_broker_client_options

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

@@ -7,15 +7,16 @@ module PactBroker
           last_flag = nil
           options.each do | option |
             case option
-            when "--name", "-n"
+            when "--pacticipant", "-a"
               versions << {}
             when /^\-/
               nil
             else
               case last_flag
-              when "--name", "-n"
-                versions.last[:name] = option
-              when "--version", "-a"
+              when "--pacticipant", "-a"
+                versions.last[:pacticipant] = option
+              when "--version", "-e"
+                versions << {pacticipant: nil} unless versions.last
                 versions.last[:version] = option
               end
             end

data/lib/pact_broker/client/git.rb

@@ -0,0 +1,15 @@
+require 'pact_broker/client/error'
+
+module PactBroker
+  module Client
+    module Git
+      COMMAND = 'git rev-parse --abbrev-ref HEAD'
+
+      def self.branch
+        `#{COMMAND}`.strip
+      rescue StandardError => e
+        raise PactBroker::Client::Error, "Could not determine current git branch using command `#{COMMAND}`. #{e.class} #{e.message}"
+      end
+    end
+  end
+end

data/lib/pact_broker/client/matrix.rb

@@ -3,8 +3,10 @@ require_relative 'base_client'
 module PactBroker
   module Client
     class Matrix < BaseClient
-      def get selectors
-        query = {selectors: convert_selector_hashes_to_params(selectors)}
+      def get selectors, options = {}
+        query = {
+          q: convert_selector_hashes_to_params(selectors)
+        }.merge(query_options(options))
         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?
@@ -31,8 +33,20 @@ module PactBroker
         end
       end
 
+      def query_options(options)
+        opts = {}
+        if options.key?(:success)
+          opts[:success] = [*options[:success]]
+        end
+        opts
+      end
+
       def convert_selector_hashes_to_params(selectors)
-        selectors.collect{ |selector| "#{selector[:name]}/version/#{selector[:version]}" }
+        selectors.collect do |selector|
+          { pacticipant: selector[:pacticipant] }.tap do | hash |
+            hash[:version] = selector[:version] if selector[:version]
+          end
+        end
       end
     end
   end

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

@@ -4,8 +4,8 @@ module PactBroker
   module Client
     class Matrix
       class JsonFormatter
-        def self.call(matrix_lines)
-          JSON.pretty_generate(matrix: matrix_lines)
+        def self.call(matrix)
+          JSON.pretty_generate(matrix)
         end
       end
     end

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

@@ -7,12 +7,12 @@ module PactBroker
 
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
 
-        def self.call(matrix_lines)
-          data = matrix_lines.collect do | line |
+        def self.call(matrix)
+          data = matrix[:matrix].collect do | line |
             Line.new(
               lookup(line, :consumer, :name),
               lookup(line, :consumer, :version, :number),
-              lookup(line, :consumer, :name),
+              lookup(line, :provider, :name),
               lookup(line, :provider, :version, :number),
               lookup(line, :verificationResult, :success).to_s
             )

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.8.0'
+    VERSION = '1.9.0'
   end
 end

data/pact-broker-client.gemspec

@@ -7,9 +7,9 @@ require 'pact_broker/client/version'
 Gem::Specification.new do |gem|
   gem.name          = "pact_broker-client"
   gem.version       = PactBroker::Client::VERSION
-  gem.authors       = ["Bethany Skurrie"]
+  gem.authors       = ["Beth Skurrie"]
   gem.email         = ["bskurrie@dius.com.au"]
-  gem.description   = %q{Publishes pacts to, and retrieves pacts from, the pact broker server.}
+  gem.description   = %q{Client for the Pact Broker. Publish, retrieve and query pacts and verification results.}
   gem.summary       = %q{See description}
   gem.homepage      = "https://github.com/bethesque/pact_broker-client.git"
 
@@ -27,7 +27,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'table_print', '~> 1.5'
 
   gem.add_development_dependency 'fakefs', '~> 0.4'
-  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'

data/script/publish-pact.sh

@@ -0,0 +1 @@
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json --consumer-app-version 1.2.3 --broker-base-url http://localhost:9292 --tag-with-git-branch

data/script/release.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -e
+bundle exec rake
+bundle exec rake generate_changelog
+git add CHANGELOG.md lib/pact_broker/client/version.rb
+git commit -m "Releasing version $(ruby -r ./lib/pact_broker/client/version.rb -e "puts PactBroker::Client::VERSION")"
+bundle exec rake release

data/spec/integration/can_i_deploy_spec.rb

@@ -0,0 +1,32 @@
+describe "pact-broker can-i-deploy" do
+  before(:all) do
+    @pipe = IO.popen("bundle exec pact-stub-service spec/pacts/pact_broker_client-pact_broker.json -p 5000")
+    sleep 2
+  end
+
+  context "when the pacticipants can be deployed" do
+    subject { `bundle exec bin/pact-broker can-i-deploy -v --pacticipant Foo --version 1.2.3 --pacticipant Bar --version 4.5.6 --broker-base-url http://localhost:5000` }
+
+    it "returns a success exit code" do
+      subject
+      expect($?.exitstatus).to eq 0
+      expect(subject).to match /CONSUMER/
+      expect(subject).to match /Foo/
+      expect(subject).to match /PROVIDER/
+      expect(subject).to match /Bar/
+    end
+  end
+
+  context "when the pacticipants can't be deployed" do
+    subject { `bundle exec bin/pact-broker can-i-deploy -v --pacticipant Wiffle --version 1.2.3 --pacticipant Meep --version 4.5.6 --broker-base-url http://localhost:5000` }
+
+    it "returns an error exit code" do
+      subject
+      expect($?.exitstatus).to_not eq 0
+    end
+  end
+
+  after(:all) do
+    Process.kill 'KILL', @pipe.pid
+  end
+end

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

@@ -4,7 +4,7 @@ module PactBroker
   module Client
     describe CanIDeploy do
       let(:pact_broker_base_url) { 'http://example.org' }
-      let(:version_selectors) { [{name: "Foo", version: "1"}] }
+      let(:version_selectors) { [{pacticipant: "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}} }
@@ -24,7 +24,7 @@ module PactBroker
       end
 
       it "creates a text table out of the matrix" do
-        expect(Matrix::Formatter).to receive(:call).with(['foo'], 'text')
+        expect(Matrix::Formatter).to receive(:call).with(matrix, 'text')
         subject
       end
 

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

@@ -15,7 +15,7 @@ module PactBroker
         let(:result) { instance_double('PactBroker::Client::CanIDeploy::Result', success: success, message: message) }
         let(:success) { true }
         let(:message) { 'message' }
-        let(:version_selectors) { ['selector1'] }
+        let(:version_selectors) { [{pacticipant: "Foo", version: "1"}] }
         let(:minimum_valid_options) do
           {
             broker_base_url: 'http://pact-broker',
@@ -36,6 +36,14 @@ module PactBroker
           invoke_can_i_deploy
         end
 
+        context "with a missing --version" do
+          let(:version_selectors) { [{pacticipant: "Foo", version: nil}] }
+
+          it "raises an error" do
+            expect { invoke_can_i_deploy }.to raise_error Thor::RequiredArgumentMissingError, "No --version provided for pacticipant Foo"
+          end
+        end
+
         context "with basic auth" do
           before do
             subject.options = OpenStruct.new(minimum_valid_options.merge(broker_username: 'foo', broker_password: 'bar'))