pact_broker-client 1.70.0 → 1.72.0

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

@@ -0,0 +1,104 @@
+require "pact_broker/client/base_command"
+require "pact_broker/client/versions/create"
+require 'pact_broker/client/colorize_notices'
+require "base64"
+
+module Pactflow
+  module Client
+    module ProviderContracts
+      class PublishTheOldWay < PactBroker::Client::BaseCommand
+        attr_reader :branch_name, :tags, :provider_name, :provider_version_number, :contract, :verification_results
+
+        def initialize(params, options, pact_broker_client_options)
+          super
+          @provider_name = params[:provider_name]
+          @provider_version_number = params[:provider_version_number]
+          @branch_name = params[:branch_name]
+          @tags = params[:tags] || []
+          @contract = params[:contract]
+          @verification_results = params[:verification_results]
+        end
+
+        private
+
+        def do_call
+          create_branch_version_and_tags
+          render_response(create_contract)
+        end
+
+        def render_response(res)
+          notices = [
+            { type: 'success', text: "Successfully published provider contract for #{provider_name} version #{provider_version_number} to PactFlow"},
+          ]
+          if res.body && res.body['_links'] && res.body['_links']['pf:ui']['href']
+            notices.concat([{ text: "View the uploaded contract at #{res.body['_links']['pf:ui']['href']}" }])
+          end
+          notices.concat(next_steps)
+          PactBroker::Client::CommandResult.new(true, PactBroker::Client::ColorizeNotices.call(notices.collect do |n|
+                                                                                                 OpenStruct.new(n)
+                                                                                               end).join("\n"))
+        end
+
+        def next_steps
+          [
+            { type: 'prompt', text: 'Next steps:' },
+            { type: 'prompt',
+              text: '  * Check your application is safe to deploy - https://docs.pact.io/can_i_deploy' },
+            { text: "       pact-broker can-i-deploy --pacticipant #{provider_name} --version #{provider_version_number} --to-environment <your environment name>" },
+            { type: 'prompt',
+              text: '  * Record deployment or release to specified environment (choose one) - https://docs.pact.io/go/record-deployment' },
+            { text: "       pact-broker record-deployment --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" },
+            { text: "       pact-broker record-release --pacticipant #{provider_name} --version #{provider_version_number} --environment <your environment name>" }
+          ]
+        end
+
+        def create_branch_version_and_tags
+          if branch_name || tags.any?
+            pacticipant_version_params = {
+              pacticipant_name: provider_name,
+              version_number: provider_version_number,
+              branch_name: branch_name,
+              tags: tags
+            }
+            result = PactBroker::Client::Versions::Create.call(pacticipant_version_params, options, pact_broker_client_options)
+            if !result.success
+              raise PactBroker::Client::Error.new(result.message)
+            end
+          end
+        end
+
+        def create_contract
+          contract_path = "#{pact_broker_base_url}/contracts/provider/{provider}/version/{version}"
+          entrypoint = create_entry_point(contract_path, pact_broker_client_options)
+          entrypoint.expand(provider: provider_name, version: provider_version_number).put!(contract_params).response
+        end
+
+        def contract_params
+          verification_results_params = {
+                                          success: verification_results[:success],
+                                          content:  verification_results[:content] ? encode_content(verification_results[:content]) : nil,
+                                          contentType: verification_results[:content_type],
+                                          format: verification_results[:format],
+                                          verifier: verification_results[:verifier],
+                                          verifierVersion: verification_results[:verifier_version]
+                                        }.compact
+                                        
+          body_params = {
+                          content: encode_content(contract[:content]),
+                          contractType: contract[:specification],
+                          contentType: contract[:content_type],
+                        }.compact
+
+          if verification_results_params.any?
+            body_params[:verificationResults] = verification_results_params
+          end
+          body_params
+        end
+
+        def encode_content oas
+          Base64.strict_encode64(oas)
+        end
+      end
+    end
+  end
+end

data/pact-broker-client.gemspec

@@ -27,12 +27,4 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'rake', '~> 13.0' #For FileList
   gem.add_runtime_dependency 'dig_rb', '~> 1.0'
-
-  gem.add_development_dependency 'fakefs', '~> 2.4'
-  gem.add_development_dependency 'webmock', '~> 3.0'
-  gem.add_development_dependency 'conventional-changelog', '~>1.3'
-  gem.add_development_dependency 'pact', '~> 1.16'
-  gem.add_development_dependency 'pact-support', '~> 1.16'
-  gem.add_development_dependency 'approvals', '0.0.26' 
-  gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/script/ci/record-release.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -Eeuxo pipefail
+
+bundle exec bin/pact-broker record-deployment \
+   --pacticipant "Pact Broker Client" --version $GITHUB_SHA \
+   --environment production

data/script/foo-bar.json

@@ -0,0 +1,81 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description": "a request to list the latest pacts",
+      "providerState": "a pact between Condor and the Pricing Service exists",
+      "request": {
+        "method": "get",
+        "path": "/pacts/latest",
+        "headers": {
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json"
+        },
+        "body": {
+          "_links": {
+            "self": {
+              "href": "http://example.org/pacts/latest"
+            }
+          },
+          "pacts": [
+            {
+              "_links": {
+                "self": [
+                  {
+                    "href": "http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/latest"
+                  },
+                  {
+                    "href": "http://example.org/pacts/provider/Pricing%20Service/consumer/Condor/version/1.3.0"
+                  }
+                ]
+              },
+              "_embedded": {
+                "consumer": {
+                  "name": "Condor",
+                  "_links": {
+                    "self": {
+                      "href": "http://example.org/pacticipants/Condor"
+                    }
+                  },
+                  "_embedded": {
+                    "version": {
+                      "number": "1.3.0"
+                    }
+                  }
+                },
+                "provider": {
+                  "_links": {
+                    "self": {
+                      "href": "http://example.org/pacticipants/Pricing%20Service"
+                    }
+                  },
+                  "name": "Pricing Service"
+                }
+              }
+            }
+          ]
+        },
+        "matchingRules": {
+          "$.headers.Content-Type": {
+            "match": "regex",
+            "regex": "application\\/hal\\+json"
+          }
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

data/script/publish-pact.sh

@@ -1,5 +1,5 @@
-export PACT_BROKER_BASE_URL="http://localhost:9292"
-export PACT_BROKER_TOKEN="localhost"
+export PACT_BROKER_BASE_URL=${PACT_BROKER_BASE_URL:-"http://localhost:9292"}
+export PACT_BROKER_TOKEN=${PACT_BROKER_TOKEN:-"localhost"}
 #export PACT_BROKER_FEATURES=publish_pacts_using_old_api
 
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
@@ -8,11 +8,11 @@ export PACT_BROKER_TOKEN="localhost"
 #   --description "foo webhook" \
 #   --contract-published
 
-bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
-  --uuid d40f38c3-aaa3-47f5-9161-95csfadfsd7 \
-  --description "This is quite a long description for a webhook that I hope will be truncated" \
-  --request POST \
-  --contract-published
+# bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
+#   --uuid d40f38c3-aaa3-47f5-9161-95csfadfsd7 \
+#   --description "This is quite a long description for a webhook that I hope will be truncated" \
+#   --request POST \
+#   --contract-published
 
 # bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json spec/fixtures/foo-bar.json \
 #   --consumer-app-version 1.2.12 \
@@ -29,10 +29,8 @@ bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --contract-published
 
 
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+bundle exec bin/pact-broker publish scripts/foo-bar.json \
   --consumer-app-version 1.2.26 \
-  --broker-base-url http://localhost:9292 \
-   --broker-token localhost \
     --auto-detect-version-properties \
     --build-url http://mybuild \
     --branch master --tag foo5 --tag foo6

data/script/publish-provider-contract.sh

@@ -1,7 +1,7 @@
 export PACT_BROKER_BASE_URL=${PACT_BROKER_BASE_URL:-"http://localhost:9292"}
 bundle exec bin/pactflow publish-provider-contract  \
   script/oas.yml \
-  --provider Foo \
+  --provider Bar \
   --provider-app-version 1013b5650d61214e19f10558f97fb5a3bb082d44 \
   --branch main \
   --tag dev \

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

@@ -13,7 +13,7 @@ PACT_BROKER_COMMAND_GROUPS = [
   [PactBroker::Client::CLI::Broker, "Environments", %w[create-environment update-environment describe-environment delete-environment list-environments]],
   [PactBroker::Client::CLI::Broker, "Deployments", %w[record-deployment record-undeployment]],
   [PactBroker::Client::CLI::Broker, "Releases", %w[record-release record-support-ended]],
-  [PactBroker::Client::CLI::Broker, "Matrix", %w[can-i-deploy]],
+  [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, "Tags", %w[create-version-tag]],

data/spec/fixtures/approvals/publish_provider_contract.approved.txt

@@ -0,0 +1,2 @@
+some notice
+some other notice

data/spec/integration/publish_provider_contract_spec.rb

@@ -0,0 +1,53 @@
+require "pactflow/client/cli/pactflow"
+
+RSpec.describe "publish-provider-contract" do
+  let(:index_body_hash) do
+    {
+      _links: {
+        "pf:publish-provider-contract" => {
+          href: "http://broker/some-publish/{provider}"
+        }
+      }
+    }
+  end
+
+  let(:post_response_body) do
+      {
+        "notices"=>[{"text"=>"some notice", "type"=>"info"}, {"text"=>"some other notice", "type"=>"info"}]
+      }
+  end
+
+  let!(:index_request) do
+    stub_request(:get, "http://broker").to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  let!(:publish_request) do
+    stub_request(:post, "http://broker/some-publish/Bar").to_return(status: 200, body: post_response_body.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  let(:parameters) do
+    %w{
+      publish-provider-contract
+      script/oas.yml
+      --provider Bar
+      --broker-base-url http://broker
+      --provider-app-version 1013b5650d61214e19f10558f97fb5a3bb082d44
+      --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
+      --verification-results-format text
+      --verifier my-custom-tool
+      --verifier-version "1.0"
+    }
+  end
+
+  subject { capture(:stdout) { Pactflow::Client::CLI::Pactflow.start(parameters) } }
+
+  it "prints the notices" do
+    Approvals.verify(subject, :name => "publish_provider_contract", format: :txt)
+  end
+end

data/spec/lib/pactflow/client/provider_contracts/publish_spec.rb

@@ -0,0 +1,178 @@
+require "pactflow/client/provider_contracts/publish"
+
+module Pactflow
+  module Client
+    module ProviderContracts
+      describe Publish 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(:command_params) do
+          {
+            provider_name: "Bar",
+            provider_version_number: "1",
+            branch_name: "main",
+            tags: ["dev"],
+            build_url: "http://build",
+            contract: {
+              content: { "some" => "contract" }.to_yaml,
+              content_type: "application/yaml",
+              specification: "oas"
+            },
+            verification_results: {
+              success: true,
+              content: "some results",
+              content_type: "text/plain",
+              format: "text",
+              verifier: "my custom tool",
+              verifier_version: "1.0"
+            }
+          }
+        end
+
+        let(:options) do
+          {
+            verbose: false
+          }
+        end
+
+        let(:pact_broker_client_options) do
+          { pact_broker_base_url: "http://pactflow" }
+        end
+
+        let(:index_body_hash) do
+          {
+            _links: {
+              "pf:publish-provider-contract" => {
+                href: "http://pactflow/some-publish/{provider}"
+              }
+            }
+          }
+        end
+
+        let(:post_response_body) do
+            {
+              "notices"=>[{"text"=>"some notice", "type"=>"info"}]
+            }
+        end
+
+        let!(:index_request) do
+          stub_request(:get, "http://pactflow")
+            .to_return(
+              status: index_status,
+              body: index_body_hash.to_json,
+              headers: { "Content-Type" => "application/hal+json" }
+            )
+        end
+        let(:index_status) { 200 }
+
+        let!(:publish_request) do
+          stub_request(:post, "http://pactflow/some-publish/Bar")
+            .to_return(
+              status: publish_status,
+              body: post_response_body.to_json,
+              headers: { "Content-Type" => "application/hal+json" }
+            )
+        end
+        let(:publish_status) { 200 }
+
+        subject { Publish.call(command_params, options, pact_broker_client_options) }
+
+        context "when there is no relation pf:publish-provider-contract" do
+          before do
+            allow(PublishTheOldWay).to receive(:call).with(command_params, options, pact_broker_client_options).and_return(instance_double(PactBroker::Client::CommandResult))
+          end
+
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+
+          it "publishes the provider contracts the old way" do
+            expect(PublishTheOldWay).to receive(:call).with(command_params, options, pact_broker_client_options)
+            subject
+          end
+        end
+
+        context "when the feature is disabled" do
+          before do
+            allow(ENV).to receive(:fetch).and_call_original
+            allow(ENV).to receive(:fetch).with("PACTFLOW_FEATURES", "").and_return("publish_provider_contracts_using_old_api")
+          end
+
+          it "publishes the provider contracts the old way" do
+            expect(PublishTheOldWay).to receive(:call).with(command_params, options, pact_broker_client_options)
+            subject
+          end
+        end
+
+        it "returns a result and message" do
+          expect(subject.success).to be true
+          expect(subject.message).to include("some notice")
+        end
+
+        it "colourises the notices" do
+          expect(PactBroker::Client::ColorizeNotices).to receive(:call).with([OpenStruct.new(text: "some notice", type: "info")]).and_return("coloured notices")
+          expect(subject.message).to eq "coloured notices"
+        end
+
+        context "when the output is json" do
+          let(:options) { { output: "json" } }
+
+          it "returns the raw response" do
+            expect(subject.message).to eq post_response_body.to_json
+          end
+        end
+
+        context "when there is an error retrieving the index" do
+          let(:index_status) { 500 }
+          let(:index_body_hash) { { "some" => "error" }}
+
+          it "returns an error result with the response body" do
+            expect(subject.success).to be false
+            expect(subject.message).to match(/some.*error/)
+          end
+        end
+
+        context "when there is an error response from publishing" do
+          let(:publish_status) { 400 }
+          let(:post_response_body) do
+            {
+              "some" => "error"
+            }
+          end
+
+          it "returns an error result with the response body" do
+            expect(subject.success).to be false
+            expect(subject.message).to match(/some.*error/)
+          end
+
+          context "when the output is json" do
+            let(:options) { { output: "json" } }
+
+            it "returns the raw response" do
+              expect(subject.message).to eq post_response_body.to_json
+            end
+          end
+        end
+
+        context "when there is an error response from publishing" do
+          let(:publish_status) { 400 }
+          let(:post_response_body) do
+            {
+              "some" => "error"
+            }
+          end
+
+          it "returns an error result with the response body" do
+            expect(subject.success).to be false
+            expect(subject.message).to match(/some.*error/)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pactflow.json

@@ -6,6 +6,103 @@
     "name": "PactFlow"
   },
   "interactions": [
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:publish-provider-contract 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": {
+            "pf:publish-provider-contract": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-{provider}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pf:publish-provider-contract.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{provider}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to publish a provider contract",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PF-PUBLISH-PROVIDER-CONTRACT-Bar",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "pacticipantVersionNumber": "1",
+          "tags": [
+            "dev"
+          ],
+          "branch": "main",
+          "buildUrl": "http://build",
+          "contract": {
+            "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
+            "contentType": "application/yaml",
+            "specification": "oas",
+            "selfVerificationResults": {
+              "success": true,
+              "content": "c29tZSByZXN1bHRz",
+              "contentType": "text/plain",
+              "format": "text",
+              "verifier": "my custom tool",
+              "verifierVersion": "1.0"
+            }
+          }
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "notices": [
+            {
+              "text": "some notice",
+              "type": "info"
+            }
+          ],
+          "_embedded": {
+            "version": {
+              "number": "1"
+            }
+          },
+          "_links": {
+            "pb:pacticipant-version-tags": [
+              {
+              }
+            ],
+            "pb:branch-version": {
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.notices": {
+            "min": 1
+          },
+          "$.body.notices[*].*": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request to create a provider contract",
       "request": {
@@ -16,7 +113,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
-          "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+          "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
           "contractType": "oas",
           "contentType": "application/yaml",
           "verificationResults": {
@@ -47,7 +144,7 @@
           "Accept": "application/hal+json"
         },
         "body": {
-          "content": "LS0tCjpzb21lOiBjb250cmFjdAo=",
+          "content": "LS0tCnNvbWU6IGNvbnRyYWN0Cg==",
           "contractType": "oas",
           "contentType": "application/yaml",
           "verificationResults": {
@@ -68,9 +165,14 @@
         "body": {
           "_links": {
             "pf:ui": {
-              "href": "http://localhost:1235/contracts/bi-directional/provider/Bar/version/1/provider-contract"
+              "href": "some-url"
             }
           }
+        },
+        "matchingRules": {
+          "$.body._links.pf:ui.href": {
+            "match": "type"
+          }
         }
       }
     },

data/spec/service_providers/pact_helper.rb

@@ -25,10 +25,12 @@ end
 
 module PactBrokerPactHelperMethods
 
+  # @param [String] relation eg "pb:pacticipant"
+  # @param [Array<String>] params eg ["Foo"]
   def placeholder_path(relation, params = [])
     path = "/HAL-REL-PLACEHOLDER-#{relation.gsub(':', '-').upcase}"
     if params.any?
-      joined_params = params.collect{ |param| "{#{param}}"}.join("-")
+      joined_params = params.join("-")
       path = "#{path}-#{joined_params}"
     end
 
@@ -36,7 +38,19 @@ module PactBrokerPactHelperMethods
   end
 
   def placeholder_url(relation, params = [], mock_service = pact_broker)
-    "#{mock_service.mock_service_base_url}#{placeholder_path(relation, params)}"
+    "#{mock_service.mock_service_base_url}#{placeholder_path_for_term(relation, params)}"
+  end
+
+  # @param [String] relation eg "pb:pacticipants"
+  # @param [Array<String>] params eg ["pacticipant"]
+  def placeholder_path_for_term(relation, params = [])
+    path = "/HAL-REL-PLACEHOLDER-#{relation.gsub(':', '-').upcase}"
+    if params.any?
+      joined_params = params.collect{ |param| "{#{param}}"}.join("-")
+      path = "#{path}-#{joined_params}"
+    end
+
+    path
   end
 
   def placeholder_url_term(relation, params = [], mock_service = pact_broker)