pact_broker-client 1.45.0 → 1.48.0

data/spec/pacts/pact_broker_client-pactflow.json

@@ -0,0 +1,118 @@
+{
+  "consumer": {
+    "name": "Pact Broker Client"
+  },
+  "provider": {
+    "name": "Pactflow"
+  },
+  "interactions": [
+    {
+      "description": "a request for 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": {
+            "pb:webhooks": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-WEBHOOKS"
+            },
+            "pb:pacticipants": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANTS"
+            },
+            "pb:pacticipant": {
+              "href": "http://localhost:1235/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-{pacticipant}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:webhooks.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.pb:pacticipants.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          },
+          "$.body._links.pb:pacticipant.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to create a webhook for a team",
+      "providerState": "a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists",
+      "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"
+            }
+          },
+          "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/hal+json;charset=utf-8"
+        },
+        "body": {
+          "description": "a webhook",
+          "teamUuid": "2abbc12a-427d-432a-a521-c870af1739d9",
+          "_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"
+          }
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

data/spec/service_providers/pact_helper.rb

@@ -8,7 +8,6 @@ Pact.configure do | config |
 end
 
 Pact.service_consumer 'Pact Broker Client' do
-
   has_pact_with "Pact Broker" do
     mock_service :pact_broker do
       port 1234
@@ -16,6 +15,12 @@ Pact.service_consumer 'Pact Broker Client' do
     end
   end
 
+  has_pact_with "Pactflow" do
+    mock_service :pactflow do
+      port 1235
+      pact_specification_version "2.0"
+    end
+  end
 end
 
 module PactBrokerPactHelperMethods
@@ -30,22 +35,22 @@ module PactBrokerPactHelperMethods
     path
   end
 
-  def placeholder_url(relation, params = [])
-    "#{pact_broker.mock_service_base_url}#{placeholder_path(relation, params)}"
+  def placeholder_url(relation, params = [], mock_service = pact_broker)
+    "#{mock_service.mock_service_base_url}#{placeholder_path(relation, params)}"
   end
 
-  def placeholder_url_term(relation, params = [])
+  def placeholder_url_term(relation, params = [], mock_service = pact_broker)
     regexp = "http:\/\/.*"
     if params.any?
       joined_params_for_regexp = params.collect{ |param| "{#{param}}"}.join(".*")
       regexp = "#{regexp}#{joined_params_for_regexp}"
     end
 
-    Pact.term(placeholder_url(relation, params), /#{regexp}/)
+    Pact.term(placeholder_url(relation, params, mock_service), /#{regexp}/)
   end
 
-  def mock_pact_broker_index(context)
-    pact_broker
+  def mock_pact_broker_index(context, mock_service = pact_broker)
+    mock_service
       .upon_receiving("a request for the index resource")
       .with(
           method: :get,
@@ -57,13 +62,13 @@ module PactBrokerPactHelperMethods
           body: {
             _links: {
               :'pb:webhooks' => {
-                href: placeholder_url_term('pb:webhooks')
+                href: placeholder_url_term('pb:webhooks', [], mock_service)
               },
               :'pb:pacticipants' => {
-                href: placeholder_url_term('pb:pacticipants')
+                href: placeholder_url_term('pb:pacticipants', [], mock_service)
               },
               :'pb:pacticipant' => {
-                href: placeholder_url_term('pb:pacticipant', ['pacticipant'])
+                href: placeholder_url_term('pb:pacticipant', ['pacticipant'], mock_service)
               }
             }
           }

data/spec/service_providers/pactflow_webhooks_create_spec.rb

@@ -0,0 +1,86 @@
+require_relative 'pact_helper'
+require 'pact_broker/client/webhooks/create'
+
+RSpec.describe "creating a webhook in Pactflow", pact: true do
+
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) do
+    {
+      description: "a webhook",
+      events: %w{contract_content_changed},
+      http_method: "POST",
+      url: "https://webhook",
+      headers: { "Foo" => "bar", "Bar" => "foo"},
+      body: body,
+      team_uuid: "2abbc12a-427d-432a-a521-c870af1739d9"
+    }
+  end
+
+  let(:body) { { some: "body" }.to_json }
+
+  let(:request_body) do
+    {
+      "description" => "a webhook",
+      "events" => [
+        "name" => "contract_content_changed"
+      ],
+      "request" => {
+        "url" => "https://webhook",
+        "method" => "POST",
+        "headers" => {
+          "Foo" => "bar",
+          "Bar" => "foo"
+        },
+        "body" => {
+          "some" => "body"
+        },
+      },
+      "teamUuid" => "2abbc12a-427d-432a-a521-c870af1739d9"
+    }
+  end
+
+  let(:response_status) { 201 }
+  let(:success_response) do
+    {
+      status: response_status,
+      headers: pact_broker_response_headers,
+      body: {
+        description: Pact.like("a webhook"),
+        teamUuid: "2abbc12a-427d-432a-a521-c870af1739d9",
+        _links: {
+          self: {
+            href: Pact.term('http://localhost:1234/some-url', %r{http://.*}),
+            title: Pact.like("A title")
+          }
+        }
+      }
+    }
+  end
+
+  let(:pact_broker_client_options) { {} }
+
+  subject { PactBroker::Client::Webhooks::Create.call(params, pactflow.mock_service_base_url, pact_broker_client_options) }
+
+  context "when a valid webhook with a team specified is submitted" do
+    before do
+      mock_pact_broker_index(self, pactflow)
+      pactflow
+        .given("a team with UUID 2abbc12a-427d-432a-a521-c870af1739d9 exists")
+        .upon_receiving("a request to create a webhook for a team")
+        .with(
+            method: :post,
+            path: '/HAL-REL-PLACEHOLDER-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).to be_a PactBroker::Client::CommandResult
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Webhook \"a webhook\" created"
+    end
+  end
+end

data/spec/service_providers/record_deployment_spec.rb

@@ -1,9 +1,7 @@
 require 'service_providers/pact_helper'
 require 'pact_broker/client/deployments/record_deployment'
 
-deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
-
-RSpec.describe "recording a deployment", pact: true, skip: !deployment_feature_on do
+RSpec.describe "recording a deployment", pact: true do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 

data/spec/service_providers/record_release_spec.rb

@@ -1,9 +1,7 @@
 require 'service_providers/pact_helper'
 require 'pact_broker/client/deployments/record_deployment'
 
-deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
-
-RSpec.describe "recording a release", pact: true, skip: !deployment_feature_on do
+RSpec.describe "recording a release", pact: true do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 

data/spec/service_providers/record_undeployment_spec.rb

@@ -1,9 +1,7 @@
 require 'service_providers/pact_helper'
 require 'pact_broker/client/deployments/record_undeployment'
 
-deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
-
-RSpec.describe "recording an undeployment", pact: true, skip: !deployment_feature_on do
+RSpec.describe "recording an undeployment", pact: true do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 
@@ -77,7 +75,7 @@ RSpec.describe "recording an undeployment", pact: true, skip: !deployment_featur
         headers: pact_broker_response_headers,
         body: {
           _links: {
-            :'pb:currently-deployed-versions' => {
+            :'pb:currently-deployed-deployed-versions' => {
               href: Pact.term( pact_broker.mock_service_base_url + currently_deployed_versions_placeholder_path, /^http.*/)
             }
           }

data/spec/service_providers/webhooks_create_spec.rb

@@ -134,7 +134,7 @@ RSpec.describe "creating a webhook", pact: true do
   context "when an invalid webhook is submitted" do
     before do
       params[:url] = nil
-      request_body["request"]["url"] = nil
+      request_body["request"].delete("url")
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")

data/spec/spec_helper.rb

@@ -15,6 +15,7 @@ RSpec.configure do | config |
     ENV.delete('PACT_BROKER_BASE_URL')
     ENV.delete('PACT_BROKER_USERNAME')
     ENV.delete('PACT_BROKER_PASSWORD')
+    ENV.delete('PACT_BROKER_TOKEN')
   end
 
   config.after(:all) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.45.0
+  version: 1.48.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -230,6 +230,7 @@ files:
 - doc/markdown/Pact Broker Client - Pact Broker.md
 - doc/markdown/README.md
 - doc/pacts/markdown/Pact Broker Client - Pact Broker.md
+- doc/pacts/markdown/Pact Broker Client - Pactflow.md
 - doc/pacts/markdown/README.md
 - example/scripts/README.md
 - example/scripts/deploy-consumer.sh
@@ -249,9 +250,11 @@ files:
 - lib/pact_broker/client/cli/custom_thor.rb
 - lib/pact_broker/client/cli/deployment_commands.rb
 - lib/pact_broker/client/cli/environment_commands.rb
+- lib/pact_broker/client/cli/matrix_commands.rb
 - lib/pact_broker/client/cli/pacticipant_commands.rb
 - lib/pact_broker/client/cli/record_deployment_long_desc.txt
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
+- lib/pact_broker/client/cli/webhook_commands.rb
 - lib/pact_broker/client/colorize_notices.rb
 - lib/pact_broker/client/command_result.rb
 - lib/pact_broker/client/create_tag.rb
@@ -304,6 +307,7 @@ files:
 - lib/pact_broker/client/string_refinements.rb
 - lib/pact_broker/client/tasks.rb
 - lib/pact_broker/client/tasks/publication_task.rb
+- lib/pact_broker/client/verification_required.rb
 - lib/pact_broker/client/version.rb
 - lib/pact_broker/client/versions.rb
 - lib/pact_broker/client/versions/describe.rb
@@ -323,6 +327,7 @@ files:
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- script/webhook-commands.sh
 - spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt
@@ -368,6 +373,7 @@ files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
 - spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
@@ -383,6 +389,7 @@ files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb
@@ -422,7 +429,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: See description
@@ -472,6 +479,7 @@ test_files:
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
 - spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_environments_spec.rb
@@ -487,6 +495,7 @@ test_files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.rb
 - spec/service_providers/pacticipants_create_spec.rb
 - spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb