pact_broker-client 1.54.0 → 1.58.0

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

@@ -81,10 +81,14 @@ module PactBroker
 
           if params.consumer
             body[:consumer] = { name: params.consumer }
+          elsif params.consumer_label
+            body[:consumer] = { label: params.consumer_label }
           end
 
           if params.provider
             body[:provider] = { name: params.provider }
+          elsif params.provider_label
+            body[:provider] = { label: params.provider_label }
           end
 
           if params.team_uuid

data/script/can-i-deploy.sh

@@ -0,0 +1,5 @@
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json \
+  --consumer-app-version 1.2.26 \
+  --branch main
+
+bundle exec bin/pact-broker can-i-deploy --pacticipant "Pact Broker Client" --branch "main"

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

@@ -6,12 +6,12 @@ bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-envi
 
 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-deployment --pacticipant Foo --version 2 --environment test --application-instance customer-1
 
-bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --target customer-2
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --environment test --application-instance customer-2
 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-undeployment --pacticipant Foo --environment test --application-instance 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/spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb

@@ -49,7 +49,9 @@ module PactBroker
               password: "password",
               body: "data",
               consumer: "consumer",
+              consumer_label: nil,
               provider: "provider",
+              provider_label: nil,
               events: ["contract_content_changed"],
               team_uuid: "1234"
             }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
@@ -223,6 +225,59 @@ module PactBroker
                 expect { subject }.to raise_error(WebhookCreationError, /foo/)
               end
             end
+
+          end
+
+          context "when both consumer name and label options are specified" do
+            before do
+              options_hash[:consumer_label] = "consumer_label"
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "raises a WebhookCreationError" do
+              expect { subject }.to raise_error(
+                WebhookCreationError,
+                "Consumer name (--consumer) and label (--consumer_label) options are mutually exclusive"
+              )
+            end
+          end
+
+          context "when both provider name and label options are specified" do
+            before do
+              options_hash[:provider_label] = "provider_label"
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "raises a WebhookCreationError" do
+              expect { subject }.to raise_error(
+                WebhookCreationError,
+                "Provider name (--provider) and label (--provider_label) options are mutually exclusive"
+              )
+            end
+          end
+
+          context "when participant labels are specified" do
+            before do
+              options_hash.delete(:consumer)
+              options_hash.delete(:provider)
+              options_hash.merge!(consumer_label: 'consumer_label', provider_label: 'provider_label')
+              expected_params.merge!(
+                consumer: nil,
+                consumer_label: 'consumer_label',
+                provider: nil,
+                provider_label: 'provider_label'
+              )
+
+              broker.options = OpenStruct.new(options_hash)
+            end
+
+            it "calls PactBroker::Client::Webhooks::Create with participant labels in params" do
+              expect(PactBroker::Client::Webhooks::Create).to receive(:call) do | params, _, _ |
+                expect(params).to eq expected_params
+                command_result
+              end
+              subject
+            end
           end
         end
       end

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

@@ -69,6 +69,12 @@ module PactBroker
           ],[
             ["--version", "2"],
             [{ pacticipant: nil, version: "2" }]
+          ],[
+            ["--pacticipant", "Foo", "--branch", "main"],
+            [{ pacticipant: "Foo", branch: "main", latest: true }]
+          ],[
+            ["--branch", "main"],
+            [{ pacticipant: nil, branch: "main", latest: true }]
           ]
         ]
 

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

@@ -44,8 +44,9 @@ module PactBroker
           let(:record_deployment_body_hash) do
             { "some" => "response" }
           end
+          let(:index_headers) { { "Content-Type" => "application/hal+json" } }
           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" }  )
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: index_headers  )
           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" }  )
@@ -89,10 +90,20 @@ module PactBroker
                 "_links" => {}
               }
             end
+
             it "returns an error response" do
               expect(subject.success).to be false
               expect(subject.message).to include "does not support"
             end
+
+            context "when the server is Pactflow" do
+              let(:index_headers) { { "Content-Type" => "application/hal+json", "Pactflow-Something" => "foo" } }
+
+              it "returns an error response" do
+                expect(subject.message).to include "permission"
+                expect(subject.message).to include "does not support"
+              end
+            end
           end
 
           context "when the specified version does not exist" do

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

@@ -174,7 +174,7 @@ module PactBroker
 
         context "when a target is provided and there is no deployed version with a matching target" do
           let(:application_instance) { "wrong" }
-          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance to undeploy from the anonymous instance or specify one of the following application instances to record the undeployment from: customer-1." }
+          let(:expected_message) { "Foo is not currently deployed to application instance 'wrong' in test environment. Please omit the application instance or specify one of the following application instances to record the undeployment from: customer-1." }
 
           its(:success) { is_expected.to be false }
           its(:message) { is_expected.to include expected_message }

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

@@ -35,6 +35,16 @@ module PactBroker
           end
         end
 
+        context "when the branch starts with refs/heads/" do
+          before do
+            allow(ENV).to receive(:[]).with("GITHUB_REF").and_return("refs/heads/feature-x")
+          end
+
+          it "trims off the refs/heads/" do
+            expect(subject).to eq "feature-x"
+          end
+        end
+
         context "when there is one environment variable ending with _BRANCH" do
           before do
             allow(ENV).to receive(:keys).and_return(%w{FOO_BRANCH BAR_BRANCH BLAH})
@@ -108,6 +118,42 @@ module PactBroker
           include_examples "when raise_error is false"
         end
       end
+
+      describe ".build_url" do
+        before do
+          allow(ENV).to receive(:[]).and_call_original
+        end
+
+        subject { Git.build_url }
+
+        context "when nothing is set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+          end
+
+          it { is_expected.to eq nil }
+        end
+
+        context "when BUILDKITE_BUILD_URL is set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+            allow(ENV).to receive(:[]).with("BUILDKITE_BUILD_URL").and_return("http://build")
+          end
+
+          it { is_expected.to eq "http://build" }
+        end
+
+        context "when the Github Actions env vars are set" do
+          before do
+            allow(ENV).to receive(:[]).and_return(nil)
+            allow(ENV).to receive(:[]).with("GITHUB_SERVER_URL").and_return("https://github.com")
+            allow(ENV).to receive(:[]).with("GITHUB_REPOSITORY").and_return("org/repo")
+            allow(ENV).to receive(:[]).with("GITHUB_RUN_ID").and_return("1")
+          end
+
+          it { is_expected.to eq "https://github.com/org/repo/actions/runs/1" }
+        end
+      end
     end
   end
 end

data/spec/lib/pact_broker/client/hal/link_spec.rb

@@ -5,6 +5,10 @@ require 'pact_broker/client/hal/http_client'
 module PactBroker::Client
   module Hal
     describe Link do
+      before do
+        allow(response).to receive(:header).with("Content-Type").and_return(content_type)
+      end
+
       let(:http_client) do
         instance_double('PactBroker::Client::Hal::HttpClient', post: response)
       end
@@ -33,6 +37,8 @@ module PactBroker::Client
         }
       end
 
+      let(:content_type) { nil }
+
       subject { Link.new(attrs, http_client) }
 
       before do
@@ -67,6 +73,15 @@ module PactBroker::Client
             expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body.to_json, http_client, response)
             do_run
           end
+
+          context "when a JSON error is returned" do
+            let(:content_type) { "application/json" }
+
+            it "parses the response body" do
+              expect(PactBroker::Client::Hal::ErrorEntity).to receive(:new).with("http://foo/{bar}", response_body, http_client, response)
+              do_run
+            end
+          end
         end
       end
 

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1995,6 +1995,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2067,6 +2077,28 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            },
+            {
+              "name": "contract_published"
+            },
+            {
+              "name": "provider_verification_published"
+            },
+            {
+              "name": "provider_verification_succeeded"
+            },
+            {
+              "name": "provider_verification_failed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2125,6 +2157,14 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": "<xml></xml>"
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2323,6 +2363,88 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a consumer specified by a label",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "consumer": {
+            "label": "consumer_label"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2442,6 +2564,88 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url",
+              "title": "A title"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body.description": {
+            "match": "type"
+          },
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.self.title": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook with a JSON body for a provider specified by a label",
+      "request": {
+        "method": "post",
+        "path": "/HAL-REL-PLACEHOLDER-PB-WEBHOOKS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "description": "a webhook",
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
+          "request": {
+            "url": "https://webhook",
+            "method": "POST",
+            "headers": {
+              "Foo": "bar",
+              "Bar": "foo"
+            },
+            "body": {
+              "some": "body"
+            },
+            "username": "username",
+            "password": "password"
+          },
+          "provider": {
+            "label": "provider_label"
+          }
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2501,6 +2705,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2597,6 +2811,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",
@@ -2663,6 +2887,16 @@
         },
         "body": {
           "description": "a webhook",
+          "request": {
+            "body": {
+              "some": "body"
+            }
+          },
+          "events": [
+            {
+              "name": "contract_content_changed"
+            }
+          ],
           "_links": {
             "self": {
               "href": "http://localhost:1234/some-url",

data/spec/service_providers/webhooks_create_spec.rb

@@ -54,6 +54,14 @@ RSpec.describe "creating a webhook", pact: true do
       headers: pact_broker_response_headers,
       body: {
         description: Pact.like("a webhook"),
+        request: {
+          body: {
+            some: "body"
+          }
+        },
+        events: [
+          name: "contract_content_changed"
+        ],
         _links: {
           self: {
             href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
@@ -92,6 +100,7 @@ RSpec.describe "creating a webhook", pact: true do
     before do
       params.merge!(events: event_names)
       request_body.merge!("events" => event_names.map{ |event_name| { "name" => event_name } })
+      success_response[:body].merge!(events: event_names.map{ |event_name| { "name" => event_name } })
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
@@ -112,6 +121,7 @@ RSpec.describe "creating a webhook", pact: true do
   context "when a valid webhook with an XML body is submitted" do
     before do
       request_body["request"]["body"] = body
+      success_response[:body][:request][:body] = body
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")
@@ -207,6 +217,30 @@ RSpec.describe "creating a webhook", pact: true do
     end
   end
 
+  context "when consumer is specified using a label" do
+    before do
+      params.delete(:consumer)
+      params.delete(:provider)
+      params.merge!(consumer_label: "consumer_label")
+      request_body["consumer"] = { "label" => "consumer_label" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body for a consumer specified by a label")
+        .with(
+          method: :post,
+          path: placeholder_path('pb:webhooks'),
+          headers: post_request_headers,
+          body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+
   context "when only a consumer is specified and it does not exist" do
     before do
       params.delete(:provider)
@@ -257,6 +291,30 @@ RSpec.describe "creating a webhook", pact: true do
     end
   end
 
+  context "when provider is specified using a label" do
+    before do
+      params.delete(:consumer)
+      params.delete(:provider)
+      params.merge!(provider_label: "provider_label")
+      request_body["provider"] = { "label" => "provider_label" }
+      mock_pact_broker_index(self)
+
+      pact_broker
+        .upon_receiving("a request to create a webhook with a JSON body for a provider specified by a label")
+        .with(
+          method: :post,
+          path: placeholder_path('pb:webhooks'),
+          headers: post_request_headers,
+          body: request_body)
+        .will_respond_with(success_response)
+    end
+
+    it "returns a CommandResult with success = true" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+
   context "when neither consumer nor provider are specified" do
     before do
       params.delete(:consumer)

data/tasks/pact.rake

@@ -1,4 +1,5 @@
-require 'pact_broker/client/tasks'
+require "pact_broker/client/tasks"
+require "pact_broker/client/git"
 
 PactBroker::Client::PublicationTask.new(:localhost) do | task |
   require 'pact_broker/client/version'
@@ -35,4 +36,5 @@ PactBroker::Client::PublicationTask.new(:pactflow) do | task |
   task.consumer_version = version
   task.pact_broker_base_url = "https://pact-oss.pactflow.io"
   task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
+  task.build_url = PactBroker::Client::Git.build_url
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.54.0
+  version: 1.58.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -319,6 +319,7 @@ files:
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - script/approve-all.sh
+- script/can-i-deploy.sh
 - script/create-pacticipant.sh
 - script/publish-pact.sh
 - script/record-deployment.sh
@@ -430,7 +431,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.31
 signing_key: 
 specification_version: 4
 summary: See description