pact_broker-client 1.38.3 → 1.39.0

data/spec/lib/pact_broker/client/tasks/publication_task_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'pact_broker/client/tasks/publication_task'
 require 'pact_broker/client/publish_pacts'
+require 'pact_broker/client/command_result'
 
 module PactBroker::Client
   describe PublicationTask do
@@ -9,13 +10,16 @@ module PactBroker::Client
       @consumer_version = "1.2.3"
     end
 
-    let(:publish_pacts) { instance_double("PactBroker::ClientSupport::PublishPacts", call: true)}
+    let(:publish_pacts) { instance_double("PactBroker::ClientSupport::PublishPacts", call: result)}
     let(:pact_file_list) { ['spec/pact/consumer-provider.json'] }
+    let(:success) { true }
+    let(:result) { instance_double(PactBroker::Client::CommandResult, success: success, message: "message")}
 
     before do
       allow(PactBroker::Client::PublishPacts).to receive(:new).and_return(publish_pacts)
       allow(FileList).to receive(:[]).with(pattern).and_return(pact_file_list)
       allow(PactBroker::Client::Git).to receive(:branch).and_return('foo')
+      allow($stdout).to receive(:puts)
     end
 
     let(:pattern) { "spec/pacts/*.json" }
@@ -29,15 +33,16 @@ module PactBroker::Client
 
       context "when pacts are succesfully published" do
         it "invokes PublishPacts with the default values" do
-          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: '1.2.3', branch: "foo", tags: [], version_required: false}, {}).and_return(publish_pacts)
-          expect(publish_pacts).to receive(:call).and_return(true)
+          expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: '1.2.3', branch: "foo", tags: [], version_required: false}, {}, {}).and_return(publish_pacts)
+          expect(publish_pacts).to receive(:call).and_return(result)
           Rake::Task['pact:publish'].execute
         end
       end
 
       context "when a pact fails to be published" do
+        let(:success) { false }
+
         it "raises an error" do
-          expect(publish_pacts).to receive(:call).and_return(false)
           expect { Rake::Task['pact:publish'].execute }.to raise_error("One or more pacts failed to be published")
         end
       end
@@ -52,8 +57,8 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the write method set" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: "1.2.3", branch: "foo", tags: [], version_required: false }, {write: :merge}).and_return(publish_pacts)
-        expect(publish_pacts).to receive(:call).and_return(true)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with('http://pact-broker', pact_file_list, { number: "1.2.3", branch: "foo", tags: [], version_required: false }, {}, {write: :merge}).and_return(publish_pacts)
+        expect(publish_pacts).to receive(:call).and_return(result)
         Rake::Task['pact:publish:merge'].execute
       end
     end
@@ -74,7 +79,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the git branch name as a tag" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(tags: ['bar', 'foo']), anything).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(tags: ['bar', 'foo']), anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch'].execute
       end
     end
@@ -93,7 +98,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch_auto_detect_true'].execute
       end
     end
@@ -113,7 +118,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the specified branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "main"), anything).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "main"), anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch_auto_detect_true_with_branch'].execute
       end
     end
@@ -132,7 +137,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts without the branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_not_including(branch: "foo"), anything).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_not_including(branch: "foo"), anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch_auto_detect_false'].execute
       end
     end
@@ -150,7 +155,7 @@ module PactBroker::Client
       end
 
       it "invokes PublishPacts with the branch name" do
-        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"), anything).and_return(publish_pacts)
+        expect(PactBroker::Client::PublishPacts).to receive(:new).with(anything, anything, hash_including(branch: "foo"),anything, anything).and_return(publish_pacts)
         Rake::Task['pact:publish:git_branch_auto_detect_default'].execute
       end
     end
@@ -180,9 +185,10 @@ module PactBroker::Client
           @pact_broker_base_url,
           pact_file_list,
           { number: "1.2.3", tags: [@tag], branch: "foo", version_required: false},
+          {},
           { basic_auth: @pact_broker_basic_auth, token: @pact_broker_token }
         )
-        expect(publish_pacts).to receive(:call).and_return(true)
+        expect(publish_pacts).to receive(:call).and_return(result)
         Rake::Task['pact:publish:custom'].execute
       end
     end

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) { true }
 
           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
@@ -57,7 +57,7 @@ module PactBroker
             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

@@ -1550,6 +1550,112 @@
         }
       }
     },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:publish-contracts relations exists in 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:publish-contracts": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:publish-contracts.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to publish contracts",
+      "request": {
+        "method": "POST",
+        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
+        "headers": {
+          "Content-Type": "application/json",
+          "Accept": "application/hal+json"
+        },
+        "body": {
+          "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"
+            }
+          ]
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "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:pacticipant-version-tags": [
+              {
+                "name": "dev"
+              }
+            ],
+            "pb:contracts": [
+              {
+                "href": "http://some-pact"
+              }
+            ]
+          }
+        },
+        "matchingRules": {
+          "$.body.logs": {
+            "min": 1
+          },
+          "$.body.logs[*].*": {
+            "match": "type"
+          },
+          "$.body._links.pb:contracts[0].href": {
+            "match": "type"
+          }
+        }
+      }
+    },
     {
       "description": "a request for the index resource",
       "providerState": "the pb:pacticipant-version and pb:environments relations exist in the index resource",

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

@@ -0,0 +1,115 @@
+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"
+        }
+      ]
+    }
+  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

data/spec/service_providers/record_deployment_spec.rb

@@ -10,13 +10,13 @@ RSpec.describe "recording a deployment", pact: true do
   let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
   let(:environment_name) { "test" }
   let(:output) { "text" }
-  let(:replaced_previous_deployed_version) { true }
+  let(:target) { true }
   let(:params) do
     {
       pacticipant_name: pacticipant_name,
       version_number: version_number,
       environment_name: environment_name,
-      replaced_previous_deployed_version: replaced_previous_deployed_version,
+      target: target,
       output: output
     }
   end
@@ -148,14 +148,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: replaced_previous_deployed_version
+          replacedPreviousDeployedVersion: target
         }
       )
       .will_respond_with(
         status: 201,
         headers: pact_broker_response_headers,
         body: {
-          replacedPreviousDeployedVersion: replaced_previous_deployed_version
+          replacedPreviousDeployedVersion: target
         }
       )
   end
@@ -176,7 +176,7 @@ RSpec.describe "recording a deployment", pact: true do
       let(:output) { "json" }
 
       it "returns the JSON payload" do
-        expect(JSON.parse(subject.message)).to eq "replacedPreviousDeployedVersion" => replaced_previous_deployed_version
+        expect(JSON.parse(subject.message)).to eq "replacedPreviousDeployedVersion" => target
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.38.3
+  version: 1.39.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -212,6 +212,7 @@ files:
 - lib/pact_broker/client/cli/create_or_update_webhook_long_desc.txt
 - lib/pact_broker/client/cli/create_webhook_long_desc.txt
 - lib/pact_broker/client/cli/custom_thor.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/command_result.rb
 - lib/pact_broker/client/create_tag.rb
@@ -240,6 +241,7 @@ files:
 - lib/pact_broker/client/pacts.rb
 - lib/pact_broker/client/pacts/list_latest_versions.rb
 - lib/pact_broker/client/publish_pacts.rb
+- lib/pact_broker/client/publish_pacts_the_old_way.rb
 - lib/pact_broker/client/retry.rb
 - lib/pact_broker/client/tasks.rb
 - lib/pact_broker/client/tasks/publication_task.rb
@@ -259,8 +261,10 @@ files:
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
 - script/record-deployment.sh
+- script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
@@ -284,7 +288,7 @@ files:
 - spec/lib/pact_broker/client/pact_broker_client_spec.rb
 - spec/lib/pact_broker/client/pacticipants/create_spec.rb
 - spec/lib/pact_broker/client/pacticipants_spec.rb
-- spec/lib/pact_broker/client/publish_pacts_spec.rb
+- spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
@@ -305,6 +309,7 @@ files:
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/service_providers/pacticipants_create_spec.rb
+- spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
@@ -339,11 +344,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
+- spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
@@ -367,7 +373,7 @@ test_files:
 - spec/lib/pact_broker/client/pact_broker_client_spec.rb
 - spec/lib/pact_broker/client/pacticipants/create_spec.rb
 - spec/lib/pact_broker/client/pacticipants_spec.rb
-- spec/lib/pact_broker/client/publish_pacts_spec.rb
+- spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
@@ -388,6 +394,7 @@ test_files:
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/service_providers/pacticipants_create_spec.rb
+- spec/service_providers/publish_pacts_spec.rb
 - spec/service_providers/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb