pact_broker-client 1.43.0 → 1.44.0

data/spec/service_providers/publish_pacts_spec.rb

@@ -1,7 +1,9 @@
 require 'pact_broker/client/publish_pacts'
 require 'service_providers/pact_helper'
 
-RSpec.describe "publishing contracts", pact: true do
+publish_contracts_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("publish_contracts")
+
+RSpec.describe "publishing contracts", pact: true, skip: !publish_contracts_feature_on 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)

data/spec/service_providers/record_deployment_spec.rb

@@ -1,7 +1,9 @@
 require 'service_providers/pact_helper'
-require 'pact_broker/client/versions/record_deployment'
+require 'pact_broker/client/deployments/record_deployment'
 
-RSpec.describe "recording a deployment", pact: true do
+deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
+
+RSpec.describe "recording a deployment", pact: true, skip: !deployment_feature_on do
   include_context "pact broker"
   include PactBrokerPactHelperMethods
 
@@ -25,7 +27,7 @@ RSpec.describe "recording a deployment", pact: true do
   end
   let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url } }
 
-  subject { PactBroker::Client::Versions::RecordDeployment.call(params, options, pact_broker_client_options) }
+  subject { PactBroker::Client::Deployments::RecordDeployment.call(params, options, pact_broker_client_options) }
 
   def mock_index
     pact_broker
@@ -105,18 +107,6 @@ RSpec.describe "recording a deployment", pact: true do
       )
   end
 
-  def mock_pacticipant_version_not_found
-    pact_broker
-      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist")
-      .upon_receiving("a request for a pacticipant version")
-      .with(
-        method: "GET",
-        path: "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-        headers: get_request_headers
-      )
-      .will_respond_with(status: 404)
-  end
-
   def mock_environments
     pact_broker
       .given("an environment with name test exists")
@@ -184,18 +174,6 @@ RSpec.describe "recording a deployment", pact: true do
     end
   end
 
-  context "when the specified version does not exist" do
-    before do
-      mock_index
-      mock_pacticipant_version_not_found
-    end
-
-    it "returns an error response" do
-      expect(subject.success).to be false
-      expect(subject.message).to include "Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 not found"
-    end
-  end
-
   context "when the specified environment is not available for recording a deployment" do
     before do
       mock_index
@@ -208,14 +186,14 @@ RSpec.describe "recording a deployment", pact: true do
 
       it "returns an error response" do
         expect(subject.success).to be false
-        expect(subject.message).to include "No environment found with name 'foo'. Available options: test"
+        expect(subject.message).to include "No environment found"
       end
     end
 
     context "when the specified environment does exist" do
       it "returns an error response" do
         expect(subject.success).to be false
-        expect(subject.message).to include "Environment 'test' is not an available option for recording a deployment of Foo. Available options: prod, dev"
+        expect(subject.message).to include "not an available option"
       end
     end
   end

data/spec/service_providers/record_release_spec.rb

@@ -0,0 +1,135 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/deployments/record_deployment'
+
+deployment_feature_on = ENV.fetch('PACT_BROKER_FEATURES', '').include?("deployments")
+
+RSpec.describe "recording a release", pact: true, skip: !deployment_feature_on do
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:pacticipant_name) { "Foo" }
+  let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
+  let(:environment_name) { "test" }
+  let(:output) { "text" }
+  let(:target) { "blue" }
+  let(:params) do
+    {
+      pacticipant_name: pacticipant_name,
+      version_number: version_number,
+      environment_name: environment_name
+    }
+  end
+  let(:options) do
+    {
+      output: output
+    }
+  end
+  let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url } }
+
+  subject { PactBroker::Client::Deployments::RecordRelease.call(params, options, pact_broker_client_options) }
+
+  def mock_index
+    pact_broker
+      .given("the pb:pacticipant-version and pb:environments relations exist 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:pacticipant-version' => {
+                href: placeholder_url_term("pb:pacticipant-version", ["pacticipant", "version"])
+              },
+              :'pb:environments' => {
+                href: placeholder_url_term("pb:environments")
+              }
+            }
+          }
+        )
+  end
+
+  def mock_pacticipant_version_with_test_environment_available_for_release
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for release")
+      .upon_receiving("a request for a pacticipant version")
+      .with(
+        method: "GET",
+        path: "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            "pb:record-release" => [
+              {
+                name: "test",
+                href: placeholder_url_term("pb:record-release-#{pacticipant_name}-#{version_number}-#{environment_name}")
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_environments
+    pact_broker
+      .given("an environment with name test exists")
+      .upon_receiving("a request for the environments")
+      .with(
+        method: "GET",
+        path: "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
+        headers: get_request_headers
+      )
+      .will_respond_with(
+        status: 200,
+        headers: pact_broker_response_headers,
+        body: {
+          _links: {
+            "pb:environments" => [
+              {
+                name: "test",
+                href: Pact.like("href")
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_record_release
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment")
+      .upon_receiving("a request to record a release")
+      .with(
+        method: "POST",
+        path: "/HAL-REL-PLACEHOLDER-PB-RECORD-RELEASE-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        headers: post_request_headers
+      )
+      .will_respond_with(
+        status: 201,
+        headers: pact_broker_response_headers,
+        body: {
+          target: target
+        }
+      )
+  end
+
+  context "when the deployment is recorded successfully" do
+    before do
+      mock_index
+      mock_pacticipant_version_with_test_environment_available_for_release
+      mock_record_release
+    end
+
+    it "returns a success message" do
+      expect(subject.success).to be true
+      expect(subject.message).to include "Recorded release of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test environment in the Pact Broker."
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,6 @@
 require 'webmock/rspec'
 require 'rspec/its'
 
-ENV['PACT_BROKER_FEATURES'] = 'deployments publish_contracts ignore'
-
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"
@@ -25,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/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.43.0
+  version: 1.44.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -247,6 +247,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/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
@@ -254,6 +255,11 @@ files:
 - 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
@@ -286,6 +292,7 @@ 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
@@ -301,8 +308,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
@@ -313,15 +318,18 @@ 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
 - 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
@@ -331,6 +339,7 @@ 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
@@ -351,7 +360,6 @@ 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
@@ -373,6 +381,7 @@ 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
@@ -414,10 +423,12 @@ 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
@@ -427,6 +438,7 @@ 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
@@ -447,7 +459,6 @@ 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
@@ -469,6 +480,7 @@ 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

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

@@ -1,85 +0,0 @@
-require 'pact_broker/client/base_command'
-
-module PactBroker
-  module Client
-    class Versions
-      class RecordDeployment < PactBroker::Client::BaseCommand
-
-        NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support recording deployments. Please upgrade to version 2.80.0 or later."
-
-        def initialize(params, options, pact_broker_client_options)
-          super
-          @pacticipant_name = params.fetch(:pacticipant_name)
-          @version_number = params.fetch(:version_number)
-          @environment_name = params.fetch(:environment_name)
-          @target = params.fetch(:target)
-        end
-
-        private
-
-        def do_call
-          record_deployment
-          PactBroker::Client::CommandResult.new(true, result_message)
-        end
-
-        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
-          { target: target }
-        end
-
-        def result_message
-          if json_output?
-            deployed_version_resource.response.raw_body
-          else
-            message = "Recorded deployment of #{pacticipant_name} version #{version_number} to #{environment_name} environment"
-            message = "#{message} (target #{target})" if target
-            green("#{message} in #{pact_broker_name}.")
-          end
-        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