pact_broker-client 1.40.0 → 1.41.0

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

@@ -15,7 +15,7 @@ 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(:target) { true }
+          let(:target) { "blue" }
 
           let(:params) do
             {
@@ -53,7 +53,7 @@ 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
 

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1604,7 +1604,8 @@
               "specification": "pact",
               "contentType": "application/json",
               "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
-              "writeMode": "overwrite"
+              "writeMode": "overwrite",
+              "onConflict": "overwrite"
             }
           ]
         }
@@ -1656,187 +1657,6 @@
         }
       }
     },
-    {
-      "description": "a request for the index resource",
-      "providerState": "the pb:pacticipant-version and pb:environments relations exist 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: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"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:pacticipant-version.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*{pacticipant}.*{version}"
-          },
-          "$.body._links.pb:environments.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "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",
-      "request": {
-        "method": "POST",
-        "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
-        "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"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_links": {
-            "pb:record-deployment": [
-              {
-                "name": "prod",
-                "href": "href"
-              },
-              {
-                "name": "dev",
-                "href": "href"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:record-deployment[0]": {
-            "match": "type"
-          },
-          "$.body._links.pb:record-deployment[1]": {
-            "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": {
-            "match": "type"
-          }
-        }
-      }
-    },
     {
       "description": "a request to create a webhook with a JSON body for a consumer and provider",
       "providerState": "the 'Pricing Service' and 'Condor' already exist in the 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

@@ -42,7 +42,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,7 @@
 require 'service_providers/pact_helper'
 require 'pact_broker/client/versions/record_deployment'
 
-RSpec.describe "recording a deployment", pact: true do
-
+RSpec.describe "recording a deployment", pact: true, skip: true do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 
@@ -10,7 +9,7 @@ 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,
@@ -148,14 +147,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
@@ -176,7 +175,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" => target
+        expect(JSON.parse(subject.message)).to eq "target" => target
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'webmock/rspec'
 
-ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts'
+ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts ignore'
 
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"
+require "./spec/support/approvals.rb"
 
 is_windows = (RbConfig::CONFIG['host_os'] =~ /bccwin|cygwin|djgpp|mingw|mswin|wince/i) != nil
 is_ci = ENV['CI'] == 'true'

data/spec/support/approvals.rb

@@ -0,0 +1,26 @@
+require 'approvals/rspec'
+require 'pact/support'
+
+Approvals.configure do |c|
+  c.approvals_path = 'spec/fixtures/approvals/'
+end
+
+def print_diff(exception)
+  parts = exception.message.split('"')
+  received_file = parts[1]
+  approved_file = parts[3]
+  if File.exist?(received_file) && File.exist?(approved_file)
+    received_hash = JSON.parse(File.read(received_file))
+    approved_hash = JSON.parse(File.read(approved_file))
+    diff = Pact::Matchers.diff(approved_hash, received_hash)
+    puts Pact::Matchers::UnixDiffFormatter.call(diff)
+  end
+end
+
+RSpec.configure do | config |
+  config.after(:each) do | example |
+    if example.exception.is_a?(Approvals::ApprovalError)
+      print_diff(example.exception)
+    end
+  end
+end

data/spec/support/shared_context.rb

@@ -1,6 +1,11 @@
 require 'pact_broker/client/pact_hash'
-shared_context "pact broker" do
+require 'pact_broker/client/hal/http_client'
 
+shared_context "pact broker" 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
   let(:pact_hash) { PactBroker::Client::PactHash[consumer: {name: 'Condor'}, provider: {name: 'Pricing Service'}, interactions: []] }
   let(:consumer_contract) { Pact::ConsumerContract.from_hash pact_hash }
   let(:pact_json) { pact_hash.to_json }
@@ -16,5 +21,4 @@ shared_context "pact broker" do
   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'} }
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -170,6 +170,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: approvals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.24
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.24
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
   results.
 email:
@@ -214,6 +234,7 @@ files:
 - 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/colorize_notices.rb
 - lib/pact_broker/client/command_result.rb
 - lib/pact_broker/client/create_tag.rb
 - lib/pact_broker/client/error.rb
@@ -228,6 +249,7 @@ files:
 - lib/pact_broker/client/hal_client_methods.rb
 - lib/pact_broker/client/hash_refinements.rb
 - lib/pact_broker/client/matrix.rb
+- lib/pact_broker/client/matrix/abbreviate_version_number.rb
 - lib/pact_broker/client/matrix/formatter.rb
 - lib/pact_broker/client/matrix/json_formatter.rb
 - lib/pact_broker/client/matrix/resource.rb
@@ -257,6 +279,7 @@ files:
 - lib/pact_broker/client/webhooks/test.rb
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
+- script/approve-all.sh
 - script/create-pacticipant.sh
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
@@ -264,6 +287,7 @@ files:
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
@@ -299,6 +323,7 @@ files:
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak
 - spec/service_providers/pact_broker_client_create_version_spec.rb
+- spec/service_providers/pact_broker_client_matrix_ignore_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb
@@ -313,6 +338,7 @@ files:
 - spec/service_providers/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
+- spec/support/approvals.rb
 - spec/support/cli_test_pacts/bar.json
 - spec/support/cli_test_pacts/foo.json
 - spec/support/latest_pacts_for_provider.json
@@ -344,11 +370,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
+- spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
@@ -384,6 +411,7 @@ test_files:
 - spec/service_providers/extra_goodies_spec.rb
 - spec/service_providers/list_latest_pact_versions_spec.rb.bak
 - spec/service_providers/pact_broker_client_create_version_spec.rb
+- spec/service_providers/pact_broker_client_matrix_ignore_spec.rb
 - spec/service_providers/pact_broker_client_matrix_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb
@@ -398,6 +426,7 @@ test_files:
 - spec/service_providers/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
+- spec/support/approvals.rb
 - spec/support/cli_test_pacts/bar.json
 - spec/support/cli_test_pacts/foo.json
 - spec/support/latest_pacts_for_provider.json