pact_broker-client 1.43.0 → 1.47.0

data/lib/pact_broker/client/verification_required.rb

@@ -0,0 +1,32 @@
+require "pact_broker/client/can_i_deploy"
+
+module PactBroker
+  module Client
+    class VerificationRequired < PactBroker::Client::CanIDeploy
+      def call
+        create_result(fetch_matrix_with_retries)
+      rescue StandardError => e
+        message = "Error determining if a verification already existed (#{e.message}) - verification should run just in case"
+        if options[:verbose]
+          message = "#{message}\n#{e.class} - #{e.backtrace.join("\n")}"
+        end
+        Result.new(true, message)
+      end
+
+      private
+
+      def create_result(matrix)
+        matrix_and_notices = format_matrix(matrix) + "\n\n" + remove_warnings(Term::ANSIColor.uncolor(notice_or_reason(matrix, :white)))
+        if matrix.any_unknown?
+          Result.new(true, matrix_and_notices + "\n\nVerification is required.")
+        else
+          Result.new(false, matrix_and_notices + "\n\nNo verification is required.")
+        end
+      end
+
+      def remove_warnings(lines)
+        lines.split("\n").select{ | line | !line.include?("WARN:") }.join("\n")
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.43.0'
+    VERSION = '1.47.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -1,4 +1,7 @@
-require_relative 'base_client'
+require 'pact_broker/client/base_client'
+require 'pact_broker/client/versions/describe'
+
+# Old code
 require 'pact_broker/client/pacts'
 
 module PactBroker

data/lib/pact_broker/client/versions/describe.rb

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/versions/formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Describe
 
         class Result

data/lib/pact_broker/client/versions/formatter.rb

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/json_formatter'
 require 'pact_broker/client/versions/text_formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Formatter
         def self.call(matrix_lines, format)
           formatter = case format

data/lib/pact_broker/client/versions/json_formatter.rb

@@ -1,11 +1,13 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class JsonFormatter
-        def self.call(matrix)
-          JSON.pretty_generate(matrix)
+        def self.call(version)
+          JSON.pretty_generate(version)
         end
       end
     end

data/lib/pact_broker/client/versions/text_formatter.rb

@@ -1,8 +1,10 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class TextFormatter
 
         Line = Struct.new(:number, :tags)

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

@@ -3,6 +3,7 @@ require 'pact_broker/client/hal'
 require 'ostruct'
 require 'json'
 require 'pact_broker/client/command_result'
+require "pact_broker/client/backports"
 
 module PactBroker
   module Client
@@ -61,16 +62,17 @@ module PactBroker
 
         def request_body
           webhook_request_body = JSON.parse(params.body) rescue params.body
+          request_params = {
+            url: params.url,
+            method: params.http_method,
+            headers: params.headers,
+            body: webhook_request_body,
+            username: params.username,
+            password: params.password
+          }.compact
           {
             events: params.events.collect{ | event | { "name" => event }},
-            request: {
-              url: params.url,
-              method: params.http_method,
-              headers: params.headers,
-              body: webhook_request_body,
-              username: params.username,
-              password: params.password
-            }
+            request: request_params
           }.tap { |req| req[:description] = params.description if params.description }
         end
 
@@ -85,6 +87,10 @@ module PactBroker
             body[:provider] = { name: params.provider }
           end
 
+          if params.team_uuid
+            body[:teamUuid] = params.team_uuid
+          end
+
           body
         end
 

data/script/record-deployment.sh

@@ -1,2 +1,2 @@
-PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-deployment \
+bundle exec bin/pact-broker record-deployment \
    --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292

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

@@ -0,0 +1,16 @@
+bundle exec bin/pact-broker create-or-update-pacticipant --name Foo
+bundle exec bin/pact-broker create-version-tag --pacticipant Foo --version 2 --tag main --auto-create-version
+bundle exec bin/pact-broker describe-version --pacticipant Foo --version 2
+bundle exec bin/pact-broker create-environment --name test
+bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-environment test
+
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target customer-1
+
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-1
+
+bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test
+bundle exec bin/pact-broker record-support-ended --pacticipant Foo --version 2 --environment test

data/script/record-undeployment.sh

@@ -1,4 +1,4 @@
-PACT_BROKER_FEATURES=deployments bundle exec bin/pact-broker record-undeployment \
+bundle exec bin/pact-broker record-undeployment \
    --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292 --output json --verbose
 
 

data/script/webhook-commands.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+bundle exec bin/pact-broker create-webhook \
+  'https://api.github.com/repos/foo/bar/statuses/${pactbroker.consumerVersionNumber}' \
+  -X POST \
+  -H "Content-Type: application/json" \
+  -d '{ "state": "${pactbroker.githubVerificationStatus}", "description": "Pact Verification Tests ${pactbroker.providerVersionTags}", "context": "${pactbroker.providerName}", "target_url": "${pactbroker.verificationResultUrl}" }' \
+  --user username:password \
+  --description "Publish pact verification status to Github" \
+  --contract-published \
+  --provider-verification-published \
+  --team-uuid 4ac05ed8-9e3b-4159-96c0-ad19e3b93658

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

@@ -0,0 +1,7 @@
+[dry-run] Computer says no ¯\_(ツ)_/¯ (but you're ignoring this by enabling dry run)
+[dry-run] 
+[dry-run] text matrix
+[dry-run] 
+[dry-run] some reason
+[dry-run] 
+[dry-run] Dry run enabled - ignoring any failures

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

@@ -0,0 +1,7 @@
+[dry-run] Computer says yes \o/ (and maybe you don't need to enable dry run)
+[dry-run] 
+[dry-run] text matrix
+[dry-run] 
+[dry-run] some reason
+[dry-run] 
+[dry-run] Dry run enabled - ignoring any failures

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

@@ -0,0 +1,2 @@
+Name: Pricing Service
+Repository Url: git@git.realestate.com.au:business-systems/pricing-service

data/spec/integration/describe_environment_spec.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/cli/broker'
+
+RSpec.describe "describe-environment" do
+  let(:index_body_hash) do
+    {
+      _links: {
+        "pb:pacticipant" => {
+          href: "http://broker/pacticipants/{pacticipant}"
+        }
+      }
+    }
+  end
+
+  let(:pacticipant_body_hash) { JSON.parse(File.read("./spec/support/pacticipant_get.json")) }
+
+  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!(:pacticipant_request) do
+    stub_request(:get, "http://broker/pacticipants/Foo").to_return(status: 200, body: pacticipant_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  let(:parameters) { %w{describe-pacticipant --name Foo --broker-base-url http://broker} }
+
+  subject { capture(:stdout) { PactBroker::Client::CLI::Broker.start(parameters) } }
+
+  it "prints the pacticipant properties" do
+    Approvals.verify(subject, :name => "describe_pacticipant", format: :txt)
+  end
+end

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

@@ -8,6 +8,7 @@ module PactBroker
       let(:version_selectors) { [{ pacticipant: "Foo", version: "1" }] }
       let(:matrix_options) { { } }
       let(:pact_broker_client_options) { { foo: 'bar' } }
+      let(:dry_run) { false }
       let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
       let(:matrix) do
         instance_double('Matrix::Resource',
@@ -23,7 +24,7 @@ module PactBroker
       let(:any_unknown) { unknown_count > 0 }
       let(:supports_unknown_count) { true }
       let(:retry_while_unknown) { 0 }
-      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5 } }
+      let(:options) { { output: 'text', retry_while_unknown: retry_while_unknown, retry_interval: 5, dry_run: dry_run } }
       let(:notices) { nil }
       let(:supports_ignore) { true }
       let(:deployable) { true }
@@ -69,6 +70,14 @@ module PactBroker
             expect(subject.message).to include "some notice"
           end
         end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "prefixes each line with [dry-run]" do
+            Approvals.verify(subject.message, :name => "can_i_deploy_success_dry_run", format: :txt)
+          end
+        end
       end
 
       context "when the versions are not deployable" do
@@ -94,6 +103,18 @@ module PactBroker
             expect(subject.message).to include "some notice"
           end
         end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "prefixes each line with [dry-run]" do
+            Approvals.verify(subject.message, :name => "can_i_deploy_failure_dry_run", format: :txt)
+          end
+        end
       end
 
       context "when retry_while_unknown is greater than 0" do
@@ -135,6 +156,19 @@ module PactBroker
           it "returns a failure message" do
             expect(subject.message).to match /does not provide a count/
           end
+
+          context "when dry_run is enabled" do
+            let(:dry_run) { true }
+
+            it "returns a success response" do
+              expect(subject.success).to be true
+            end
+
+            it "returns a failure message" do
+              expect(subject.message).to include "[dry-run]"
+              expect(subject.message).to match /does not provide a count/
+            end
+          end
         end
       end
 
@@ -169,6 +203,19 @@ module PactBroker
         it "returns a failure message" do
           expect(subject.message).to include "error text"
         end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "returns a failure message" do
+            expect(subject.message).to include "[dry-run]"
+            expect(subject.message).to match /error text/
+          end
+        end
       end
 
       context "when a StandardError is raised" do
@@ -183,7 +230,20 @@ module PactBroker
         end
 
         it "returns a failure message and backtrace" do
-          expect(subject.message).to include "Error retrieving matrix. StandardError - error text\n"
+          expect(subject.message).to include "Error retrieving matrix. StandardError - error text"
+        end
+
+        context "when dry_run is enabled" do
+          let(:dry_run) { true }
+
+          it "returns a success response" do
+            expect(subject.success).to be true
+          end
+
+          it "returns a failure message" do
+            expect(subject.message).to include "[dry-run]"
+            expect(subject.message).to match /error text/
+          end
         end
       end
     end

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

@@ -25,7 +25,8 @@ module PactBroker
             verbose: 'verbose',
             retry_while_unknown: 1,
             retry_interval: 2,
-            limit: 1000
+            limit: 1000,
+            dry_run: false
           }
         end
 
@@ -37,7 +38,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
+          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2, dry_run: false, verbose: "verbose"}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
           invoke_can_i_deploy
         end
 
@@ -94,6 +95,18 @@ module PactBroker
           end
         end
 
+        context "when PACT_BROKER_CAN_I_DEPLOY_DRY_RUN=true" do
+          before do
+            allow(ENV).to receive(:[]).and_call_original
+            allow(ENV).to receive(:[]).with("PACT_BROKER_CAN_I_DEPLOY_DRY_RUN").and_return("true")
+          end
+
+          it "invokes the CanIDeploy service with dry_run set to true" do
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, hash_including(dry_run: true), anything)
+            invoke_can_i_deploy
+          end
+        end
+
         context "when successful" do
           it "prints the message to stdout" do
             expect($stdout).to receive(:puts).with(message)

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

@@ -33,7 +33,8 @@ module PactBroker
               broker_username: "username",
               broker_password: "password",
               contract_content_changed: true,
-              verbose: true
+              verbose: true,
+              team_uuid: "1234"
             }
           end
 
@@ -49,7 +50,8 @@ module PactBroker
               body: "data",
               consumer: "consumer",
               provider: "provider",
-              events: ["contract_content_changed"]
+              events: ["contract_content_changed"],
+              team_uuid: "1234"
             }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
           end
 

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -0,0 +1,204 @@
+require 'pact_broker/client/deployments/record_deployment'
+
+module PactBroker
+  module Client
+    module Deployments
+      describe RecordDeployment do
+        describe ".call" do
+          let(:broker_base_url) { "http://broker" }
+          let(:index_body_hash) do
+            {
+              _links: {
+                "pb:environments" => { href: "#{broker_base_url}/environments" },
+                "pb:pacticipant-version" => {
+                  href: "#{broker_base_url}/pacticipants/{pacticipant}/versions/{version}"
+                }
+              }
+            }
+          end
+          let(:version_body_hash) do
+            {
+              "_links" => {
+                "pb:record-deployment" => [
+                  {
+                    name: "test",
+                    href: "#{broker_base_url}/record-deployment"
+                  }
+                ]
+              }
+            }
+          end
+          let(:environments_body_hash) do
+            {
+              "_links" => {
+                "pb:environments" => [
+                  {
+                    "name" => "test",
+                    "href" => ""
+                  }
+                ]
+              }
+
+            }
+          end
+          let(:record_deployment_body_hash) do
+            { "some" => "response" }
+          end
+          let!(:index_request) do
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+          let!(:version_request) do
+            stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 200, body: version_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let!(:environments_request) do
+            stub_request(:get, "http://broker/environments").
+              with(headers: { 'Accept'=>'application/hal+json' }).
+              to_return(status: 200, body: environments_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+          end
+          let!(:record_deployment_request) do
+            stub_request(:post, "http://broker/record-deployment").
+              to_return(status: 200, body: record_deployment_body_hash.to_json , headers: {})
+          end
+
+          let(:target) { "blue" }
+
+          let(:params) do
+            {
+              pacticipant_name: "Foo",
+              version_number: "1",
+              environment_name: "test",
+              target: target
+            }
+          end
+
+          let(:options) do
+            {
+              output: output,
+              verbose: true
+            }
+          end
+          let(:output) { "text" }
+          let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
+
+          subject { RecordDeployment.call(params, options, pact_broker_client_options) }
+
+          context "when the pb:environments relation does not exist" do
+            let(:index_body_hash) do
+              {
+                "_links" => {}
+              }
+            end
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the specified version does not exist" do
+            let!(:version_request) do
+              stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 404)
+            end
+
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "Foo version 1 not found"
+            end
+          end
+
+          context "when the pacticipant version does not support recording deployments" do
+            let(:version_body_hash) do
+              {
+                "_links" => {}
+              }
+            end
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the specified environment is not available for recording a deployment" do
+            let(:version_body_hash) do
+              {
+                "_links" => {
+                  "pb:record-deployment" => [
+                    {
+                      "name" => "prod",
+                      "href" => ""
+                    }
+                  ]
+                }
+              }
+            end
+
+            context "when the environment does not exist" do
+              let(:environments_body_hash) do
+                {
+                  "_links" => {
+                    "pb:environments" => [
+                      {
+                        "name" => "prod",
+                        "href" => ""
+                      },{
+                        "name" => "uat",
+                        "href" => ""
+                      }
+                    ]
+                  }
+                }
+              end
+
+              it "returns an error response" do
+                expect(subject.success).to be false
+                expect(subject.message).to include "No environment found with name 'test'. Available options: prod"
+              end
+            end
+
+            context "when the environment does exist" do
+              it "returns an error response" do
+                expect(subject.success).to be false
+                expect(subject.message).to include "Environment 'test' is not an available option for recording a deployment of Foo. Available options: prod"
+              end
+            end
+          end
+
+          context "when the output is json" do
+            let(:output) { "json" }
+
+            it "returns the JSON payload" do
+              expect(JSON.parse(subject.message)).to eq record_deployment_body_hash
+            end
+          end
+
+          context "when the response headers contain Pactflow" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_action)
+              allow_any_instance_of(RecordDeployment).to receive(:index_resource).and_return(index_resource)
+            end
+
+            let(:response_headers) { { "X-Pactflow-Sha" => "abc" } }
+
+            let(:index_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "indicates the API was Pactflow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (target blue) in Pactflow"
+            end
+
+            context "when target is nil" do
+              let(:target) { nil }
+
+              it "does not include the target in the result message" do
+                expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment in"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end