pact_broker-client 1.38.2 → 1.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134d7fe9f87596c2b56d1edfb136bdff06c045cf1f6e2ef8a3f93b805d3e108d
-  data.tar.gz: 57acfb55120c41e97ec1397dceebdd6f9784b9a3ff50c47c6464735c11c6e5a1
+  metadata.gz: 1da6a5e8cef3f91ae1cd441eb92dd2d788ad67ccac947c476090787b27b134ea
+  data.tar.gz: 0df7d512c7c45a8b7ea4d049560be927d1d7c3273c0ec157c22cb81651caa16e
 SHA512:
-  metadata.gz: 235afd0d61e101c549795f7dec7ea22f7d282456d59e72d8f49d7b383e358742e75f6eb866154f99af21b73a34671af6bfc6337fd72fc08b44049d47daeef2f9
-  data.tar.gz: 23e3aa5306ce014268b287d7de00b200476cea6f7711821ee5dac95586a3d8ccd1f9152959409209349b0a9a3cc77febcba26d6c90be7b7aa165ef2a3ceb3b22
+  metadata.gz: 27dc97ff230f86c530b8aed93cf5e86334dd51982017627a7c99de57a2cf8f65af6706c5a73c5d1999df0b145b60b88a649b716fc7f859cbc289193f9dbca437
+  data.tar.gz: 1f970d5b863efc1bc27c55515b95afe8c4a3e166e3da62819ac92e1d4f6205fccb7f8979925266dc37342c1be496310c59a150408398e000b5e8e8b2079ab609

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.approvals
 coverage
 InstalledFiles
 lib/bundler/man

data/CHANGELOG.md

@@ -1,3 +1,50 @@
+<a name="v1.42.0"></a>
+### v1.42.0 (2021-05-31)
+
+#### Features
+
+* add list-pacticipants	 ([fc8ce3b](/../../commit/fc8ce3b))
+* add --display-name to create-or-update-pacticipant	 ([76f323b](/../../commit/76f323b))
+* add backtrace to error output when verbose is true	 ([abf1ef0](/../../commit/abf1ef0))
+* add list-environments and describe-environment	 ([4472d48](/../../commit/4472d48))
+* add delete-environment	 ([361eed1](/../../commit/361eed1))
+* add update-environment command	 ([95276cd](/../../commit/95276cd))
+* add create-environment command	 ([a9fab50](/../../commit/a9fab50))
+
+#### Bug Fixes
+
+* stop long values in columns from being truncated	 ([18063fd](/../../commit/18063fd))
+
+<a name="v1.41.0"></a>
+### v1.41.0 (2021-05-25)
+
+#### Features
+
+* update colours of pact publish output	 ([2a51e37](/../../commit/2a51e37))
+
+<a name="v1.40.0"></a>
+### v1.40.0 (2021-04-26)
+
+#### Features
+
+* use the pb:publish-contracts relation and endpoint to publish pacts	 ([19f1b0b](/../../commit/19f1b0b))
+* update publish pacts command to use new 'all in one' contract publishing endpoint	 ([50dfb11](/../../commit/50dfb11))
+
+<a name="v1.39.0"></a>
+### v1.39.0 (2021-04-27)
+
+#### Features
+
+* publish pacts using the "all in one" endpoint (#86)	 ([3a1ea22](/../../commit/3a1ea22))
+* provide a more helpful error message when the specified pact file does not exist	 ([29a7962](/../../commit/29a7962))
+
+<a name="v1.38.3"></a>
+### v1.38.3 (2021-04-08)
+
+#### Bug Fixes
+
+* URL encode parameters for HAL templated URLs	 ([764a0fa](/../../commit/764a0fa))
+
 <a name="v1.38.2"></a>
 ### v1.38.2 (2021-04-01)
 

data/Gemfile

@@ -10,3 +10,7 @@ if ENV['X_PACT_DEVELOPMENT'] == 'true'
   gem 'pact-mock_service', path: '../pact-mock_service'
   gem 'pact-support', path: '../pact-support'
 end
+
+group :development do
+  gem 'pry-byebug'
+end

data/README.md

@@ -309,6 +309,24 @@ Description:
   the `generate-uuid` command.
 ```
 
+### create-or-update-pacticipant
+
+```
+Usage:
+  pact-broker create-or-update-pacticipant --name=NAME -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+      --name=NAME                          # Pacticipant name
+      [--repository-url=REPOSITORY_URL]    # The repository URL of the pacticipant
+  -b, --broker-base-url=BROKER_BASE_URL    # The base URL of the Pact Broker
+  -u, [--broker-username=BROKER_USERNAME]  # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]  # Pact Broker basic auth password
+  -k, [--broker-token=BROKER_TOKEN]        # Pact Broker bearer token
+  -v, [--verbose], [--no-verbose]          # Verbose output. Default: false
+
+Create or update pacticipant by name
+```
+
 ### describe-version
 
 ```

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -2,12 +2,6 @@
 
 #### Requests from Pact Broker Client to Pact Broker
 
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren't_test_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with 2 environments that aren't test available for deployment
-
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
-
-* [A request for a pacticipant version](#a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist
-
 * [A request for the compatibility matrix for a pacticipant that does not exist](#a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist)
 
 * [A request for the compatibility matrix for all versions of Foo and Bar](#a_request_for_the_compatibility_matrix_for_all_versions_of_Foo_and_Bar_given_the_pact_for_Foo_version_1.2.3_and_1.2.4_has_been_verified_by_Bar_version_4.5.6) given the pact for Foo version 1.2.3 and 1.2.4 has been verified by Bar version 4.5.6
@@ -26,8 +20,6 @@
 
 * [A request for the compatibility matrix where only the version of Foo is specified](#a_request_for_the_compatibility_matrix_where_only_the_version_of_Foo_is_specified_given_the_pact_for_Foo_version_1.2.3_has_been_verified_by_Bar_version_4.5.6_and_version_5.6.7) given the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6 and version 5.6.7
 
-* [A request for the environments](#a_request_for_the_environments_given_an_environment_with_name_test_exists) given an environment with name test exists
-
 * [A request for the index resource](#a_request_for_the_index_resource)
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pacticipant_relations_are_present) given the pacticipant relations are present
@@ -36,10 +28,10 @@
 
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:latest-version_relation_exists_in_the_index_resource) given the pb:latest-version relation exists in the index resource
 
-* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource) given the pb:pacticipant-version and pb:environments relations exist in the index resource
-
 * [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource) given the pb:pacticipant-version relation exists in the index resource
 
+* [A request for the index resource](#a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource) given the pb:publish-contracts relations exists in the index resource
+
 * [A request for the index resource with the webhook relation](#a_request_for_the_index_resource_with_the_webhook_relation)
 
 * [A request for the list of the latest pacts from all consumers for the Pricing Service'](#a_request_for_the_list_of_the_latest_pacts_from_all_consumers_for_the_Pricing_Service'_given_a_latest_pact_between_Condor_and_the_Pricing_Service_exists) given a latest pact between Condor and the Pricing Service exists
@@ -92,7 +84,7 @@
 
 * [A request to publish a pact with method put](#a_request_to_publish_a_pact_with_method_put_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker,_and_Condor_already_has_a_pact_published_for_version_1.3.0) given the 'Pricing Service' and 'Condor' already exist in the pact-broker, and Condor already has a pact published for version 1.3.0
 
-* [A request to record a deployment](#a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment) given version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment
+* [A request to publish contracts](#a_request_to_publish_contracts)
 
 * [A request to register the repository URL of a pacticipant](#a_request_to_register_the_repository_URL_of_a_pacticipant_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
 
@@ -126,87 +118,6 @@
 
 #### Interactions
 
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_2_environments_that_aren&#39;t_test_available_for_deployment"></a>
-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** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:record-deployment": [
-        {
-          "name": "prod",
-          "href": "href"
-        },
-        {
-          "name": "dev",
-          "href": "href"
-        }
-      ]
-    }
-  }
-}
-```
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "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"
-        }
-      ]
-    }
-  }
-}
-```
-<a name="a_request_for_a_pacticipant_version_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_does_not_exist"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo does not exist**, upon receiving **a request for a pacticipant version** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-PACTICIPANT-VERSION-Foo-5556b8149bf8bac76bc30f50a8a2dd4c22c85f30",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 404
-}
-```
 <a name="a_request_for_the_compatibility_matrix_for_a_pacticipant_that_does_not_exist"></a>
 Upon receiving **a request for the compatibility matrix for a pacticipant that does not exist** from Pact Broker Client, with
 ```json
@@ -628,36 +539,6 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_for_the_environments_given_an_environment_with_name_test_exists"></a>
-Given **an environment with name test exists**, upon receiving **a request for the environments** from Pact Broker Client, with
-```json
-{
-  "method": "GET",
-  "path": "/HAL-REL-PLACEHOLDER-PB-ENVIRONMENTS",
-  "headers": {
-    "Accept": "application/hal+json"
-  }
-}
-```
-Pact Broker will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/hal+json;charset=utf-8"
-  },
-  "body": {
-    "_links": {
-      "pb:environments": [
-        {
-          "name": "test",
-          "href": "href"
-        }
-      ]
-    }
-  }
-}
-```
 <a name="a_request_for_the_index_resource"></a>
 Upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
@@ -775,11 +656,11 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_and_pb:environments_relations_exist_in_the_index_resource"></a>
-Given **the pb:pacticipant-version and pb:environments relations exist in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
+Given **the pb:pacticipant-version relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
 {
-  "method": "GET",
+  "method": "get",
   "path": "/",
   "headers": {
     "Accept": "application/hal+json"
@@ -796,20 +677,17 @@ Pact Broker will respond with:
   "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"
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
       }
     }
   }
 }
 ```
-<a name="a_request_for_the_index_resource_given_the_pb:pacticipant-version_relation_exists_in_the_index_resource"></a>
-Given **the pb:pacticipant-version relation exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
+<a name="a_request_for_the_index_resource_given_the_pb:publish-contracts_relations_exists_in_the_index_resource"></a>
+Given **the pb:publish-contracts relations exists in the index resource**, upon receiving **a request for the index resource** from Pact Broker Client, with
 ```json
 {
-  "method": "get",
+  "method": "GET",
   "path": "/",
   "headers": {
     "Accept": "application/hal+json"
@@ -825,8 +703,8 @@ Pact Broker will respond with:
   },
   "body": {
     "_links": {
-      "pb:pacticipant-version": {
-        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-PACTICIPANT-VERSION-{pacticipant}-{version}"
+      "pb:publish-contracts": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
       }
     }
   }
@@ -1928,30 +1806,73 @@ Pact Broker will respond with:
   }
 }
 ```
-<a name="a_request_to_record_a_deployment_given_version_5556b8149bf8bac76bc30f50a8a2dd4c22c85f30_of_pacticipant_Foo_exists_with_a_test_environment_available_for_deployment"></a>
-Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exists with a test environment available for deployment**, upon receiving **a request to record a deployment** from Pact Broker Client, with
+<a name="a_request_to_publish_contracts"></a>
+Upon receiving **a request to publish contracts** from Pact Broker Client, with
 ```json
 {
   "method": "POST",
-  "path": "/HAL-REL-PLACEHOLDER-PB-RECORD-DEPLOYMENT-FOO-5556B8149BF8BAC76BC30F50A8A2DD4C22C85F30-TEST",
+  "path": "/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS",
   "headers": {
     "Content-Type": "application/json",
     "Accept": "application/hal+json"
   },
   "body": {
-    "replacedPreviousDeployedVersion": true
+    "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"
+      }
+    ]
   }
 }
 ```
 Pact Broker will respond with:
 ```json
 {
-  "status": 201,
+  "status": 200,
   "headers": {
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
-    "replacedPreviousDeployedVersion": true
+    "_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"
+        }
+      ]
+    }
   }
 }
 ```

data/example/scripts/publish-pact.sh

@@ -1,3 +1,3 @@
 # assumes you've set PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD already
 
-bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version=1.0.0 --tag master
+bundle exec bin/pact-broker publish $(dirname "$0")/pact.json --consumer-app-version=1.0.0 --tag master --verbose

data/lib/pact_broker/client/backports.rb

@@ -10,4 +10,13 @@ class Hash
   def compact!
     reject! {|_key, value| value == nil}
   end unless method_defined? :compact!
+
+  def except(*keys)
+    if keys.size > 4 && size > 4 # index if O(m*n) is big
+      h = {}
+      keys.each { |key| h[key] = true }
+      keys = h
+    end
+    reject { |key, _value| keys.include? key}
+  end unless method_defined? :except
 end

data/lib/pact_broker/client/base_client.rb

@@ -119,7 +119,7 @@ module PactBroker
           if relation
             url = relation['href']
             params.each do | (key, value) |
-              url = url.gsub("{#{key}}", value)
+              url = url.gsub("{#{key}}", encode_param(value))
             end
             url
           else

data/lib/pact_broker/client/base_command.rb

@@ -0,0 +1,95 @@
+require 'pact_broker/client/hal_client_methods'
+require 'pact_broker/client/error'
+require 'pact_broker/client/command_result'
+require 'term/ansicolor'
+require 'pact_broker/client/backports'
+
+module PactBroker
+  module Client
+    class BaseCommand
+      include PactBroker::Client::HalClientMethods
+
+      def self.call(params, options, pact_broker_client_options)
+        new(params, options, pact_broker_client_options).call
+      end
+
+      def initialize(params, options, pact_broker_client_options)
+        @params = params
+        @options = options
+        @pact_broker_base_url = pact_broker_client_options.fetch(:pact_broker_base_url)
+        @pact_broker_client_options = pact_broker_client_options
+      end
+
+      def call
+        check_if_command_supported
+        do_call
+      rescue PactBroker::Client::Hal::ErrorResponseReturned => e
+        handle_http_error(e)
+      rescue PactBroker::Client::Error => e
+        handle_ruby_error(e)
+      rescue StandardError => e
+        handle_ruby_error(e, verbose?)
+      end
+
+      private
+
+      attr_reader :params, :options
+      attr_reader :pact_broker_base_url, :pact_broker_client_options
+
+      def handle_http_error(e)
+        message = if json_output?
+          body = e.entity.response.raw_body
+          (body.nil? || body == "") ? "{}" : body
+        else
+          red(e.message)
+        end
+        PactBroker::Client::CommandResult.new(false, message)
+      end
+
+      def handle_ruby_error(e, include_backtrace = false)
+        PactBroker::Client::CommandResult.new(false,  error_message(e, include_backtrace))
+      end
+
+      def error_message(e, include_backtrace)
+        if json_output?
+          json_error_message(e, include_backtrace)
+        else
+          text_error_message(e, include_backtrace)
+        end
+      end
+
+      def json_error_message(e, include_backtrace)
+        error_hash = { message: e.message }
+        error_hash[:class] = e.class.name unless e.is_a?(PactBroker::Client::Error)
+        error_hash[:backtrace] = e.backtrace if include_backtrace
+        { error: error_hash }.to_json
+      end
+
+
+      def text_error_message(e, include_backtrace)
+        maybe_backtrace = (include_backtrace ? "\n" + e.backtrace.join("\n") : "")
+        exception_message = e.is_a?(PactBroker::Client::Error) ? e.message : "#{e.class} - #{e.message}"
+        red(exception_message) + maybe_backtrace
+      end
+
+      def check_if_command_supported
+      end
+
+      def json_output?
+        options[:output] == "json"
+      end
+
+      def verbose?
+        options[:verbose]
+      end
+
+      def green(text)
+        ::Term::ANSIColor.green(text)
+      end
+
+      def red(text)
+        ::Term::ANSIColor.red(text)
+      end
+    end
+  end
+end