pact_broker-client 1.49.0 → 1.51.2

data/lib/pact_broker/client/publish_pacts_the_old_way.rb

@@ -25,14 +25,13 @@ module PactBroker
         @branch = consumer_version_params[:branch]
         @build_url = consumer_version_params[:build_url]
         @tags = consumer_version_params[:tags] ? consumer_version_params[:tags].collect{ |tag| tag.respond_to?(:strip) ? tag.strip : tag } : []
-        @version_required = consumer_version_params[:version_required]
         @pact_broker_client_options = pact_broker_client_options
       end
 
       def call
         validate
         $stdout.puts("")
-        result = create_consumer_versions && apply_tags && publish_pacts
+        result = apply_tags && publish_pacts
         $stdout.puts("")
         if result
           PactBroker::Client::CommandResult.new(true)
@@ -59,10 +58,6 @@ module PactBroker
         end
       end
 
-      def can_create_version_with_branch?
-        @can_create_version_with_branch ||= index_resource.can?('pb:pacticipant-version')
-      end
-
       def merge_on_server?
         pact_broker_client_options[:write] == :merge
       end
@@ -96,49 +91,6 @@ module PactBroker
         end
       end
 
-      def create_consumer_versions
-        if create_versions?
-          consumer_names.collect do | consumer_name |
-            create_version(index_resource, consumer_name)
-          end
-          true
-        else
-          true
-        end
-      end
-
-      def create_versions?
-        if version_required
-          if can_create_version_with_branch?
-            true
-          else
-            raise PactBroker::Client::Error.new("This version of the Pact Broker does not support versions with branches or build URLs. Please upgrade your broker to 2.76.2 or later.")
-          end
-        elsif (branch || build_url) && can_create_version_with_branch?
-          true
-        else
-          false
-        end
-      end
-
-      def create_version(index_resource, consumer_name)
-        Retry.while_error do
-          version_resource = index_resource._link('pb:pacticipant-version').expand(version: consumer_version_number, pacticipant: consumer_name).put(version_body).assert_success!
-          message = if version_resource.response.status == 200
-            "Replaced version #{consumer_version_number} of #{consumer_name}"
-          else
-            "Created version #{consumer_version_number} of #{consumer_name}"
-          end
-
-          message = message + " (branch #{branch})" if branch
-          $stdout.puts message
-          if version_resource.response.status == 200
-            $stdout.puts ::Term::ANSIColor.yellow("Replacing the version resource is not recommended under normal circumstances and may indicate that you have not configured your Pact pipeline correctly (unless you are just re-running a build for a particular commit). For more information see https://docs.pact.io/versioning")
-          end
-          true
-        end
-      end
-
       def version_body
         {
           branch: branch,
@@ -185,6 +137,9 @@ module PactBroker
       end
 
       def validate
+        if branch || build_url
+          $stdout.puts ::Term::ANSIColor.yellow("WARN: This version of the Pact Broker does not support versions with branches or build URLs. Please upgrade your broker to 2.86.0 or later.")
+        end
         raise PactBroker::Client::Error.new("Please specify the consumer_version_number") unless (consumer_version_number && consumer_version_number.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("Please specify the pact_broker_base_url") unless (pact_broker_base_url && pact_broker_base_url.to_s.strip.size > 0)
         raise PactBroker::Client::Error.new("No pact files found") unless (pact_file_paths && pact_file_paths.any?)

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.49.0'
+    VERSION = '1.51.2'
   end
 end

data/pact-broker-client.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency 'httparty', '~>0.18'
+  gem.add_runtime_dependency 'httparty', '~>0.18.1' # https://github.com/jnunemaker/httparty/issues/733
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.7'
   gem.add_runtime_dependency 'table_print', '~> 1.5'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'

data/script/publish-pact.sh

@@ -28,7 +28,7 @@ bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --contract-published
 
 
-PACT_BROKER_FEATURES=publish_contracts bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
   --consumer-app-version 1.2.26 \
   --broker-base-url http://localhost:9292 \
    --broker-token localhost \

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

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+require "stringio"
+require "pact_broker/client/cli/broker"
+
+ENV["THOR_COLUMNS"] = "160"
+START_MARKER = "<!-- start-autogenerated-docs -->"
+END_MARKER = "<!-- end-autogenerated-docs -->"
+TERMINAL_WIDTH = 80
+
+def print_wrapped(message, options = {})
+  out = StringIO.new
+  indent = options[:indent] || 0
+  width = TERMINAL_WIDTH - indent
+  paras = message.split("\n\n")
+
+  paras.map! do |unwrapped|
+    counter = 0
+    unwrapped.split(" ").inject do |memo, word|
+      word = word.gsub(/\n\005/, "\n").gsub(/\005/, "\n")
+      counter = 0 if word.include? "\n"
+      if (counter + word.length + 1) < width
+        memo = "#{memo} #{word}"
+        counter += (word.length + 1)
+      else
+        memo = "#{memo}\n#{word}"
+        counter = word.length
+      end
+      memo
+    end
+  end.compact!
+
+  paras.each do |para|
+    para.split("\n").each do |line|
+      out.puts line.insert(0, " " * indent)
+    end
+    out.puts unless para == paras.last
+  end
+  out.string
+end
+
+def format_banner(banner)
+  banner_lines = print_wrapped(banner, indent: 16).split("\n")
+  banner_lines[0] = banner_lines[0].gsub(/^\s\s/, "")
+  banner_lines
+end
+
+def generate_thor_docs
+  begin
+    out = StringIO.new
+    $stdout = out
+
+    command_groups = [
+      ["Pacts", %w[publish list-latest-pact-versions] ],
+      ["Environments", %w[create-environment update-environment describe-environment delete-environment list-environments]],
+      ["Deployments", %w[record-deployment record-undeployment]],
+      ["Releases", %w[record-release record-support-ended]],
+      ["Matrix", %w[can-i-deploy]],
+      ["Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
+      ["Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
+      ["Tags", %w[create-version-tag]],
+      ["Versions", %w[describe-version]],
+      ["Miscellaneous", %w[generate-uuid]]
+    ]
+
+    command_groups.collect do | group, commands |
+      puts "### #{group}\n\n"
+      commands.each do | command |
+        puts "#### #{command}\n\n"
+        PactBroker::Client::CLI::Broker.start(["help", command])
+        puts "\n"
+      end
+    end
+    out.string
+  ensure
+    $stdout = STDOUT
+  end
+end
+
+STATES = {
+  start: {
+    /^Usage:/ => :usage
+  },
+  usage: {
+    /^Options:/ => :options
+  },
+  options: {
+    /^$/ => :after_options
+  },
+  after_options: {
+    /^Usage:/ => :usage
+  }
+}
+
+def entered?(state)
+  @old_state != state && @current_state == state
+end
+
+def exited?(state)
+  @old_state == state && @current_state != state
+end
+
+def has_option_and_banner(line)
+  line =~ /--.*\s#\s/
+end
+
+def has_only_banner(line)
+  line =~ /^\s+#\s/
+end
+
+@current_state = :start
+@old_state = nil
+
+def reformat_docs(generated_thor_docs)
+  generated_thor_docs.split("\n").collect do | line |
+    @old_state = @current_state
+
+    transitions = STATES[@current_state]
+
+    line_starts_with = transitions.keys.find { | key |  line =~ key }
+    if line_starts_with
+      @current_state = transitions[line_starts_with]
+    end
+
+
+    lines = if has_option_and_banner(line)
+      option, banner = line.split("#", 2)
+      [option] + format_banner("# " + banner)
+    elsif has_only_banner(line)
+      space, banner = line.split("#", 2)
+      format_banner("#  " + banner)
+    else
+      [line]
+    end
+
+    if entered?(:usage) || exited?(:options)
+      ["```"] + lines
+    else
+      lines
+    end
+    # line
+  end.flatten.join("\n").gsub("/go/", "/").gsub(File.basename(__FILE__), "pact-broker")
+end
+
+def update_readme(usage_docs)
+  readme_text = File.read("README.md")
+  before_text = readme_text.split(START_MARKER).first
+  after_text = readme_text.split("<!-- end-autogenerated-docs -->", 2).last
+  new_readme_text = before_text + START_MARKER + "\n\n" + usage_docs + "\n\n" + END_MARKER + after_text
+  File.open("README.md", "w") { |file| file << new_readme_text }
+end
+
+update_readme(reformat_docs(generate_thor_docs))

data/spec/lib/pact_broker/client/matrix/abbreviate_version_number_spec.rb

@@ -0,0 +1,42 @@
+
+require 'pact_broker/client/matrix/abbreviate_version_number'
+
+module PactBroker
+  module Client
+    describe Matrix::AbbreviateVersionNumber do
+      describe '.call' do
+        subject(:result) { described_class.call(version) }
+
+        context 'when version is nil' do
+          let(:version) { nil }
+          it { is_expected.to be_nil }
+        end
+
+        context 'when version is git sha' do
+          let(:version) { '182f9c6e4d7a5779c4507cb8b3e505ac927d0394' }
+          it { is_expected.to eq('182f9c6...') }
+        end
+
+        context 'when version is too long' do
+          let(:version) { '182f9c6e4d7a5779c4507cb8b3e505ac927d0394' * 2 }
+          it { is_expected.to eq(version[0...60] + '...') }
+        end
+
+        context 'when the version is something unknown and fits max length' do
+          let(:version) { '123' }
+          it { is_expected.to eq('123') }
+        end
+
+        context 'when version is embedded into semantic version v1' do
+          let(:version) { 'v1.3.4+182f9c6e4d7a5779c4507cb8b3e505ac927d0394' }
+          it { is_expected.to eq('v1.3.4+182f9c6...') }
+        end
+
+        context 'when version is embedded into semantic version v2' do
+          let(:version) { '1.3.4(182f9c6e4d7a5779c4507cb8b3e505ac927d0394)' }
+          it { is_expected.to eq('1.3.4(182f9c6...)') }
+        end
+      end
+    end
+  end
+end

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

@@ -263,80 +263,9 @@ module PactBroker
         context "when the broker does not support creation of a version with a branch but a branch is specified" do
           let(:branch) { "main" }
 
-          context "when version_required is true" do
-            let(:version_required) { true }
-
-            it "raises an error" do
-              expect { subject.call }.to raise_error PactBroker::Client::Error
-            end
-          end
-        end
-
-        context "when the broker supports creation of a version with a branch" do
-          before do
-            allow(version_link).to receive(:expand).and_return(version_link)
-            allow(version_resource).to receive(:assert_success!).and_return(version_resource)
-            allow(version_resource).to receive_message_chain(:response, :status).and_return(version_creation_response_status)
-          end
-          let(:can_create_version) { true }
-          let(:version_link) { instance_double("PactBroker::Client::Hal::Link", put: version_resource) }
-          let(:version_resource) { instance_double("PactBroker::Client::Hal::Entity") }
-          let(:version_creation_response_status) { 201 }
-
-          before do
-            allow(index_resource).to receive(:_link).and_return(version_link)
-          end
-
-          context "when there is a branch, build_url or tags specified" do
-            let(:tags) { ["dev"] }
-            let(:branch) { ["main"] }
-            let(:build_url) { "build_url" }
-
-            it "creates a version with the branch, build_url and tags" do
-              expect(index_resource).to receive(:_link)
-              expect(version_link).to receive(:expand).with(pacticipant: "Consumer", version: "1.2.3")
-              expect(version_link).to receive(:put).with(branch: branch, buildUrl: build_url)
-              subject.call
-            end
-
-            context "when there is a branch but no tags" do
-              let(:tags) { [] }
-
-              it "does not set the tags, as this would overwrite the existing ones - not sure about this implementation" do
-                expect(version_link).to receive(:put).with(branch: branch, buildUrl: build_url)
-                subject.call
-              end
-            end
-
-            context "when the version response status is 201" do
-              it "puts a message indicating the version was created" do
-                expect($stdout).to receive(:puts).with(/Created/)
-                subject.call
-              end
-            end
-
-            context "when the version response status is 200" do
-              let(:version_creation_response_status) { 200 }
-
-              it "puts a message indicating the version was replaced" do
-                expect($stdout).to receive(:puts).with(/Replaced/)
-                subject.call
-              end
-            end
-          end
-
-          context "when there is no branch, tags or build_url specified" do
-            before do
-              allow(Retry).to receive(:while_error) { |&block| block.call }
-            end
-            let(:tags) { [] }
-            let(:branch) { nil }
-            let(:build_url) { nil }
-
-            it "does not create a version resource" do
-              expect(index_resource).to_not receive(:_link)
-              subject.call
-            end
+          it "logs a warning" do
+            expect($stdout).to receive(:puts).with(/WARN: This version/)
+            subject.call
           end
         end
       end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -186,112 +186,6 @@
         }
       }
     },
-    {
-      "description": "a request for the index resource",
-      "providerState": "the pb:pacticipant-version 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-version": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:pacticipant-version.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to create a pacticipant version",
-      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does not exist",
-      "request": {
-        "method": "put",
-        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
-        "headers": {
-          "Content-Type": "application/json",
-          "Accept": "application/hal+json"
-        },
-        "body": {
-          "branch": "main",
-          "buildUrl": "http://my-ci/builds/1"
-        }
-      },
-      "response": {
-        "status": 201,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
-          "branch": "main",
-          "buildUrl": "http://my-ci/builds/1",
-          "_links": {
-            "self": {
-              "href": "http://localhost:1234/some-url"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.self.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to create a pacticipant version",
-      "providerState": "version 26f353580936ad3b9baddb17b00e84f33c69e7cb of pacticipant Foo does exist",
-      "request": {
-        "method": "put",
-        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-26f353580936ad3b9baddb17b00e84f33c69e7cb",
-        "headers": {
-          "Content-Type": "application/json",
-          "Accept": "application/hal+json"
-        },
-        "body": {
-          "branch": "main",
-          "buildUrl": "http://my-ci/builds/1"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "number": "26f353580936ad3b9baddb17b00e84f33c69e7cb",
-          "branch": "main",
-          "buildUrl": "http://my-ci/builds/1",
-          "_links": {
-            "self": {
-              "href": "http://localhost:1234/some-url"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.self.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
     {
       "description": "a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5",
       "providerState": "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",
@@ -1638,6 +1532,112 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:publish-contracts relations 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:publish-contracts": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:publish-contracts.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to publish contracts",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "pacticipantName": "Foo",
+          "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+          "branch": "main",
+          "tags": [
+            "dev"
+          ],
+          "buildUrl": "http://build",
+          "contracts": [
+            {
+              "consumerName": "Foo",
+              "providerName": "Bar",
+              "specification": "pact",
+              "contentType": "application/json",
+              "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
+              "onConflict": "merge"
+            }
+          ]
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "_embedded": {
+            "pacticipant": {
+              "name": "Foo"
+            },
+            "version": {
+              "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+              "buildUrl": "http://build"
+            }
+          },
+          "logs": [
+            {
+              "level": "info",
+              "message": "some message"
+            }
+          ],
+          "_links": {
+            "pb:pacticipant-version-tags": [
+              {
+                "name": "dev"
+              }
+            ],
+            "pb:contracts": [
+              {
+                "href": "http://some-pact"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body.logs": {
+            "min": 1
+          },
+          "$.body.logs[*].*": {
+            "match": "type"
+          },
+          "$.body._links.pb:contracts[0].href": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request for the index resource",
       "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",

data/spec/readme_spec.rb

@@ -0,0 +1,16 @@
+require "pact_broker/client/cli/broker"
+
+RSpec.describe "the README" do
+  NOT_DOCUMENTED = ["version"]
+  COMMANDS = PactBroker::Client::CLI::Broker
+              .commands
+              .values
+              .collect(&:usage).collect { | usage | usage.split(" ").first } - NOT_DOCUMENTED
+  README = File.read("README.md")
+
+  COMMANDS.each do | command |
+    it "includes the documentation for #{command}" do
+      expect(README.include?("\n#### " + command)).to be_truthy
+    end
+  end
+end

data/spec/service_providers/publish_pacts_spec.rb

@@ -1,9 +1,7 @@
 require 'pact_broker/client/publish_pacts'
 require 'service_providers/pact_helper'
 
-publish_contracts_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("publish_contracts")
-
-RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feature_on do
+RSpec.describe "publishing contracts", pact: true 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)
@@ -27,7 +25,7 @@ RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feat
   end
   let(:pact_file_path_1) { "spec/fixtures/foo-bar.json" }
   let(:pact_file_paths) { [pact_file_path_1] }
-  let(:options) { {} }
+  let(:options) { { merge: true } }
   let(:pact_broker_client_options) { {} }
   let(:expected_content) { Base64.strict_encode64(JSON.parse(File.read(pact_file_path_1)).to_json) }
   let(:request_body) do
@@ -44,8 +42,7 @@ RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feat
           specification: "pact",
           contentType: "application/json",
           content: expected_content,
-          writeMode: "overwrite",
-          onConflict: "overwrite"
+          onConflict: "merge"
         }
       ]
     }