pact_broker-client 1.39.0 → 1.44.0

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 require 'webmock/rspec'
-
-ENV['PACT_BROKER_FEATURES'] = 'deployments'
+require 'rspec/its'
 
 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'
@@ -23,6 +23,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

@@ -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_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)
+    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

data/tasks/pact.rake

@@ -14,5 +14,23 @@ 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['GITHUB_SHA']
+  tags = ENV['GITHUB_REF'] ? [ENV['GITHUB_REF'].gsub("refs/heads/", "")] : []
+
+  if ENV.fetch('TEST_FEATURE', '') != ''
+    version = "#{version}+#{ENV['TEST_FEATURE']}"
+    tags = ENV['TEST_FEATURE']
+  end
+
+  require 'pact_broker/client/version'
+  task.auto_detect_version_properties = false
+  task.tags = tags
+  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.39.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -170,6 +170,40 @@ 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
+- !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:
@@ -206,17 +240,36 @@ 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/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_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
@@ -228,6 +281,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
@@ -238,11 +292,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
@@ -250,23 +308,28 @@ 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
 - 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
 - script/record-deployment.sh
+- script/record-deployments-and-releases.sh
 - script/record-undeployment.sh
 - script/release.sh
 - script/trigger-release.sh
+- spec/fixtures/approvals/can_i_deploy_ignore.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
@@ -276,6 +339,11 @@ 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/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
@@ -292,13 +360,15 @@ 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/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
 - 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
@@ -311,8 +381,10 @@ files:
 - 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/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,14 +416,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.19
 signing_key: 
 specification_version: 4
 summary: See description
 test_files:
+- spec/fixtures/approvals/can_i_deploy_ignore.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
@@ -361,6 +438,11 @@ 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/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
@@ -377,13 +459,15 @@ 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/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
 - 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
@@ -396,8 +480,10 @@ test_files:
 - 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/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

data/lib/pact_broker/client/versions/record_deployment.rb

@@ -1,109 +0,0 @@
-require 'pact_broker/client/hal_client_methods'
-require 'pact_broker/client/error'
-require 'pact_broker/client/command_result'
-
-module PactBroker
-  module Client
-    class Versions
-      class RecordDeployment
-        include PactBroker::Client::HalClientMethods
-
-        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. Please upgrade to version 2.80.0 or later."
-
-        def self.call(params, pact_broker_base_url, pact_broker_client_options)
-          new(params, pact_broker_base_url, pact_broker_client_options).call
-        end
-
-        def initialize(params, pact_broker_base_url, pact_broker_client_options)
-          @pact_broker_base_url = pact_broker_base_url
-          @pacticipant_name = params.fetch(:pacticipant_name)
-          @version_number = params.fetch(:version_number)
-          @environment_name = params.fetch(:environment_name)
-          @target = params.fetch(:target)
-          @output = params.fetch(:output)
-          @pact_broker_client_options = pact_broker_client_options
-        end
-
-        def call
-          check_if_command_supported
-          record_deployment
-
-          PactBroker::Client::CommandResult.new(true, result_message)
-        rescue PactBroker::Client::Error => e
-          PactBroker::Client::CommandResult.new(false, e.message)
-        end
-
-        private
-
-        attr_reader :pact_broker_base_url, :pact_broker_client_options
-        attr_reader :pacticipant_name, :version_number, :environment_name, :target, :output
-        attr_reader :deployed_version_resource
-
-        def check_environment_exists
-          index_resource
-            ._link!("pb:environments")
-            .get!
-            ._links("pb:environments")
-            .find!(environment_name, "No environment found with name '#{environment_name}'")
-        end
-
-        def record_deployment
-          @deployed_version_resource =
-            get_record_deployment_relation
-            .post(record_deployment_request_body)
-            .assert_success!
-        end
-
-        def get_record_deployment_relation
-          record_deployment_links = get_pacticipant_version._links!("pb:record-deployment")
-          link_for_environment = record_deployment_links.find(environment_name)
-          if link_for_environment
-            link_for_environment
-          else
-            check_environment_exists
-            # Force the exception to be raised
-            record_deployment_links.find!(environment_name, "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}.")
-          end
-        end
-
-        def get_pacticipant_version
-          index_resource
-            ._link!("pb:pacticipant-version")
-            .expand(pacticipant: pacticipant_name, version: version_number)
-            .get
-            .assert_success!(404 => "#{pacticipant_name} version #{version_number} not found")
-        end
-
-        def record_deployment_request_body
-          { replacedPreviousDeployedVersion: target }
-        end
-
-        def result_message
-          if output == "text"
-            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} in #{pact_broker_name}."
-            suffix = target ? " Marked previous deployed version as undeployed." : ""
-            message + suffix
-          elsif output == "json"
-            deployed_version_resource.response.raw_body
-          else
-            ""
-          end
-        end
-
-        def pact_broker_name
-          is_pactflow? ? "Pactflow" : "the Pact Broker"
-        end
-
-        def is_pactflow?
-          deployed_version_resource.response.headers.keys.any?{ | header_name | header_name.downcase.include?("pactflow") }
-        end
-
-        def check_if_command_supported
-          unless index_resource.can?("pb:environments")
-            raise PactBroker::Client::Error.new(NOT_SUPPORTED_MESSAGE)
-          end
-        end
-      end
-    end
-  end
-end