pact_broker-client 1.44.0 → 1.45.0

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

@@ -0,0 +1,219 @@
+require 'pact_broker/client/deployments/record_undeployment'
+
+module PactBroker
+  module Client
+    module Deployments
+      describe RecordUndeployment do
+        let(:params) do
+          {
+            pacticipant_name: "Foo",
+            target: target,
+            environment_name: "test"
+          }
+        end
+        let(:target) { "customer-1" }
+        let(:output) { "text" }
+        let(:options) { { output: output, verbose: true } }
+        let(:pact_broker_base_url) { "http://broker" }
+        let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url } }
+
+        let(:index_body_hash) do
+          {
+            _links: {
+              :'pb:environments' => {
+                href: environments_url
+              },
+              :'pb:pacticipant' => {
+                href: pacticipant_url
+              }
+            }
+          }
+        end
+
+        let(:environments_hash) do
+          {
+            _links: {
+              :'pb:environments' => [
+                {
+                  name: "test",
+                  href: test_environment_url
+                }
+              ]
+            }
+          }
+        end
+
+        let(:environment_hash) do
+          {
+            _links: {
+              :'pb:currently-deployed-versions' => {
+                href: currently_deployed_versions_url
+              }
+            }
+          }
+        end
+
+        let(:deployed_versions_hash) do
+          {
+            _embedded: {
+              deployedVersions: [
+                {
+                  target: "customer-1",
+                  _links: {
+                    self: {
+                      href: deployed_version_url_1
+                    }
+                  }
+                },
+                {
+                  target: returned_target_2,
+                  _links: {
+                    self: {
+                      href: deployed_version_url_2
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        end
+
+        let(:returned_target_2) { nil }
+        let(:deployed_version_hash) do
+          {
+            _embedded: {
+              version: {
+                number: "2"
+              }
+            }
+          }
+        end
+
+        let(:environments_url) { "#{webmock_base_url}/environments" }
+        let(:test_environment_url) { "#{webmock_base_url}/environments/1234" }
+        let(:currently_deployed_versions_url) { "#{webmock_base_url}/currently-deployed-versions" }
+        let(:deployed_version_url_1) { "#{webmock_base_url}/deployed-version-1" }
+        let(:deployed_version_url_2) { "#{webmock_base_url}/deployed-version-2" }
+        let(:pacticipant_url) { "#{webmock_base_url}/pacticipant" }
+
+        let(:webmock_base_url) { "http://broker" }
+
+        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!(:environments_request) do
+          stub_request(:get, "http://broker/environments").to_return(status: 200, body: environments_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:environment_request) do
+          stub_request(:get, test_environment_url).to_return(status: 200, body: environment_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:deployed_versions_request) do
+          stub_request(:get, currently_deployed_versions_url + "?pacticipant=Foo").to_return(status: 200, body: deployed_versions_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:deployed_version_patch_request_1) do
+          stub_request(:patch, deployed_version_url_1).with(body: { currentlyDeployed: false}.to_json).to_return(status: 200, body: deployed_version_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let!(:deployed_version_patch_request_2) do
+          stub_request(:patch, deployed_version_url_2).with(body: { currentlyDeployed: false}.to_json).to_return(status: 200, body: deployed_version_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let!(:pacticipant_request) do
+          stub_request(:get, pacticipant_url).to_return(status: pacticipant_request_status, body: {}.to_json, headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let(:pacticipant_request_status) { 200 }
+
+        subject { RecordUndeployment.call(params, options, pact_broker_client_options) }
+
+        its(:success) { is_expected.to eq true }
+        its(:message) { is_expected.to include "Recorded undeployment of Foo version 2 from test environment (target customer-1) in the Pact Broker" }
+
+        context "when there is no pb:environments relation in the index" do
+          let(:index_body_hash) do
+            {
+              _links: {}
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "support" }
+        end
+
+        context "when output is json" do
+          let(:output) { "json" }
+          its(:message) { is_expected.to eq [deployed_version_hash].to_json }
+        end
+
+        context "when there is an error returned from one of the deployed version updates (there should only ever be one deployed version, but testing just for the sake of it)" do
+          let!(:deployed_version_patch_request_2) do
+            stub_request(:patch, deployed_version_url_2).to_return(status: 400, body: { errors: { foo: ["some error"]}}.to_json, headers: { "Content-Type" => "application/hal+json" })
+          end
+
+          let(:returned_target_2) { "customer-1" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "Recorded undeployment of Foo version 2" }
+          its(:message) { is_expected.to include "some error" }
+        end
+
+        context "when there is no currently-deployed-versions relation in the environment resource" do
+          let(:environment_hash) do
+            {
+              _links: {}
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "support" }
+        end
+
+        context "when a target is provided and there is no deployed version with a matching target" do
+          let(:target) { "wrong" }
+          let(:expected_message) { "Foo is not currently deployed to target 'wrong' in test environment. Please specify one of the following targets to record the undeployment from: customer-1, <no target>" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include expected_message }
+
+          context "when output is json" do
+            let(:output) { "json" }
+
+            its(:message) { is_expected.to eq({ error: { message: expected_message } }.to_json) }
+          end
+        end
+
+        context "when a target is not provided and there is no deployed verison without a target" do
+          let(:target) { nil }
+          let(:returned_target_2) { "customer-2" }
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "Please specify one of the following targets to record the undeployment from: customer-1, customer-2" }
+        end
+
+        context "when there are no deployed versions for the pacticipant" do
+          let(:deployed_versions_hash) do
+            {
+              _embedded: {
+                deployedVersions: []
+              }
+            }
+          end
+
+          its(:success) { is_expected.to be false }
+          its(:message) { is_expected.to include "Foo is not currently deployed to test environment. Cannot record undeployment." }
+
+          context "when the pacticipant does not exist" do
+            let(:pacticipant_request_status) { 404 }
+
+            its(:success) { is_expected.to be false }
+            its(:message) { is_expected.to include "No pacticipant with name 'Foo' found" }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -113,10 +113,7 @@ RSpec.describe "recording a release", pact: true, skip: !deployment_feature_on d
       )
       .will_respond_with(
         status: 201,
-        headers: pact_broker_response_headers,
-        body: {
-          target: target
-        }
+        headers: pact_broker_response_headers
       )
   end
 

data/spec/service_providers/record_undeployment_spec.rb

@@ -0,0 +1,166 @@
+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
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:pacticipant_name) { "Foo" }
+  let(:environment_name) { "test" }
+  let(:output) { "text" }
+  let(:target) { "customer-1" }
+  let(:params) do
+    {
+      pacticipant_name: pacticipant_name,
+      environment_name: environment_name,
+      target: target
+    }
+  end
+  let(:options) do
+    {
+      output: output,
+      verbose: true
+    }
+  end
+  let(:webmock_base_url) { "http://broker" }
+  let(:pact_broker_client_options) { { pact_broker_base_url: webmock_base_url } }
+  let(:test_environment_placeholder_path) { "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENT-16926ef3-590f-4e3f-838e-719717aa88c9" }
+  let(:currently_deployed_versions_placeholder_path) { "/PLACEHOLDER-ENVIRONMENT-CURRENTLY-DEPLOYED-16926ef3-590f-4e3f-838e-719717aa88c9" }
+  let(:deployed_version_placeholder_path) { "/PLACEHOLDER-DEPLOYED-VERSION-ff3adecf-cfc5-4653-a4e3-f1861092f8e0"}
+
+  subject { PactBroker::Client::Deployments::RecordUndeployment.call(params, options, pact_broker_client_options) }
+
+  let(:index_body_hash) do
+    {
+      _links: {
+        :'pb:environments' => {
+          href: "#{webmock_base_url}/environments"
+        }
+      }
+    }
+  end
+
+  let(:environments_hash) do
+    {
+      _links: {
+        :'pb:environments' => [
+          {
+            name: "test",
+            href: pact_broker.mock_service_base_url + test_environment_placeholder_path
+          }
+        ]
+      }
+    }
+  end
+
+  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!(:environments_request) do
+    stub_request(:get, "http://broker/environments").to_return(status: 200, body: environments_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  def mock_test_environment
+    pact_broker
+      .given("an environment with name test and UUID 16926ef3-590f-4e3f-838e-719717aa88c9 exists")
+      .upon_receiving("a request for an environment")
+      .with(
+        method: "GET",
+        path: test_environment_placeholder_path,
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            :'pb:currently-deployed-versions' => {
+              href: Pact.term( pact_broker.mock_service_base_url + currently_deployed_versions_placeholder_path, /^http.*/)
+            }
+          }
+        }
+      )
+  end
+
+  def mock_deployed_versions_search_results
+    pact_broker
+      .given("an version is deployed to environment with UUID 16926ef3-590f-4e3f-838e-719717aa88c9 with target customer-1")
+      .upon_receiving("a request to list the versions deployed to an environment for a pacticipant name and target")
+      .with(
+        method: "GET",
+        path: currently_deployed_versions_placeholder_path,
+        query: { pacticipant: pacticipant_name },
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _embedded: {
+            deployedVersions: [
+              {
+                target: target,
+                _links: {
+                  self: {
+                    href: Pact.term(pact_broker.mock_service_base_url + deployed_version_placeholder_path, /^http/)
+                  }
+                }
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_mark_deployed_version_as_undeployed
+    pact_broker
+      .given("a currently deployed version exists")
+      .upon_receiving("a request to mark a deployed version as not currently deploye")
+      .with(
+        method: "PATCH",
+        path: deployed_version_placeholder_path,
+        body: { currentlyDeployed: false },
+        headers: patch_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: deployed_version_hash
+      )
+  end
+
+  let(:deployed_version_hash) do
+    {
+      "currentlyDeployed" => false,
+      "_embedded" => {
+        "version" => {
+          "number" => Pact.like("2")
+        }
+      }
+    }
+  end
+
+  context "when the deployment is recorded successfully" do
+    before do
+      mock_test_environment
+      mock_deployed_versions_search_results
+      mock_mark_deployed_version_as_undeployed
+    end
+
+    it "returns a success message" do
+      expect(subject.success).to be true
+      expect(subject.message).to include "Recorded undeployment of Foo version 2 from test environment (target customer-1) in the Pact Broker"
+    end
+
+    context "when the output is json" do
+      let(:output) { "json" }
+
+      it "returns the JSON payload" do
+        expect(JSON.parse(subject.message)).to eq [Pact::Reification.from_term(deployed_version_hash)]
+      end
+    end
+  end
+end

data/spec/support/shared_context.rb

@@ -17,7 +17,8 @@ shared_context "pact broker" do
   let(:pact_broker_version) { Pact::Term.new(:matcher => /\d+\.\d+\.\d+/, :generate => '1.0.0') }
   let(:pact_broker_response_headers) { {'Content-Type' => 'application/hal+json;charset=utf-8'} }
   let(:default_request_headers) { { 'Content-Type' => 'application/json'} }
-  let(:patch_request_headers)   { { 'Content-Type' => 'application/json'} }
+  let(:old_patch_request_headers)   { { 'Content-Type' => 'application/json'} }
+  let(:patch_request_headers)   { { 'Content-Type' => 'application/merge-patch+json'} }
   let(:put_request_headers)     { { 'Content-Type' => 'application/json', 'Accept' => 'application/hal+json'} }
   let(:post_request_headers)    { { 'Content-Type' => 'application/json', 'Accept' => 'application/hal+json'} }
   let(:get_request_headers)     { { 'Accept' => 'application/hal+json'} }

data/tasks/pact.rake

@@ -18,17 +18,19 @@ PactBroker::Client::PublicationTask.new(:remote) do | task |
 end
 
 PactBroker::Client::PublicationTask.new(:pactflow) do | task |
-  version = ENV['GITHUB_SHA']
-  tags = ENV['GITHUB_REF'] ? [ENV['GITHUB_REF'].gsub("refs/heads/", "")] : []
+  version = ENV.fetch('GITHUB_SHA')
+  branch = ENV.fetch('GITHUB_REF').gsub("refs/heads/", "")
+  feature = ENV.fetch('TEST_FEATURE', '')
+  tag = branch
 
-  if ENV.fetch('TEST_FEATURE', '') != ''
-    version = "#{version}+#{ENV['TEST_FEATURE']}"
-    tags = ENV['TEST_FEATURE']
+  if feature != ''
+    version = "#{version}+#{feature}"
+    tag = "#{tag}+#{feature}"
   end
 
   require 'pact_broker/client/version'
   task.auto_detect_version_properties = false
-  task.tags = tags
+  task.tags = [tag]
   task.branch = nil
   task.consumer_version = version
   task.pact_broker_base_url = "https://pact-oss.pactflow.io"