pact_broker-client 1.72.0 → 1.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95192c76cf2b56651bb52de5cd2c5f1bea45d966e5dfa4e8ef78d1e11a3a2a51
-  data.tar.gz: 1a095144bc411e428556f47da77160d5c7a182e4eb2201d75f30075adb1cb009
+  metadata.gz: 84c25ce85cb110411ce145b803e155a0cb8c30a356bb3a6dc8239ab14fbc97c4
+  data.tar.gz: 57a8dcaf85657dc9f99c233abf1cbd1fa0672e0c942ba8d0f009907afda87309
 SHA512:
-  metadata.gz: 3553d23ad0bdae6e6f460a6a85dd3ab46789bf3cfe6241881c1f126642b73cf6ee9714f60e830c7108f8e0a0a188a7a2a6b1a42dda55be7ae2339b9ccfd3552b
-  data.tar.gz: 3c039eb65e3f4f02c9f32ebf52936535ccb125e8105c4b1681aeafa90de007c7dc032824d20facf6e023c61e3b32147e188312b8a8244b506627fe69e8f414c0
+  metadata.gz: 732c56c1c831f3f154e9be33ef949208057db7705a7bca291d1a356923729acda5f762ff2e57ab51409afa71e425eec7bc775964816de74d215229a66583bedf
+  data.tar.gz: 97f2acafe53b570a5945d1e3c8750cf6f35f5a122ba58e5b8646ba2dc2b1702ad44489ab21ba53fa19220aca569bd8495c5ce6f694b9ec1784caf8a247cd6fed

data/.github/workflows/release_gem.yml

@@ -10,7 +10,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
     - run: |
         gem install bundler -v 2.4
@@ -26,7 +26,7 @@ jobs:
       version: ${{ steps.release.outputs.version }}
       increment: ${{ steps.release.outputs.increment }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
     - uses: pact-foundation/release-gem@v0.0.14
@@ -40,7 +40,7 @@ jobs:
     needs: release
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
     - name: Bundle install
       run: |
@@ -61,7 +61,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Notify ${{ matrix.repository }} of gem release
-        uses: peter-evans/repository-dispatch@v1
+        uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
           repository: ${{ matrix.repository }}

data/.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
         ruby_version: ["2.7", "3.0", "3.1", "3.2"]
         os: ["ubuntu-latest","windows-latest","macos-latest"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
@@ -25,7 +25,7 @@ jobs:
       matrix:
         feature: [""]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.2"
@@ -47,11 +47,11 @@ jobs:
     steps:
       - run: |
           docker run --rm \
-           -e PACT_BROKER_BASE_URL=https://pact-oss.pactflow.io \
+           -e PACT_BROKER_BASE_URL=https://pact-foundation.pactflow.io \
            -e PACT_BROKER_TOKEN \
             pactfoundation/pact-cli:latest \
             broker can-i-deploy \
             --pacticipant "Pact Broker Client" --version ${GITHUB_SHA} \
-            --pacticipant "Pact Broker" --latest master
+            --pacticipant "Pact Broker" --branch master
         env:
-          PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
+          PACT_BROKER_TOKEN: ${{ secrets.PACT_BROKER_TOKEN_PACT_FOUNDATION }}

data/.github/workflows/trigger_pact_docs_update.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Trigger docs.pact.io update workflow
-        uses: peter-evans/repository-dispatch@v1
+        uses: peter-evans/repository-dispatch@v2
         with:
           token: ${{ secrets.GHTOKENFORTRIGGERINGPACTDOCSUPDATE }}
           repository: pact-foundation/docs.pact.io

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="v1.74.0"></a>
+### v1.74.0 (2023-10-14)
+
+#### Features
+
+* auto detect commit sha, add shorthand -r flag (#119)	 ([1dac9f8](/../../commit/1dac9f8))
+
+#### Bug Fixes
+
+* support merging v3 pacts	 ([d1e01d0](/../../commit/d1e01d0))
+
+<a name="v1.73.0"></a>
+### v1.73.0 (2023-10-13)
+
+#### Features
+
+* print warnings and allow error to be raised when unknown option is used	 ([5412121](/../../commit/5412121))
+* raise an error when an em dash is used instead of a normal dash	 ([0e8e773](/../../commit/0e8e773))
+* support --help and -h flags	 ([a6458ab](/../../commit/a6458ab))
+* handle x509 certs in HTTP Client (#142)	 ([c3aa8dc](/../../commit/c3aa8dc))
+
 <a name="v1.72.0"></a>
 ### v1.72.0 (2023-09-11)
 

data/DEVELOPING.md

@@ -0,0 +1,17 @@
+# Developing
+
+## Testing pact_broker-client locally
+
+1. Make sure you have `ruby` available on the command line
+2. Install with `bundle install`
+3. Run tests with `bundle exec rake`
+4. Run individual test with `rspec <path to test>`
+5. Run one of the scripts in `./example/scripts`, see the readme for more detail, and scripts
+
+##  Available Rake tasks
+
+1. check `bundle exec rake --tasks`
+
+## Generating docs
+
+If you change the CLI commands, run `bundle exec script/update-cli-usage-in-readme.rb` to update the `README.md` automatically.

data/Gemfile

@@ -21,3 +21,8 @@ group :development do
   gem 'rspec-its', '~> 1.3'
   gem 'pry-byebug'
 end
+
+group :test do
+  gem 'faraday', '~>2.0'
+  gem 'faraday-retry', '~>2.0'
+end

data/README.md

@@ -42,6 +42,14 @@ Basic auth parameters can be specified using the `$PACT_BROKER_USERNAME` and `$P
 
 Authentication using a bearer token can be specified using the environment variable `$PACT_BROKER_TOKEN` or the `-k` or `--broker-token` parameters. This bearer token authentication is used by [PactFlow](https://pactflow.io) and is not available in the [OSS Pact Broker](https://docs.pact.io/pact_broker/), which only supports basic auth.
 
+### Handling unknown options
+
+By default, the underlying library used for the Pact Broker CLI (Thor) does not raise an error in every situation where there is an unknown option used.
+This can allow invalid commands to be executed that do not perform as expected.
+
+From version 1.73.0, warnings will be printed for unknown options, and if the environment variable `PACT_BROKER_ERROR_ON_UNKNOWN_OPTION=true` is set, an error will be raised when an unknown option is used.
+
+In the next major version, an error will be raised by default.
 
 <!-- start-autogenerated-docs -->
 
@@ -51,18 +59,18 @@ Authentication using a bearer token can be specified using the environment varia
 
 ```
 Usage:
-  pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
+  pact-broker publish PACT_DIRS_OR_FILES ... -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --consumer-app-version=CONSUMER_APP_VERSION
+  -a, [--consumer-app-version=CONSUMER_APP_VERSION]
               # The consumer application version
   -h, [--branch=BRANCH]
               # Repository branch of the consumer version
-      [--auto-detect-version-properties], [--no-auto-detect-version-properties]
-              # Automatically detect the repository branch from known CI
-                environment variables or git CLI. Supports Buildkite, Circle
-                CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor,
-                GitLab, CodeShip, Bitbucket and Azure DevOps.
+  -r, [--auto-detect-version-properties], [--no-auto-detect-version-properties]
+              # Automatically detect the repository commit, branch and build
+                URL from known CI environment variables or git CLI. Supports
+                Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins,
+                Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps.
   -t, [--tag=TAG]
               # Tag name for consumer version. Can be specified multiple
                 times.
@@ -680,7 +688,9 @@ Options:
   -H, [--header=one two three]
               # Webhook Header
   -d, [--data=DATA]
-              # Webhook payload (file or string)
+              # Webhook payload. Provide a JSON string (remember to escape
+                characters appropriately for the shell) or a file path prefixed
+                with the @ symbol, as per the curl usage for this flag.
   -u, [--user=USER]
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]
@@ -743,7 +753,9 @@ Options:
   -H, [--header=one two three]
               # Webhook Header
   -d, [--data=DATA]
-              # Webhook payload (file or string)
+              # Webhook payload. Provide a JSON string (remember to escape
+                characters appropriately for the shell) or a file path prefixed
+                with the @ symbol, as per the curl usage for this flag.
   -u, [--user=USER]
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -2305,8 +2305,7 @@ Pact Broker will respond with:
         "name": "Foo"
       },
       "version": {
-        "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "buildUrl": "http://build"
+        "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30"
       }
     },
     "logs": [

data/example/scripts/publish-pact-rake.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_TOKEN already
+
+bundle exec rake pact:publish:pactflow_auto_on_nil_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_on_user_commit_user_branch
+bundle exec rake pact:publish:pactflow_auto_on_user_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_on_nil_commit_user_branch
+bundle exec rake pact:publish:pactflow_auto_off_user_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_off_nil_commit_nil_branch
+bundle exec rake pact:publish:pactflow_auto_off_empty_string_commit_nil_branch

data/example/scripts/publish-pact.sh

@@ -1,3 +1,27 @@
 # assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Must be executed from root directory of project.
 
-bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version=1.0.0 --tag master --verbose
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --branch branch-user-override --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --auto-detect-version-properties --tag-with-git-branch
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override --auto-detect-version-properties
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version commit-user-override --branch branch-user-override --auto-detect-version-properties --tag-with-git-branch
+
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -h branch-user-override -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -r -g
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override -r
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json -a commit-user-override -h branch-user-override -r -g

data/example/scripts/publish-provider-contract.sh

@@ -1,4 +1,5 @@
-# assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
+# Must be executed from root directory of project.
 
 bundle exec bin/pactflow publish-provider-contract $(dirname "$0")/oas.yml \
     --provider pactflow-cli-test-provider \

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

@@ -1,30 +1,41 @@
 require 'thor'
+require 'pact_broker/client/cli/thor_unknown_options_monkey_patch'
 require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     module CLI
       class AuthError < ::Thor::Error; end
-
       ##
       # Custom Thor task allows the following:
       #
       # `--option 1 --option 2` to be interpreted as `--option 1 2` (the standard Thor format for multiple value options)
       #
+
       class CustomThor < ::Thor
         using PactBroker::Client::HashRefinements
 
+        EM_DASH = "\u2014"
+
+        check_unknown_options!
+
         no_commands do
           def self.exit_on_failure?
             true
           end
 
+          # Provide a wrapper method that can be stubbed in tests
+          def self.exit_with_error_code
+            exit(1)
+          end
+
           def self.start given_args = ARGV, config = {}
+            check_for_mdash!(given_args)
             super(massage_args(given_args))
           end
 
           def self.massage_args argv
-            add_broker_config_from_environment_variables(turn_muliple_tag_options_into_array(argv))
+            add_broker_config_from_environment_variables(turn_muliple_tag_options_into_array(handle_help(argv)))
           end
 
           def self.add_broker_config_from_environment_variables argv
@@ -42,6 +53,25 @@ module PactBroker
             end
           end
 
+          # Thor expects help to be invoked by typing `help <command>`, which is very odd.
+          # Add support for `command --help|-h` by massaging the arguments into the format that Thor expects.
+          def self.handle_help(argv)
+            if argv.last == "--help" || argv.last == "-h"
+              argv[0..-3] + ["help", argv[-2]].compact
+            else
+              argv
+            end
+          end
+
+          def self.check_for_mdash!(argv)
+            if (word_with_mdash = argv.find{ |arg | arg.include?(EM_DASH) })
+              # Can't use the `raise Thor::Error` approach here (which is designed to show the error without a backtrace)
+              # because the exception is not handled within the Thor code, and will show an ugly backtrace.
+              $stdout.puts "The argument '#{word_with_mdash}' contains an em dash (the long dash you get in Microsoft Word when you type two short dashes in a row). Please replace it with a normal dash and try again."
+              exit_with_error_code
+            end
+          end
+
           # other task names, help, and the help shortcuts
           def self.known_first_arguments
             @known_first_arguments ||= tasks.keys + ::Thor::HELP_MAPPINGS + ['help']

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

@@ -1,4 +1,5 @@
 require "pact_broker/client/hash_refinements"
+require 'pact_broker/client/string_refinements'
 
 module PactBroker
   module Client
@@ -8,13 +9,14 @@ module PactBroker
 
       module PactCommands
         using PactBroker::Client::HashRefinements
+        using PactBroker::Client::StringRefinements
 
         def self.included(thor)
           thor.class_eval do
             desc 'publish 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 :consumer_app_version, aliases: "-a", desc: "The consumer application version"
             method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
-            method_option :auto_detect_version_properties, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps."
+            method_option :auto_detect_version_properties, aliases: "-r", type: :boolean, default: false, desc: "Automatically detect the repository commit, branch and build URL from known CI environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps."
             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. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps. Default: false"
             method_option :build_url, desc: "The build URL that created the pact"
@@ -23,8 +25,10 @@ module PactBroker
             shared_authentication_options
 
             def publish(*pact_files)
-              require 'pact_broker/client/error'
+              require "pact_broker/client/error"
+              require "pact_broker/client/git"
               validate_credentials
+              validate_consumer_version
               validate_pact_files(pact_files)
               result = publish_pacts(pact_files)
               $stdout.puts result.message
@@ -50,17 +54,21 @@ module PactBroker
                 end
               end
 
+              def validate_consumer_version
+                if consumer_app_version.blank?
+                  raise ::Thor::RequiredArgumentMissingError, "No value provided for required option --consumer-app-version"
+                end
+              end
 
               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,
+                  number: consumer_app_version,
                   branch: branch,
                   tags: tags,
-                  build_url: options.build_url,
-                  version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+                  build_url: build_url
                 }.compact
 
                 PactBroker::Client::PublishPacts.call(
@@ -99,25 +107,38 @@ module PactBroker
               end
 
               def tags
-                require 'pact_broker/client/git'
-
                 t = [*options.tag]
                 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)
+                  PactBroker::Client::Git.branch(raise_error: true)
                 else
                   options.branch
                 end
               end
 
-              def explict_auto_detect_version_properties
-                @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+              def consumer_app_version
+                if defined?(@consumer_app_version)
+                  @consumer_app_version
+                else
+                  @consumer_app_version = if options.consumer_app_version.blank? && options.auto_detect_version_properties
+                                            PactBroker::Client::Git.commit(raise_error: true)
+                                          else
+                                            options.consumer_app_version
+                                          end
+                end
+
+              end
+
+              def build_url
+                if options.build_url.blank? && options.auto_detect_version_properties
+                  PactBroker::Client::Git.build_url
+                else
+                  options.build_url
+                end
               end
             end
           end

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

@@ -0,0 +1,38 @@
+require "thor"
+require "term/ansicolor"
+
+# Monkey patch Thor so we can print out a warning when there are unknown options, rather than raising an error.
+# If PACT_BROKER_ERROR_ON_UNKNOWN_OPTION=true, raise the error, as the user will have opted in to this behaviour.
+# This is for backwards compatibility reasons, and in the next major version, the flag will be removed.
+
+class Thor
+  class Options < Arguments
+
+    alias_method :original_check_unknown!, :check_unknown!
+
+    # Replace the original check_unknown! method with an implementation
+    # that will print a warning rather than raising an error
+    # unless PACT_BROKER_ERROR_ON_UNKNOWN_OPTION=true is set.
+    def check_unknown!
+      if raise_error_on_unknown_options?
+        original_check_unknown!
+      else
+        check_unknown_and_warn
+      end
+    end
+
+    def raise_error_on_unknown_options?
+      ENV["PACT_BROKER_ERROR_ON_UNKNOWN_OPTION"] == "true"
+    end
+
+    def check_unknown_and_warn
+      begin
+        original_check_unknown!
+      rescue UnknownArgumentError => e
+        $stderr.puts(::Term::ANSIColor.yellow(e.message))
+        $stderr.puts(::Term::ANSIColor.yellow("This is a warning rather than an error so as not to break backwards compatibility. To raise an error for unknown options set PACT_BROKER_ERROR_ON_UNKNOWN_OPTION=true"))
+        $stderr.puts("\n")
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module PactBroker
               def self.shared_options_for_webhook_commands
                 method_option :request, banner: "METHOD", aliases: "-X", desc: "Webhook HTTP method", required: true
                 method_option :header, aliases: "-H", type: :array, desc: "Webhook Header"
-                method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
+                method_option :data, aliases: "-d", desc: "Webhook payload. Provide a JSON string (remember to escape characters appropriately for the shell) or a file path prefixed with the @ symbol, as per the curl usage for this flag."
                 method_option :user, aliases: "-u", desc: "Webhook basic auth username and password eg. username:password"
                 method_option :consumer, desc: "Consumer name"
                 method_option :consumer_label, desc: "Consumer label, mutually exclusive with consumer name"

data/lib/pact_broker/client/git.rb

@@ -2,7 +2,6 @@ require 'pact_broker/client/error'
 require 'pact_broker/client/hash_refinements'
 
 =begin
-
 BUILDKITE_BRANCH BUILDKITE_COMMIT https://buildkite.com/docs/pipelines/environment-variables
 CIRCLE_BRANCH CIRCLE_SHA1 https://circleci.com/docs/2.0/env-vars/
 TRAVIS_COMMIT TRAVIS_BRANCH - TRAVIS_PULL_REQUEST_BRANCH TRAVIS_PULL_REQUEST_SHA https://docs.travis-ci.com/user/environment-variables/
@@ -26,18 +25,21 @@ module PactBroker
       using PactBroker::Client::HashRefinements
 
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
+      COMMIT_COMMAND = 'git rev-parse HEAD'.freeze
       BRANCH_ENV_VAR_NAMES = %w{GITHUB_HEAD_REF GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH BUILD_SOURCEBRANCHNAME CIRRUS_BRANCH}.freeze
       COMMIT_ENV_VAR_NAMES = %w{GITHUB_SHA BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT BUILD_SOURCEVERSION CIRRUS_CHANGE_IN_REPO}
       BUILD_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
 
-      def self.commit
-        find_commit_from_env_vars
+      def self.commit(options)
+        find_commit_from_env_vars || commit_from_git_command(options[:raise_error])
       end
 
       def self.branch(options)
         find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command(options[:raise_error])
       end
 
+      # This does not belong in the Git module.
+      # TODO move it.
       def self.build_url
         github_build_url || BUILD_URL_ENV_VAR_NAMES.collect{ | name | value_from_env_var(name) }.compact.first
       end
@@ -79,6 +81,10 @@ module PactBroker
         branch_names.size == 1 ? branch_names[0] : nil
       end
 
+      def self.commit_from_git_command(raise_error)
+        execute_git_commit_command(raise_error)
+      end
+
       def self.validate_branch_names(branch_names)
         if branch_names.size == 0
           raise PactBroker::Client::Error, "Command `#{COMMAND}` didn't return anything that could be identified as the current branch."
@@ -93,6 +99,17 @@ module PactBroker
         `#{COMMAND}`
       end
 
+      def self.execute_git_commit_command(raise_error)
+        `#{COMMIT_COMMAND}`
+      rescue StandardError => e
+        if raise_error
+          raise PactBroker::Client::Error,
+                "Could not determine current git commit using command `#{COMMIT_COMMAND}`. #{e.class} #{e.message}"
+        else
+          return nil
+        end
+      end
+
       def self.execute_and_parse_command(raise_error)
         execute_git_command
           .split("\n")

data/lib/pact_broker/client/hal/http_client.rb

@@ -71,6 +71,12 @@ module PactBroker
             # See https://github.com/pact-foundation/pact-ruby-standalone/issues/57
             http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
             http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+
+            if x509_certificate?
+              http.cert = OpenSSL::X509::Certificate.new(x509_client_cert_file)
+              http.key = OpenSSL::PKey::RSA.new(x509_client_key_file)
+            end
+
             if disable_ssl_verification?
               if verbose?
                 $stdout.puts("SSL verification is disabled")
@@ -127,6 +133,19 @@ module PactBroker
           verbose || ENV["VERBOSE"] == "true"
         end
 
+        def x509_certificate?
+          ENV['X509_CLIENT_CERT_FILE'] && ENV['X509_CLIENT_CERT_FILE'] != '' &&
+            ENV['X509_CLIENT_KEY_FILE'] && ENV['X509_CLIENT_KEY_FILE'] != ''
+        end
+
+        def x509_client_cert_file
+          File.read(ENV['X509_CLIENT_CERT_FILE'])
+        end
+
+        def x509_client_key_file
+          File.read(ENV['X509_CLIENT_KEY_FILE'])
+        end
+
         def disable_ssl_verification?
           ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
         end

data/lib/pact_broker/client/merge_pacts.rb

@@ -53,14 +53,17 @@ module PactBroker
       end
 
       def almost_duplicate_message(original, new_interaction)
-        "Two interactions have been found with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response. " +
+        "Two interactions have been found with same description (#{new_interaction[:description].inspect}) and provider state (#{(new_interaction[:providerState] || new_interaction[:providerStates]).inspect}) but a different request or response. " +
           "Please use a different description or provider state, or hard-code any random data.\n\n" +
           original.to_json + "\n\n" + new_interaction.to_json
       end
 
       def same_description_and_state? original, additional
         original[:description] == additional[:description] &&
-          original[:providerState] == additional[:providerState]
+          (
+            (original[:providerState] && original[:providerState] == additional[:providerState]) ||
+              (original[:providerStates] && original[:providerStates] == additional[:providerStates])
+          )
       end
     end
   end

data/lib/pact_broker/client/publish_pacts_the_old_way.rb

@@ -42,7 +42,7 @@ module PactBroker
 
       private
 
-      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_number, :branch, :tags, :build_url, :pact_broker_client_options, :version_required
+      attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_number, :branch, :tags, :build_url, :pact_broker_client_options
 
       def pact_broker_client
         @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)