pact_broker-client 1.39.0 → 1.44.0

data/spec/service_providers/list_environments_spec.rb

@@ -0,0 +1,77 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/environments/list_environments'
+
+RSpec.describe "list environments", pact: true, skip: true do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:params) { { output: output } }
+  let(:output) { "text" }
+  let(:pact_broker_client_options) { {} }
+  let(:response_body) do
+    {
+      _embedded: {
+        environments: Pact.each_like(
+          {
+            uuid: "78e85fb2-9df1-48da-817e-c9bea6294e01",
+            name: "test",
+            displayName: "Test",
+            production: false,
+            contacts: [{
+              name: "Foo team",
+              details: {
+                emailAddress: "foo@bar.com"
+              }
+            }]
+          }
+        )
+      }
+    }
+  end
+
+  subject { PactBroker::Client::Environments::ListEnvironments.call(params, broker_base_url, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:environments relation exists 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:environments' => {
+              href: placeholder_url_term("pb:environments")
+            }
+          }
+        }
+      )
+  end
+
+  def mock_get_environments
+    pact_broker
+      .given("an environment exists")
+      .upon_receiving("a request to list 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: response_body
+      )
+  end
+
+  it "returns a success result" do
+    mock_index
+    mock_get_environments
+    expect(subject.success).to be true
+    Approvals.verify(subject.message, :name => "list_environments", format: :txt)
+  end
+end

data/spec/service_providers/pact_broker_client_matrix_ignore_spec.rb

@@ -0,0 +1,98 @@
+require_relative 'pact_helper'
+require 'pact_broker/client/can_i_deploy'
+
+module PactBroker::Client
+  describe Matrix, :pact => true do
+
+    include_context "pact broker"
+
+    describe "can-i-deploy ignoring a pacticipant version" do
+      let(:matrix_response_body) { matrix }
+      let(:matrix) do
+        {
+          "summary" => {
+            "deployable" => true,
+            "ignored" => 1
+          },
+          "notices" => Pact.each_like("text" => "some notice", "type" => "info"),
+          "matrix" => [
+            {
+              "consumer" => {
+                "name" => "Foo",
+                "version" => {
+                  "number" => "1.2.3"
+                }
+              },
+              "provider" => {
+                "name" => "Bar",
+                "version" => {
+                  "number" => "4.5.6"
+                }
+              },
+              "verificationResult" => {
+                "success" => true,
+                "_links" => {
+                  "self" => {
+                    "href" => Pact.like("http://result")
+                  }
+                }
+              }
+            },{
+              "consumer" => {
+                "name" => "Foo",
+                "version" => {
+                  "number" => "3.4.5"
+                }
+              },
+              "provider" => {
+                "name" => "Bar",
+                "version" => {
+                  "number" => "4.5.6"
+                }
+              },
+              "verificationResult" => {
+                "success" => false,
+                "_links" => {
+                  "self" => {
+                    "href" => Pact.like("http://result")
+                  }
+                }
+              },
+              "ignored" => true
+            }
+          ]
+        }
+
+      end
+      let(:selectors) { [{ pacticipant: "Bar", version: "4.5.6" }, { pacticipant: "Foo", tag: "prod" } ] }
+      let(:matrix_options) do
+        {
+          ignore_selectors: [{ pacticipant: "Foo", version: "3.4.5" }]
+        }
+      end
+      let(:options) { { retry_while_unknown: 0, output: 'table' } }
+
+      before do
+        pact_broker
+          .given("provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod")
+          .upon_receiving("a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5")
+          .with(
+            method: :get,
+            path: "/matrix",
+            query: "q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Btag%5D=prod&latestby=cvpv&ignore%5B%5D%5Bpacticipant%5D=Foo&ignore%5B%5D%5Bversion%5D=3.4.5"
+          )
+          .will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: matrix_response_body
+          )
+      end
+
+      subject { PactBroker::Client::CanIDeploy.call(broker_base_url, selectors, matrix_options, options, {})}
+
+      it 'returns the CLI output' do
+        Approvals.verify(subject.message, :name => "can_i_deploy_ignore", format: :txt)
+      end
+    end
+  end
+end

data/spec/service_providers/pacticipants_create_spec.rb

@@ -54,9 +54,10 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     }
   end
 
-  let(:pact_broker_client_options) { {} }
+  let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
+  let(:options) { {} }
 
-  subject { PactBroker::Client::Pacticipants2::Create.call(params, broker_base_url, pact_broker_client_options) }
+  subject { PactBroker::Client::Pacticipants2::Create.call(params, options, pact_broker_client_options) }
 
   context "when the pacticipant does not already exist" do
     before do
@@ -81,7 +82,7 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     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 "Pacticipant \"Foo\" created"
+      expect(subject.message).to include "Pacticipant \"Foo\" created"
     end
   end
 
@@ -112,7 +113,7 @@ RSpec.describe "creating or updating a pacticipant", pact: true do
     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 "Pacticipant \"Foo\" updated"
+      expect(subject.message).to include "Pacticipant \"Foo\" updated"
     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)
@@ -42,7 +44,8 @@ RSpec.describe "publishing contracts", pact: true do
           specification: "pact",
           contentType: "application/json",
           content: expected_content,
-          writeMode: "overwrite"
+          writeMode: "overwrite",
+          onConflict: "overwrite"
         }
       ]
     }

data/spec/service_providers/record_deployment_spec.rb

@@ -1,8 +1,9 @@
 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
+deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
 
+RSpec.describe "recording a deployment", pact: true, skip: !deployment_feature_on do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 
@@ -10,19 +11,23 @@ RSpec.describe "recording a deployment", pact: true do
   let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
   let(:environment_name) { "test" }
   let(:output) { "text" }
-  let(:target) { true }
+  let(:target) { "blue" }
   let(:params) do
     {
       pacticipant_name: pacticipant_name,
       version_number: version_number,
       environment_name: environment_name,
-      target: target,
+      target: target
+    }
+  end
+  let(:options) do
+    {
       output: output
     }
   end
-  let(:pact_broker_client_options) { {} }
+  let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url } }
 
-  subject { PactBroker::Client::Versions::RecordDeployment.call(params, broker_base_url, pact_broker_client_options) }
+  subject { PactBroker::Client::Deployments::RecordDeployment.call(params, options, pact_broker_client_options) }
 
   def mock_index
     pact_broker
@@ -102,18 +107,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")
@@ -148,14 +141,14 @@ RSpec.describe "recording a deployment", pact: true do
         path: "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
         headers: post_request_headers,
         body: {
-          replacedPreviousDeployedVersion: target
+          target: target
         }
       )
       .will_respond_with(
         status: 201,
         headers: pact_broker_response_headers,
         body: {
-          replacedPreviousDeployedVersion: target
+          target: target
         }
       )
   end
@@ -169,30 +162,18 @@ RSpec.describe "recording a deployment", pact: true do
 
     it "returns a success message" do
       expect(subject.success).to be true
-      expect(subject.message).to eq "Recorded deployment of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test in the Pact Broker. Marked previous deployed version as undeployed."
+      expect(subject.message).to include "Recorded deployment of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test environment (target blue) 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 "replacedPreviousDeployedVersion" => target
+        expect(JSON.parse(subject.message)).to eq "target" => target
       end
     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
@@ -205,14 +186,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 eq "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 eq "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,135 @@
+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
+  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,
+        body: {
+          target: target
+        }
+      )
+  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