pact_broker-client 1.34.0 → 1.38.0

data/spec/service_providers/pact_broker_client_create_version_spec.rb

@@ -0,0 +1,89 @@
+require_relative 'pact_helper'
+require 'pact_broker/client'
+require 'pact_broker/client/publish_pacts'
+
+describe PactBroker::Client::Versions, pact: true do
+
+  include_context "pact broker"
+
+
+  describe "creating a pacticipant version" do
+    before do
+      allow(publish_pacts).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}" }
+    let(:version_url) { pact_broker.mock_service_base_url + version_path }
+    let(:number) { "26f353580936ad3b9baddb17b00e84f33c69e7cb" }
+    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(:provider_state) { "version #{number} of pacticipant Foo does not exist" }
+    let(:expected_response_status) { 201 }
+
+    subject { publish_pacts.send(:create_consumer_versions) }
+
+    before do
+      pact_broker
+        .given("the pb:pacticipant-version relation 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:pacticipant-version' => {
+                  href: Pact.term(version_url, /http:\/\/.*{pacticipant}.*{version}/)
+                }
+              }
+            }
+          )
+
+      pact_broker
+        .given(provider_state)
+        .upon_receiving("a request to create a pacticipant version")
+        .with(
+            method: :put,
+            path: "/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-Foo-#{number}",
+            headers: put_request_headers,
+            body: {
+              branch: branch,
+              buildUrl: build_url
+            }).
+          will_respond_with(
+            status: expected_response_status,
+            headers: pact_broker_response_headers,
+            body: {
+              number: number,
+              branch: branch,
+              buildUrl: build_url,
+              _links: {
+                self: {
+                  href: Pact.term('http://localhost:1234/some-url', %r{http://.*})
+                }
+              }
+            }
+          )
+    end
+
+    context "when the version does not already exist" do
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+
+    context "when the version does exist" do
+      let(:provider_state) { "version #{number} of pacticipant Foo does exist" }
+      let(:expected_response_status) { 200 }
+
+      it "returns true" do
+        expect(subject).to be true
+      end
+    end
+  end
+end

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -279,6 +279,10 @@ module PactBroker::Client
           expect(matrix[:matrix].size).to eq 1
         end
       end
+
+      context "with an environment name" do
+        it "passes the environment name in the options"
+      end
     end
   end
 end

data/spec/service_providers/pact_broker_client_versions_spec.rb

@@ -1,6 +1,5 @@
-require 'spec_helper'
-require 'pact_broker/client'
 require_relative 'pact_helper'
+require 'pact_broker/client'
 
 describe PactBroker::Client::Versions, pact: true do
 

data/spec/service_providers/record_deployment_spec.rb

@@ -0,0 +1,219 @@
+require 'service_providers/pact_helper'
+require 'pact_broker/client/versions/record_deployment'
+
+RSpec.describe "recording a deployment", pact: true do
+
+  include_context "pact broker"
+  include PactBrokerPactHelperMethods
+
+  let(:pacticipant_name) { "Foo" }
+  let(:version_number) { "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30" }
+  let(:environment_name) { "test" }
+  let(:output) { "text" }
+  let(:replaced_previous_deployed_version) { true }
+  let(:params) do
+    {
+      pacticipant_name: pacticipant_name,
+      version_number: version_number,
+      environment_name: environment_name,
+      replaced_previous_deployed_version: replaced_previous_deployed_version,
+      output: output
+    }
+  end
+  let(:pact_broker_client_options) { {} }
+
+  subject { PactBroker::Client::Versions::RecordDeployment.call(params, broker_base_url, 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_deployment
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment")
+      .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-deployment" => [
+              {
+                name: "test",
+                href: placeholder_url_term("pb:record-deployment-#{pacticipant_name}-#{version_number}-#{environment_name}")
+              }
+            ]
+          }
+        }
+      )
+  end
+
+  def mock_pacticipant_version_without_test_environment_available_for_deployment
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment")
+      .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-deployment" => [
+              Pact.like(
+                name: "prod",
+                href: "href"
+              ),
+              Pact.like(
+                name: "dev",
+                href: "href"
+              ),
+            ]
+          }
+        }
+      )
+  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")
+      .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_deployment
+    pact_broker
+      .given("version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment")
+      .upon_receiving("a request to record a deployment")
+      .with(
+        method: "POST",
+        path: "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+        headers: post_request_headers,
+        body: {
+          replacedPreviousDeployedVersion: replaced_previous_deployed_version
+        }
+      )
+      .will_respond_with(
+        status: 201,
+        headers: pact_broker_response_headers,
+        body: {
+          replacedPreviousDeployedVersion: replaced_previous_deployed_version
+        }
+      )
+  end
+
+  context "when the deployment is recorded successfully" do
+    before do
+      mock_index
+      mock_pacticipant_version_with_test_environment_available_for_deployment
+      mock_record_deployment
+    end
+
+    it "returns a success message" do
+      expect(subject.success).to be true
+      expect(subject.message).to eq "Recorded deployment of Foo version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 to test in the Pact Broker. Marked previous deployed version as undeployed."
+    end
+
+    context "when the output is json" do
+      let(:output) { "json" }
+
+      it "returns the JSON payload" do
+        expect(JSON.parse(subject.message)).to eq "replacedPreviousDeployedVersion" => replaced_previous_deployed_version
+      end
+    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
+      mock_pacticipant_version_without_test_environment_available_for_deployment
+      mock_environments
+    end
+
+    context "when the specified environment does not exist" do
+      let(:environment_name) { "foo" }
+
+      it "returns an error response" do
+        expect(subject.success).to be false
+        expect(subject.message).to eq "No environment found with name 'foo'. Available options: test"
+      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 eq "Environment 'test' is not an available option for recording a deployment of Foo. Available options: prod, dev"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'webmock/rspec'
 
+ENV['PACT_BROKER_FEATURES'] = 'deployments'
+
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"

data/spec/support/matrix.json

@@ -20,7 +20,12 @@
       },
       "verificationResult": {
         "verifiedAt": "2017-10-10T12:49:04+11:00",
-        "success": true
+        "success": true,
+        "_links": {
+          "self": {
+            "href": "http://result"
+          }
+        }
       },
       "pact": {
         "createdAt": "2017-10-10T12:49:04+11:00"

data/spec/support/matrix.txt

@@ -1,3 +1,3 @@
-CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
----------|-----------|----------|-----------|---------
-Foo      | 4         | Bar      | 5         | true
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+Foo      | 4         | Bar      | 5         | true     | 1

data/spec/support/matrix_error.txt

@@ -1,3 +1,3 @@
-CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS?
----------|-----------|----------|-----------|---------
-???      | ???       | ???      | ???       | ???
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+???      | ???       | ???      | ???       | ???      |

data/spec/support/matrix_with_results.txt

@@ -0,0 +1,10 @@
+CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
+---------|-----------|----------|-----------|----------|--------
+Foo      | 4         | Bar      | 5         | true     | 1
+Foo      | 4         | Bar      | 5         | ???      |
+Foo      | 4         | Bar      | 5         | false    | 2
+
+VERIFICATION RESULTS
+--------------------
+1. http://result (success)
+2. http://result (failure)

data/tasks/pact.rake

@@ -5,6 +5,8 @@ PactBroker::Client::PublicationTask.new(:localhost) do | task |
   task.tag = `git rev-parse --abbrev-ref HEAD`.strip
   task.consumer_version = PactBroker::Client::VERSION
   task.pact_broker_base_url = "http://localhost:9292"
+  task.build_url = "http://ci"
+  # task.branch = "main"
 end
 
 PactBroker::Client::PublicationTask.new(:remote) do | task |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.38.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -86,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: dig_rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
@@ -146,16 +160,16 @@ dependencies:
   name: pact-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.16'
 description: Client for the Pact Broker. Publish, retrieve and query pacts and verification
   results.
 email:
@@ -166,10 +180,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/release_gem.yml"
+- ".github/workflows/test.yml"
 - ".github/workflows/trigger_pact_docs_update.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -190,6 +204,7 @@ files:
 - example/scripts/publish-verification.sh
 - example/scripts/verification.json
 - lib/pact_broker/client.rb
+- lib/pact_broker/client/backports.rb
 - lib/pact_broker/client/base_client.rb
 - lib/pact_broker/client/can_i_deploy.rb
 - lib/pact_broker/client/cli/broker.rb
@@ -208,7 +223,9 @@ files:
 - lib/pact_broker/client/hal/entry_point.rb
 - lib/pact_broker/client/hal/http_client.rb
 - lib/pact_broker/client/hal/link.rb
+- lib/pact_broker/client/hal/links.rb
 - 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/formatter.rb
 - lib/pact_broker/client/matrix/json_formatter.rb
@@ -231,6 +248,8 @@ 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
@@ -239,6 +258,7 @@ files:
 - script/create-pacticipant.sh
 - script/generate-cli-usage.sh
 - script/publish-pact.sh
+- script/record-deployment.sh
 - script/release.sh
 - script/trigger-release.sh
 - spec/integration/can_i_deploy_spec.rb
@@ -268,11 +288,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/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_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb
@@ -283,6 +305,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/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json
@@ -291,6 +314,7 @@ files:
 - spec/support/matrix.json
 - spec/support/matrix.txt
 - spec/support/matrix_error.txt
+- spec/support/matrix_with_results.txt
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json
 - spec/support/pacts_latest_list.json
@@ -315,7 +339,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: See description
@@ -347,11 +371,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/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_spec.rb
 - spec/service_providers/pact_broker_client_pacticipant_version_spec.rb
 - spec/service_providers/pact_broker_client_publish_spec.rb
@@ -362,6 +388,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/record_deployment_spec.rb
 - spec/service_providers/webhooks_create_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json
@@ -370,6 +397,7 @@ test_files:
 - spec/support/matrix.json
 - spec/support/matrix.txt
 - spec/support/matrix_error.txt
+- spec/support/matrix_with_results.txt
 - spec/support/pacticipant_get.json
 - spec/support/pacticipants_list.json
 - spec/support/pacts_latest_list.json