pact_broker-client 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2da168156e0a87c5ada9a57862ff68b35457aee7
-  data.tar.gz: 6e7a10febc1466ffd8362d287be80c24a9cf99dd
+  metadata.gz: a8305e2cc46298df3b6b08f4209aacef58f9fd1b
+  data.tar.gz: 61f58e6adb4dcf2911aa031d4ecd58a48042c7a4
 SHA512:
-  metadata.gz: 3366140d2ba0adc2a2a3a9d5d91d4821877a3a32b2b97348140d86a591b2eb0bb7333480d1c385d179d1a89dca2fd434ee5315daf5723d49bea50cb4578a3830
-  data.tar.gz: df9d0e2fad9fc73a7d890ab7c283700e8c169d8f8ebb094de21bf54fa7c5b7d8a3482ec62f34393c6bd47e8fa711815bde6302971dab5d0227965ecc030e3f00
+  metadata.gz: ff29557b0f7134e880bd7748ed4ac2e5b6c1fdfdc3f58ea1a8423213a914ddb4a1509b0c49943c8570c28db4bc9520c1e91fe88354341f52619f1cf4ab40ff96
+  data.tar.gz: 98656507dcf1571631e1c377fa28b0d2bc8780412a707615ade09c56f30918bbf682a2b8a8ab5ba943d7ae7ead971c25b790450c25a7fead68e010c12b4ca9ec

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 rvm:
-  - 2.0.0
   - 2.1.8
   - 2.2.4
   - 2.3.1
+  - 2.4.1
 gemfile:
   - gemfiles/default.gemfile
   - gemfiles/ruby_under_22.gemfile

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+<a name="v1.7.0"></a>
+### v1.7.0 (2017-10-19)
+
+
+#### Features
+
+* **can-i-deploy**
+  * change cli to use --name and --version options instead of bespoke version selector format	 ([15e8131](/../../commit/15e8131))
+  * puts output to stdout for both success and failure scenarios so that JSON output can be parsed by capturing stdout	 ([6db595a](/../../commit/6db595a))
+  * remove dates from table output and add success status	 ([5dc9484](/../../commit/5dc9484))
+  * add --output option allowing table or json to be specified	 ([57fa24e](/../../commit/57fa24e))
+
+* changed name of verification date field	 ([962b7d1](/../../commit/962b7d1))
+* output table of verification results when present	 ([9220703](/../../commit/9220703))
+* add 'pact-broker can-i-deploy' executable	 ([ca68c54](/../../commit/ca68c54))
+
+
 <a name="v1.6.0"></a>
 ### v1.6.0 (2017-10-01)
 

data/README.md

@@ -24,9 +24,10 @@ require 'pact_broker/client/tasks'
 PactBroker::Client::PublicationTask.new do | task |
   require 'my_consumer/version'
   task.consumer_version = MyConsumer::VERSION
+  task.pattern = 'custom/path/to/pacts/*.json' # optional, default value is 'spec/pacts/*.json'
   task.pact_broker_base_url = "http://pact-broker.my.org"
   task.tags = ["dev"] # optional
-  task.pact_broker_basic_auth =  { username: 'basic_auth_user', password: 'basic_auth_pass'} #optional
+  task.pact_broker_basic_auth =  { username: 'basic_auth_user', password: 'basic_auth_pass'} # optional
   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.
 end
 ```

data/bin/pact-broker

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'pact_broker/client/cli/broker'
+
+PactBroker::Client::CLI::Broker.start

data/gemfiles/default.gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: ..
   specs:
-    pact_broker-client (1.6.0)
+    pact_broker-client (1.7.0)
       httparty
       json
+      table_print (~> 1.5)
       term-ansicolor
 
 GEM
@@ -16,20 +17,22 @@ GEM
       rake
       thor (>= 0.14.0)
     awesome_print (1.8.0)
+    byebug (9.1.0)
     coderay (1.1.2)
     conventional-changelog (1.3.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    fakefs (0.11.2)
+    fakefs (0.11.3)
+    filelock (1.1.1)
     find_a_port (1.0.1)
-    hashdiff (0.3.6)
+    hashdiff (0.3.7)
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
     json (2.1.0)
     method_source (0.9.0)
     multi_xml (0.6.0)
-    pact (1.16.0)
+    pact (1.16.1)
       json (> 1.8.5)
       pact-mock_service (~> 2.0)
       pact-support (~> 1.1, >= 1.1.8)
@@ -39,17 +42,18 @@ GEM
       term-ansicolor (~> 1.0)
       thor
       webrick
-    pact-mock_service (2.2.0)
+    pact-mock_service (2.4.0)
+      filelock (~> 1.1)
       find_a_port (~> 1.0.1)
       json
-      pact-support (~> 1.2)
+      pact-support (~> 1.2, >= 1.2.1)
       rack (~> 2.0)
       rack-test (~> 0.6.2)
       rspec (>= 2.14)
       term-ansicolor (~> 1.0)
       thor (~> 0.19)
       webrick (~> 1.3)
-    pact-support (1.2.0)
+    pact-support (1.2.1)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -58,36 +62,38 @@ GEM
       rspec (>= 2.14)
       term-ansicolor (~> 1.0)
       thor
-    pry (0.11.1)
+    pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
     public_suffix (3.0.0)
     rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.0.4)
     randexp (0.1.7)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-fire (1.3.0)
-      rspec (>= 2.11, < 4)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     safe_yaml (1.0.4)
+    table_print (1.5.6)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.20.0)
     tins (1.15.0)
-    webmock (3.0.1)
+    webmock (3.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -102,9 +108,8 @@ DEPENDENCIES
   fakefs (~> 0.4)
   pact (~> 1.16)
   pact_broker-client!
-  pry
+  pry-byebug
   rake (~> 10.0.3)
-  rspec-fire
   webmock (~> 3.0)
 
 BUNDLED WITH

data/gemfiles/ruby_under_22.gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: ..
   specs:
-    pact_broker-client (1.6.0)
+    pact_broker-client (1.7.0)
       httparty
       json
+      table_print (~> 1.5)
       term-ansicolor
 
 GEM
@@ -16,20 +17,21 @@ GEM
       rake
       thor (>= 0.14.0)
     awesome_print (1.8.0)
+    byebug (9.1.0)
     coderay (1.1.2)
     conventional-changelog (1.3.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    fakefs (0.11.2)
+    fakefs (0.11.3)
     find_a_port (1.0.1)
-    hashdiff (0.3.6)
+    hashdiff (0.3.7)
     httparty (0.15.6)
       multi_xml (>= 0.5.2)
     json (2.1.0)
     method_source (0.9.0)
     multi_xml (0.6.0)
-    pact (1.16.0)
+    pact (1.16.1)
       json (> 1.8.5)
       pact-mock_service (~> 2.0)
       pact-support (~> 1.1, >= 1.1.8)
@@ -49,7 +51,7 @@ GEM
       term-ansicolor (~> 1.0)
       thor
       webrick
-    pact-support (1.2.0)
+    pact-support (1.2.1)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -58,36 +60,38 @@ GEM
       rspec (>= 2.14)
       term-ansicolor (~> 1.0)
       thor
-    pry (0.11.1)
+    pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
     public_suffix (3.0.0)
     rack (1.6.8)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.0.4)
     randexp (0.1.7)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-fire (1.3.0)
-      rspec (>= 2.11, < 4)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     safe_yaml (1.0.4)
+    table_print (1.5.6)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.20.0)
     tins (1.15.0)
-    webmock (3.0.1)
+    webmock (3.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -102,10 +106,9 @@ DEPENDENCIES
   fakefs (~> 0.4)
   pact (~> 1.16)
   pact_broker-client!
-  pry
+  pry-byebug
   rack (< 2.0)
   rake (~> 10.0.3)
-  rspec-fire
   webmock (~> 3.0)
 
 BUNDLED WITH

data/lib/pact_broker/client/base_client.rb

@@ -1,9 +1,12 @@
 require 'erb'
 require 'httparty'
+require 'pact_broker/client/error'
 
 module PactBroker
   module Client
 
+    class Error < StandardError; end
+
     module UrlHelpers
       def encode_param param
         ERB::Util.url_encode param
@@ -31,6 +34,7 @@ module PactBroker
       def initialize options
         @base_url = options[:base_url]
         @client_options = options[:client_options] || {}
+        @verbose = @client_options[:verbose]
         self.class.base_uri base_url
         self.class.basic_auth(client_options[:basic_auth][:username], client_options[:basic_auth][:password]) if client_options[:basic_auth]
       end
@@ -56,8 +60,16 @@ module PactBroker
           yield
         elsif response.code == 404
           nil
+        elsif response.code == 401
+          raise Error.new("Authentication failed")
         else
-          raise response.body
+          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
 
@@ -73,6 +85,9 @@ module PactBroker
         self.class.get(url, *args)
       end
 
+      def verbose?
+        @verbose
+      end
     end
   end
 end

data/lib/pact_broker/client/can_i_deploy.rb

@@ -0,0 +1,80 @@
+require 'pact_broker/client/error'
+require 'pact_broker/client/pact_broker_client'
+require 'pact_broker/client/retry'
+require 'pact_broker/client/matrix/formatter'
+
+
+module PactBroker
+  module Client
+    class CanIDeploy
+
+      class Result
+        attr_reader :success, :message
+
+        def initialize success, message = nil
+          @success = success
+          @message = message
+        end
+      end
+
+      def self.call(pact_broker_base_url, version_selectors, options, pact_broker_client_options={})
+        new(pact_broker_base_url, version_selectors, options, pact_broker_client_options).call
+      end
+
+      def initialize(pact_broker_base_url, version_selectors, options, pact_broker_client_options)
+        @pact_broker_base_url = pact_broker_base_url
+        @version_selectors = version_selectors
+        @options = options
+        @pact_broker_client_options = pact_broker_client_options
+      end
+
+      def call
+        if matrix[:summary][:compatible]
+          Result.new(true, success_message(matrix))
+        else
+          Result.new(false, failure_message(matrix))
+        end
+      rescue PactBroker::Client::Error => e
+        Result.new(false, e.message)
+      rescue StandardError => e
+        Result.new(false, "Error retrieving matrix. #{e.class} - #{e.message}\n#{e.backtrace.join("\n")}")
+      end
+
+      private
+
+      attr_reader :pact_broker_base_url, :version_selectors, :options, :pact_broker_client_options
+
+      def success_message(matrix)
+        message = format_matrix(matrix[:matrix])
+        if format != 'json'
+          message = 'Computer says yes \o/' + "\n\n" + message
+        end
+        message
+      end
+
+      def failure_message(matrix)
+        message = format_matrix(matrix[:matrix])
+        if format != 'json'
+          message = 'Computer says no ¯\_(ツ)_/¯' + "\n\n" + message
+        end
+        message
+      end
+
+      def format_matrix(matrix)
+        Matrix::Formatter.call(matrix, format)
+      end
+
+      def format
+        options[:output]
+      end
+
+      def matrix
+        @matrix ||= Retry.until_true { pact_broker_client.matrix.get(version_selectors) }
+      end
+
+      def pact_broker_client
+        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'pact_broker/client/can_i_deploy'
+require 'pact_broker/client/version'
+require 'pact_broker/client/cli/version_selector_options_parser'
+require 'thor'
+
+module PactBroker
+  module Client
+    module CLI
+      class Broker < Thor
+        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 :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
+
+        def can_i_deploy
+          selectors = VersionSelectorOptionsParser.call(ARGV)
+          result = CanIDeploy.call(options.broker_base_url, selectors, {output: options.output}, pact_broker_client_options)
+          $stdout.puts result.message
+          exit(1) unless result.success
+        end
+
+        desc 'version', "Show the pact_broker-client gem version"
+        def version
+          $stdout.puts PactBroker::Client::VERSION
+        end
+
+        no_commands do
+          def pact_broker_client_options
+            if options.broker_username
+              {
+                basic_auth: {
+                  username: options.broker_username,
+                  password: options.broker_password
+                },
+                verbose: options.verbose
+              }
+            else
+              {
+                verbose: options.verbose
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end