pact_broker-client 1.31.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6d01915e01529a223ea249ec54672916c03f7518564710937570e8236c6317d
-  data.tar.gz: 9afcd886e4a3028fdfa66f7cca8a9f1d37e1fab30db469507b49843c84a6a4aa
+  metadata.gz: d55a0e281744620059c94153234610bf5368b178eff81765250a1b31b00ef124
+  data.tar.gz: 42edd3c93f27dc59e498e52f36628158ac79bb8d7aa72a4b469ac69ec5734e00
 SHA512:
-  metadata.gz: 1099d5d729df80630cb6f95e916a1d05628f536adaa4e939ff7dbf4158145179b6676746ce3e71ea9dadf89ac565a0ebdbea7229bfb00167bc301f783342830d
-  data.tar.gz: 40bed81357857aeb44dd7c0acaa81a7b51ceda70294586daf78d058b16357dce5f814b0c6562000d55c47db1527509fae2d745119511180588c97e2a80a96e93
+  metadata.gz: af0ca16aa9d4f2732ac72b42a102d4567d5a0541510967bfa38a4b2d3302f6d40e17f81af6c444cf93c7710edc583da4715f39aebdb736e471d7cc26e67503d6
+  data.tar.gz: e276cb64d985c93dcb55185c6ed9b61fc8c392a90d28cf7fc4b49246f986503005d111c8f0802166364f316bf3bde100d2d71a36f533d899e32c00ff76681542

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,52 @@
+<a name="v1.36.0"></a>
+### v1.36.0 (2021-02-21)
+
+#### Features
+
+* **can-i-deploy**
+  * add --to-environment option	 ([05ae44c](/../../commit/05ae44c))
+
+* support version branch and build URL when publishing pacts	 ([a75f7df](/../../commit/a75f7df))
+
+<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)
+
+#### Features
+
+* **pact publish**
+  * strip new lines from version numbers and tags	 ([5842d24](/../../commit/5842d24))
+
+* **publish**
+  * update output text when pact already exists and merging	 ([9b849d3](/../../commit/9b849d3))
+
+<a name="v1.33.0"></a>
+### v1.33.0 (2020-11-10)
+
+#### Features
+
+* **publish**
+  * allow pacts to be merged on the server side	 ([bd80f10](/../../commit/bd80f10))
+
+<a name="v1.32.0"></a>
+### v1.32.0 (2020-10-26)
+
+#### Features
+
+* Improve HTTP errors handling (#76)	 ([d8eaf16](/../../commit/d8eaf16))
+
+#### Bug Fixes
+
+* **list-latest-pact-versions**
+  * correct json output	 ([cf77666](/../../commit/cf77666))
+
 <a name="v1.31.0"></a>
 ### v1.31.0 (2020-10-22)
 

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

@@ -28,6 +28,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
+
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -42,6 +44,10 @@
 
 * [A request to create a pacticipant](#a_request_to_create_a_pacticipant)
 
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist
+
+* [A request to create a pacticipant version](#a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist) given version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist
+
 * [A request to create a webhook for a consumer and provider](#a_request_to_create_a_webhook_for_a_consumer_and_provider_given_'Condor'_does_not_exist_in_the_pact-broker) given 'Condor' does not exist in the pact-broker
 
 * [A request to create a webhook with a JSON body and a uuid](#a_request_to_create_a_webhook_with_a_JSON_body_and_a_uuid_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -164,7 +170,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 +196,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 +249,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 +302,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 +355,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 +444,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 +520,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"
@@ -611,6 +652,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-version relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant-version": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -735,7 +803,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"
@@ -858,6 +931,76 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_pacticipant_version_given_version_26f353580936ad3b9baddb17b00e84f33c69e7cb_of_pacticipant_Foo_does_not_exist"></a>
+Given **version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist**, upon receiving **a request to create a pacticipant version** from Pact Broker Client, with
+```json
+{
+  "method": "put",
+  "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
+    "branch": "main",
+    "buildUrl": "http://my-ci/builds/1",
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url"
+      }
+    }
+  }
+}
+```
 <a name="a_request_to_create_a_webhook_for_a_consumer_and_provider_given_&#39;Condor&#39;_does_not_exist_in_the_pact-broker"></a>
 Given **'Condor' does not exist in the pact-broker**, upon receiving **a request to create a webhook for a consumer and provider** from Pact Broker Client, with
 ```json

data/lib/pact_broker/client/base_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'erb'
 require 'httparty'
 require 'pact_broker/client/error'
@@ -30,6 +32,12 @@ module PactBroker
     end
 
     class BaseClient
+      ERROR_CODE_MAPPING = {
+        401 => "Authentication failed",
+        403 => "Authorization failed (insufficient permissions)",
+        409 => "Potential duplicate pacticipants"
+      }.freeze
+
       include UrlHelpers
       include HTTParty
       include StringToSymbol
@@ -69,14 +77,8 @@ module PactBroker
           yield response
         elsif response.code == 404
           nil
-        elsif response.code == 403
-          message = "Authorization failed (insufficient permissions)"
-          if response.body && response.body.size > 0
-            message = message + ": #{response.body}"
-          end
-          raise Error.new(message)
-        elsif response.code == 401
-          message = "Authentication failed"
+        elsif ERROR_CODE_MAPPING.key?(response.code)
+          message = ERROR_CODE_MAPPING.fetch(response.code)
           if response.body && response.body.size > 0
             message = message + ": #{response.body}"
           end
@@ -93,7 +95,7 @@ module PactBroker
               response.body
             end
           rescue
-            raise Error.new(response.body)
+            raise Error.new("status=#{response.code} #{response.body}")
           end
           raise Error.new(error_message)
         end

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

@@ -18,6 +18,7 @@ module PactBroker
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
         method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
         method_option :to, required: false, banner: 'TAG', desc: "This is too hard to explain in a short sentence. Look at the examples.", default: nil
+        method_option :to_environment, required: false, banner: 'ENVIRONMENT', desc: "The environment into which the pacticipant(s) are to be deployed", default: nil, hide: true
         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"
@@ -37,7 +38,7 @@ module PactBroker
           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 }
-          result = CanIDeploy.call(options.broker_base_url, selectors, {to_tag: options.to, limit: options.limit}, can_i_deploy_options, pact_broker_client_options)
+          result = CanIDeploy.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit }, can_i_deploy_options, pact_broker_client_options)
           $stdout.puts result.message
           exit(1) unless result.success
         end
@@ -48,8 +49,12 @@ 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 :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
+        method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
+        method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
         method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
         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 :build_url, desc: "The build URL that created the pact"
+        method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
         method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
 
         def publish(*pact_files)
@@ -209,13 +214,20 @@ module PactBroker
 
           def publish_pacts pact_files
             require 'pact_broker/client/publish_pacts'
+            write_options = options[:merge] ? { write: :merge } : {}
+            consumer_version_params = {
+              number: options.consumer_app_version,
+              branch: branch,
+              tags: tags,
+              build_url: options.build_url,
+              version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+            }.compact
 
             PactBroker::Client::PublishPacts.call(
               options.broker_base_url,
               file_list(pact_files),
-              options.consumer_app_version,
-              tags,
-              pact_broker_client_options
+              consumer_version_params,
+              pact_broker_client_options.merge(write_options)
             )
           end
 
@@ -236,10 +248,24 @@ module PactBroker
             require 'pact_broker/client/git'
 
             t = [*options.tag]
-            t << PactBroker::Client::Git.branch if options.tag_with_git_branch
+            t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
             t.compact.uniq
           end
 
+          def branch
+            require 'pact_broker/client/git'
+
+            if options.branch.nil? && options.auto_detect_version_properties
+              PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
+            else
+              options.branch
+            end
+          end
+
+          def explict_auto_detect_version_properties
+            @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+          end
+
           def pact_broker_client_options
             client_options = { verbose: options.verbose }
             client_options[:token] =  options.broker_token if options.broker_token