pact_broker-client 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108c1ab15ca6e36cc62cd630bdd73e716d83ed78ae9cdf718edb5abc7741ac3b
-  data.tar.gz: fa0e07f37153ce67e4b76a9e2ed32635e613d38972b60687e4eeff659e8d6dff
+  metadata.gz: 1bf1176c39519652e60c6aab383a941a2dd5a1c8e968b746741a290e68c736e9
+  data.tar.gz: 04b1f3aa9f25b353e61eb558d393d108750cd97b4645fe81313b1d04dca33ba5
 SHA512:
-  metadata.gz: b3a851164b96ca422c7c3e683c389f5731c86e85fa8a7fe29501fb9b0719b4ac20fc8caed19654324765c2f29e1b253dfd12055268b45e59d75eef73507c834f
-  data.tar.gz: c9f836d70e375a8a6205855184fefaf0712cfeb4c46a14bd71433406ddf6aa445c50d76a3d36044d4427ac63b4ad14b2eab5890a16d502e68a4704a4b3cac540
+  metadata.gz: cbb4fe27ce2979d3daea2c597ca7509b6d4136ac53d139a738fd672f30d114fcce23ce4f3ba3c108aef13ec88b9793715bf57ec05a2fda6255dfcd7ed9c99875
+  data.tar.gz: 443c3e2e5fb75bcbfa3850ce1498f859c45872145f813c50b260a9a7d28a32f5aa7618c1f55b0c798b34975ec7b35d7e44b0937c6bd2575dea1b86356eb8ca5b

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on: push
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ["2.2", "2.7"]
+        experimental: [false]
+        include:
+          - ruby_version: "3.0"
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="v1.35.0"></a>
+### v1.35.0 (2021-01-21)
+
+#### Features
+
+* **can-i-deploy**
+  * display links to verification results in the output of can-i-deploy when using text format	 ([976950d](/../../commit/976950d))
+
 <a name="v1.34.0"></a>
 ### v1.34.0 (2020-11-20)
 

data/README.md

@@ -2,7 +2,9 @@
 
 A client for the Pact Broker. Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
 
-[![Build Status](https://travis-ci.org/pact-foundation/pact_broker-client.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker-client)
+![Build status](https://github.com/pact-foundation/pact_broker-client/workflows/Test/badge.svg)
+
+[![Gem Version](https://badge.fury.io/rb/pact_broker-client.svg)](http://badge.fury.io/rb/pact_broker-client)
 
 ![Trigger update to docs.pact.io](https://github.com/pact-foundation/pact_broker-client/workflows/Trigger%20update%20to%20docs.pact.io/badge.svg)
 
@@ -16,9 +18,19 @@ Download the latest [pact-ruby-standalone][pact-ruby-standalone] package. You do
 
 Add `gem 'pact_broker-client'` to your Gemfile and run `bundle install`, or install the gem directly by running `gem install pact_broker-client`.
 
+## Connecting to a Pact Broker with a self signed certificate
+
+To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate. Read more at https://docs.pact.io/pact_broker/advanced_topics/using-tls#for-non-jvm
+
 ## Usage - CLI
 
-To connect to a Pact Broker that uses custom SSL cerificates, set the environment variable `$SSL_CERT_FILE` or `$SSL_CERT_DIR` to a path that contains the appropriate certificate.
+The Pact Broker base URL can be specified either using the environment variable `$PACT_BROKER_BASE_URL` or the `-b` or `--broker-base-url` parameters.
+
+Pact Broker authentication can be performed either using basic auth or a bearer token.
+
+Basic auth parameters can be specified using the `$PACT_BROKER_USERNAME` and `$PACT_BROKER_PASSWORD` environment variables, or the `-u` or `--broker-username` and `-p` or `--broker-password` parameters.
+
+Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This authentication system is used by [Pactflow](pactflow.io).
 
 ### publish
 
@@ -188,7 +200,7 @@ Can I deploy all the applications in my monorepo to prod?
                                --pacticipant B --version a7e28207 \
                                --pacticipant C --version a7e28207 \
                                --to prod \
-                               --broker-base-url BROKER_BASE_URL                               
+                               --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/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -164,7 +164,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -185,7 +190,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -233,7 +243,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -281,7 +296,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -329,7 +349,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -413,7 +438,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -484,7 +514,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"
@@ -735,7 +770,12 @@ Pact Broker will respond with:
         },
         "verificationResult": {
           "verifiedAt": "2017-10-10T12:49:04+11:00",
-          "success": true
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
         },
         "pact": {
           "createdAt": "2017-10-10T12:49:04+11:00"

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

@@ -1,41 +1,74 @@
 require 'table_print'
+require 'dig_rb'
 
 module PactBroker
   module Client
     class Matrix
       class TextFormatter
 
-        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success)
+        Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref)
 
         OPTIONS = [
           { consumer: {} },
           { consumer_version: {display_name: 'C.VERSION'} },
           { provider: {} },
           { provider_version: {display_name: 'P.VERSION'} },
-          { success: {display_name: 'SUCCESS?'} }
+          { success: {display_name: 'SUCCESS?'} },
+          { ref: { display_name: 'RESULT#' }}
         ]
 
         def self.call(matrix)
           matrix_rows = matrix[:matrix]
           return "" if matrix_rows.size == 0
-          data = matrix_rows.collect do | line |
+          verification_result_number = 0
+          data = matrix_rows.each_with_index.collect do | line |
+            has_verification_result_url = lookup(line, nil, :verificationResult, :_links, :self, :href)
+            if has_verification_result_url
+              verification_result_number += 1
+            end
             Line.new(
-              lookup(line, :consumer, :name),
-              lookup(line, :consumer, :version, :number),
-              lookup(line, :provider, :name),
-              lookup(line, :provider, :version, :number),
-              lookup(line, :verificationResult, :success).to_s
+              lookup(line, "???", :consumer, :name),
+              lookup(line, "???", :consumer, :version, :number),
+              lookup(line, "???", :provider, :name) ,
+              lookup(line, "???", :provider, :version, :number),
+              (lookup(line, "???", :verificationResult, :success)).to_s,
+              has_verification_result_url ? verification_result_number : ""
             )
           end
 
           printer = TablePrint::Printer.new(data, OPTIONS)
-          printer.table_print
+          printer.table_print + verification_result_urls_text(matrix)
         end
 
-        def self.lookup line, *keys
+        def self.lookup line, default, *keys
           keys.reduce(line) { | line, key | line[key] }
         rescue NoMethodError
-          "???"
+          default
+        end
+
+        def self.verification_results_urls_and_successes(matrix)
+          (matrix[:matrix] || []).collect do | row |
+            url = row.dig(:verificationResult, :_links, :self, :href)
+            if url
+              success = row.dig(:verificationResult, :success)
+              [url, success]
+            else
+              nil
+            end
+          end.compact
+        end
+
+        def self.verification_result_urls_text(matrix)
+          text = self.verification_results_urls_and_successes(matrix).each_with_index.collect do |(url, success), i|
+            status = success ? 'success' : 'failure'
+            "#{i+1}. #{url} (#{status})"
+          end.join("\n")
+
+          if text.size > 0
+            "\n\nVERIFICATION RESULTS\n--------------------\n#{text}"
+          else
+            text
+          end
         end
       end
     end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.34.0'
+    VERSION = '1.35.0'
   end
 end

data/pact-broker-client.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
+  gem.add_runtime_dependency 'dig_rb', '~> 1.0'
 
   gem.add_development_dependency 'fakefs', '~> 0.4'
   gem.add_development_dependency 'webmock', '~> 3.0'

data/spec/lib/pact_broker/client/matrix/text_formatter_spec.rb

@@ -1,29 +1,54 @@
+require 'pact_broker/client/matrix/resource'
 require 'pact_broker/client/matrix/text_formatter'
 
 module PactBroker
   module Client
     describe Matrix::TextFormatter do
-      let(:matrix_lines) { JSON.parse(File.read('spec/support/matrix.json'), symbolize_names: true)[:matrix] }
+      let(:matrix) { PactBroker::Client::Matrix::Resource.new(JSON.parse(File.read('spec/support/matrix.json'), symbolize_names: true)) }
       let(:expected_matrix_lines) { File.read('spec/support/matrix.txt') }
 
       # SublimeText removes whitespace from the end of files when you save them,
       # so removing trailing whitespace before comparing
-      subject { Matrix::TextFormatter.call(matrix: matrix_lines).split("\n").collect(&:strip).join("\n") }
+      def strip_trailing_whitespace(text)
+        text.split("\n").collect(&:strip).join("\n")
+      end
+
+      subject { strip_trailing_whitespace(Matrix::TextFormatter.call(matrix)) }
 
       context "with valid data" do
         it "it has the right text" do
-          expect(subject).to eq expected_matrix_lines
+          expect(subject).to start_with expected_matrix_lines
         end
       end
 
       context "with invalid data" do
         let(:expected_matrix_lines) { File.read('spec/support/matrix_error.txt') }
-        let(:matrix_lines) { [{}] }
+        let(:matrix) { PactBroker::Client::Matrix::Resource.new(matrix: [{}]) }
 
         it "doesn't blow up" do
           expect(subject).to eq expected_matrix_lines
         end
       end
+
+      context "when some rows have a verification result URL and some don't" do
+        let(:matrix_lines) do
+          line_creator = -> { JSON.parse(File.read('spec/support/matrix.json'), symbolize_names: true)[:matrix].first }
+          line_1 = line_creator.call
+          line_2 = line_creator.call
+          line_3 = line_creator.call
+          line_2[:verificationResult] = nil
+          line_3[:verificationResult][:success] = false
+          [line_1, line_2, line_3]
+        end
+
+        let(:matrix) { PactBroker::Client::Matrix::Resource.new(matrix: matrix_lines) }
+
+        let(:expected_matrix_lines) { File.read('spec/support/matrix_with_results.txt') }
+
+        it "only provides a result number for the lines that have a result URL" do
+          expect(subject).to eq expected_matrix_lines
+        end
+      end
     end
   end
 end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -221,7 +221,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -271,7 +276,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -321,7 +331,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -418,7 +433,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -439,7 +459,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -492,7 +517,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -542,7 +572,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"
@@ -592,7 +627,12 @@
               },
               "verificationResult": {
                 "verifiedAt": "2017-10-10T12:49:04+11:00",
-                "success": true
+                "success": true,
+                "_links": {
+                  "self": {
+                    "href": "http://result"
+                  }
+                }
               },
               "pact": {
                 "createdAt": "2017-10-10T12:49:04+11:00"

data/spec/support/matrix.json

@@ -20,7 +20,12 @@
       },
       "verificationResult": {
         "verifiedAt": "2017-10-10T12:49:04+11:00",
-        "success": true
+        "success": true,
+        "_links": {
+          "self": {
+            "href": "http://result"
+          }
+        }
       },
       "pact": {
         "createdAt": "2017-10-10T12:49:04+11:00"

data/spec/support/matrix.txt

@@ -1,3 +1,3 @@
-CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
----------|-----------|----------|-----------|---------
-Foo      | 4         | Bar      | 5         | true
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+Foo      | 4         | Bar      | 5         | true     | 1

data/spec/support/matrix_error.txt

@@ -1,3 +1,3 @@
-CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
----------|-----------|----------|-----------|---------
-???      | ???       | ???      | ???       | ???
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+???      | ???       | ???      | ???       | ???      |

data/spec/support/matrix_with_results.txt

@@ -0,0 +1,10 @@
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+Foo      | 4         | Bar      | 5         | true     | 1
+Foo      | 4         | Bar      | 5         | ???      |
+Foo      | 4         | Bar      | 5         | false    | 2
+
+VERIFICATION RESULTS
+--------------------
+1. http://result (success)
+2. http://result (failure)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: dig_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -166,10 +180,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/release_gem.yml"
+- ".github/workflows/test.yml"
 - ".github/workflows/trigger_pact_docs_update.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -291,6 +305,7 @@ files:
 - spec/support/matrix.json
 - spec/support/matrix.txt
 - spec/support/matrix_error.txt
+- spec/support/matrix_with_results.txt
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json
 - spec/support/pacts_latest_list.json
@@ -315,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: See description
@@ -370,6 +385,7 @@ test_files:
 - spec/support/matrix.json
 - spec/support/matrix.txt
 - spec/support/matrix_error.txt
+- spec/support/matrix_with_results.txt
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json
 - spec/support/pacts_latest_list.json

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.4
-  - 2.4.1
-
-# before_install:
-#   - (git show-ref | grep $(git log --pretty=%h -1) | sed 's|.*/\(.*\)|\1|' | sort -u | grep -v HEAD) || true
-#   - (git show -s --pretty=%d HEAD) || true
-#   - (git for-each-ref --format='%(objectname) %(refname:short)' refs/heads | awk "/^$(git rev-parse HEAD)/ {print \$2}") || true
-#   - (git show -s --pretty=%D HEAD | tr -s ', ' '\n' | grep -v HEAD | head -n1) || true
-#   - (git name-rev --name-only HEAD) || true