pact_broker-client 1.73.0 → 1.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfeaaf44e2dc8a19f90bd55795542da931dec46853371ea5a51955ccb1f3a39f
-  data.tar.gz: c9d00e81e65a20bc6f8a0b38c5c2af2c135e05266906f3b7bd45207a8f7e7b07
+  metadata.gz: 84c25ce85cb110411ce145b803e155a0cb8c30a356bb3a6dc8239ab14fbc97c4
+  data.tar.gz: 57a8dcaf85657dc9f99c233abf1cbd1fa0672e0c942ba8d0f009907afda87309
 SHA512:
-  metadata.gz: 521599522cf724dd5f0f28becbcc7faf2695c45e1050892ae0494573dc220d22427712548d4a1c5395d7caf9d59263405ff4b8158fdc2634ba8416292afc3447
-  data.tar.gz: 987e4569edfac0db3e0bc81483b67cee1d73803422e4dea145456dd61dd7afdad2ad632190cba28eb91501069fce9aa6a49b661cb6398be8a865a6dd681a81aa
+  metadata.gz: 732c56c1c831f3f154e9be33ef949208057db7705a7bca291d1a356923729acda5f762ff2e57ab51409afa71e425eec7bc775964816de74d215229a66583bedf
+  data.tar.gz: 97f2acafe53b570a5945d1e3c8750cf6f35f5a122ba58e5b8646ba2dc2b1702ad44489ab21ba53fa19220aca569bd8495c5ce6f694b9ec1784caf8a247cd6fed

data/.github/workflows/release_gem.yml

@@ -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/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,14 @@
+<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)
 

data/README.md

@@ -59,18 +59,18 @@ In the next major version, an error will be raised by default.
 
 ```
 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.

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/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/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/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)

data/lib/pact_broker/client/tasks/publication_task.rb

@@ -1,6 +1,8 @@
 require 'rake/tasklib'
 require 'pact_broker/client/git'
 require 'pact_broker/client/hash_refinements'
+require 'pact_broker/client/string_refinements'
+require "pact_broker/client/error"
 
 =begin
 require pact_broker/client/tasks
@@ -19,57 +21,52 @@ module PactBroker
   module Client
     class PublicationTask < ::Rake::TaskLib
       using PactBroker::Client::HashRefinements
+      using PactBroker::Client::StringRefinements
 
-      attr_accessor :pattern, :pact_broker_base_url, :consumer_version, :tag, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
-      attr_reader :auto_detect_version_properties, :branch, :build_url
+      attr_accessor :pattern, :pact_broker_base_url, :tag, :build_url, :write_method, :tag_with_git_branch, :pact_broker_basic_auth, :pact_broker_token
+      attr_reader :auto_detect_version_properties, :build_url
+      attr_writer :consumer_version, :branch
       alias_method :tags=, :tag=
       alias_method :tags, :tag
 
       def initialize name = nil, &block
         @name = name
         @auto_detect_version_properties = nil
-        @version_required = false
         @pattern = 'spec/pacts/*.json'
         @pact_broker_base_url = 'http://pact-broker'
         rake_task &block
       end
 
       def auto_detect_version_properties= auto_detect_version_properties
-        @version_required = version_required || auto_detect_version_properties
         @auto_detect_version_properties = auto_detect_version_properties
       end
-
-      def branch= branch
-        @version_required = version_required || !!branch
-        @branch = branch
-      end
-
-      def build_url= build_url
-        @version_required = version_required || !!build_url
-        @build_url = build_url
-      end
-
+      
       private
 
-      attr_reader :version_required
-
       def rake_task &block
         namespace :pact do
           desc "Publish pacts to pact broker"
           task task_name do
             block.call(self)
+            validate!
             require 'pact_broker/client/publish_pacts'
             pact_broker_client_options = { write: write_method, token: pact_broker_token }
             pact_broker_client_options[:basic_auth] = pact_broker_basic_auth if pact_broker_basic_auth && pact_broker_basic_auth.any?
             pact_broker_client_options.compact!
-            consumer_version_params = { number: consumer_version, branch: the_branch, build_url: build_url, tags: all_tags, version_required: version_required }.compact
+            consumer_version_params = { number: consumer_version, branch: branch, build_url: build_url, tags: all_tags }.compact
             result = PactBroker::Client::PublishPacts.new(pact_broker_base_url, FileList[pattern], consumer_version_params, {}, pact_broker_client_options).call
             $stdout.puts result.message
-            raise "One or more pacts failed to be published" unless result.success
+            raise PactBroker::Client::Error.new("One or more pacts failed to be published") unless result.success
           end
         end
       end
 
+      def validate!
+        if consumer_version.blank?
+          raise PactBroker::Client::Error.new("A consumer version must be provided")
+        end
+      end
+
       def task_name
         @name ? "publish:#{@name}" : "publish"
       end
@@ -80,11 +77,31 @@ module PactBroker
         t.compact.uniq
       end
 
-      def the_branch
-        if branch.nil? && auto_detect_version_properties != false
-          PactBroker::Client::Git.branch(raise_error: auto_detect_version_properties == true)
+      # Attempt to detect the branch automatically, but don't raise an error if the branch can't be found
+      # unless the user has explicitly enabled auto_detect_version_properties.
+      # This approach is an attempt to include the branch without the user having to explicitly
+      # set it, because people tend to not update things.
+      def branch
+        if @branch.nil? && auto_detect_version_properties != false
+          @branch = PactBroker::Client::Git.branch(raise_error: auto_detect_version_properties == true)
+        else
+          @branch
+        end
+      end
+
+      def consumer_version
+        if @consumer_version.nil? && @auto_detect_version_properties
+          @consumer_version = PactBroker::Client::Git.commit(raise_error: true)
+        else
+          @consumer_version
+        end
+      end
+
+      def build_url
+        if @build_url.nil? && @auto_detect_version_properties
+          @build_url = PactBroker::Client::Git.build_url
         else
-          branch
+          @build_url
         end
       end
     end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.73.0'
+    VERSION = '1.74.0'
   end
 end

data/spec/fixtures/MyConsumer-MyProvider (1).json

@@ -0,0 +1,37 @@
+{
+  "consumer": {
+    "name": "MyConsumer"
+  },
+  "interactions": [
+    {
+      "description": "request",
+      "providerStates": [
+        {
+          "name": "state 2"
+        }
+      ],
+      "request": {
+        "method": "GET",
+        "path": "/2"
+      },
+      "response": {
+        "status": 200
+      }
+    }
+  ],
+  "metadata": {
+    "pact-js": {
+      "version": "11.0.2"
+    },
+    "pactRust": {
+      "ffi": "0.4.0",
+      "models": "1.0.4"
+    },
+    "pactSpecification": {
+      "version": "3.0.0"
+    }
+  },
+  "provider": {
+    "name": "MyProvider"
+  }
+}

data/spec/fixtures/MyConsumer-MyProvider.json

@@ -0,0 +1,37 @@
+{
+  "consumer": {
+    "name": "MyConsumer"
+  },
+  "interactions": [
+    {
+      "description": "request",
+      "providerStates": [
+        {
+          "name": "state 1"
+        }
+      ],
+      "request": {
+        "method": "GET",
+        "path": "/1"
+      },
+      "response": {
+        "status": 200
+      }
+    }
+  ],
+  "metadata": {
+    "pact-js": {
+      "version": "11.0.2"
+    },
+    "pactRust": {
+      "ffi": "0.4.0",
+      "models": "1.0.4"
+    },
+    "pactSpecification": {
+      "version": "3.0.0"
+    }
+  },
+  "provider": {
+    "name": "MyProvider"
+  }
+}

data/spec/integration/can_i_deploy_spec.rb

@@ -18,15 +18,6 @@ describe "pact-broker can-i-deploy", skip_windows: true do
     end
   end
 
-  context "when the pacticipants can't be deployed" do
-    subject { `bundle exec bin/pact-broker can-i-deploy --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

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

@@ -4,10 +4,12 @@ require 'pact_broker/client/git'
 
 module PactBroker::Client::CLI
   describe Broker do
-    describe ".broker" do
+    describe '.broker' do
       before do
         allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(result)
-        allow(PactBroker::Client::Git).to receive(:branch).and_return("bar")
+        allow(PactBroker::Client::Git).to receive(:branch).and_return('bar')
+        allow(PactBroker::Client::Git).to receive(:commit).and_return('6.6.6')
+        allow(PactBroker::Client::Git).to receive(:build_url).and_return('build_url')
         subject.options = OpenStruct.new(minimum_valid_options)
         allow($stdout).to receive(:puts)
       end
@@ -30,7 +32,7 @@ module PactBroker::Client::CLI
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             "http://pact-broker",
             ["spec/support/cli_test_pacts/foo.json"],
-            { number: "1.2.3", tags: [], version_required: false },
+            { number: "1.2.3", tags: [] },
             {},
             { pact_broker_base_url: 'http://pact-broker' }
           )
@@ -151,7 +153,7 @@ module PactBroker::Client::CLI
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
             anything,
-            hash_including(branch: "main", version_required: true),
+            hash_including(branch: "main"),
             anything,
             anything
           )
@@ -159,50 +161,55 @@ module PactBroker::Client::CLI
         end
       end
 
-      context "with --auto-detect-version-properties on by default" do
+      context "with --auto-detect-version-properties specified" do
         before do
           subject.options = OpenStruct.new(
-            minimum_valid_options.merge(auto_detect_version_properties: true)
+            minimum_valid_options.merge(auto_detect_version_properties: true, consumer_app_version: nil)
           )
-          allow(subject).to receive(:explict_auto_detect_version_properties).and_return(false)
         end
 
         it "determines the git branch name" do
-          expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: false)
+          expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
           invoke_broker
         end
 
-        it "passes in the auto detected branch option with version_required: false" do
+        it "passes in the auto detected branch option" do
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
             anything,
-            hash_including(branch: "bar", version_required: false),
+            hash_including(branch: "bar"),
             anything,
             anything
           )
           invoke_broker
         end
-      end
 
+        it 'determines the commit sha' do
+          expect(PactBroker::Client::Git).to receive(:commit).with(raise_error: true)
+          invoke_broker
+        end
 
-      context "with --auto-detect-version-properties specified explicitly" do
-        before do
-          subject.options = OpenStruct.new(
-            minimum_valid_options.merge(auto_detect_version_properties: true)
+        it 'passes in the auto detected commit sha option' do
+          expect(PactBroker::Client::PublishPacts).to receive(:call).with(
+            anything,
+            anything,
+            hash_including(number: '6.6.6'),
+            anything,
+            anything
           )
-          allow(subject).to receive(:explict_auto_detect_version_properties).and_return(true)
+          invoke_broker
         end
 
-        it "determines the git branch name" do
-          expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
+        it 'determines the build URL' do
+          expect(PactBroker::Client::Git).to receive(:build_url)
           invoke_broker
         end
 
-        it "passes in the auto detected branch option with version_required: true" do
+        it 'passes in the auto detected build URL' do
           expect(PactBroker::Client::PublishPacts).to receive(:call).with(
             anything,
             anything,
-            hash_including(branch: "bar", version_required: true),
+            hash_including(build_url: 'build_url'),
             anything,
             anything
           )
@@ -220,7 +227,7 @@ module PactBroker::Client::CLI
             expect(PactBroker::Client::PublishPacts).to receive(:call).with(
               anything,
               anything,
-              hash_including(branch: "specified-branch", version_required: true),
+              hash_including(branch: "specified-branch"),
               anything,
               anything
             )
@@ -248,6 +255,16 @@ module PactBroker::Client::CLI
         end
       end
 
+      context "with no consumer_app_version" do
+        before do
+          subject.options.consumer_app_version = nil
+        end
+
+        it "raises an error" do
+          expect { invoke_broker }.to raise_error ::Thor::RequiredArgumentMissingError, /--consumer-app-version/
+        end
+      end
+
       context "with basic auth options specified" do
         before do
           subject.options = OpenStruct.new(

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

@@ -166,6 +166,32 @@ module PactBroker
             expect(subject).to eq expected_merge
           end
         end
+
+        describe "with v3 pacts" do
+          let(:pact_hash_1) { JSON.parse(File.read("spec/fixtures/MyConsumer-MyProvider.json"), symbolize_names: true) }
+          let(:pact_hash_2) { JSON.parse(File.read("spec/fixtures/MyConsumer-MyProvider (1).json"), symbolize_names: true) }
+          let(:pact_hashes) { [pact_hash_1, pact_hash_2] }
+
+          subject { MergePacts.call(pact_hashes) }
+
+          context "when there are no conflicts and no duplicates" do
+            it "adds all the interactions to the merged file" do
+              expect(subject[:interactions].size).to eq 2
+            end
+          end
+
+          context "when there is a conflict" do
+            let(:pact_hash_2) do
+              hash = JSON.parse(File.read("spec/fixtures/MyConsumer-MyProvider.json"), symbolize_names: true)
+              hash[:interactions].first[:request][:path] = "/a-different-path"
+              hash
+            end
+
+            it "raises an error with a message that contains the provider states of the conflicting interactions" do
+              expect { subject }.to raise_error PactMergeError, /state 1/
+            end
+          end
+        end
       end
     end
   end

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

@@ -37,7 +37,6 @@ module PactBroker
       let(:tags) { nil }
       let(:branch) { nil }
       let(:build_url) { nil }
-      let(:version_required) { false }
       let(:pact_hash) { { consumer: { name: 'Consumer'}, provider: { name: 'Provider' }, interactions: [] } }
       let(:pact_hash_2) { {consumer: { name: 'Foo' }, provider: { name: 'Bar' }, interactions: [] } }
       let(:pacts_client) { instance_double("PactBroker::ClientSupport::Pacts")}
@@ -48,8 +47,7 @@ module PactBroker
           number: consumer_version,
           branch: branch,
           tags: tags,
-          build_url: build_url,
-          version_required: version_required
+          build_url: build_url
         }
       end
       let(:pact_broker_client_options) do

data/spec/lib/pact_broker/client/tasks/publication_task_spec.rb

@@ -5,7 +5,6 @@ require 'pact_broker/client/command_result'
 
 module PactBroker::Client
   describe PublicationTask do
-
     before do
       @consumer_version = "1.2.3"
     end
@@ -19,6 +18,8 @@ module PactBroker::Client
       allow(PactBroker::Client::PublishPacts).to receive(:new).and_return(publish_pacts)
       allow(FileList).to receive(:[]).with(pattern).and_return(pact_file_list)
       allow(PactBroker::Client::Git).to receive(:branch).and_return('foo')
+      allow(PactBroker::Client::Git).to receive(:commit).and_return('6.6.6')
+      allow(PactBroker::Client::Git).to receive(:build_url).and_return("build_url")
       allow($stdout).to receive(:puts)
     end
 
@@ -33,7 +34,7 @@ module PactBroker::Client
 
       context "when pacts are succesfully published" do
         it "invokes PublishPacts with the default values" do
-          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: '1.2.3', branch: "foo", tags: [], version_required: false}, {}, {}).and_return(publish_pacts)
+          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: '1.2.3', branch: "foo", tags: [] }, {}, {}).and_return(publish_pacts)
           expect(publish_pacts).to receive(:call).and_return(result)
           Rake::Task['pact:publish'].execute
         end
@@ -57,7 +58,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the write method set" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: "1.2.3", branch: "foo", tags: [], version_required: false }, {}, {write: :merge}).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: "1.2.3", branch: "foo", tags: [] }, {}, {write: :merge}).and_return(publish_pacts)
         expect(publish_pacts).to receive(:call).and_return(result)
         Rake::Task['pact:publish:merge'].execute
       end
@@ -87,81 +88,92 @@ module PactBroker::Client
     context "when auto_detect_version_properties is explicitly set to true" do
       before :all do
         PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_true) do | task |
-          task.consumer_version = '1.2.3'
           task.auto_detect_version_properties = true
         end
       end
 
-      it "gets the git branch name" do
+      # Don't usually put 3 expects into the one it block, but if I separate them,
+      # only the first it block passes for some reason that I can't work out.
+      it "gets the commit, build_url and branch" do
+        expect(PactBroker::Client::Git).to receive(:commit).with(raise_error: true)
+        expect(PactBroker::Client::Git).to receive(:build_url)
         expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: true)
         Rake::Task['pact:publish:git_branch_auto_detect_true'].execute
       end
 
-      it "invokes PublishPacts with the branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything, anything).and_return(publish_pacts)
+      it "invokes PublishPacts with the branch name and build URL" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(number: "6.6.6", branch: "foo", build_url: "build_url"), anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch_auto_detect_true'].execute
       end
     end
 
-    context "when auto_detect_version_properties is explicitly set to true and the branch is specified" do
+    context "when auto_detect_version_properties is explicitly set to true and the auto detectable attributes are specified" do
       before :all do
-        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_true_with_branch) do | task |
-          task.consumer_version = '1.2.3'
+        PactBroker::Client::PublicationTask.new(:auto_detect_true_with_attributes_specified) do | task |
           task.auto_detect_version_properties = true
-          task.branch = "main"
+          task.consumer_version = '1.2.3'
+          task.branch = "feat/foo"
+          task.consumer_version = "3"
+          task.build_url = "some_build"
         end
       end
 
-      it "does not get the branch name" do
+      it "does not get the commit, branch or build URL from Git" do
+        expect(PactBroker::Client::Git).to_not receive(:commit)
+        expect(PactBroker::Client::Git).to_not receive(:build_url)
         expect(PactBroker::Client::Git).to_not receive(:branch)
-        Rake::Task['pact:publish:git_branch_auto_detect_true_with_branch'].execute
+        Rake::Task['pact:publish:auto_detect_true_with_attributes_specified'].execute
       end
 
-      it "invokes PublishPacts with the specified branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "main"), anything, anything).and_return(publish_pacts)
-        Rake::Task['pact:publish:git_branch_auto_detect_true_with_branch'].execute
+      it "invokes PublishPacts with the specified attributes" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(number: "3", branch: "feat/foo", build_url: "some_build"), anything, anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:auto_detect_true_with_attributes_specified'].execute
       end
     end
 
     context "when auto_detect_version_properties is explicitly set to false" do
       before :all do
-        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_false) do | task |
-          task.consumer_version = '1.2.3'
+        PactBroker::Client::PublicationTask.new(:auto_detect_false) do | task |
           task.auto_detect_version_properties = false
+          task.consumer_version = '1.2.3'
+          task.branch = "feat/foo"
+          task.consumer_version = "3"
+          task.build_url = "some_build"
         end
       end
 
-      it "does not get the git branch name" do
+      it "does not get the commit, branch or build URL from Git" do
+        expect(PactBroker::Client::Git).to_not receive(:commit)
+        expect(PactBroker::Client::Git).to_not receive(:build_url)
         expect(PactBroker::Client::Git).to_not receive(:branch)
-        Rake::Task['pact:publish:git_branch_auto_detect_false'].execute
+        Rake::Task['pact:publish:auto_detect_false'].execute
       end
 
-      it "invokes PublishPacts without the branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_not_including(branch: "foo"), anything, anything).and_return(publish_pacts)
-        Rake::Task['pact:publish:git_branch_auto_detect_false'].execute
+      it "invokes PublishPacts with the specified attributes" do
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(number: "3", branch: "feat/foo", build_url: "some_build"), anything, anything).and_return(publish_pacts)
+        Rake::Task['pact:publish:auto_detect_false'].execute
       end
     end
 
-    context "when auto_detect_version_properties is left as its default" do
+    context "when auto_detect_version_properties is left as its default and the branch is not specified" do
       before :all do
-        PactBroker::Client::PublicationTask.new(:git_branch_auto_detect_default) do | task |
+        PactBroker::Client::PublicationTask.new(:auto_detect_default) do | task |
           task.consumer_version = '1.2.3'
         end
       end
 
-      it "gets the git branch name" do
+      it "gets the git branch name but won't raise an error if it can't be determined" do
         expect(PactBroker::Client::Git).to receive(:branch).with(raise_error: false)
-        Rake::Task['pact:publish:git_branch_auto_detect_default'].execute
+        Rake::Task['pact:publish:auto_detect_default'].execute
       end
 
-      it "invokes PublishPacts with the branch name" do
+      it "invokes PublishPacts with the branch name if found" do
         expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"),anything, anything).and_return(publish_pacts)
-        Rake::Task['pact:publish:git_branch_auto_detect_default'].execute
+        Rake::Task['pact:publish:auto_detect_default'].execute
       end
     end
 
     describe "custom task" do
-
       before :all do
         @pact_broker_base_url = "http://some-host"
         @pattern = "pact/*.json"
@@ -184,7 +196,7 @@ module PactBroker::Client
         expect(PactBroker::Client::PublishPacts).to receive(:new).with(
           @pact_broker_base_url,
           pact_file_list,
-          { number: "1.2.3", tags: [@tag], branch: "foo", version_required: false},
+          { number: "1.2.3", tags: [@tag], branch: "foo" },
           {},
           { basic_auth: @pact_broker_basic_auth, token: @pact_broker_token }
         )
@@ -193,6 +205,17 @@ module PactBroker::Client
       end
     end
 
+    describe "with no consumer version" do
+      before :all do
+        PactBroker::Client::PublicationTask.new(:no_consumer_version) do
+        end
+      end
+
+      it "raises an error" do
+        expect { Rake::Task['pact:publish:no_consumer_version'].execute }.to raise_error PactBroker::Client::Error, /consumer version/
+      end
+    end
+
     describe "timing of block execution" do
       before :all do
         PactBroker::Client::PublicationTask.new(:exception) do | task |

data/tasks/pact.rake

@@ -59,3 +59,82 @@ PactBroker::Client::PublicationTask.new(:pactflow_pact_foundation) do | task |
   task.pact_broker_token = ENV["PACT_BROKER_TOKEN_PACT_FOUNDATION"]
   task.build_url = PactBroker::Client::Git.build_url
 end
+PactBroker::Client::PublicationTask.new(:pactflow_auto_on_nil_commit_nil_branch) do | task |
+  require 'pact_broker/client/version'
+  # publish with auto detected commit and branch
+  task.auto_detect_version_properties = true
+  task.branch = nil
+  task.consumer_version = nil
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+PactBroker::Client::PublicationTask.new(:pactflow_auto_on_user_commit_user_branch) do | task |
+  require 'pact_broker/client/version'
+  # always accept user provided commit and branch
+  # even when auto_detect_version_properties enabled
+  task.auto_detect_version_properties = true
+  task.branch = 'user-provided-branch'
+  task.consumer_version = 'user-provided-version'
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+
+PactBroker::Client::PublicationTask.new(:pactflow_auto_on_user_commit_nil_branch) do | task |
+  require 'pact_broker/client/version'
+  # auto detect branch, always accept user provided commit
+  # even where set to auto_detect_version_properties
+  task.auto_detect_version_properties = true
+  task.branch = nil
+  task.consumer_version = 'user-provided-version'
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+PactBroker::Client::PublicationTask.new(:pactflow_auto_on_nil_commit_user_branch) do | task |
+  require 'pact_broker/client/version'
+  # auto detect commit, always accept user provided branch
+  # even where set to auto_detect_version_properties
+  task.auto_detect_version_properties = true
+  task.branch = 'user-provided-branch'
+  task.consumer_version = nil
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+
+PactBroker::Client::PublicationTask.new(:pactflow_auto_off_user_commit_nil_branch) do | task |
+  require 'pact_broker/client/version'
+  # accept publish without branch, but has user provided commit
+  # auto_detect_version_properties off
+  task.auto_detect_version_properties = false
+  task.branch = nil
+  task.consumer_version = 'user-provided-version'
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+
+PactBroker::Client::PublicationTask.new(:pactflow_auto_off_nil_commit_nil_branch) do | task |
+  require 'pact_broker/client/version'
+  # reject publish without user provided commit
+  # auto_detect_version_properties off
+  task.auto_detect_version_properties = false
+  task.branch = nil
+  task.consumer_version = nil
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end
+PactBroker::Client::PublicationTask.new(:pactflow_auto_off_empty_string_commit_nil_branch) do | task |
+  require 'pact_broker/client/version'
+  # reject publish without user provided commit
+  # auto_detect_version_properties off
+  task.auto_detect_version_properties = false
+  task.branch = nil
+  task.consumer_version = ''
+  task.pact_broker_base_url = ENV['PACT_BROKER_BASE_URL']
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.73.0
+  version: 1.74.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -145,6 +145,7 @@ files:
 - example/scripts/deploy-consumer.sh
 - example/scripts/oas.yml
 - example/scripts/pact.json
+- example/scripts/publish-pact-rake.sh
 - example/scripts/publish-pact.sh
 - example/scripts/publish-provider-contract.sh
 - example/scripts/publish-verification.sh
@@ -255,6 +256,8 @@ files:
 - script/update-cli-usage-in-readme.rb
 - script/verification-results.txt
 - script/webhook-commands.sh
+- spec/fixtures/MyConsumer-MyProvider (1).json
+- spec/fixtures/MyConsumer-MyProvider.json
 - spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt
@@ -379,6 +382,8 @@ signing_key:
 specification_version: 4
 summary: See description
 test_files:
+- spec/fixtures/MyConsumer-MyProvider (1).json
+- spec/fixtures/MyConsumer-MyProvider.json
 - spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt