pact_broker-client 1.38.3 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7e8fccfd3284da577d92cac60037f56d293b613ac0dd1d3b58a439027ef6401
-  data.tar.gz: 806f879281896358482de7cd2a0dd880688fded9a7f29f9da2f41f783cd782b0
+  metadata.gz: 687ab091422717162f63b7fd2ee9dc336bd73f24c48b48f5e0a1299ab88dc036
+  data.tar.gz: 32fcd370558280287bf284ff4306f36ccfea94359278fd157a4db32ec5d7911f
 SHA512:
-  metadata.gz: 81f3b06673555261c984203492523162b54ead2221701e1c5d474de22ec7e7a03cca95c0289f86532d739f0d4dbeac104e8abd55e315d262c84d6e847159e269
-  data.tar.gz: 52d2a1c8ff9ed55a73b45991b459d11a9240f7eec1c9863d0625bb740a853ed7d811106537cf91ce5ffbe9581cb9cb26b94fdd4d61a797ba59e2aef37002f8c1
+  metadata.gz: 290ee48f43fffa0b48c467a37e8433ada2f1abfde564d0aad62e9eb3adf27bc3ac957decf233c0de6e6373b0c74183e76b2c709335fc3692d2932fcf7e4305e7
+  data.tar.gz: 9a64e0d22fbcb7e82fb586f5f463b41fc13df73e32be1ce64358b871dc41a1dbbd034c4971b411858537eb561063f66a8fee010b83e008170ea9a23e7559a0ba

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<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/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

@@ -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
@@ -92,6 +94,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 +836,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
@@ -1928,6 +1959,75 @@ 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"
+      }
+    ]
+  }
+}
+```
+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

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/cli/broker.rb

@@ -15,7 +15,7 @@ module PactBroker
         using PactBroker::Client::HashRefinements
 
         desc 'can-i-deploy', ''
-        long_desc File.read(File.join(File.dirname(__FILE__), 'can_i_deploy_long_desc.txt'))
+        long_desc File.read(File.join(__dir__, 'can_i_deploy_long_desc.txt'))
 
         method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
         method_option :version, required: false, aliases: "-e", desc: "The pacticipant version. Must be entered after the --pacticipant that it relates to."
@@ -51,14 +51,16 @@ module PactBroker
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Default: false"
         method_option :build_url, desc: "The build URL that created the pact"
         method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
+        method_option :output, aliases: "-o", desc: "json or text", default: 'text'
         shared_authentication_options
 
         def publish(*pact_files)
           require 'pact_broker/client/error'
           validate_credentials
           validate_pact_files(pact_files)
-          success = publish_pacts(pact_files)
-          raise PactPublicationError, "One or more pacts failed to be published" unless success
+          result = publish_pacts(pact_files)
+          $stdout.puts result.message
+          exit(1) unless result.success
         rescue PactBroker::Client::Error => e
           raise PactPublicationError, "#{e.class} - #{e.message}"
         end
@@ -173,10 +175,11 @@ module PactBroker
 
           ignored_and_hidden_potential_options_from_environment_variables
           desc "record-deployment", "Record deployment of a pacticipant version to an environment"
+          long_desc File.read(File.join(__dir__, 'record_deployment_long_desc.txt'))
           method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that was deployed."
           method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number that was deployed."
           method_option :environment, required: true, desc: "The name of the environment that the pacticipant version was deployed to."
-          method_option :replaced_previous_deployed_version, type: :boolean, default: true, required: false, desc: "Whether or not this deployment replaced the previous deployed version. If it did, the previous deployed version of this pacticipant will be marked as undeployed in the Pact Broker."
+          method_option :target, default: nil, required: false, desc: "The target of the deployment - a logical identifer that represents where the application version was deployed to. See the usage docs for information on when to use this."
           method_option :output, aliases: "-o", desc: "json or text", default: 'text'
           shared_authentication_options
 
@@ -186,7 +189,7 @@ module PactBroker
               pacticipant_name: options.pacticipant,
               version_number: options.version,
               environment_name: options.environment,
-              replaced_previous_deployed_version: options.replaced_previous_deployed_version,
+              target: options.target,
               output: options.output
             }
             result = PactBroker::Client::Versions::RecordDeployment.call(
@@ -282,6 +285,7 @@ module PactBroker
               options.broker_base_url,
               file_list(pact_files),
               consumer_version_params,
+              { merge: options[:merge], output: options.output }.compact,
               pact_broker_client_options.merge(write_options)
             )
           end
@@ -290,13 +294,26 @@ module PactBroker
             require 'rake/file_list'
 
             correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
-            Rake::FileList[correctly_separated_pact_files].collect do | path |
+            paths = Rake::FileList[correctly_separated_pact_files].collect do | path |
               if File.directory?(path)
                 Rake::FileList[File.join(path, "*.json")]
               else
                 path
               end
             end.flatten
+            validate_pact_path_list(paths)
+          end
+
+          def validate_pact_path_list(paths)
+            paths.collect do | path |
+              if File.exist?(path)
+                path
+              elsif path.start_with?("-")
+                raise Thor::Error.new("ERROR: pact-broker publish was called with invalid arguments #{[path]}")
+              else
+                raise Thor::Error.new("Specified pact file '#{path}' does not exist. This sometimes indicates one of the arguments has been specified with the wrong name and has been incorrectly identified as a file path.")
+              end
+            end
           end
 
           def tags
@@ -379,7 +396,6 @@ module PactBroker
               provider: options.provider,
               events: events
             }
-
           end
 
           def run_webhook_commands webhook_url

data/lib/pact_broker/client/cli/record_deployment_long_desc.txt

@@ -0,0 +1,55 @@
+The record-deployment command is used to allow the Pact Broker to keep track of which version(s) of an application are currently deployed in each environment. It is used to keep track of applications that are deployed to known instances. If you are releasing a client library or mobile application to a repository or application store, please use record-release instead.
+
+## Examples
+
+
+record-deployment --pacticipant Foo --version 6897aa95e --environment production
+record-deployment --pacticipant Foo --version 6897aa95e --environment production --target blue
+record-deployment --pacticipant Foo --version 6897aa95e --environment production --target green
+
+## Target
+
+The "target" field is used to distinguish between deployed versions of an application within the same environment, and most importantly, to identify which previously deployed version has been replaced by the current deployment. The Pact Broker only allows one unique combination of pacticipant/environment/target to be considered the "currently deployed" one, and any call to record a deployment will cause the previously deployed version with the same pacticipant/environment/target to be automatically marked as undeployed (mimicking the real world process of "deploying over" a previous version).
+
+### Use cases
+
+#### There is a single instance of an application deployed within an environment and deployments of integrated applications are NOT likely to happen during the deployment window of this application
+
+eg.
+
+* the window of time when there are multiple versions in prod is small
+* or there aren't many other integrations
+* or deployments happen rarely
+* or the same team controls all the deployments and generally only runs one deployment at a time
+
+In this case, there is no need to specify a target. The call to record deployment should be done at the end of the deployment and it will automatically mark the version of Foo that was previously the currently deployed version as undeployed. Only one version of the pacticipant is ever considered to be currently deployed at a time.
+
+eg.
+
+# actual call to deploy here...
+record-deployment --pacticipant Foo --version 6897aa95e --environment production
+
+#### There is a single instance of an application deployed within an environment and but deployments of integrated applications ARE likely to happen during the deployment window of this application
+
+eg.
+* the window of time when there are multiple versions in prod is large
+* or there are many integrations
+* or deployments happen often
+* or there are many different teams deploying and deployments aren't coordinated
+
+To allow multiple versions to be considered currently deployed at the same time, use two different targets, and call the first record-deployment at the start of the deployment process and a second one at the end.
+
+eg.
+
+This will use the targets "blue" and "green" to model stages of the deployment.
+
+record-deployment --pacticipant Foo --version 6897aa95e --environment production --target blue
+# actual call to deploy here...
+record-deployment --pacticipant Foo --version 6897aa95e --environment production --target green
+
+After the first call to record-deployment, there will be two versions considered currently deployed - the "blue" one that was just recorded, and the one from the previous "green" deployment. After the second call to record-deployment, there is only one version considered currently deployed - both "blue" and "green" targets will be have version 6897aa95e deployed to them.
+
+
+#### There are multiple permanent application versions deployed to the same environment
+
+TBC

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

@@ -23,18 +23,34 @@ module PactBroker
           _link(key).get(*args)
         end
 
+        def get!(key, *args)
+          get(key, *args).assert_success!
+        end
+
         def post(key, *args)
           _link(key).post(*args)
         end
 
+        def post!(key, *args)
+          post(key, *args).assert_success!
+        end
+
         def put(key, *args)
           _link(key).put(*args)
         end
 
+        def put!(key, *args)
+          put(key, *args).assert_success!
+        end
+
         def patch(key, *args)
           _link(key).patch(*args)
         end
 
+        def patch!(key, *args)
+          patch(key, *args).assert_success!
+        end
+
         def can?(key)
           @links.key? key.to_s
         end

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

@@ -54,7 +54,7 @@ module PactBroker
         end
 
         def perform_request request, uri
-          response = until_truthy_or_max_times(times: 5, sleep: 5, condition: ->(resp) { resp.code.to_i < 500 }) do
+          response = until_truthy_or_max_times(condition: ->(resp) { resp.code.to_i < 500 }) do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
             http.set_debug_output(output_stream) if verbose
             http.use_ssl = (uri.scheme == 'https')
@@ -71,7 +71,7 @@ module PactBroker
         end
 
         def until_truthy_or_max_times options = {}
-          max_tries = options.fetch(:times, 3)
+          max_tries = options.fetch(:times, default_max_tries)
           tries = 0
           sleep_interval = options.fetch(:sleep, 5)
           sleep(sleep_interval) if options[:sleep_first]
@@ -97,6 +97,10 @@ module PactBroker
           end
         end
 
+        def default_max_tries
+          5
+        end
+
         def sleep seconds
           Kernel.sleep seconds
         end

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

@@ -49,14 +49,26 @@ module PactBroker
           wrap_response(href, @http_client.put(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def put!(*args)
+          put(*args).assert_success!
+        end
+
         def post(payload = nil, headers = {})
           wrap_response(href, @http_client.post(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def post!(*args)
+          post(*args).assert_success!
+        end
+
         def patch(payload = nil, headers = {})
           wrap_response(href, @http_client.patch(href, payload ? JSON.dump(payload) : nil, headers))
         end
 
+        def patch!(*args)
+          patch(*args).assert_success!
+        end
+
         def expand(params)
           expanded_url = expand_url(params, href)
           new_attrs = @attrs.merge('href' => expanded_url)

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

@@ -30,6 +30,21 @@ module PactBroker
           links.find{ | link | link.name == name }
         end
 
+        def select!(name, not_found_message = nil)
+          selected_links = select(name)
+          if selected_links.any?
+            selected_links
+          else
+            message = not_found_message || "Could not find relation '#{key}' with name '#{name}' in resource at #{href}."
+            available_options = names.any? ? names.join(", ") : "<none found>"
+            raise RelationNotFoundError.new(message.chomp(".") + ". Available options: #{available_options}")
+          end
+        end
+
+        def select(name)
+          links.select{ | link | link.name == name }
+        end
+
         private
 
         attr_reader :links, :key, :href