pact_broker-client 1.38.1 → 1.41.0

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

@@ -15,14 +15,14 @@ module PactBroker
             stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
           end
 
-          let(:replaced_previous_deployed_version) { true }
+          let(:target) { "blue" }
 
           let(:params) do
             {
               pacticipant_name: "Foo",
               version_number: "1",
               environment_name: "test",
-              replaced_previous_deployed_version: replaced_previous_deployed_version,
+              target: target,
               output: "text"
             }
           end
@@ -53,11 +53,11 @@ module PactBroker
             end
 
             it "indicates the API was Pactflow" do
-              expect(subject.message).to include "Recorded deployment of Foo version 1 to test in Pactflow"
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test (target blue) in Pactflow"
             end
           end
 
-          context "when replaced_previous_deployed_version is false" do
+          context "when target is false" do
             before do
               allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
               allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
@@ -65,7 +65,7 @@ module PactBroker
               allow_any_instance_of(RecordDeployment).to receive(:pact_broker_name).and_return("")
             end
 
-            let(:replaced_previous_deployed_version) { false }
+            let(:target) { false }
 
             let(:deployed_version_resource) do
               double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1552,7 +1552,7 @@
     },
     {
       "description": "a request for the index resource",
-      "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",
+      "providerState": "the pb:publish-contracts relations exists in the index resource",
       "request": {
         "method": "GET",
         "path": "/",
@@ -1567,20 +1567,13 @@
         },
         "body": {
           "_links": {
-            "pb:pacticipant-version": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
-            },
-            "pb:environments": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS"
+            "pb:publish-contracts": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
             }
           }
         },
         "matchingRules": {
-          "$.body._links.pb:pacticipant-version.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
-          },
-          "$.body._links.pb:environments.href": {
+          "$.body._links.pb:publish-contracts.href": {
             "match": "regex",
             "regex": "http:\\/\\/.*"
           }
@@ -1588,86 +1581,33 @@
       }
     },
     {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:record-deployment": [
-              {
-                "name": "test",
-                "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:record-deployment[0].href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to record a deployment",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment",
+      "description": "a request to publish contracts",
       "request": {
         "method": "POST",
-        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
         "headers": {
           "Content-Type": "application/json",
           "Accept": "application/hal+json"
         },
         "body": {
-          "replacedPreviousDeployedVersion": true
-        }
-      },
-      "response": {
-        "status": 201,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "replacedPreviousDeployedVersion": true
-        }
-      }
-    },
-    {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 404,
-        "headers": {
-        }
-      }
-    },
-    {
-      "description": "a request for a pacticipant version",
-      "providerState": "version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        "headers": {
-          "Accept": "application/hal+json"
+          "pacticipantName": "Foo",
+          "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+          "branch": "main",
+          "tags": [
+            "dev"
+          ],
+          "buildUrl": "http://build",
+          "contracts": [
+            {
+              "consumerName": "Foo",
+              "providerName": "Bar",
+              "specification": "pact",
+              "contentType": "application/json",
+              "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
+              "writeMode": "overwrite",
+              "onConflict": "overwrite"
+            }
+          ]
         }
       },
       "response": {
@@ -1676,56 +1616,42 @@
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
+          "_embedded": {
+            "pacticipant": {
+              "name": "Foo"
+            },
+            "version": {
+              "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+              "buildUrl": "http://build"
+            }
+          },
+          "logs": [
+            {
+              "level": "info",
+              "message": "some message"
+            }
+          ],
           "_links": {
-            "pb:record-deployment": [
+            "pb:pacticipant-version-tags": [
               {
-                "name": "prod",
-                "href": "href"
-              },
+                "name": "dev"
+              }
+            ],
+            "pb:contracts": [
               {
-                "name": "dev",
-                "href": "href"
+                "href": "http://some-pact"
               }
             ]
           }
         },
         "matchingRules": {
-          "$.body._links.pb:record-deployment[0]": {
-            "match": "type"
+          "$.body.logs": {
+            "min": 1
           },
-          "$.body._links.pb:record-deployment[1]": {
+          "$.body.logs[*].*": {
             "match": "type"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request for the environments",
-      "providerState": "an environment with name test exists",
-      "request": {
-        "method": "GET",
-        "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
-        "headers": {
-          "Accept": "application/hal+json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:environments": [
-              {
-                "name": "test",
-                "href": "href"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:environments[0].href": {
+          },
+          "$.body._links.pb:contracts[0].href": {
             "match": "type"
           }
         }

data/spec/service_providers/pact_broker_client_create_version_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'pact_helper'
 require 'pact_broker/client'
-require 'pact_broker/client/publish_pacts'
+require 'pact_broker/client/publish_pacts_the_old_way'
 
 describe PactBroker::Client::Versions, pact: true do
 
@@ -9,7 +9,7 @@ describe PactBroker::Client::Versions, pact: true do
 
   describe "creating a pacticipant version" do
     before do
-      allow(publish_pacts).to receive(:consumer_names).and_return(["Foo"])
+      allow(publish_pacts_the_old_way).to receive(:consumer_names).and_return(["Foo"])
       allow($stdout).to receive(:puts)
     end
     let(:version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}" }
@@ -18,11 +18,11 @@ describe PactBroker::Client::Versions, pact: true do
     let(:branch) { "main" }
     let(:build_url) { "http://my-ci/builds/1" }
     let(:consumer_version_params) { { number: number, branch: branch, build_url: build_url } }
-    let(:publish_pacts) { PactBroker::Client::PublishPacts.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
+    let(:publish_pacts_the_old_way) { PactBroker::Client::PublishPactsTheOldWay.new(pact_broker.mock_service_base_url, ["some-pact.json"], consumer_version_params, {}) }
     let(:provider_state) { "version #{number} of pacticipant Foo does not exist" }
     let(:expected_response_status) { 201 }
 
-    subject { publish_pacts.send(:create_consumer_versions) }
+    subject { publish_pacts_the_old_way.send(:create_consumer_versions) }
 
     before do
       pact_broker

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

@@ -0,0 +1,116 @@
+require 'pact_broker/client/publish_pacts'
+require 'service_providers/pact_helper'
+
+RSpec.describe "publishing contracts", pact: true 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)
+  end
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:pacticipant_name) { "Foo" }
+  let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
+  let(:output) { "text" }
+  let(:build_url) { "http://build" }
+  let(:consumer_version_params) do
+    {
+      pacticipant_name: pacticipant_name,
+      number: version_number,
+      tags: ["dev"],
+      branch: "main",
+      build_url: build_url,
+      output: output
+    }
+  end
+  let(:pact_file_path_1) { "spec/fixtures/foo-bar.json" }
+  let(:pact_file_paths) { [pact_file_path_1] }
+  let(:options) { {} }
+  let(:pact_broker_client_options) { {} }
+  let(:expected_content) { Base64.strict_encode64(JSON.parse(File.read(pact_file_path_1)).to_json) }
+  let(:request_body) do
+    {
+      pacticipantName: pacticipant_name,
+      pacticipantVersionNumber: version_number,
+      branch: "main",
+      tags: ["dev"],
+      buildUrl: "http://build",
+      contracts: [
+        {
+          consumerName: pacticipant_name,
+          providerName: "Bar",
+          specification: "pact",
+          contentType: "application/json",
+          content: expected_content,
+          writeMode: "overwrite",
+          onConflict: "overwrite"
+        }
+      ]
+    }
+  end
+
+  subject { PactBroker::Client::PublishPacts.call(broker_base_url, pact_file_paths, consumer_version_params, options, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:publish-contracts relations 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:publish-contracts' => {
+                href: placeholder_url_term("pb:publish-contracts")
+              }
+            }
+          }
+        )
+  end
+
+  def mock_contract_publication
+    pact_broker
+      .upon_receiving("a request to publish contracts")
+      .with(
+          method: "POST",
+          path: '/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS',
+          headers: post_request_headers,
+          body: request_body).
+        will_respond_with(
+          status: 200,
+          headers: pact_broker_response_headers,
+          body: {
+            _embedded: {
+              pacticipant: {
+                name: pacticipant_name
+              },
+              version: {
+                number: version_number,
+                buildUrl: build_url
+              }
+            },
+            logs: Pact.each_like(level: "info", message: "some message"),
+            _links: {
+              :'pb:pacticipant-version-tags' => [{ name: "dev"} ],
+              :'pb:contracts' => [{ href: Pact.like("http://some-pact") }]
+            }
+          }
+        )
+  end
+
+  context "with valid params" do
+    before do
+      mock_index
+      mock_contract_publication
+    end
+
+    it "returns a success result" do
+      expect(subject.success).to be true
+      expect(subject.message).to include "some message"
+    end
+  end
+end