pact_broker-client 1.36.0 → 1.37.0

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1550,6 +1550,187 @@
         }
       }
     },
+    {
+      "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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.36.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -204,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
@@ -222,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
@@ -245,6 +248,7 @@ 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/text_formatter.rb
 - lib/pact_broker/client/webhooks/create.rb
 - lib/pact_broker/client/webhooks/test.rb
@@ -282,6 +286,7 @@ 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
@@ -298,6 +303,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
@@ -363,6 +369,7 @@ 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
@@ -379,6 +386,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