pact_broker-client 1.38.2 → 1.42.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,7 +1,38 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
-  --consumer-app-version 1.2.7 \
+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 \
+#   --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 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 \
-    --auto-detect-branch \
-    --build-url http://mybuild
+   --broker-token localhost \
+    --auto-detect-version-properties \
+    --build-url http://mybuild \
+    --branch master --tag foo5 --tag foo6
 

data/script/record-deployment.sh

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

data/script/record-undeployment.sh

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

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

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

data/spec/fixtures/foo-bar.json

@@ -0,0 +1,31 @@
+{
+  "consumer": {
+    "name": "Foo"
+  },
+  "provider": {
+    "name": "Bar"
+  },
+  "interactions": [
+    {
+      "description": "an example request",
+      "providerState": "a provider state",
+      "request": {
+        "method": "GET",
+        "path": "/",
+        "headers": {
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/hal+json"
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

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

@@ -6,11 +6,14 @@ module PactBroker::Client::CLI
   describe Broker do
     describe ".broker" do
       before do
-        allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(true)
+        allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(result)
         allow(PactBroker::Client::Git).to receive(:branch).and_return("bar")
         subject.options = OpenStruct.new(minimum_valid_options)
+        allow($stdout).to receive(:puts)
       end
 
+      let(:success) { true }
+      let(:result) { instance_double(PactBroker::Client::CommandResult, success: success, message: "message")}
       let(:file_list) { ["spec/support/cli_test_pacts/foo.json"] }
       let(:minimum_valid_options) do
         {
@@ -28,7 +31,8 @@ module PactBroker::Client::CLI
             "http://pact-broker",
             ["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
@@ -42,6 +46,7 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
@@ -56,6 +61,7 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
@@ -70,12 +76,29 @@ module PactBroker::Client::CLI
             anything,
             ["spec/support/cli_test_pacts/bar.json", "spec/support/cli_test_pacts/foo.json"],
             anything,
+            anything,
             anything
           )
           invoke_broker
         end
       end
 
+      context "with an invalid argument specified that gets interpreted as a path" do
+        let(:file_list) { ['--wrong'] }
+
+        it "raises a more helpful error" do
+          expect{ invoke_broker }.to raise_error(Thor::Error, 'ERROR: pact-broker publish was called with invalid arguments ["--wrong"]')
+        end
+      end
+
+      context "when a specified file does not exist" do
+        let(:file_list) { ['no-existy'] }
+
+        it "raises a more helpful error" do
+          expect{ invoke_broker }.to raise_error(Thor::Error, /Specified pact file 'no-existy' does not exist/)
+        end
+      end
+
       context "with a tag" do
         before do
           subject.options = OpenStruct.new(minimum_valid_options.merge(tag: ['foo']))
@@ -86,6 +109,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(tags: ['foo']),
+            anything,
             anything
           )
           invoke_broker
@@ -109,6 +133,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(tags: ['foo', 'bar']),
+            anything,
             anything
           )
           invoke_broker
@@ -127,6 +152,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "main", version_required: true),
+            anything,
             anything
           )
           invoke_broker
@@ -151,6 +177,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "bar", version_required: false),
+            anything,
             anything
           )
           invoke_broker
@@ -176,6 +203,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(branch: "bar", version_required: true),
+            anything,
             anything
           )
           invoke_broker
@@ -193,6 +221,7 @@ module PactBroker::Client::CLI
               anything,
               anything,
               hash_including(branch: "specified-branch", version_required: true),
+              anything,
               anything
             )
             invoke_broker
@@ -212,6 +241,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             hash_including(build_url: "http://ci"),
+            anything,
             anything
           )
           invoke_broker
@@ -230,6 +260,7 @@ module PactBroker::Client::CLI
             anything,
             anything,
             anything,
+            anything,
             hash_including(basic_auth: { username: 'foo', password: 'bar' })
           )
           invoke_broker
@@ -267,12 +298,10 @@ module PactBroker::Client::CLI
       end
 
       context "when the publish command is not successful" do
-        before do
-          allow(PactBroker::Client::PublishPacts).to receive(:call).and_return(false)
-        end
+        let(:success) { false }
 
-        it "raises a PactPublicationError" do
-          expect { invoke_broker }.to raise_error PactPublicationError
+        it "raises a SystemExit" do
+          expect { invoke_broker }.to raise_error SystemExit
         end
       end
     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