pact_broker-client 1.52.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c645adf22b85e738f227eec38baf09fe06241aeaeb4c75abc4c4558c66c2716f
-  data.tar.gz: e32efad31615c7335df1c36dea365fcc5e001574143a3df3d98e23c1c5c84c71
+  metadata.gz: 449848d07d065628a69bd18154f106f438cadcb51cccd11a3e5214000a17dce2
+  data.tar.gz: 187e875cee98166e6fe85f2bd76314ac642a131a8a4cd48f861694eac5daf002
 SHA512:
-  metadata.gz: 02c18bab0a1d08d568524ccd0a48d526e2aebf3d17db29dc83884f82db4c4ebf9864fd2e6d3de01ab6b11febc658d94efe28a817f351266059771fff8a95a446
-  data.tar.gz: d647f077b021640b520babbc4e7ba5ed8bd4d460ebe826e98900f356bbd79dda96ee7c425d0ee6eeff7aa2648f996ded578f22a24708b8efdf5725cfd8fd97b9
+  metadata.gz: 354fb2790242a8b7c64f568306013055f07223fd5f016d441f0fb6addb479ac1ed59467733a5d44264d5800d13500b9b652964cc7fc34341778b5472c5c7e3c0
+  data.tar.gz: 0fc195c4957214522ecce949daaa9b08f84f5024c82ceea0bc16cf197493b6fd042fb1886c1da31dec25767a2ef3fd439eaf6894cb422282b8654901e796f4f1

data/.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
       - run: |
           rm -rf spec/pacts/*
           bundle exec rspec spec/service_providers/
-          bundle exec rake pact:publish:pactflow
+          VERBOSE=true bundle exec rake pact:publish:pactflow
         env:
           PACT_BROKER_TOKEN: ${{ secrets.PACTFLOW_PACT_OSS_TOKEN }}
           PACT_BROKER_FEATURES: ${{ matrix.feature }}

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+<a name="v1.56.0"></a>
+### v1.56.0 (2021-10-06)
+
+#### Features
+
+* add pacticipant label options to webhook create/update commands (#96)	 ([710293f](/../../commit/710293f))
+
+<a name="v1.55.0"></a>
+### v1.55.0 (2021-10-03)
+
+#### Features
+
+* support Github Actions environment variables for --tag-with-git-branch	 ([2b8dac5](/../../commit/2b8dac5))
+
+<a name="v1.54.0"></a>
+### v1.54.0 (2021-10-01)
+
+#### Features
+
+* disable SSL verification for HAL client and HTTParty client when environment variable PACT_DISABLE_SSL_VERIFICATION=true	 ([470aafa](/../../commit/470aafa))
+* support setting the --main-branch for a pacticipant	 ([1f18e70](/../../commit/1f18e70))
+
+<a name="v1.53.0"></a>
+### v1.53.0 (2021-09-29)
+
+#### Features
+
+* allow pacts to be published using the old API by setting the environment variable PACT_BROKER_FEATURES=publish_pacts_using_old_api	 ([7c34132](/../../commit/7c34132))
+
 <a name="v1.52.0"></a>
 ### v1.52.0 (2021-09-29)
 

data/README.md

@@ -517,6 +517,8 @@ Options:
               # Pacticipant name
       [--display-name=DISPLAY_NAME]        
               # Display name
+      [--main-branch=MAIN_BRANCH]          
+              # The main development branch of the pacticipant repository
       [--repository-url=REPOSITORY_URL]    
               # The repository URL of the pacticipant
   -o, [--output=OUTPUT]                    
@@ -605,8 +607,12 @@ Options:
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]                                                        
               # Consumer name
+      [--consumer-label=CONSUMER_LABEL]                                                        
+              # Consumer label
       [--provider=PROVIDER]                                                        
               # Provider name
+      [--provider-label=PROVIDER_LABEL]                                                        
+              # Provider label
       [--description=DESCRIPTION]                                                  
               # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]                
@@ -661,8 +667,12 @@ Options:
               # Webhook basic auth username and password eg. username:password
       [--consumer=CONSUMER]                                                        
               # Consumer name
+      [--consumer-label=CONSUMER_LABEL]                                                        
+              # Consumer label
       [--provider=PROVIDER]                                                        
               # Provider name
+      [--provider-label=PROVIDER_LABEL]                                                        
+              # Provider label
       [--description=DESCRIPTION]                                                  
               # Webhook description
       [--contract-content-changed], [--no-contract-content-changed]                

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

@@ -64,10 +64,14 @@
 
 * [A request to create a webhook with a JSON body for a consumer and provider](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_and_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to create a webhook with a JSON body for a consumer specified by a label](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_specified_by_a_label)
+
 * [A request to create a webhook with a JSON body for a consumer that does not exist](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_that_does_not_exist)
 
 * [A request to create a webhook with a JSON body for a provider](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to create a webhook with a JSON body for a provider specified by a label](#a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_specified_by_a_label)
+
 * [A request to create a webhook with a non-JSON body for a consumer and provider](#a_request_to_create_a_webhook_with_a_non-JSON_body_for_a_consumer_and_provider_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
 * [A request to create a webhook with every possible event type](#a_request_to_create_a_webhook_with_every_possible_event_type_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
@@ -1089,6 +1093,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1222,6 +1236,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1276,6 +1300,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1327,6 +1361,80 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_with_a_JSON_body_for_a_consumer_specified_by_a_label"></a>
+Upon receiving **a request to create a webhook with a JSON body for a consumer specified by a label** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      },
+      "username": "username",
+      "password": "password"
+    },
+    "consumer": {
+      "label": "consumer_label"
+    }
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1433,6 +1541,80 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "_links": {
+      "self": {
+        "href": "http://localhost:1234/some-url",
+        "title": "A title"
+      }
+    }
+  }
+}
+```
+<a name="a_request_to_create_a_webhook_with_a_JSON_body_for_a_provider_specified_by_a_label"></a>
+Upon receiving **a request to create a webhook with a JSON body for a provider specified by a label** from Pact Broker Client, with
+```json
+{
+  "method": "post",
+  "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+  "headers": {
+    "Content-Type": "application/json",
+    "Accept": "application/hal+json"
+  },
+  "body": {
+    "description": "a webhook",
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
+    "request": {
+      "url": "https://webhook",
+      "method": "POST",
+      "headers": {
+        "Foo": "bar",
+        "Bar": "foo"
+      },
+      "body": {
+        "some": "body"
+      },
+      "username": "username",
+      "password": "password"
+    },
+    "provider": {
+      "label": "provider_label"
+    }
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 201,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1482,6 +1664,14 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": "<xml></xml>"
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -1545,6 +1735,28 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      },
+      {
+        "name": "contract_published"
+      },
+      {
+        "name": "provider_verification_published"
+      },
+      {
+        "name": "provider_verification_succeeded"
+      },
+      {
+        "name": "provider_verification_failed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",
@@ -2550,6 +2762,16 @@ Pact Broker will respond with:
   },
   "body": {
     "description": "a webhook",
+    "request": {
+      "body": {
+        "some": "body"
+      }
+    },
+    "events": [
+      {
+        "name": "contract_content_changed"
+      }
+    ],
     "_links": {
       "self": {
         "href": "http://localhost:1234/some-url",

data/lib/pact_broker/client/base_client.rb

@@ -54,6 +54,8 @@ module PactBroker
         self.class.headers('Authorization' => "Bearer #{client_options[:token]}") if client_options[:token]
         self.class.ssl_ca_file(ENV['SSL_CERT_FILE']) if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
         self.class.ssl_ca_path(ENV['SSL_CERT_DIR']) if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+        @default_options = {}
+        @default_options[:verify] = false if (ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true')
       end
 
       def default_request_headers
@@ -102,15 +104,15 @@ module PactBroker
       end
 
       def patch url, options
-        self.class.patch(url, options.merge(body: options[:body].to_json))
+        self.class.patch(url, @default_options.merge(options.merge(body: options[:body].to_json)))
       end
 
-      def put url, *args
-        self.class.put(url, *args)
+      def put url, options = {}, &block
+        self.class.put(url, @default_options.merge(options), &block)
       end
 
-      def get url, *args
-        self.class.get(url, *args)
+      def get url, options = {}, &block
+        self.class.get(url, @default_options.merge(options), &block)
       end
 
       def url_for_relation relation_name, params

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

@@ -2,13 +2,14 @@ module PactBroker
   module Client
     module CLI
       module PacticipantCommands
-        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :repository_url]
+        PACTICIPANT_PARAM_NAMES = [:name, :display_name, :main_branch, :repository_url]
 
         def self.included(thor)
           thor.class_eval do
             desc 'create-or-update-pacticipant', 'Create or update pacticipant by name'
             method_option :name, type: :string, required: true, desc: "Pacticipant name"
             method_option :display_name, type: :string, desc: "Display name"
+            method_option :main_branch, type: :string, required: false, desc: "The main development branch of the pacticipant repository"
             method_option :repository_url, type: :string, required: false, desc: "The repository URL of the pacticipant"
             output_option_json_or_text
             shared_authentication_options

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

@@ -15,7 +15,9 @@ module PactBroker
                 method_option :data, aliases: "-d", desc: "Webhook payload (file or string)"
                 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"
                 method_option :provider, desc: "Provider name"
+                method_option :provider_label, desc: "Provider label, mutually exclusive with provider name"
                 method_option :description, desc: "Webhook description"
                 method_option :contract_content_changed, type: :boolean, desc: "Trigger this webhook when the pact content changes"
                 method_option :contract_published, type: :boolean, desc: "Trigger this webhook when a pact is published"
@@ -70,6 +72,7 @@ module PactBroker
               end
 
               def parse_webhook_options(webhook_url)
+                validate_mutual_exclusiveness_of_participant_name_and_label_options
                 events = parse_webhook_events
 
                 # TODO update for contract_requiring_verification_published when released
@@ -102,7 +105,9 @@ module PactBroker
                   password: password,
                   body: body,
                   consumer: options.consumer,
+                  consumer_label: options.consumer_label,
                   provider: options.provider,
+                  provider_label: options.provider_label,
                   events: events,
                   team_uuid: options.team_uuid
                 }
@@ -118,10 +123,20 @@ module PactBroker
               rescue PactBroker::Client::Error => e
                 raise WebhookCreationError, "#{e.class} - #{e.message}"
               end
+
+              def validate_mutual_exclusiveness_of_participant_name_and_label_options
+                if options.consumer && options.consumer_label
+                  raise WebhookCreationError.new("Consumer name (--consumer) and label (--consumer_label) options are mutually exclusive")
+                end
+
+                if options.provider && options.provider_label
+                  raise WebhookCreationError.new("Provider name (--provider) and label (--provider_label) options are mutually exclusive")
+                end
+              end
             end
           end
         end
       end
     end
   end
-end
+end

data/lib/pact_broker/client/environments/environment_command.rb

@@ -39,7 +39,7 @@ module PactBroker
           @existing_environment_params ||= existing_environment_resource!
             .response
             .body
-            .except("uuid", "_links", "createdAt", "updatedAt")
+            .except("uuid", "_links", "_embedded", "createdAt", "updatedAt")
         end
 
         def contacts

data/lib/pact_broker/client/git.rb

@@ -25,9 +25,8 @@ module PactBroker
       using PactBroker::Client::HashRefinements
 
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
-      BRANCH_ENV_VAR_NAMES = %w{BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
-      COMMIT_ENV_VAR_NAMES = %w{BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}
-
+      BRANCH_ENV_VAR_NAMES = %w{GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_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_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
 
       def self.commit
@@ -38,6 +37,10 @@ module PactBroker
         find_branch_from_known_env_vars || find_branch_from_env_var_ending_with_branch || branch_from_git_command(options[:raise_error])
       end
 
+      def self.build_url
+        github_build_url || BUILD_URL_ENV_VAR_NAMES.collect{ | name | value_from_env_var(name) }.compact.first
+      end
+
       # private
 
       def self.find_commit_from_env_vars
@@ -45,7 +48,8 @@ module PactBroker
       end
 
       def self.find_branch_from_known_env_vars
-        BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
+        val = BRANCH_ENV_VAR_NAMES.collect { |env_var_name| value_from_env_var(env_var_name) }.compact.first
+        val.gsub(%r{^refs/heads/}, "") if val
       end
 
       def self.find_branch_from_env_var_ending_with_branch
@@ -104,6 +108,13 @@ module PactBroker
           return []
         end
       end
+
+      def self.github_build_url
+        parts = %w{GITHUB_SERVER_URL GITHUB_REPOSITORY GITHUB_RUN_ID}.collect{ | name | value_from_env_var(name) }
+        if parts.all?
+          [parts[0], parts[1], "actions", "runs", parts[2]].join("/")
+        end
+      end
     end
   end
 end

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

@@ -2,6 +2,7 @@ require 'pact_broker/client/retry'
 require 'pact_broker/client/hal/authorization_header_redactor'
 require 'net/http'
 require 'json'
+require 'openssl'
 
 module PactBroker
   module Client
@@ -62,13 +63,19 @@ module PactBroker
         def perform_request request, uri
           response = until_truthy_or_max_times(condition: ->(resp) { resp.code.to_i < 500 }) do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
-            http.set_debug_output(output_stream) if verbose
+            http.set_debug_output(output_stream) if verbose?
             http.use_ssl = (uri.scheme == 'https')
             # Need to manually set the ca_file and ca_path for the pact-ruby-standalone.
             # The env vars seem to be picked up automatically in later Ruby versions.
             # 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 disable_ssl_verification?
+              if verbose?
+                $stdout.puts("SSL verification is disabled")
+              end
+              http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
             http.start do |http|
               http.request request
             end
@@ -115,6 +122,14 @@ module PactBroker
           AuthorizationHeaderRedactor.new($stdout)
         end
 
+        def verbose?
+          verbose || ENV["VERBOSE"] == "true"
+        end
+
+        def disable_ssl_verification?
+          ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
+        end
+
         class Response < SimpleDelegator
           def body
             bod = raw_body

data/lib/pact_broker/client/pacticipants/create.rb

@@ -38,7 +38,8 @@ module PactBroker
           {
             name: params[:name],
             repositoryUrl: params[:repository_url],
-            displayName: params[:display_name]
+            displayName: params[:display_name],
+            mainBranch: params[:main_branch]
           }.compact
         end
       end

data/lib/pact_broker/client/publish_pacts.rb

@@ -28,7 +28,7 @@ module PactBroker
 
       def call
         validate
-        if index_resource.can?("pb:publish-contracts")
+        if !force_use_old_api? && index_resource.can?("pb:publish-contracts")
           publish_pacts
           PactBroker::Client::CommandResult.new(success?, message)
         else
@@ -40,6 +40,10 @@ module PactBroker
 
       attr_reader :pact_broker_base_url, :pact_file_paths, :consumer_version_params, :consumer_version_number, :branch, :tags, :build_url, :options, :pact_broker_client_options, :response_entities
 
+      def force_use_old_api?
+        ENV.fetch("PACT_BROKER_FEATURES", "").include?("publish_pacts_using_old_api")
+      end
+
       def request_body_for(consumer_name)
         {
           pacticipantName: consumer_name,

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.52.0'
+    VERSION = '1.56.0'
   end
 end

data/lib/pact_broker/client/webhooks/create.rb

@@ -81,10 +81,14 @@ module PactBroker
 
           if params.consumer
             body[:consumer] = { name: params.consumer }
+          elsif params.consumer_label
+            body[:consumer] = { label: params.consumer_label }
           end
 
           if params.provider
             body[:provider] = { name: params.provider }
+          elsif params.provider_label
+            body[:provider] = { label: params.provider_label }
           end
 
           if params.team_uuid

data/script/publish-pact.sh

@@ -1,5 +1,6 @@
 export PACT_BROKER_BASE_URL="http://localhost:9292"
 export PACT_BROKER_TOKEN="localhost"
+#export PACT_BROKER_FEATURES=publish_pacts_using_old_api
 
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16b14 \

data/script/record-deployments-and-releases.sh

@@ -16,7 +16,6 @@ bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment
 bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test
 
-
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
 bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1

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

@@ -49,7 +49,9 @@ module PactBroker
               password: "password",
               body: "data",
               consumer: "consumer",
+              consumer_label: nil,
               provider: "provider",
+              provider_label: nil,
               events: ["contract_content_changed"],
               team_uuid: "1234"
             }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
@@ -223,6 +225,59 @@ module PactBroker
                 expect { subject }.to raise_error(WebhookCreationError, /foo/)
               end
             end
+
+          end
+
+          context "when both consumer name and label options are specified" do
+            before do
+              options_hash[:consumer_label] = "consumer_label"
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "raises a WebhookCreationError" do
+              expect { subject }.to raise_error(
+                WebhookCreationError,
+                "Consumer name (--consumer) and label (--consumer_label) options are mutually exclusive"
+              )
+            end
+          end
+
+          context "when both provider name and label options are specified" do
+            before do
+              options_hash[:provider_label] = "provider_label"
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "raises a WebhookCreationError" do
+              expect { subject }.to raise_error(
+                WebhookCreationError,
+                "Provider name (--provider) and label (--provider_label) options are mutually exclusive"
+              )
+            end
+          end
+
+          context "when participant labels are specified" do
+            before do
+              options_hash.delete(:consumer)
+              options_hash.delete(:provider)
+              options_hash.merge!(consumer_label: 'consumer_label', provider_label: 'provider_label')
+              expected_params.merge!(
+                consumer: nil,
+                consumer_label: 'consumer_label',
+                provider: nil,
+                provider_label: 'provider_label'
+              )
+
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "calls PactBroker::Client::Webhooks::Create with participant labels in params" do
+              expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | params, _, _ |
+                expect(params).to eq expected_params
+                command_result
+              end
+              subject
+            end
           end
         end
       end

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

@@ -35,6 +35,16 @@ module PactBroker
           end
         end
 
+        context "when the branch starts with refs/heads/" do
+          before do
+            allow(ENV).to receive(:[]).with("GITHUB_REF").and_return("refs/heads/feature-x")
+          end
+
+          it "trims off the refs/heads/" do
+            expect(subject).to eq "feature-x"
+          end
+        end
+
         context "when there is one environment variable ending with _BRANCH" do
           before do
             allow(ENV).to receive(:keys).and_return(%w{FOO_BRANCH BAR_BRANCH BLAH})
@@ -108,6 +118,42 @@ module PactBroker
           include_examples "when raise_error is false"
         end
       end
+
+      describe ".build_url" do
+        before do
+          allow(ENV).to receive(:[]).and_call_original
+        end
+
+        subject { Git.build_url }
+
+        context "when nothing is set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+          end
+
+          it { is_expected.to eq nil }
+        end
+
+        context "when BUILDKITE_BUILD_URL is set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+            allow(ENV).to receive(:[]).with("BUILDKITE_BUILD_URL").and_return("http://build")
+          end
+
+          it { is_expected.to eq "http://build" }
+        end
+
+        context "when the Github Actions env vars are set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+            allow(ENV).to receive(:[]).with("GITHUB_SERVER_URL").and_return("https://github.com")
+            allow(ENV).to receive(:[]).with("GITHUB_REPOSITORY").and_return("org/repo")
+            allow(ENV).to receive(:[]).with("GITHUB_RUN_ID").and_return("1")
+          end
+
+          it { is_expected.to eq "https://github.com/org/repo/actions/runs/1" }
+        end
+      end
     end
   end
 end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1995,6 +1995,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2067,6 +2077,28 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            },
+            {
+              "name": "contract_published"
+            },
+            {
+              "name": "provider_verification_published"
+            },
+            {
+              "name": "provider_verification_succeeded"
+            },
+            {
+              "name": "provider_verification_failed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2125,6 +2157,14 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": "<xml></xml>"
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2323,6 +2363,88 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a consumer specified by a label",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "consumer": {
+            "label": "consumer_label"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2442,6 +2564,88 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a provider specified by a label",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "provider": {
+            "label": "provider_label"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2501,6 +2705,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2597,6 +2811,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2663,6 +2887,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",

data/spec/service_providers/webhooks_create_spec.rb

@@ -54,6 +54,14 @@ RSpec.describe "creating a webhook", pact: true do
       headers: pact_broker_response_headers,
       body: {
         description: Pact.like("a webhook"),
+        request: {
+          body: {
+            some: "body"
+          }
+        },
+        events: [
+          name: "contract_content_changed"
+        ],
         _links: {
           self: {
             href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
@@ -92,6 +100,7 @@ RSpec.describe "creating a webhook", pact: true do
     before do
       params.merge!(events: event_names)
       request_body.merge!("events" => event_names.map{ |event_name| { "name" => event_name } })
+      success_response[:body].merge!(events: event_names.map{ |event_name| { "name" => event_name } })
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
@@ -112,6 +121,7 @@ RSpec.describe "creating a webhook", pact: true do
   context "when a valid webhook with an XML body is submitted" do
     before do
       request_body["request"]["body"] = body
+      success_response[:body][:request][:body] = body
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
@@ -207,6 +217,30 @@ RSpec.describe "creating a webhook", pact: true do
     end
   end
 
+  context "when consumer is specified using a label" do
+    before do
+      params.delete(:consumer)
+      params.delete(:provider)
+      params.merge!(consumer_label: "consumer_label")
+      request_body["consumer"] = { "label" => "consumer_label" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body for a consumer specified by a label")
+        .with(
+          method: :post,
+          path: placeholder_path('pb:webhooks'),
+          headers: post_request_headers,
+          body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+
   context "when only a consumer is specified and it does not exist" do
     before do
       params.delete(:provider)
@@ -257,6 +291,30 @@ RSpec.describe "creating a webhook", pact: true do
     end
   end
 
+  context "when provider is specified using a label" do
+    before do
+      params.delete(:consumer)
+      params.delete(:provider)
+      params.merge!(provider_label: "provider_label")
+      request_body["provider"] = { "label" => "provider_label" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body for a provider specified by a label")
+        .with(
+          method: :post,
+          path: placeholder_path('pb:webhooks'),
+          headers: post_request_headers,
+          body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+
   context "when neither consumer nor provider are specified" do
     before do
       params.delete(:consumer)

data/tasks/pact.rake

@@ -1,4 +1,5 @@
-require 'pact_broker/client/tasks'
+require "pact_broker/client/tasks"
+require "pact_broker/client/git"
 
 PactBroker::Client::PublicationTask.new(:localhost) do | task |
   require 'pact_broker/client/version'
@@ -35,4 +36,5 @@ PactBroker::Client::PublicationTask.new(:pactflow) do | task |
   task.consumer_version = version
   task.pact_broker_base_url = "https://pact-oss.pactflow.io"
   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.52.0
+  version: 1.56.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-29 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty