pact_broker-client 1.43.0 → 1.47.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_broker_client_register_repository_spec.rb

@@ -14,7 +14,7 @@ module PactBroker::Client
             with(
                 method: :patch,
                 path: '/pacticipants/Pricing%20Service',
-                headers: patch_request_headers,
+                headers: old_patch_request_headers,
                 body: {repository_url: repository_url} ).
               will_respond_with(
                 status: 201,
@@ -33,7 +33,7 @@ module PactBroker::Client
             with(
               method: :patch,
               path: '/pacticipants/Pricing%20Service',
-              headers: patch_request_headers,
+              headers: old_patch_request_headers,
               body: { repository_url: repository_url }).
             will_respond_with(
               status: 200,

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/publish_pacts_spec.rb

@@ -1,7 +1,9 @@
 require 'pact_broker/client/publish_pacts'
 require 'service_providers/pact_helper'
 
-RSpec.describe "publishing contracts", pact: true do
+publish_contracts_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("publish_contracts")
+
+RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feature_on do
   before do
     allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:sleep)
     allow_any_instance_of(PactBroker::Client::Hal::HttpClient).to receive(:default_max_tries).and_return(1)

data/spec/service_providers/record_deployment_spec.rb

@@ -1,5 +1,5 @@
 require 'service_providers/pact_helper'
-require 'pact_broker/client/versions/record_deployment'
+require 'pact_broker/client/deployments/record_deployment'
 
 RSpec.describe "recording a deployment", pact: true do
   include_context "pact broker"
@@ -25,7 +25,7 @@ RSpec.describe "recording a deployment", pact: true do
   end
   let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url } }
 
-  subject { PactBroker::Client::Versions::RecordDeployment.call(params, options, pact_broker_client_options) }
+  subject { PactBroker::Client::Deployments::RecordDeployment.call(params, options, pact_broker_client_options) }
 
   def mock_index
     pact_broker
@@ -105,18 +105,6 @@ RSpec.describe "recording a deployment", pact: true do
       )
   end
 
-  def mock_pacticipant_version_not_found
-    pact_broker
-      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist")
-      .upon_receiving("a request for a pacticipant version")
-      .with(
-        method: "GET",
-        path: "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        headers: get_request_headers
-      )
-      .will_respond_with(status: 404)
-  end
-
   def mock_environments
     pact_broker
       .given("an environment with name test exists")
@@ -184,18 +172,6 @@ RSpec.describe "recording a deployment", pact: true do
     end
   end
 
-  context "when the specified version does not exist" do
-    before do
-      mock_index
-      mock_pacticipant_version_not_found
-    end
-
-    it "returns an error response" do
-      expect(subject.success).to be false
-      expect(subject.message).to include "Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 not found"
-    end
-  end
-
   context "when the specified environment is not available for recording a deployment" do
     before do
       mock_index
@@ -208,14 +184,14 @@ RSpec.describe "recording a deployment", pact: true do
 
       it "returns an error response" do
         expect(subject.success).to be false
-        expect(subject.message).to include "No environment found with name 'foo'. Available options: test"
+        expect(subject.message).to include "No environment found"
       end
     end
 
     context "when the specified 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, dev"
+        expect(subject.message).to include "not an available option"
       end
     end
   end

data/spec/service_providers/record_release_spec.rb

@@ -0,0 +1,130 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/deployments/record_deployment'
+
+RSpec.describe "recording a release", pact: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:pacticipant_name) { "Foo" }
+  let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
+  let(:environment_name) { "test" }
+  let(:output) { "text" }
+  let(:target) { "blue" }
+  let(:params) do
+    {
+      pacticipant_name: pacticipant_name,
+      version_number: version_number,
+      environment_name: environment_name
+    }
+  end
+  let(:options) do
+    {
+      output: output
+    }
+  end
+  let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url } }
+
+  subject { PactBroker::Client::Deployments::RecordRelease.call(params, options, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:pacticipant-version and pb:environments relations exist in the index resource")
+      .upon_receiving("a request for the index resource")
+      .with(
+          method: "GET",
+          path: '/',
+          headers: get_request_headers).
+        will_respond_with(
+          status: 200,
+          headers: pact_broker_response_headers,
+          body: {
+            _links: {
+              :'pb:pacticipant-version' => {
+                href: placeholder_url_term("pb:pacticipant-version", ["pacticipant", "version"])
+              },
+              :'pb:environments' => {
+                href: placeholder_url_term("pb:environments")
+              }
+            }
+          }
+        )
+  end
+
+  def mock_pacticipant_version_with_test_environment_available_for_release
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for release")
+      .upon_receiving("a request for a pacticipant version")
+      .with(
+        method: "GET",
+        path: "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            "pb:record-release" => [
+              {
+                name: "test",
+                href: placeholder_url_term("pb:record-release-#{pacticipant_name}-#{version_number}-#{environment_name}")
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_environments
+    pact_broker
+      .given("an environment with name test exists")
+      .upon_receiving("a request for the environments")
+      .with(
+        method: "GET",
+        path: "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            "pb:environments" => [
+              {
+                name: "test",
+                href: Pact.like("href")
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_record_release
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment")
+      .upon_receiving("a request to record a release")
+      .with(
+        method: "POST",
+        path: "/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        headers: post_request_headers
+      )
+      .will_respond_with(
+        status: 201,
+        headers: pact_broker_response_headers
+      )
+  end
+
+  context "when the deployment is recorded successfully" do
+    before do
+      mock_index
+      mock_pacticipant_version_with_test_environment_available_for_release
+      mock_record_release
+    end
+
+    it "returns a success message" do
+      expect(subject.success).to be true
+      expect(subject.message).to include "Recorded release of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test environment in the Pact Broker."
+    end
+  end
+end