pact_broker-client 1.39.0 → 1.44.0

data/pact-broker-client.gemspec

@@ -33,4 +33,6 @@ Gem::Specification.new do |gem|
   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.24', '<1.0.0'
+  gem.add_development_dependency 'rspec-its', '~> 1.3'
 end

data/script/approve-all.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+for file in $(find spec/fixtures/approvals -ipath "*.received.*"); do
+  approved_path=$(echo "$file" | sed 's/received/approved/')
+  mv "$file" "$approved_path"
+done;

data/script/publish-pact.sh

@@ -1,3 +1,6 @@
+export PACT_BROKER_BASE_URL="http://localhost:9292"
+export PACT_BROKER_TOKEN="localhost"
+
 # bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
 #   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16b14 \
 #   --request POST \
@@ -5,16 +8,31 @@
 #   --contract-published
 
 bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
-  --uuid d40f38c3-aaa3-47f5-9161-95c07bc16555 \
-  --provider Bar \
+  --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/pacts/foo-bar.json \
-  --consumer-app-version 1.2.12 \
+# 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 \
+#   --broker-base-url http://localhost:9292 \
+#    --broker-username localhost --broker-password localhost \
+#     --auto-detect-version-properties \
+#     --build-url http://mybuild \
+#     --branch master --tag foo5
+
+# bundle exec bin/pact-broker create-or-update-webhook http://localhost:9393 \
+#   --uuid d40f38c3-aaa3-47f5-9161-95c07bc16555 \
+#   --provider Bar \
+#   --request POST \
+#   --contract-published
+
+
+PACT_BROKER_FEATURES=publish_contracts 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-username localhost --broker-password localhost \
+   --broker-token localhost \
     --auto-detect-version-properties \
     --build-url http://mybuild \
-    --branch master --tag foo5
+    --branch master --tag foo5 --tag foo6
 

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

@@ -0,0 +1,10 @@
+export PACT_BROKER_FEATURES=deployments
+
+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 --target foo
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --version 2 --environment test --target foo
+bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test

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

@@ -0,0 +1,13 @@
+Computer says yes \o/ 
+
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?        | RESULT#
+---------|-----------|----------|-----------|-----------------|--------
+Foo      | 1.2.3     | Bar      | 4.5.6     | true            | 1      
+Foo      | 3.4.5     | Bar      | 4.5.6     | false [ignored] | 2      
+
+VERIFICATION RESULTS
+--------------------
+1. http://result (success)
+2. http://result (failure)
+
+some notice

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

@@ -0,0 +1,7 @@
+Name: existing name
+Display Name: existing display name
+Production: true
+Contacts:
+- Name: Someone
+  Details:
+    Email Address: foo@bar.com

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/fixtures/approvals/list_environments.approved.txt

@@ -0,0 +1,3 @@
+UUID                                 | NAME | DISPLAY NAME | PRODUCTION
+-------------------------------------|------|--------------|-----------
+78e85fb2-9df1-48da-817e-c9bea6294e01 | test | Test         | false     

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

@@ -6,22 +6,27 @@ module PactBroker
     describe CanIDeploy do
       let(:pact_broker_base_url) { 'http://example.org' }
       let(:version_selectors) { [{ pacticipant: "Foo", version: "1" }] }
-      let(:matrix_options) { {} }
+      let(:matrix_options) { { } }
       let(:pact_broker_client_options) { { foo: 'bar' } }
       let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
       let(:matrix) do
         instance_double('Matrix::Resource',
-          deployable?: true,
+          deployable?: deployable,
           reason: 'some reason',
           any_unknown?: any_unknown,
           supports_unknown_count?: supports_unknown_count,
-          unknown_count: unknown_count)
+          supports_ignore?: supports_ignore,
+          unknown_count: unknown_count,
+          notices: notices)
       end
       let(:unknown_count) { 0 }
       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(:notices) { nil }
+      let(:supports_ignore) { true }
+      let(:deployable) { true }
 
 
       before do
@@ -55,10 +60,19 @@ module PactBroker
         it "returns a success reason" do
           expect(subject.message).to include "some reason"
         end
+
+        context "when there are notices" do
+          let(:notices) { [Notice.new(text: "some notice", type: "info")] }
+
+          it "returns the notices instead of the reason" do
+            expect(subject.message).to_not include "some reason"
+            expect(subject.message).to include "some notice"
+          end
+        end
       end
 
       context "when the versions are not deployable" do
-        let(:matrix) { instance_double('Matrix::Resource', deployable?: false, reason: 'some reason', any_unknown?: false) }
+        let(:matrix) { instance_double('Matrix::Resource', deployable?: false, reason: 'some reason', any_unknown?: false, notices: notices) }
 
         it "returns a failure response" do
           expect(subject.success).to be false
@@ -71,6 +85,15 @@ module PactBroker
         it "returns a failure reason" do
           expect(subject.message).to include "some reason"
         end
+
+        context "when there are notices" do
+          let(:notices) { [Notice.new(text: "some notice", type: "info")] }
+
+          it "returns the notices instead of the reason" do
+            expect(subject.message).to_not include "some reason"
+            expect(subject.message).to include "some notice"
+          end
+        end
       end
 
       context "when retry_while_unknown is greater than 0" do
@@ -115,6 +138,25 @@ module PactBroker
         end
       end
 
+      context "when there are ignore selectors but the matrix does not support ignoring" do
+        let(:matrix_options) { { ignore_selectors: [{ pacticipant_name: "Foo" }]} }
+        let(:supports_ignore) { false }
+
+        context "when deployable" do
+          it "returns a warning" do
+            expect(subject.message).to include "does not support"
+          end
+        end
+
+        context "when not deployable" do
+          let(:deployable) { false }
+
+          it "returns a warning" do
+            expect(subject.message).to include "does not support"
+          end
+        end
+      end
+
       context "when a PactBroker::Client::Error is raised" do
         before do
           allow(matrix_client).to receive(:get).and_raise(PactBroker::Client::Error.new('error text'))
@@ -125,7 +167,7 @@ module PactBroker
         end
 
         it "returns a failure message" do
-          expect(subject.message).to eq "error text"
+          expect(subject.message).to include "error text"
         end
       end
 

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

@@ -37,7 +37,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}, {output: 'table', retry_while_unknown: 1, retry_interval: 2}, {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}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
           invoke_can_i_deploy
         end
 
@@ -55,7 +55,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -66,7 +66,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -78,7 +78,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, { pact_broker_base_url: 'http://pact-broker', basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end
@@ -89,7 +89,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {token: "some token", verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {pact_broker_base_url: 'http://pact-broker', token: "some token", verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end

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

@@ -32,7 +32,7 @@ module PactBroker::Client::CLI
             ["spec/support/cli_test_pacts/foo.json"],
             { number: "1.2.3", tags: [], version_required: false },
             {},
-            {}
+            { pact_broker_base_url: 'http://pact-broker' }
           )
           invoke_broker
         end

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

@@ -66,7 +66,7 @@ module PactBroker
           it "calls PactBroker::Client::Webhooks::Create with pact broker details" do
             expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, broker_base_url, pact_broker_client_options |
               expect(broker_base_url).to eq "http://broker"
-              expect(pact_broker_client_options).to eq(basic_auth: { username: "username", password: "password"}, verbose: true)
+              expect(pact_broker_client_options).to eq(pact_broker_base_url: 'http://broker', basic_auth: { username: "username", password: "password"}, verbose: true)
               command_result
             end
             subject
@@ -92,7 +92,7 @@ module PactBroker
 
             it "calls Webhooks::Create without basic auth" do
               expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
-                expect(pact_broker_client_options).to eq(verbose: true)
+                expect(pact_broker_client_options).to eq(verbose: true, pact_broker_base_url: 'http://broker')
                 command_result
               end
               subject
@@ -110,7 +110,7 @@ module PactBroker
             it "calls Webhooks::Create without basic auth" do
 
               expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | _, _, pact_broker_client_options |
-                expect(pact_broker_client_options).to eq(verbose: true, token: "token")
+                expect(pact_broker_client_options).to eq(verbose: true, token: "token", pact_broker_base_url: 'http://broker')
                 command_result
               end
               subject

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

@@ -48,6 +48,27 @@ module PactBroker
           ],[
             ["--pacticipant", "Foo=Bar", "--version", "1.2.3"],
             [{ pacticipant: "Foo=Bar", version: "1.2.3" } ]
+          ],[
+            ["--ignore", "Foo", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", version: "1.2.3", ignore: true }]
+          ],[
+            ["--ignore", "Foo", "--ignore", "Bar", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", ignore: true }, { pacticipant: "Bar", version: "1.2.3", ignore: true }]
+          ],[
+            ["--ignore", "Foo", "--pacticipant", "Bar", "--version", "1.2.3"],
+            [{ pacticipant: "Foo", ignore: true }, { pacticipant: "Bar", version: "1.2.3" }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "1", "--version", "2"],
+            [{ pacticipant: "Foo", version: "2" }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "2", "--latest"],
+            [{ pacticipant: "Foo", version: "2", latest: true }]
+          ],[
+            ["--pacticipant", "Foo", "--version", "2", "--latest", "--latest"],
+            [{ pacticipant: "Foo", version: "2", latest: true }]
+          ],[
+            ["--version", "2"],
+            [{ pacticipant: nil, version: "2" }]
           ]
         ]
 

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