pact_broker-client 1.73.0 → 1.75.0

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

@@ -1,4 +1,5 @@
 require "pact_broker/client/hash_refinements"
+require 'pact_broker/client/string_refinements'
 
 module PactBroker
   module Client
@@ -8,23 +9,26 @@ 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 :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
             shared_authentication_options
 
             def publish(*pact_files)
-              require 'pact_broker/client/error'
+              require "pact_broker/client/error"
+              require "pact_broker/client/git"
               validate_credentials
+              validate_consumer_version
               validate_pact_files(pact_files)
               result = publish_pacts(pact_files)
               $stdout.puts result.message
@@ -50,17 +54,21 @@ module PactBroker
                 end
               end
 
+              def validate_consumer_version
+                if consumer_app_version.blank?
+                  raise ::Thor::RequiredArgumentMissingError, "No value provided for required option --consumer-app-version"
+                end
+              end
 
               def publish_pacts pact_files
                 require 'pact_broker/client/publish_pacts'
 
                 write_options = options[:merge] ? { write: :merge } : {}
                 consumer_version_params = {
-                  number: options.consumer_app_version,
+                  number: consumer_app_version,
                   branch: branch,
                   tags: tags,
-                  build_url: options.build_url,
-                  version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+                  build_url: build_url
                 }.compact
 
                 PactBroker::Client::PublishPacts.call(
@@ -99,25 +107,38 @@ module PactBroker
               end
 
               def tags
-                require 'pact_broker/client/git'
-
                 t = [*options.tag]
                 t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
                 t.compact.uniq
               end
 
               def branch
-                require 'pact_broker/client/git'
-
                 if options.branch.nil? && options.auto_detect_version_properties
-                  PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
+                  PactBroker::Client::Git.branch(raise_error: true)
                 else
                   options.branch
                 end
               end
 
-              def explict_auto_detect_version_properties
-                @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+              def consumer_app_version
+                if defined?(@consumer_app_version)
+                  @consumer_app_version
+                else
+                  @consumer_app_version = if options.consumer_app_version.blank? && options.auto_detect_version_properties
+                                            PactBroker::Client::Git.commit(raise_error: true)
+                                          else
+                                            options.consumer_app_version
+                                          end
+                end
+
+              end
+
+              def build_url
+                if options.build_url.blank? && options.auto_detect_version_properties
+                  PactBroker::Client::Git.build_url
+                else
+                  options.build_url
+                end
               end
             end
           end

data/lib/pact_broker/client/cli/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/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.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/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/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