pact_broker-client 1.41.0 → 1.46.0

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/service_providers/webhooks_create_spec.rb

@@ -134,7 +134,7 @@ RSpec.describe "creating a webhook", pact: true do
   context "when an invalid webhook is submitted" do
     before do
       params[:url] = nil
-      request_body["request"]["url"] = nil
+      request_body["request"].delete("url")
 
       pact_broker
         .given("the 'Pricing Service' and 'Condor' already exist in the pact-broker")

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'webmock/rspec'
-
-ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts ignore'
+require 'rspec/its'
 
 WebMock.disable_net_connect!(allow_localhost: true)
 
@@ -16,6 +15,7 @@ RSpec.configure do | config |
     ENV.delete('PACT_BROKER_BASE_URL')
     ENV.delete('PACT_BROKER_USERNAME')
     ENV.delete('PACT_BROKER_PASSWORD')
+    ENV.delete('PACT_BROKER_TOKEN')
   end
 
   config.after(:all) do
@@ -24,6 +24,19 @@ RSpec.configure do | config |
 
   config.filter_run_excluding skip_windows: is_windows, skip_ci: is_ci
   config.example_status_persistence_file_path = "./spec/examples.txt"
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
 end
 
 module Pact

data/spec/support/approvals.rb

@@ -9,7 +9,7 @@ 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)
+  if File.exist?(received_file) && File.exist?(approved_file) && received_file.end_with?(".json") && approved_file.end_with?(".json")
     received_hash = JSON.parse(File.read(received_file))
     approved_hash = JSON.parse(File.read(approved_file))
     diff = Pact::Matchers.diff(approved_hash, received_hash)

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

@@ -14,5 +14,25 @@ PactBroker::Client::PublicationTask.new(:remote) do | task |
   task.tag = `git rev-parse --abbrev-ref HEAD`.strip
   task.consumer_version = PactBroker::Client::VERSION
   task.pact_broker_base_url = "https://test.pact.dius.com.au"
-  task.pact_broker_basic_auth = {username: ENV.fetch('PACT_BROKER_USERNAME'), password: ENV.fetch('PACT_BROKER_PASSWORD')}
+  task.pact_broker_basic_auth = { username: ENV.fetch('PACT_BROKER_USERNAME'), password: ENV.fetch('PACT_BROKER_PASSWORD') }
+end
+
+PactBroker::Client::PublicationTask.new(:pactflow) do | task |
+  version = ENV.fetch('GITHUB_SHA')
+  branch = ENV.fetch('GITHUB_REF').gsub("refs/heads/", "")
+  feature = ENV.fetch('TEST_FEATURE', '')
+  tag = branch
+
+  if feature != ''
+    version = "#{version}+#{feature}"
+    tag = "#{tag}+#{feature}"
+  end
+
+  require 'pact_broker/client/version'
+  task.auto_detect_version_properties = false
+  task.tags = [tag]
+  task.branch = nil
+  task.consumer_version = version
+  task.pact_broker_base_url = "https://pact-oss.pactflow.io"
+  task.pact_broker_token = ENV['PACT_BROKER_TOKEN']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,6 +190,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
   results.
 email:
@@ -216,6 +230,7 @@ files:
 - doc/markdown/Pact Broker Client - Pact Broker.md
 - doc/markdown/README.md
 - doc/pacts/markdown/Pact Broker Client - Pact Broker.md
+- doc/pacts/markdown/Pact Broker Client - Pactflow.md
 - doc/pacts/markdown/README.md
 - example/scripts/README.md
 - example/scripts/deploy-consumer.sh
@@ -226,18 +241,38 @@ files:
 - lib/pact_broker/client.rb
 - lib/pact_broker/client/backports.rb
 - lib/pact_broker/client/base_client.rb
+- lib/pact_broker/client/base_command.rb
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
 - lib/pact_broker/client/cli/can_i_deploy_long_desc.txt
 - 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/deployment_commands.rb
+- lib/pact_broker/client/cli/environment_commands.rb
+- lib/pact_broker/client/cli/pacticipant_commands.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/cli/webhook_commands.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/deployments.rb
+- lib/pact_broker/client/deployments/record_deployment.rb
+- lib/pact_broker/client/deployments/record_release.rb
+- lib/pact_broker/client/deployments/record_support_ended.rb
+- lib/pact_broker/client/deployments/record_undeployment.rb
+- lib/pact_broker/client/describe_text_formatter.rb
+- lib/pact_broker/client/environments.rb
+- lib/pact_broker/client/environments/create_environment.rb
+- lib/pact_broker/client/environments/delete_environment.rb
+- lib/pact_broker/client/environments/describe_environment.rb
+- lib/pact_broker/client/environments/environment_command.rb
+- lib/pact_broker/client/environments/list_environments.rb
+- lib/pact_broker/client/environments/text_formatter.rb
+- lib/pact_broker/client/environments/update_environment.rb
 - lib/pact_broker/client/error.rb
+- lib/pact_broker/client/generate_display_name.rb
 - lib/pact_broker/client/git.rb
 - lib/pact_broker/client/hal.rb
 - lib/pact_broker/client/hal/authorization_header_redactor.rb
@@ -260,11 +295,15 @@ files:
 - lib/pact_broker/client/pact_hash.rb
 - lib/pact_broker/client/pacticipants.rb
 - lib/pact_broker/client/pacticipants/create.rb
+- lib/pact_broker/client/pacticipants/describe.rb
+- lib/pact_broker/client/pacticipants/list.rb
+- lib/pact_broker/client/pacticipants/text_formatter.rb
 - 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/string_refinements.rb
 - lib/pact_broker/client/tasks.rb
 - lib/pact_broker/client/tasks/publication_task.rb
 - lib/pact_broker/client/version.rb
@@ -272,8 +311,6 @@ files:
 - lib/pact_broker/client/versions/describe.rb
 - lib/pact_broker/client/versions/formatter.rb
 - lib/pact_broker/client/versions/json_formatter.rb
-- lib/pact_broker/client/versions/record_deployment.rb
-- lib/pact_broker/client/versions/record_undeployment.rb
 - lib/pact_broker/client/versions/text_formatter.rb
 - lib/pact_broker/client/webhooks/create.rb
 - lib/pact_broker/client/webhooks/test.rb
@@ -284,13 +321,21 @@ files:
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
 - script/record-deployment.sh
+- script/record-deployments-and-releases.sh
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- script/webhook-commands.sh
+- spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
+- spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt
+- spec/fixtures/approvals/describe_environment.approved.txt
+- spec/fixtures/approvals/describe_pacticipant.approved.txt
+- spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
+- spec/integration/describe_environment_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
@@ -300,6 +345,13 @@ files:
 - spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/deployments/record_deployment_spec.rb
+- spec/lib/pact_broker/client/deployments/record_support_ended_spec.rb
+- spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb
+- spec/lib/pact_broker/client/environments/delete_environment_spec.rb
+- spec/lib/pact_broker/client/environments/describe_environment_spec.rb
+- spec/lib/pact_broker/client/environments/update_environment_spec.rb
+- spec/lib/pact_broker/client/generate_display_name_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
@@ -316,11 +368,13 @@ files:
 - 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
-- spec/lib/pact_broker/client/versions/record_deployment_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
+- spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
+- spec/service_providers/list_environments_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
@@ -333,9 +387,12 @@ files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.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/record_release_spec.rb
+- spec/service_providers/record_undeployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/approvals.rb
@@ -370,15 +427,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.21
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
+- spec/fixtures/approvals/can_i_deploy_failure_dry_run.approved.txt
 - spec/fixtures/approvals/can_i_deploy_ignore.approved.txt
+- spec/fixtures/approvals/can_i_deploy_success_dry_run.approved.txt
+- spec/fixtures/approvals/describe_environment.approved.txt
+- spec/fixtures/approvals/describe_pacticipant.approved.txt
+- spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
 - spec/integration/create_version_tag_spec.rb
+- spec/integration/describe_environment_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
 - spec/lib/pact_broker/client/can_i_deploy_spec.rb
 - spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb
@@ -388,6 +451,13 @@ test_files:
 - spec/lib/pact_broker/client/cli/broker_run_webhook_commands_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/deployments/record_deployment_spec.rb
+- spec/lib/pact_broker/client/deployments/record_support_ended_spec.rb
+- spec/lib/pact_broker/client/deployments/record_undeployment_spec.rb
+- spec/lib/pact_broker/client/environments/delete_environment_spec.rb
+- spec/lib/pact_broker/client/environments/describe_environment_spec.rb
+- spec/lib/pact_broker/client/environments/update_environment_spec.rb
+- spec/lib/pact_broker/client/generate_display_name_spec.rb
 - spec/lib/pact_broker/client/git_spec.rb
 - spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
@@ -404,11 +474,13 @@ test_files:
 - 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
-- spec/lib/pact_broker/client/versions/record_deployment_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
+- spec/pacts/pact_broker_client-pactflow.json
+- spec/service_providers/create_environment_spec.rb
 - spec/service_providers/extra_goodies_spec.rb
+- spec/service_providers/list_environments_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
@@ -421,9 +493,12 @@ test_files:
 - spec/service_providers/pact_broker_client_tags_spec.rb
 - spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
+- spec/service_providers/pactflow_webhooks_create_spec.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/record_release_spec.rb
+- spec/service_providers/record_undeployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/approvals.rb