pact_broker-client 1.38.3 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e8fccfd3284da577d92cac60037f56d293b613ac0dd1d3b58a439027ef6401
-  data.tar.gz: 806f879281896358482de7cd2a0dd880688fded9a7f29f9da2f41f783cd782b0
+  metadata.gz: 62d6345d206920c405cd04c6a3984ac2d3de6ebc687283eb22f3400f7e51e7fa
+  data.tar.gz: 18e2425b5fb80db316beaf58977432316afe9a48cc508a619006c5e8a9ec59af
 SHA512:
-  metadata.gz: 81f3b06673555261c984203492523162b54ead2221701e1c5d474de22ec7e7a03cca95c0289f86532d739f0d4dbeac104e8abd55e315d262c84d6e847159e269
-  data.tar.gz: 52d2a1c8ff9ed55a73b45991b459d11a9240f7eec1c9863d0625bb740a853ed7d811106537cf91ce5ffbe9581cb9cb26b94fdd4d61a797ba59e2aef37002f8c1
+  metadata.gz: 6ec0cca0de9787d4493143c2a2d9f9512df1b800c978a274a58b0b14a9d8fd7fc6c87609d2c3dd7f6916273c6600b9ec11a98dc47b8ac614aa71843f97c48378
+  data.tar.gz: f0c96d94f6bcd765ac5ac20bbc4950f64b205555461bdc2ca0a7fcfbe5d57e704eea430a3ddf1b11e2b499a76d828a2fdb552b8ce5a03d56bb3b852378690a32

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.43.0"></a>
+### v1.43.0 (2021-06-03)
+
+#### Features
+
+* enable --ignore option for can-i-deploy without a feature toggle	 ([bcc9dfe](/../../commit/bcc9dfe))
+
+<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)
 

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

@@ -78,27 +78,48 @@ Usage:
   pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL
 
 Options:
-  -a, --pacticipant=PACTICIPANT            # The pacticipant name. Use once for each pacticipant being checked.
-  -e, [--version=VERSION]                  # The pacticipant version. Must be entered after the --pacticipant that it relates to.
-  -l, [--latest=[TAG]]                     # Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag.
-      [--to=TAG]                           # This is too hard to explain in a short sentence. Look at the examples.
-  -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
-  -o, [--output=OUTPUT]                    # json or table
-                                           # Default: table
-  -v, [--verbose], [--no-verbose]          # Verbose output. Default: false
-      [--retry-while-unknown=TIMES]        # The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)
-                                           # Default: 0
-      [--retry-interval=SECONDS]           # The time between retries in seconds. Use in conjuction with --retry-while-unknown
-                                           # Default: 10
+  -a, --pacticipant=PACTICIPANT            
+                # The pacticipant name. Use once for each pacticipant being checked.
+  -e, [--version=VERSION]                  
+                # The pacticipant version. Must be entered after the --pacticipant that it relates to.
+      [--ignore=IGNORE]                    
+                # The pacticipant name to ignore. Use once for each pacticipant being ignored. 
+                A specific version can be ignored by also specifying a --version after the pacticipant name option.
+  -l, [--latest=[TAG]]                     
+                # Use the latest pacticipant version. Optionally specify a TAG to use the 
+                latest version with the specified tag.
+      [--to=TAG]                           
+                # This is too hard to explain in a short sentence. Look at the examples.
+  -o, [--output=OUTPUT]                    
+                # json or table
+                                           
+                # Default: table
+      [--retry-while-unknown=TIMES]        
+                # The number of times to retry while there is an unknown verification result 
+                (ie. the provider verification is likely still running)
+                                           
+                # Default: 0
+      [--retry-interval=SECONDS]           
+                # The time between retries in seconds. Use in conjuction with --retry-while-unknown
+                                           
+                # Default: 10
+  -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
 
 Description:
-  Returns exit code 0 or 1, indicating whether or not the specified pacticipant versions are compatible. Prints out the relevant
-  pact/verification details.
+  Returns exit code 0 or 1, indicating whether or not the specified application (pacticipant) versions are
+  compatible (ie. safe to deploy). Prints out the relevant pact/verification details, indicating any
+  missing or failed verification results.
 
-  The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_BASE_URL_USERNAME and PACT_BROKER_BASE_URL_PASSWORD may be used
+  The environment variables PACT_BROKER_BASE_URL, PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD may be used
   instead of their respective command line options.
 ```
 
@@ -309,6 +330,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

@@ -40,6 +40,8 @@
 
 * [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
@@ -74,6 +76,8 @@
 
 * [A request to create a webhook with every possible event type](#a_request_to_create_a_webhook_with_every_possible_event_type_given_the_'Pricing_Service'_and_'Condor'_already_exist_in_the_pact-broker) given the 'Pricing Service' and 'Condor' already exist in the pact-broker
 
+* [A request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5](#a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod) given provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod
+
 * [A request to get the Pricing Service](#a_request_to_get_the_Pricing_Service_given_the_'Pricing_Service'_already_exists_in_the_pact-broker) given the 'Pricing Service' already exists in the pact-broker
 
 * [A request to get the Pricing Service](#a_request_to_get_the_Pricing_Service_given_the_'Pricing_Service'_does_not_exist_in_the_pact-broker) given the 'Pricing Service' does not exist in the pact-broker
@@ -92,6 +96,8 @@
 
 * [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 publish contracts](#a_request_to_publish_contracts)
+
 * [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 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
@@ -832,6 +838,33 @@ Pact Broker will respond 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",
+  "path": "/",
+  "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:publish-contracts": {
+        "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-PB-PUBLISH-CONTRACTS"
+      }
+    }
+  }
+}
+```
 <a name="a_request_for_the_index_resource_with_the_webhook_relation"></a>
 Upon receiving **a request for the index resource with the webhook relation** from Pact Broker Client, with
 ```json
@@ -1576,6 +1609,83 @@ Pact Broker will respond with:
   }
 }
 ```
+<a name="a_request_to_determine_if_Bar_can_be_deployed_with_all_Foo_tagged_prod,_ignoring_the_verification_for_Foo_version_3.4.5_given_provider_Bar_version_4.5.6_has_a_successful_verification_for_Foo_version_1.2.3_tagged_prod_and_a_failed_verification_for_version_3.4.5_tagged_prod"></a>
+Given **provider Bar version 4.5.6 has a successful verification for Foo version 1.2.3 tagged prod and a failed verification for version 3.4.5 tagged prod**, upon receiving **a request to determine if Bar can be deployed with all Foo tagged prod, ignoring the verification for Foo version 3.4.5** from Pact Broker Client, with
+```json
+{
+  "method": "get",
+  "path": "/matrix",
+  "query": "q%5B%5D%5Bpacticipant%5D=Bar&q%5B%5D%5Bversion%5D=4.5.6&q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Btag%5D=prod&latestby=cvpv&ignore%5B%5D%5Bpacticipant%5D=Foo&ignore%5B%5D%5Bversion%5D=3.4.5"
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/hal+json;charset=utf-8"
+  },
+  "body": {
+    "summary": {
+      "deployable": true,
+      "ignored": 1
+    },
+    "notices": [
+      {
+        "text": "some notice",
+        "type": "info"
+      }
+    ],
+    "matrix": [
+      {
+        "consumer": {
+          "name": "Foo",
+          "version": {
+            "number": "1.2.3"
+          }
+        },
+        "provider": {
+          "name": "Bar",
+          "version": {
+            "number": "4.5.6"
+          }
+        },
+        "verificationResult": {
+          "success": true,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
+        }
+      },
+      {
+        "consumer": {
+          "name": "Foo",
+          "version": {
+            "number": "3.4.5"
+          }
+        },
+        "provider": {
+          "name": "Bar",
+          "version": {
+            "number": "4.5.6"
+          }
+        },
+        "verificationResult": {
+          "success": false,
+          "_links": {
+            "self": {
+              "href": "http://result"
+            }
+          }
+        },
+        "ignored": true
+      }
+    ]
+  }
+}
+```
 <a name="a_request_to_get_the_Pricing_Service_given_the_&#39;Pricing_Service&#39;_already_exists_in_the_pact-broker"></a>
 Given **the 'Pricing Service' already exists in the pact-broker**, upon receiving **a request to get the Pricing Service** from Pact Broker Client, with
 ```json
@@ -1928,6 +2038,76 @@ Pact Broker will respond 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-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"
+      }
+    ]
+  }
+}
+```
+Pact Broker will respond with:
+```json
+{
+  "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"
+        }
+      ]
+    }
+  }
+}
+```
 <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
 ```json
@@ -1939,7 +2119,7 @@ Given **version 5556b8149bf8bac76bc30f50a8a2dd4c22c85f30 of pacticipant Foo exis
     "Accept": "application/hal+json"
   },
   "body": {
-    "replacedPreviousDeployedVersion": true
+    "target": "blue"
   }
 }
 ```
@@ -1951,7 +2131,7 @@ Pact Broker will respond with:
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
-    "replacedPreviousDeployedVersion": true
+    "target": "blue"
   }
 }
 ```

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_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