pact_broker-client 1.38.1 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c89727fa660ba02fd9ff0565b74bf269aada75bfe3b04bb6f117048b265ad9
-  data.tar.gz: f6c946f2ab43c4cc69550b2fee0740a1782604e7843ae9b6a582664b6ecaee82
+  metadata.gz: b929ba48b8f21f7cafeb339e925fac9ecf7a4a83cd3392f5170c769c725998c3
+  data.tar.gz: 1b50eef690671dfdf9a78f1bb8da0f2f1e58cf380b199a554b5a9e770d40a825
 SHA512:
-  metadata.gz: 8a9f685a78726d293dc5017f1a142aa1d981a020ff8bdeafa56666a378562cd6c6632449c9ae980dff634e5c5ee216b3eb867b221156d15437166421b8eb1c14
-  data.tar.gz: 2ac71e6f98f361c1262e3190eb6e8b9ec588de4bb2ae51df6cd0e2bc8f44f4b5ee38270acb1ac670d772069eeaaaa1baea98ec34104c5fa9b91fa3ad5db315c3
+  metadata.gz: e527702e1d7d9cc3644f3c4db48c7e02060435699b0104f9048ab6142228475405fac9abea025c713bbf8a3a15b71660a56973515b72464814ff8dee62518289
+  data.tar.gz: 0b81d80a4ab02de7f7d71a7e5c991a6e322731c1803c7c85fd0b53379d92f4739e3296c0acd76cf528567b14147fb3743c352322104da46e4064116bc531514b

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+<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)
+
+#### Features
+
+* allow SSL verification to be disabled	 ([eb2125b](/../../commit/eb2125b))
+* automatically retry at the http client level for 50x responses	 ([a7343f8](/../../commit/a7343f8))
+
 <a name="v1.38.1"></a>
 ### v1.38.1 (2021-03-22)
 

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/bin/pact-broker

@@ -1,4 +1,10 @@
 #!/usr/bin/env ruby
 require 'pact_broker/client/cli/broker'
 
+if ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true'
+  require 'openssl'
+  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+  $stderr.puts "WARN: SSL verification has been disabled by a dodgy hack (reassigning the VERIFY_PEER constant to VERIFY_NONE). You acknowledge that you do this at your own risk!"
+end
+
 PactBroker::Client::CLI::Broker.start

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/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/can_i_deploy.rb

@@ -3,6 +3,7 @@ require 'pact_broker/client/pact_broker_client'
 require 'pact_broker/client/retry'
 require 'pact_broker/client/matrix/formatter'
 require 'term/ansicolor'
+require 'pact_broker/client/colorize_notices'
 
 module PactBroker
   module Client
@@ -32,7 +33,7 @@ module PactBroker
       def call
         create_result(fetch_matrix_with_retries)
       rescue PactBroker::Client::Error => e
-        Result.new(false, e.message)
+        Result.new(false, Term::ANSIColor.red(e.message))
       rescue StandardError => e
         Result.new(false, "Error retrieving matrix. #{e.class} - #{e.message}\n#{e.backtrace.join("\n")}")
       end
@@ -52,7 +53,7 @@ module PactBroker
       def success_message(matrix)
         message = format_matrix(matrix)
         if format != 'json'
-          message = 'Computer says yes \o/ ' + message + "\n\n" + Term::ANSIColor.green(matrix.reason)
+          message = warning(matrix) + Term::ANSIColor.green('Computer says yes \o/ ') + message + "\n\n" + notice_or_reason(matrix, :green)
         end
         message
       end
@@ -60,11 +61,19 @@ module PactBroker
       def failure_message(matrix)
         message = format_matrix(matrix)
         if format != 'json'
-          message = 'Computer says no ¯\_(ツ)_/¯ ' + message + "\n\n" + Term::ANSIColor.red(matrix.reason)
+          message = warning(matrix) + Term::ANSIColor.red('Computer says no ¯\_(ツ)_/¯ ') + message + "\n\n" + notice_or_reason(matrix, :red)
         end
         message
       end
 
+      def notice_or_reason(matrix, reason_color)
+        if matrix.notices
+          PactBroker::Client::ColorizeNotices.call(matrix.notices).join("\n")
+        else
+          Term::ANSIColor.send(reason_color, matrix.reason)
+        end
+      end
+
       def format_matrix(matrix)
         formatted_matrix = Matrix::Formatter.call(matrix, format)
         if format != 'json' && formatted_matrix.size > 0
@@ -131,6 +140,14 @@ module PactBroker
           raise PactBroker::Client::Error.new("This version of the Pact Broker does not provide a count of the unknown verification results. Please upgrade your Broker to >= v2.23.4")
         end
       end
+
+      def warning(matrix)
+        if matrix_options[:ignore_selectors] && matrix_options[:ignore_selectors].any? && !matrix.supports_ignore?
+          Term::ANSIColor.yellow("WARN: This version of the Pact Broker does not support ignoring pacticipants. Please upgrade your Broker to >= 2.80.0") + "\n\n"
+        else
+          ""
+        end
+      end
     end
   end
 end