pact_broker-client 1.43.0 → 1.44.0

data/lib/pact_broker/client/hal/http_client.rb

@@ -18,7 +18,7 @@ module PactBroker
         end
 
         def get href, params = {}, headers = {}
-          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value)}" }.join("&")
+          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}" }.join("&")
           uri = URI(href)
           uri.query = query
           perform_request(create_request(uri, 'Get', nil, headers), uri)
@@ -46,7 +46,8 @@ module PactBroker
 
         def create_request uri, http_method, body = nil, headers = {}
           request = Net::HTTP.const_get(http_method).new(uri.request_uri)
-          request['Content-Type'] = "application/json" if ['Post', 'Put', 'Patch'].include?(http_method)
+          request['Content-Type'] ||= "application/json" if ['Post', 'Put'].include?(http_method)
+          request['Content-Type'] ||= "application/merge-patch+json" if ['Patch'].include?(http_method)
           request['Accept'] = "application/hal+json"
           headers.each do | key, value |
             request[key] = value

data/lib/pact_broker/client/pacticipants.rb

@@ -1,7 +1,7 @@
 # New code
-Dir.glob(File.join(__FILE__.gsub(".rb", "/**/*.rb"))).sort.each do | path |
-  require path
-end
+require 'pact_broker/client/pacticipants/create'
+require 'pact_broker/client/pacticipants/describe'
+require 'pact_broker/client/pacticipants/list'
 
 # Old code
 require 'pact_broker/client/base_client'

data/lib/pact_broker/client/pacticipants/create.rb

@@ -17,7 +17,7 @@ module PactBroker
             index_resource._link!('pb:pacticipants').post!(pacticipant_resource_params)
           elsif pacticipant_entity.success?
             @action = "updated"
-            pacticipant_entity._link!('self').patch!(pacticipant_resource_params)
+            pacticipant_entity._link!('self').patch!(pacticipant_resource_params, { "Content-Type" => "application/json" })
           else
             pacticipant_entity.assert_success!
           end

data/lib/pact_broker/client/pacticipants/describe.rb

@@ -0,0 +1,33 @@
+require 'pact_broker/client/base_command'
+require 'pact_broker/client/describe_text_formatter'
+
+module PactBroker
+  module Client
+    module Pacticipants2
+      class Describe < PactBroker::Client::BaseCommand
+
+        private
+
+        def do_call
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        def pacticipant_entity
+          @pacticipant_entity ||= index_resource._link('pb:pacticipant').expand('pacticipant' => params[:name]).get!
+        end
+
+        def result_message
+          if json_output?
+            pacticipant_entity.response.raw_body
+          else
+            properties = pacticipant_entity.response.body.except("_links", "_embedded")
+            if pacticipant_entity._embedded && pacticipant_entity._embedded["labels"] && pacticipant_entity._embedded["labels"].any?
+              properties["labels"] = pacticipant_entity._embedded["labels"]
+            end
+            PactBroker::Client::DescribeTextFormatter.call(properties)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.43.0'
+    VERSION = '1.44.0'
   end
 end

data/lib/pact_broker/client/versions.rb

@@ -1,4 +1,7 @@
-require_relative 'base_client'
+require 'pact_broker/client/base_client'
+require 'pact_broker/client/versions/describe'
+
+# Old code
 require 'pact_broker/client/pacts'
 
 module PactBroker

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

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/versions/formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Describe
 
         class Result

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

@@ -1,9 +1,11 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/json_formatter'
 require 'pact_broker/client/versions/text_formatter'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class Formatter
         def self.call(matrix_lines, format)
           formatter = case format

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

@@ -1,11 +1,13 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class JsonFormatter
-        def self.call(matrix)
-          JSON.pretty_generate(matrix)
+        def self.call(version)
+          JSON.pretty_generate(version)
         end
       end
     end

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

@@ -1,8 +1,10 @@
+# Need Versions class to extend BaseClient until we can remove the old Versions code
+require 'pact_broker/client/base_client'
 require 'table_print'
 
 module PactBroker
   module Client
-    class Versions
+    class Versions < BaseClient
       class TextFormatter
 
         Line = Struct.new(:number, :tags)

data/script/record-deployments-and-releases.sh

@@ -0,0 +1,10 @@
+export PACT_BROKER_FEATURES=deployments
+
+bundle exec bin/pact-broker create-or-update-pacticipant --name Foo
+bundle exec bin/pact-broker create-version-tag --pacticipant Foo --version 2 --tag main --auto-create-version
+bundle exec bin/pact-broker describe-version --pacticipant Foo --version 2
+bundle exec bin/pact-broker create-environment --name test
+bundle exec bin/pact-broker can-i-deploy --pacticipant Foo --version 2 --to-environment test
+bundle exec bin/pact-broker record-deployment --pacticipant Foo --version 2 --environment test --target foo
+bundle exec bin/pact-broker record-undeployment --pacticipant Foo --version 2 --environment test --target foo
+bundle exec bin/pact-broker record-release --pacticipant Foo --version 2 --environment test

data/spec/fixtures/approvals/describe_pacticipant.approved.txt

@@ -0,0 +1,2 @@
+Name: Pricing Service
+Repository Url: git@git.realestate.com.au:business-systems/pricing-service

data/spec/integration/describe_environment_spec.rb

@@ -0,0 +1,31 @@
+require 'pact_broker/client/cli/broker'
+
+RSpec.describe "describe-environment" do
+  let(:index_body_hash) do
+    {
+      _links: {
+        "pb:pacticipant" => {
+          href: "http://broker/pacticipants/{pacticipant}"
+        }
+      }
+    }
+  end
+
+  let(:pacticipant_body_hash) { JSON.parse(File.read("./spec/support/pacticipant_get.json")) }
+
+  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!(:pacticipant_request) do
+    stub_request(:get, "http://broker/pacticipants/Foo").to_return(status: 200, body: pacticipant_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+  end
+
+  let(:parameters) { %w{describe-pacticipant --name Foo --broker-base-url http://broker} }
+
+  subject { capture(:stdout) { PactBroker::Client::CLI::Broker.start(parameters) } }
+
+  it "prints the pacticipant properties" do
+    Approvals.verify(subject, :name => "describe_pacticipant", format: :txt)
+  end
+end

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -0,0 +1,204 @@
+require 'pact_broker/client/deployments/record_deployment'
+
+module PactBroker
+  module Client
+    module Deployments
+      describe RecordDeployment do
+        describe ".call" do
+          let(:broker_base_url) { "http://broker" }
+          let(:index_body_hash) do
+            {
+              _links: {
+                "pb:environments" => { href: "#{broker_base_url}/environments" },
+                "pb:pacticipant-version" => {
+                  href: "#{broker_base_url}/pacticipants/{pacticipant}/versions/{version}"
+                }
+              }
+            }
+          end
+          let(:version_body_hash) do
+            {
+              "_links" => {
+                "pb:record-deployment" => [
+                  {
+                    name: "test",
+                    href: "#{broker_base_url}/record-deployment"
+                  }
+                ]
+              }
+            }
+          end
+          let(:environments_body_hash) do
+            {
+              "_links" => {
+                "pb:environments" => [
+                  {
+                    "name" => "test",
+                    "href" => ""
+                  }
+                ]
+              }
+
+            }
+          end
+          let(:record_deployment_body_hash) do
+            { "some" => "response" }
+          end
+          let!(:index_request) do
+            stub_request(:get, broker_base_url).to_return(status: 200, body: index_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+          let!(:version_request) do
+            stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 200, body: version_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+          end
+
+          let!(:environments_request) do
+            stub_request(:get, "http://broker/environments").
+              with(headers: { 'Accept'=>'application/hal+json' }).
+              to_return(status: 200, body: environments_body_hash.to_json, headers: { "Content-Type" => "application/hal+json" })
+          end
+          let!(:record_deployment_request) do
+            stub_request(:post, "http://broker/record-deployment").
+              to_return(status: 200, body: record_deployment_body_hash.to_json , headers: {})
+          end
+
+          let(:target) { "blue" }
+
+          let(:params) do
+            {
+              pacticipant_name: "Foo",
+              version_number: "1",
+              environment_name: "test",
+              target: target
+            }
+          end
+
+          let(:options) do
+            {
+              output: output,
+              verbose: true
+            }
+          end
+          let(:output) { "text" }
+          let(:pact_broker_client_options) { { pact_broker_base_url: broker_base_url} }
+
+          subject { RecordDeployment.call(params, options, pact_broker_client_options) }
+
+          context "when the pb:environments relation does not exist" do
+            let(:index_body_hash) do
+              {
+                "_links" => {}
+              }
+            end
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the specified version does not exist" do
+            let!(:version_request) do
+              stub_request(:get, broker_base_url + "/pacticipants/Foo/versions/1").to_return(status: 404)
+            end
+
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "Foo version 1 not found"
+            end
+          end
+
+          context "when the pacticipant version does not support recording deployments" do
+            let(:version_body_hash) do
+              {
+                "_links" => {}
+              }
+            end
+            it "returns an error response" do
+              expect(subject.success).to be false
+              expect(subject.message).to include "does not support"
+            end
+          end
+
+          context "when the specified environment is not available for recording a deployment" do
+            let(:version_body_hash) do
+              {
+                "_links" => {
+                  "pb:record-deployment" => [
+                    {
+                      "name" => "prod",
+                      "href" => ""
+                    }
+                  ]
+                }
+              }
+            end
+
+            context "when the environment does not exist" do
+              let(:environments_body_hash) do
+                {
+                  "_links" => {
+                    "pb:environments" => [
+                      {
+                        "name" => "prod",
+                        "href" => ""
+                      },{
+                        "name" => "uat",
+                        "href" => ""
+                      }
+                    ]
+                  }
+                }
+              end
+
+              it "returns an error response" do
+                expect(subject.success).to be false
+                expect(subject.message).to include "No environment found with name 'test'. Available options: prod"
+              end
+            end
+
+            context "when the 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"
+              end
+            end
+          end
+
+          context "when the output is json" do
+            let(:output) { "json" }
+
+            it "returns the JSON payload" do
+              expect(JSON.parse(subject.message)).to eq record_deployment_body_hash
+            end
+          end
+
+          context "when the response headers contain Pactflow" do
+            before do
+              allow_any_instance_of(RecordDeployment).to receive(:check_if_command_supported)
+              allow_any_instance_of(RecordDeployment).to receive(:check_environment_exists)
+              allow_any_instance_of(RecordDeployment).to receive(:record_action)
+              allow_any_instance_of(RecordDeployment).to receive(:index_resource).and_return(index_resource)
+            end
+
+            let(:response_headers) { { "X-Pactflow-Sha" => "abc" } }
+
+            let(:index_resource) do
+              double('PactBroker::Client::Hal::Entity', response: double('response', headers: response_headers) )
+            end
+
+            it "indicates the API was Pactflow" do
+              expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment (target blue) in Pactflow"
+            end
+
+            context "when target is nil" do
+              let(:target) { nil }
+
+              it "does not include the target in the result message" do
+                expect(subject.message).to include "Recorded deployment of Foo version 1 to test environment in"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1638,294 +1638,6 @@
         }
       }
     },
-    {
-      "description": "a request for the index resource",
-      "providerState": "the pb:publish-contracts relations exists 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:publish-contracts": {
-              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
-            }
-          }
-        },
-        "matchingRules": {
-          "$.body._links.pb:publish-contracts.href": {
-            "match": "regex",
-            "regex": "http:\\/\\/.*"
-          }
-        }
-      }
-    },
-    {
-      "description": "a request to publish contracts",
-      "request": {
-        "method": "POST",
-        "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
-        "headers": {
-          "Content-Type": "application/json",
-          "Accept": "application/hal+json"
-        },
-        "body": {
-          "pacticipantName": "Foo",
-          "pacticipantVersionNumber": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-          "branch": "main",
-          "tags": [
-            "dev"
-          ],
-          "buildUrl": "http://build",
-          "contracts": [
-            {
-              "consumerName": "Foo",
-              "providerName": "Bar",
-              "specification": "pact",
-              "contentType": "application/json",
-              "content": "eyJjb25zdW1lciI6eyJuYW1lIjoiRm9vIn0sInByb3ZpZGVyIjp7Im5hbWUiOiJCYXIifSwiaW50ZXJhY3Rpb25zIjpbeyJkZXNjcmlwdGlvbiI6ImFuIGV4YW1wbGUgcmVxdWVzdCIsInByb3ZpZGVyU3RhdGUiOiJhIHByb3ZpZGVyIHN0YXRlIiwicmVxdWVzdCI6eyJtZXRob2QiOiJHRVQiLCJwYXRoIjoiLyIsImhlYWRlcnMiOnt9fSwicmVzcG9uc2UiOnsic3RhdHVzIjoyMDAsImhlYWRlcnMiOnsiQ29udGVudC1UeXBlIjoiYXBwbGljYXRpb24vaGFsK2pzb24ifX19XSwibWV0YWRhdGEiOnsicGFjdFNwZWNpZmljYXRpb24iOnsidmVyc2lvbiI6IjIuMC4wIn19fQ==",
-              "writeMode": "overwrite",
-              "onConflict": "overwrite"
-            }
-          ]
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "_embedded": {
-            "pacticipant": {
-              "name": "Foo"
-            },
-            "version": {
-              "number": "5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-              "buildUrl": "http://build"
-            }
-          },
-          "logs": [
-            {
-              "level": "info",
-              "message": "some message"
-            }
-          ],
-          "_links": {
-            "pb:pacticipant-version-tags": [
-              {
-                "name": "dev"
-              }
-            ],
-            "pb:contracts": [
-              {
-                "href": "http://some-pact"
-              }
-            ]
-          }
-        },
-        "matchingRules": {
-          "$.body.logs": {
-            "min": 1
-          },
-          "$.body.logs[*].*": {
-            "match": "type"
-          },
-          "$.body._links.pb:contracts[0].href": {
-            "match": "type"
-          }
-        }
-      }
-    },
-    {
-      "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": {
-          "target": "blue"
-        }
-      },
-      "response": {
-        "status": 201,
-        "headers": {
-          "Content-Type": "application/hal+json;charset=utf-8"
-        },
-        "body": {
-          "target": "blue"
-        }
-      }
-    },
-    {
-      "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",