pact_broker-client 1.74.0 → 1.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84c25ce85cb110411ce145b803e155a0cb8c30a356bb3a6dc8239ab14fbc97c4
-  data.tar.gz: 57a8dcaf85657dc9f99c233abf1cbd1fa0672e0c942ba8d0f009907afda87309
+  metadata.gz: c5089c183a535af491e824cdb9d198cb06150cb44d77014b09957564b9a47be7
+  data.tar.gz: 4d86ae219d734f0d4266214d1adca636f4557691104e75a720e8860d4103f831
 SHA512:
-  metadata.gz: 732c56c1c831f3f154e9be33ef949208057db7705a7bca291d1a356923729acda5f762ff2e57ab51409afa71e425eec7bc775964816de74d215229a66583bedf
-  data.tar.gz: 97f2acafe53b570a5945d1e3c8750cf6f35f5a122ba58e5b8646ba2dc2b1702ad44489ab21ba53fa19220aca569bd8495c5ce6f694b9ec1784caf8a247cd6fed
+  metadata.gz: 4f7e075d702ae824e91835cfbf14068c8c2938877cc0a156f7d99e8f9a577bd41d4b4507f06f714897c8f911e7c85f647f94898d4eb0ebf1ea938b270d004708
+  data.tar.gz: e7f787f092e10fec2166328a1bca16c7517a5a1c65179f92e4b9b71f6a97caaf0633a0ecc71f03cc0b9baaf303a86d26567a11399ff8fcd9a00d1de54685f856

data/.github/workflows/release_gem.yml

@@ -29,7 +29,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    - uses: pact-foundation/release-gem@v0.0.14
+    - uses: pact-foundation/release-gem@v1
       id: release
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'

data/.github/workflows/test.yml

@@ -1,6 +1,9 @@
 name: Test
 
-on: [push, pull_request]
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   test:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+<a name="v1.75.0"></a>
+### v1.75.0 (2023-11-11)
+
+#### Features
+
+* add support for delete-branch command (#151)	 ([6da6202](/../../commit/6da6202))
+
+#### Bug Fixes
+
+* set correct Accept header when publishing provider contracts	 ([abc8ea3](/../../commit/abc8ea3))
+
 <a name="v1.74.0"></a>
 ### v1.74.0 (2023-10-14)
 

data/Gemfile

@@ -25,4 +25,5 @@ end
 group :test do
   gem 'faraday', '~>2.0'
   gem 'faraday-retry', '~>2.0'
+  gem 'rackup', '~> 2.1'
 end

data/README.md

@@ -71,6 +71,7 @@ Options:
                 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.
+              # Default: false
   -t, [--tag=TAG]
               # Tag name for consumer version. Can be specified multiple
                 times.
@@ -78,13 +79,15 @@ Options:
               # 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
+                Azure DevOps.
+              # Default: false
       [--build-url=BUILD_URL]
               # The build URL that created the pact
       [--merge], [--no-merge]
               # If a pact already exists for this consumer version and
                 provider, merge the contents. Useful when running Pact tests
                 concurrently on different build nodes.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or text
               # Default: text
@@ -97,7 +100,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Publish pacts to a Pact Broker.
@@ -118,7 +122,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or table
               # Default: table
@@ -142,7 +147,8 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                This is currently informational only. Default: false
+                This is currently informational only.
+              # Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -160,7 +166,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Create an environment resource in the Pact Broker to represent a real world deployment or release environment.
@@ -181,7 +188,8 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                This is currently informational only. Default: false
+                This is currently informational only.
+              # Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -199,7 +207,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Update an environment resource in the Pact Broker.
@@ -225,7 +234,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describe an environment
@@ -251,7 +261,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Delete an environment
@@ -275,7 +286,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 List environments
@@ -316,7 +328,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record deployment of a pacticipant version to an environment. See https://docs.pact.io/record-deployment for more information.
@@ -356,7 +369,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -392,7 +406,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record release of a pacticipant version to an environment. See See https://docs.pact.io/record-release for more information.
@@ -422,7 +437,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Record the end of support for a pacticipant version in an environment. See https://docs.pact.io/record-support-ended for more information.
@@ -459,6 +475,7 @@ Options:
               # Use the latest version of the configured main branch of the
                 pacticipant as the version for which you want to check the
                 verification results
+              # Default: false
       [--to-environment=ENVIRONMENT]
               # The environment into which the pacticipant(s) are to be
                 deployed
@@ -488,6 +505,7 @@ Options:
                 is recommended to use the environment variable and just set it
                 for the build required to deploy that particular version, so
                 you don't accidentally leave the dry run mode enabled.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -497,7 +515,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -575,6 +594,7 @@ Options:
                 is recommended to use the environment variable and just set it
                 for the build required to deploy that particular version, so
                 you don't accidentally leave the dry run mode enabled.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -584,7 +604,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -619,7 +640,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Create or update pacticipant by name
@@ -645,7 +667,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describe a pacticipant
@@ -669,7 +692,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 List pacticipants
@@ -731,7 +755,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Description:
@@ -796,7 +821,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
       --uuid=UUID
               # Specify the uuid for the webhook
 ```
@@ -827,11 +853,44 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Test the execution of a webhook
 
+### Branches
+
+#### delete-branch
+
+```
+Usage:
+  pact-broker delete-branch --branch=BRANCH -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+  -a, --pacticipant=PACTICIPANT
+              # The name of the pacticipant that the branch belongs to.
+      --branch=BRANCH
+              # The pacticipant branch name.
+      [--error-when-not-found], [--no-error-when-not-found]
+              # Raise an error if the branch that is to be deleted is not
+                found.
+              # Default: true
+  -b, --broker-base-url=BROKER_BASE_URL
+              # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]
+              # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+              # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]
+              # Pact Broker bearer token
+  -v, [--verbose], [--no-verbose]
+              # Verbose output.
+              # Default: false
+```
+
+Deletes a pacticipant branch. Does not delete the versions or pacts/verifications associated with the branch, but does make the pacts inaccessible for verification via consumer versions selectors or WIP pacts.
+
 ### Tags
 
 #### create-version-tag
@@ -850,10 +909,12 @@ Options:
                 times.
       [--auto-create-version], [--no-auto-create-version]
               # Automatically create the pacticipant version if it does not
-                exist. Default: false
+                exist.
+              # Default: false
   -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
               # Tag pacticipant version with the name of the current git
-                branch. Default: false
+                branch.
+              # Default: false
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -863,7 +924,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Add a tag to a pacticipant version
@@ -896,7 +958,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Describes a pacticipant version. If no version or tag is specified, the latest version is described.
@@ -926,7 +989,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
   -o, [--output=OUTPUT]
               # json or text
               # Default: text
@@ -1002,7 +1066,8 @@ Options:
   -k, [--broker-token=BROKER_TOKEN]
               # Pact Broker bearer token
   -v, [--verbose], [--no-verbose]
-              # Verbose output. Default: false
+              # Verbose output.
+              # Default: false
 ```
 
 Publish provider contract to PactFlow

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

@@ -38,6 +38,8 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-branch_relation_exists_in_the_index_resource) given the pb:pacticipant-branch relation exists in the index resource
+
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource) given the pb:pacticipant-version and pb:environments relations exist in the index resource
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource) given the pb:publish-contracts relations exists in the index resource
@@ -76,6 +78,8 @@
 
 * [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
 
+* [A request to delete a pacticipant branch](#a_request_to_delete_a_pacticipant_branch_given_a_branch_named_main_exists_for_pacticipant_Foo) given a branch named main exists for pacticipant Foo
+
 * [A request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5](#a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod) given provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod
 
 * [A request to get the Pricing Service](#a_request_to_get_the_Pricing_Service_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
@@ -827,6 +831,33 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-branch_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-branch relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+```json
+{
+  "method": "GET",
+  "path": "/",
+  "headers": {
+    "Accept": "application/hal+json"
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "_links": {
+      "pb:pacticipant-branch": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-{pacticipant}-{branch}"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource"></a>
 Given **the pb:pacticipant-version and pb:environments relations exist in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -1766,6 +1797,20 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_delete_a_pacticipant_branch_given_a_branch_named_main_exists_for_pacticipant_Foo"></a>
+Given **a branch named main exists for pacticipant Foo**, upon receiving **a request to delete a pacticipant branch** from Pact Broker Client, with
+```json
+{
+  "method": "DELETE",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-Foo-main"
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 204
+}
+```
 <a name="a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod"></a>
 Given **provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod**, upon receiving **a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5** from Pact Broker Client, with
 ```json

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

@@ -210,7 +210,7 @@ Upon receiving **a request to publish a provider contract** from Pact Broker Cli
   "path": "/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-Bar",
   "headers": {
     "Content-Type": "application/json",
-    "Accept": "application/hal+json"
+    "Accept": "application/hal+json,application/problem+json"
   },
   "body": {
     "pacticipantVersionNumber": "1",

data/lib/pact_broker/client/branches/delete_branch.rb

@@ -0,0 +1,64 @@
+require "pact_broker/client/base_command"
+
+module PactBroker
+  module Client
+    module Branches
+      class DeleteBranch < PactBroker::Client::BaseCommand
+
+        NOT_SUPPORTED_MESSAGE_PACT_BROKER = "This version of the Pact Broker does not support deleting branches. Please upgrade to version 2.108.0 or later."
+        NOT_SUPPORTED_MESSAGE_PACTFLOW = "This version of PactFlow does not support deleting branches. Please upgrade to the latest version."
+
+        def initialize(params, options, pact_broker_client_options)
+        	super
+          @pacticipant_name = params.fetch(:pacticipant)
+        	@branch_name = params.fetch(:branch)
+          @error_when_not_found = params.fetch(:error_when_not_found)
+        end
+
+				def do_call
+					check_if_command_supported
+          @deleted_resource = branch_link.delete
+          PactBroker::Client::CommandResult.new(success?, result_message)
+        end
+
+        private
+
+        attr_reader :pacticipant_name, :branch_name, :error_when_not_found, :deleted_resource
+
+        def branch_link
+          index_resource._link("pb:pacticipant-branch").expand(pacticipant: pacticipant_name, branch: branch_name)
+        end
+
+        def check_if_command_supported
+          unless index_resource.can?("pb:pacticipant-branch")
+          	raise PactBroker::Client::Error.new(is_pactflow? ? NOT_SUPPORTED_MESSAGE_PACTFLOW : NOT_SUPPORTED_MESSAGE_PACT_BROKER)
+          end
+        end
+
+        def success?
+          if deleted_resource.success?
+            true
+          elsif deleted_resource.response.status == 404 && !error_when_not_found
+            true
+          else
+            false
+          end
+        end
+
+        def result_message
+          if deleted_resource.success?
+					 green("Successfully deleted branch #{branch_name} of pacticipant #{pacticipant_name}")
+          elsif deleted_resource.response.status == 404
+            if error_when_not_found
+              red("Could not delete branch #{branch_name} of pacticipant #{pacticipant_name} as it was not found")
+            else
+              green("Branch #{branch_name} of pacticipant #{pacticipant_name} not found")
+            end
+          else
+            red(deleted_resource.response.raw_body)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module PactBroker
+  module Client
+    module CLI
+      module BranchCommands
+        def self.included(thor)
+          thor.class_eval do
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the branch belongs to."
+            method_option :branch, required: true,  desc: "The pacticipant branch name."
+            method_option :error_when_not_found, type: :boolean, default: true, desc: "Raise an error if the branch that is to be deleted is not found."
+            shared_authentication_options
+
+            desc "delete-branch", "Deletes a pacticipant branch. Does not delete the versions or pacts/verifications associated with the branch, but does make the pacts inaccessible for verification via consumer versions selectors or WIP pacts."
+
+            def delete_branch
+              require "pact_broker/client/branches/delete_branch"
+
+              validate_credentials
+              params = {
+                pacticipant: options.pacticipant,
+                branch: options.branch,
+                error_when_not_found: options.error_when_not_found
+              }
+
+              result = PactBroker::Client::Branches::DeleteBranch.call(params, {}, pact_broker_client_options)
+              $stdout.puts result.message
+              exit(1) unless result.success
+            end
+
+            no_commands do
+              def validate_delete_branch_params
+                raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.pacticipant.strip.size == 0
+                raise ::Thor::RequiredArgumentMissingError, "Pacticipant branch name cannot be blank" if options.branch.strip.size == 0
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ require "pact_broker/client/cli/pacticipant_commands"
 require "pact_broker/client/cli/version_commands"
 require "pact_broker/client/cli/webhook_commands"
 require "pact_broker/client/cli/matrix_commands"
-
+require "pact_broker/client/cli/branch_commands"
 module PactBroker
   module Client
     module CLI
@@ -19,6 +19,7 @@ module PactBroker
         include PactBroker::Client::CLI::MatrixCommands
         include PactBroker::Client::CLI::PacticipantCommands
         include PactBroker::Client::CLI::VersionCommands
+        include PactBroker::Client::CLI::BranchCommands
         include PactBroker::Client::CLI::WebhookCommands
 
         ignored_and_hidden_potential_options_from_environment_variables

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

@@ -126,11 +126,11 @@ module PactBroker
             method_option :broker_username, aliases: "-u", desc: "Pact Broker basic auth username"
             method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password"
             method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token"
-            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output."
           end
 
           def self.verbose_option
-            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output. Default: false"
+            method_option :verbose, aliases: "-v", type: :boolean, default: false, required: false, desc: "Verbose output."
           end
 
           def self.output_option_json_or_text

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

@@ -9,7 +9,7 @@ module PactBroker
             def self.shared_environment_options(name_required: false)
               method_option :name, required: name_required, desc: "The uniquely identifying name of the environment as used in deployment code"
               method_option :display_name, desc: "The display name of the environment"
-              method_option :production, type: :boolean, default: false, desc: "Whether or not this environment is a production environment. This is currently informational only. Default: false"
+              method_option :production, type: :boolean, default: false, desc: "Whether or not this environment is a production environment. This is currently informational only."
               method_option :contact_name, required: false, desc: "The name of the team/person responsible for this environment"
               method_option :contact_email_address, required: false, desc: "The email address of the team/person responsible for this environment"
               output_option_json_or_text

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

@@ -18,7 +18,7 @@ module PactBroker
             method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
             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 :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."
             method_option :build_url, desc: "The build URL that created the pact"
             method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
             output_option_json_or_text

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

@@ -59,8 +59,8 @@ module PactBroker
             method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name"
             method_option :version, required: true, aliases: "-e", desc: "The pacticipant version"
             method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
-            method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
-            method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
+            method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist."
+            method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch."
             shared_authentication_options
 
             def create_version_tag

data/lib/pact_broker/client/version.rb

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

data/lib/pactflow/client/cli/provider_contract_commands.rb

@@ -16,7 +16,7 @@ module Pactflow
             method_option :branch, aliases: "-h", desc: "Repository branch of the provider version"
             #method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
             method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for provider version. Can be specified multiple times."
-            #method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
+            #method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch."
             method_option :specification, default: "oas", desc: "The contract specification"
             method_option :content_type, desc: "The content type. eg. application/yml"
             method_option :verification_success, type: :boolean, desc: "Whether or not the self verification passed successfully."

data/lib/pactflow/client/provider_contracts/publish.rb

@@ -39,7 +39,7 @@ module Pactflow
         end
 
         def publish_provider_contracts
-          @response_entity = index_resource._link(PUBLISH_RELATION).expand(provider: provider_name).post!(contract_params, headers: { "Accept" => "application/hal+json,application/problem+json" })
+          @response_entity = index_resource._link(PUBLISH_RELATION).expand(provider: provider_name).post!(contract_params, { "Accept" => "application/hal+json,application/problem+json" })
         end
 
         def contract_params

data/script/publish-provider-contract.sh

@@ -6,7 +6,6 @@ bundle exec bin/pactflow publish-provider-contract  \
   --branch main \
   --tag dev \
   --specification oas \
-  --content-type application/yml \
   --verification-exit-code 0 \
   --verification-results script/verification-results.txt \
   --verification-results-content-type text/plain \

data/script/update-cli-usage-in-readme.rb

@@ -23,6 +23,7 @@ PACT_BROKER_COMMAND_GROUPS = [
   [PactBroker::Client::CLI::Broker, "Matrix", %w[can-i-deploy can-i-merge]],
   [PactBroker::Client::CLI::Broker, "Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
   [PactBroker::Client::CLI::Broker, "Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
+  [PactBroker::Client::CLI::Broker, "Branches", %w[delete-branch]],
   [PactBroker::Client::CLI::Broker, "Tags", %w[create-version-tag]],
   [PactBroker::Client::CLI::Broker, "Versions", %w[describe-version create-or-update-version]],
   [PactBroker::Client::CLI::Broker, "Miscellaneous", %w[generate-uuid]]

data/spec/lib/pact_broker/client/branches/delete_branch_spec.rb

@@ -0,0 +1,103 @@
+require "pact_broker/client/branches/delete_branch"
+
+module PactBroker
+  module Client
+    module Branches
+      describe DeleteBranch do
+        before do
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
+          allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)
+        end
+
+        let(:params) do
+          {
+            pacticipant: "Foo",
+            branch: "main",
+            error_when_not_found: error_when_not_found
+          }
+        end
+        let(:options) do
+          {
+            verbose: verbose
+          }
+        end
+        let(:error_when_not_found) { true }
+        let(:pact_broker_base_url) { "http://example.org" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+        let(:response_headers) { { "Content-Type" => "application/hal+json"} }
+        let(:verbose) { false }
+
+        before do
+          stub_request(:get, "http://example.org/").to_return(status: 200, body: index_response_body, headers: response_headers)
+          stub_request(:delete, "http://example.org/pacticipants/Foo/branches/main").to_return(status: delete_response_status, body: delete_response_body, headers: response_headers)
+        end
+        let(:delete_response_status) { 200 }
+
+        let(:index_response_body) do
+          {
+            "_links" => {
+              "pb:pacticipant-branch" => {
+                "href" => "http://example.org/pacticipants/{pacticipant}/branches/{branch}"
+              }
+            }
+          }.to_json
+        end
+
+        let(:delete_response_body) do
+          { "some" => "error message" }.to_json
+        end
+
+        subject { DeleteBranch.call(params, options, pact_broker_client_options) }
+
+        context "when the branch is deleted" do
+          it "returns a success result" do
+            expect(subject.success).to be true
+            expect(subject.message).to include "Successfully deleted branch main of pacticipant Foo"
+          end
+        end
+
+        context "when there is a non-404 error" do
+          let(:delete_response_status) { 403 }
+
+          it "returns an error result with the response body" do
+            expect(subject.success).to be false
+            expect(subject.message).to include "error message"
+          end
+        end
+
+        context "when the branch is not found" do
+          let(:delete_response_status) { 404 }
+
+          context "when error_when_not_found is true" do
+            it "returns an error" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "Could not delete branch main of pacticipant Foo as it was not found"
+            end
+          end
+
+          context "when error_when_not_found is false" do
+            let(:error_when_not_found) { false }
+
+            it "return a success" do
+              expect(subject.success).to be true
+              expect(subject.message).to include "Branch main of pacticipant Foo not found"
+            end
+          end
+        end
+
+        context "when deleting branches is not supported" do
+          let(:index_response_body) do
+            {
+              _links: {}
+            }.to_json
+          end
+
+          it "returns an error" do
+            expect(subject.success).to be false
+            expect(subject.message).to include "not support"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -6,6 +6,49 @@
     "name": "Pact Broker"
   },
   "interactions": [
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:pacticipant-branch relation exists in the index resource",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+          "Accept": "application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_links": {
+            "pb:pacticipant-branch": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-{pacticipant}-{branch}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:pacticipant-branch.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{branch}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to delete a pacticipant branch",
+      "providerState": "a branch named main exists for pacticipant Foo",
+      "request": {
+        "method": "DELETE",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-BRANCH-Foo-main"
+      },
+      "response": {
+        "status": 204,
+        "headers": {
+        }
+      }
+    },
     {
       "description": "a request to list the latest pacts",
       "providerState": "a pact between Condor and the Pricing Service exists",

data/spec/pacts/pact_broker_client-pactflow.json

@@ -43,7 +43,7 @@
         "path": "/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-Bar",
         "headers": {
           "Content-Type": "application/json",
-          "Accept": "application/hal+json"
+          "Accept": "application/hal+json,application/problem+json"
         },
         "body": {
           "pacticipantVersionNumber": "1",

data/spec/service_providers/delete_branch_spec.rb

@@ -0,0 +1,68 @@
+require "service_providers/pact_helper"
+require "pact_broker/client/branches/delete_branch"
+
+RSpec.describe "delete a branch", pact: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      pacticipant: "Foo",
+      branch: "main",
+      error_when_not_found: true
+    }
+  end
+
+  let(:options) do
+    {
+      verbose: verbose
+    }
+  end
+
+  let(:pact_broker_base_url) { pact_broker.mock_service_base_url }
+  let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+  let(:response_headers) { { "Content-Type" => "application/hal+json"} }
+  let(:verbose) { false }
+
+  subject { PactBroker::Client::Branches::DeleteBranch.call(params, options, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:pacticipant-branch relation exists in the index resource")
+      .upon_receiving("a request for the index resource")
+      .with(
+        method: "GET",
+        path: '/',
+        headers: get_request_headers).
+      will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            :'pb:pacticipant-branch' => {
+              href: placeholder_url_term("pb:pacticipant-branch", ["pacticipant", "branch"], pact_broker)
+            }
+          }
+        }
+      )
+  end
+
+  def mock_branch_delete_request
+    pact_broker
+      .given("a branch named main exists for pacticipant Foo")
+      .upon_receiving("a request to delete a pacticipant branch")
+      .with(
+        method: "DELETE",
+        path: placeholder_path("pb:pacticipant-branch", ["Foo", "main"])
+      )
+      .will_respond_with(
+        status: 204
+      )
+  end
+
+  it "returns a success result" do
+    mock_index
+    mock_branch_delete_request
+    expect(subject.success).to be true
+  end
+end

data/spec/service_providers/pact_helper.rb

@@ -25,6 +25,7 @@ end
 
 module PactBrokerPactHelperMethods
 
+  # Use this for the path in the Pact request expectation.
   # @param [String] relation eg "pb:pacticipant"
   # @param [Array<String>] params eg ["Foo"]
   def placeholder_path(relation, params = [])

data/spec/service_providers/pactflow_publish_provider_contract_spec.rb

@@ -123,7 +123,7 @@ RSpec.describe "publishing a provider contract to PactFlow", pact: true do
         .with(
             method: :post,
             path: placeholder_path("pf:publish-provider-contract", ["Bar"]),
-            headers: post_request_headers,
+            headers: post_request_headers.merge("Accept" => "application/hal+json,application/problem+json"),
             body: request_body
         ).will_respond_with(success_response)
     end

data/spec/support/ssl_server.rb

@@ -32,7 +32,7 @@ if __FILE__ == $0
   require "webrick"
   require "webrick/https"
   require "rack"
-  require "rack/handler/webrick"
+  require "rackup/handler/webrick"
 
   opts = webrick_opts(4444)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.74.0
+  version: 1.75.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-14 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -155,7 +155,9 @@ files:
 - lib/pact_broker/client/backports.rb
 - lib/pact_broker/client/base_client.rb
 - lib/pact_broker/client/base_command.rb
+- lib/pact_broker/client/branches/delete_branch.rb
 - lib/pact_broker/client/can_i_deploy.rb
+- lib/pact_broker/client/cli/branch_commands.rb
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
 - lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt
@@ -281,6 +283,7 @@ files:
 - spec/integration/publish_provider_contract_spec.rb
 - spec/integration/unknown_options_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
+- spec/lib/pact_broker/client/branches/delete_branch_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_create_or_update_webhook_spec.rb
@@ -321,6 +324,7 @@ files:
 - spec/pacts/pact_broker_client-pactflow.json
 - spec/readme_spec.rb
 - spec/service_providers/create_environment_spec.rb
+- spec/service_providers/delete_branch_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak
@@ -377,7 +381,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: See description
@@ -407,6 +411,7 @@ test_files:
 - spec/integration/publish_provider_contract_spec.rb
 - spec/integration/unknown_options_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
+- spec/lib/pact_broker/client/branches/delete_branch_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_create_or_update_webhook_spec.rb
@@ -447,6 +452,7 @@ test_files:
 - spec/pacts/pact_broker_client-pactflow.json
 - spec/readme_spec.rb
 - spec/service_providers/create_environment_spec.rb
+- spec/service_providers/delete_branch_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak