pact_broker-client 1.60.0 → 1.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd60c123fbe4481515d784d73f97296280109f50252c150c1c0c083813cb34b
-  data.tar.gz: 3b8371bd71d74a2b9ada1b3ba2d54a24f5ae6349ce2c6a44075e72546f6dbf6e
+  metadata.gz: e9d724c27e98c131d955d07160fc82b162fd16b53b8f2df9e7b8f43a43967876
+  data.tar.gz: f1128e525285066f9ed81641368f07dd64a806de10d8d501dbf626d411fc2a2a
 SHA512:
-  metadata.gz: 828e7e3d9eae551b586bff597b7229c5174ab4000fda79cab8567163b7b3c7443c535c35f504f530dc611bee0708240e27a8756bd394f5b9780047b3f8fc2391
-  data.tar.gz: 9d64d148a588d7aa240decdab057c2352409944036d35f6d7ff67a18f673107b7324d383a96bdaaa67b14e837556d04b87f91b5126c77e8103e4a3cffd153ff2
+  metadata.gz: 38f5ff3fe01ff74f462744e9cc6363eff0a62189a8561f524c24042bfd3ea1b9eea2249ed2d3508201d833bf7e08c8c69f9ad56eb8d14777cda33e3092ae4d4b
+  data.tar.gz: e0b5e788bfb8053429ba735c135c175b4ac5048d2a382c12dd4c424fc9cbdd4b6370167c57791a6978e684e9a1a778197530f05d331541d8bffe18bea4e683fa

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="v1.61.0"></a>
+### v1.61.0 (2022-05-06)
+
+#### Features
+
+* **create-or-update-version**
+  * support creating or updating a pacticipant version with a branch and/or tags	 ([e38e728](/../../commit/e38e728))
+
 <a name="v1.60.0"></a>
 ### v1.60.0 (2022-05-03)
 

data/README.md

@@ -482,8 +482,8 @@ Description:
   support for environments, deployments and releases. For documentation on how to use can-i-deploy with tags, please see
   https://docs.pact.io/pact_broker/client_cli/can_i_deploy_usage_with_tags/
 
-  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The
-  "test" and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
+  Before `can-i-deploy` can be used, the relevant environment resources must first be created in the Pact Broker using the `create-environment` command. The "test"
+  and "production" environments will have been seeded for you. You can check the existing environments by running `pact-broker list-environments`. See
   https://docs.pact.io/pact_broker/client_cli/readme#environments for more information.
 
   $ pact-broker create-environment --name "uat" --display-name "UAT" --no-production
@@ -493,8 +493,8 @@ Description:
 
   $ pact-broker record-deployment --pacticipant Foo --version 173153ae0 --environment uat
 
-  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy
-  with the versions of each integrated application that are already in that environment.
+  Before an application is deployed or released to an environment, the can-i-deploy command must be run to check that the application version is safe to deploy with
+  the versions of each integrated application that are already in that environment.
 
   $ pact-broker can-i-deploy --pacticipant PACTICIPANT --version VERSION --to-environment ENVIRONMENT
 
@@ -502,8 +502,8 @@ Description:
 
   $ pact-broker can-i-deploy --pacticipant Foo --version 173153ae0 --to-environment test
 
-  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the
-  latest version from the main branch of another application" it functions as a "can I merge" check.
+  Can-i-deploy can also be used to check if arbitrary versions have a successful verification. When asking "Can I deploy this application version with the latest version
+  from the main branch of another application" it functions as a "can I merge" check.
 
   $ pact-broker can-i-deploy --pacticipant Foo 173153ae0 \ --pacticipant Bar --latest main
 
@@ -650,8 +650,8 @@ Options:
 ```
 
 Description:
-  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the
-  consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
+  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-webhook" and add the consumer,
+  provider, event types and broker details. Note that the URL must be the first parameter when executing create-webhook.
 
   Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
   option. Please use the --broker-username or environment variable for the Pact Broker username.
@@ -715,9 +715,9 @@ Options:
 ```
 
 Description:
-  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and
-  add the consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid
-  must also be provided. You can generate a valid UUID by using the `generate-uuid` command.
+  Create a curl command that executes the request that you want your webhook to execute, then replace "curl" with "pact-broker create-or-update-webhook" and add the
+  consumer, provider, event types and broker details. Note that the URL must be the first parameter when executing create-or-update-webhook and a uuid must
+  also be provided. You can generate a valid UUID by using the `generate-uuid` command.
 
   Note that the -u option from the curl command clashes with the -u option from the pact-broker CLI. When used in this command, the -u will be used as a curl
   option. Please use the --broker-username or environment variable for the Pact Broker username.
@@ -814,6 +814,39 @@ Options:
 
 Describes a pacticipant version. If no version or tag is specified, the latest version is described.
 
+#### create-or-update-version
+
+```
+Usage:
+  pact-broker create-or-update-version -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BROKER_BASE_URL -e, --version=VERSION
+
+Options:
+  -a, --pacticipant=PACTICIPANT
+              # The pacticipant name
+  -e, --version=VERSION
+              # The pacticipant version number
+      [--branch=BRANCH]
+              # The repository branch name
+  -t, [--tag=TAG]
+              # Tag name for pacticipant version. Can be specified multiple
+                times.
+  -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
+  -o, [--output=OUTPUT]
+              # json or text
+              # Default: text
+```
+
+Create or update pacticipant version by version number
+
 ### Miscellaneous
 
 #### generate-uuid

data/lib/pact_broker/client/cli/broker.rb

@@ -1,228 +1,44 @@
-require 'pact_broker/client/cli/custom_thor'
-require 'pact_broker/client/hash_refinements'
-require 'thor/error'
-require 'pact_broker/client/cli/environment_commands'
-require 'pact_broker/client/cli/deployment_commands'
-require 'pact_broker/client/cli/pacticipant_commands'
-require 'pact_broker/client/cli/webhook_commands'
+require "pact_broker/client/cli/custom_thor"
+require "pact_broker/client/hash_refinements"
+require "thor/error"
+require "pact_broker/client/cli/pact_commands"
+require "pact_broker/client/cli/environment_commands"
+require "pact_broker/client/cli/deployment_commands"
+require "pact_broker/client/cli/pacticipant_commands"
+require "pact_broker/client/cli/version_commands"
+require "pact_broker/client/cli/webhook_commands"
 require "pact_broker/client/cli/matrix_commands"
 
 module PactBroker
   module Client
     module CLI
-      # Thor::Error will have its backtrace hidden
-      class PactPublicationError < ::Thor::Error; end
-      class AuthError < ::Thor::Error; end
-      class VersionCreationError < ::Thor::Error; end
-
       class Broker < CustomThor
-        using PactBroker::Client::HashRefinements
-
+        include PactBroker::Client::CLI::PactCommands
         include PactBroker::Client::CLI::EnvironmentCommands
         include PactBroker::Client::CLI::DeploymentCommands
         include PactBroker::Client::CLI::MatrixCommands
         include PactBroker::Client::CLI::PacticipantCommands
+        include PactBroker::Client::CLI::VersionCommands
         include PactBroker::Client::CLI::WebhookCommands
 
-        desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
-        method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
-        method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
-        method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
-        method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
-        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."
-        output_option_json_or_text
-        shared_authentication_options
-
-        def publish(*pact_files)
-          require 'pact_broker/client/error'
-          validate_credentials
-          validate_pact_files(pact_files)
-          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
-
-        desc 'create-version-tag', 'Add a tag to a pacticipant version'
-        method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name"
-        method_option :version, required: true, aliases: "-e", desc: "The pacticipant version"
-        method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
-        method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
-        method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
-        shared_authentication_options
-
-        def create_version_tag
-          require 'pact_broker/client/create_tag'
-
-          validate_credentials
-          PactBroker::Client::CreateTag.call(
-            options.broker_base_url,
-            options.pacticipant,
-            options.version,
-            tags,
-            options.auto_create_version,
-            pact_broker_client_options)
-        rescue PactBroker::Client::Error => e
-          raise VersionCreationError.new(e.message)
-        end
-
-        method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."
-        method_option :version, required: false, aliases: "-e", desc: "The pacticipant version number."
-        method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Describe the latest pacticipant version. Optionally specify a TAG to describe the latest version with the specified tag."
-        method_option :output, aliases: "-o", desc: "json or table or id", default: 'table'
-        shared_authentication_options
-
-        desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
-        def describe_version
-          require 'pact_broker/client/versions/describe'
-
-          validate_credentials
-          latest = !options.latest.nil? || (options.latest.nil? && options.version.nil?)
-          params = {
-            pacticipant: options.pacticipant,
-            version: options.version,
-            latest: latest,
-            tag: options.latest != "latest" ? options.latest : nil
-          }
-          opts = {
-            output: options.output
-          }
-          result = PactBroker::Client::Versions::Describe.call(params, opts, options.broker_base_url, pact_broker_client_options)
-          $stdout.puts result.message
-          exit(1) unless result.success
-        end
-
-
-
         ignored_and_hidden_potential_options_from_environment_variables
-        desc 'generate-uuid', 'Generate a UUID for use when calling create-or-update-webhook'
+        desc "generate-uuid", "Generate a UUID for use when calling create-or-update-webhook"
         def generate_uuid
-          require 'securerandom'
-
+          require "securerandom"
           puts SecureRandom.uuid
         end
 
-        desc 'list-latest-pact-versions', 'List the latest pact for each integration'
-        shared_authentication_options
-        output_option_json_or_table
-        def list_latest_pact_versions(*required_but_ignored)
-          require 'pact_broker/client/pacts/list_latest_versions'
-          result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
-          $stdout.puts result.message
-          exit(1) unless result.success
-        end
-
         ignored_and_hidden_potential_options_from_environment_variables
-        desc 'version', "Show the pact_broker-client gem version"
+        desc "version", "Show the pact_broker-client gem version"
         def version
-          require 'pact_broker/client/version'
-
+          require "pact_broker/client/version"
           $stdout.puts PactBroker::Client::VERSION
         end
 
         no_commands do
-
           def self.exit_on_failure?
             true
           end
-
-          def validate_credentials
-            if options.broker_username && options.broker_token
-              raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
-            end
-          end
-
-          def validate_pact_files pact_files
-            unless pact_files && pact_files.any?
-              raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
-            end
-          end
-
-
-          def publish_pacts pact_files
-            require 'pact_broker/client/publish_pacts'
-
-            write_options = options[:merge] ? { write: :merge } : {}
-            consumer_version_params = {
-              number: options.consumer_app_version,
-              branch: branch,
-              tags: tags,
-              build_url: options.build_url,
-              version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
-            }.compact
-
-            PactBroker::Client::PublishPacts.call(
-              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
-
-          def file_list pact_files
-            require 'rake/file_list'
-
-            correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
-            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
-            require 'pact_broker/client/git'
-
-            t = [*options.tag]
-            t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
-            t.compact.uniq
-          end
-
-          def branch
-            require 'pact_broker/client/git'
-
-            if options.branch.nil? && options.auto_detect_version_properties
-              PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
-            else
-              options.branch
-            end
-          end
-
-          def explict_auto_detect_version_properties
-            @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
-          end
-
-          def pact_broker_client_options
-            client_options = { verbose: options.verbose, pact_broker_base_url: options.broker_base_url }
-            client_options[:token] = options.broker_token || ENV['PACT_BROKER_TOKEN']
-            if options.broker_username || ENV['PACT_BROKER_USERNAME']
-              client_options[:basic_auth] = {
-                  username: options.broker_username || ENV['PACT_BROKER_USERNAME'],
-                  password: options.broker_password || ENV['PACT_BROKER_PASSWORD']
-                }.compact
-            end
-
-            client_options.compact
-          end
         end
       end
     end

data/lib/pact_broker/client/cli/custom_thor.rb

@@ -1,14 +1,18 @@
 require 'thor'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     module CLI
+      class AuthError < ::Thor::Error; end
+
       ##
       # Custom Thor task allows the following:
       #
       # `--option 1 --option 2` to be interpreted as `--option 1 2` (the standard Thor format for multiple value options)
       #
       class CustomThor < ::Thor
+        using PactBroker::Client::HashRefinements
 
         no_commands do
           def self.start given_args = ARGV, config = {}
@@ -106,6 +110,25 @@ module PactBroker
           def params_from_options(keys)
             keys.each_with_object({}) { | key, p | p[key] = options[key] }
           end
+
+          def pact_broker_client_options
+            client_options = { verbose: options.verbose, pact_broker_base_url: options.broker_base_url }
+            client_options[:token] = options.broker_token || ENV['PACT_BROKER_TOKEN']
+            if options.broker_username || ENV['PACT_BROKER_USERNAME']
+              client_options[:basic_auth] = {
+                  username: options.broker_username || ENV['PACT_BROKER_USERNAME'],
+                  password: options.broker_password || ENV['PACT_BROKER_PASSWORD']
+                }.compact
+            end
+
+            client_options.compact
+          end
+
+          def validate_credentials
+            if options.broker_username && options.broker_token
+              raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
+            end
+          end
         end
       end
     end

data/lib/pact_broker/client/cli/pact_commands.rb

@@ -0,0 +1,128 @@
+require "pact_broker/client/hash_refinements"
+
+module PactBroker
+  module Client
+    module CLI
+      # Thor::Error will have its backtrace hidden
+      class PactPublicationError < ::Thor::Error; end
+
+      module PactCommands
+        using PactBroker::Client::HashRefinements
+
+        def self.included(thor)
+          thor.class_eval do
+            desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
+            method_option :consumer_app_version, required: true, aliases: "-a", desc: "The consumer application version"
+            method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
+            method_option :auto_detect_version_properties, hidden: true, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI."
+            method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
+            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."
+            output_option_json_or_text
+            shared_authentication_options
+
+            def publish(*pact_files)
+              require 'pact_broker/client/error'
+              validate_credentials
+              validate_pact_files(pact_files)
+              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
+
+            desc 'list-latest-pact-versions', 'List the latest pact for each integration'
+            shared_authentication_options
+            output_option_json_or_table
+            def list_latest_pact_versions(*required_but_ignored)
+              require 'pact_broker/client/pacts/list_latest_versions'
+              result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
+              $stdout.puts result.message
+              exit(1) unless result.success
+            end
+
+            no_commands do
+              def validate_pact_files pact_files
+                unless pact_files && pact_files.any?
+                  raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
+                end
+              end
+
+
+              def publish_pacts pact_files
+                require 'pact_broker/client/publish_pacts'
+
+                write_options = options[:merge] ? { write: :merge } : {}
+                consumer_version_params = {
+                  number: options.consumer_app_version,
+                  branch: branch,
+                  tags: tags,
+                  build_url: options.build_url,
+                  version_required: (!!options.branch || !!options.build_url || explict_auto_detect_version_properties)
+                }.compact
+
+                PactBroker::Client::PublishPacts.call(
+                  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
+
+              def file_list pact_files
+                require 'rake/file_list'
+
+                correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
+                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
+                require 'pact_broker/client/git'
+
+                t = [*options.tag]
+                t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
+                t.compact.uniq
+              end
+
+              def branch
+                require 'pact_broker/client/git'
+
+                if options.branch.nil? && options.auto_detect_version_properties
+                  PactBroker::Client::Git.branch(raise_error: explict_auto_detect_version_properties)
+                else
+                  options.branch
+                end
+              end
+
+              def explict_auto_detect_version_properties
+                @explict_auto_detect_version_properties ||= ARGV.include?("--auto-detect-version-properties")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/cli/version_commands.rb

@@ -0,0 +1,102 @@
+module PactBroker
+  module Client
+    module CLI
+      class VersionCreationError < ::Thor::Error; end
+
+      module VersionCommands
+        def self.included(thor)
+          thor.class_eval do
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The name of the pacticipant that the version belongs to."
+            method_option :version, required: false, aliases: "-e", desc: "The pacticipant version number."
+            method_option :latest, required: false, aliases: "-l", banner: '[TAG]', desc: "Describe the latest pacticipant version. Optionally specify a TAG to describe the latest version with the specified tag."
+            method_option :output, aliases: "-o", desc: "json or table or id", default: 'table'
+            shared_authentication_options
+
+            desc 'describe-version', 'Describes a pacticipant version. If no version or tag is specified, the latest version is described.'
+            def describe_version
+              require 'pact_broker/client/versions/describe'
+
+              validate_credentials
+              latest = !options.latest.nil? || (options.latest.nil? && options.version.nil?)
+              params = {
+                pacticipant: options.pacticipant,
+                version: options.version,
+                latest: latest,
+                tag: options.latest != "latest" ? options.latest : nil
+              }
+              opts = {
+                output: options.output
+              }
+              result = PactBroker::Client::Versions::Describe.call(params, opts, options.broker_base_url, pact_broker_client_options)
+              $stdout.puts result.message
+              exit(1) unless result.success
+            end
+
+
+            desc "create-or-update-version", "Create or update pacticipant version by version number"
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name"
+            method_option :version, required: true, aliases: "-e", desc: "The pacticipant version number"
+            method_option :branch, required: false, desc: "The repository branch name"
+            method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
+            shared_authentication_options
+            output_option_json_or_text
+            verbose_option
+
+            def create_or_update_version(*required_but_ignored)
+              validate_create_version_params
+
+              params = {
+                pacticipant_name: options.pacticipant.strip,
+                version_number: options.version.strip,
+                branch_name: options.branch&.strip,
+                tags: options.tag&.collect(&:strip)
+              }
+
+              execute_version_command(params, "Create")
+            end
+
+            desc 'create-version-tag', 'Add a tag to a pacticipant version'
+            method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name"
+            method_option :version, required: true, aliases: "-e", desc: "The pacticipant version"
+            method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for pacticipant version. Can be specified multiple times."
+            method_option :auto_create_version, type: :boolean, default: false, desc: "Automatically create the pacticipant version if it does not exist. Default: false"
+            method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag pacticipant version with the name of the current git branch. Default: false"
+            shared_authentication_options
+
+            def create_version_tag
+              require 'pact_broker/client/create_tag'
+
+              validate_credentials
+              PactBroker::Client::CreateTag.call(
+                options.broker_base_url,
+                options.pacticipant,
+                options.version,
+                tags,
+                options.auto_create_version,
+                pact_broker_client_options)
+            rescue PactBroker::Client::Error => e
+              raise VersionCreationError.new(e.message)
+            end
+
+            no_commands do
+              def execute_version_command(params, command_class_name)
+                require "pact_broker/client/versions"
+                command_options = { verbose: options.verbose, output: options.output }
+                result = PactBroker::Client::Versions.const_get(command_class_name).call(params, command_options, pact_broker_client_options)
+                $stdout.puts result.message
+                exit(1) unless result.success
+              end
+
+              def validate_create_version_params
+                raise ::Thor::RequiredArgumentMissingError, "Pacticipant name cannot be blank" if options.pacticipant.strip.size == 0
+                raise ::Thor::RequiredArgumentMissingError, "Pacticipant version cannot be blank" if options.version.strip.size == 0
+                raise ::Thor::RequiredArgumentMissingError, "Version branch cannot be blank" if options.branch && options.branch.strip.size == 0
+                raise ::Thor::RequiredArgumentMissingError, "Version tag cannot be blank" if options.tag && options.tag.any?{ | tag | tag.strip.size == 0 }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/deployments/record_deployment.rb

@@ -1,9 +1,12 @@
 require 'pact_broker/client/deployments/record_release'
+require "pact_broker/client/hash_refinements"
 
 module PactBroker
   module Client
     module Deployments
       class RecordDeployment < PactBroker::Client::Deployments::RecordRelease
+        using PactBroker::Client::HashRefinements
+
         def initialize(params, options, pact_broker_client_options)
           super
           @application_instance = params.fetch(:application_instance)

data/lib/pact_broker/client/deployments/record_undeployment.rb

@@ -1,9 +1,12 @@
 require 'pact_broker/client/base_command'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     module Deployments
       class RecordUndeployment < PactBroker::Client::BaseCommand
+        using PactBroker::Client::HashRefinements
+
         def initialize(params, options, pact_broker_client_options)
           super
           @pacticipant_name = params.fetch(:pacticipant_name)

data/lib/pact_broker/client/environments/environment_command.rb

@@ -1,9 +1,12 @@
 require 'pact_broker/client/base_command'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     module Environments
       class EnvironmentCommand < PactBroker::Client::BaseCommand
+        using PactBroker::Client::HashRefinements
+
         NOT_SUPPORTED_MESSAGE = "This version of the Pact Broker does not support environments. Please upgrade to version 2.80.0 or later."
         PACTFLOW_NOT_SUPPORTED_MESSAGE = "This version of Pactflow does not support environments or you do not have the required permission to read them. Please upgrade to the latest version if using Pactflow On-Premises and ensure the user has the environment read permission."
 

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

@@ -1,10 +1,13 @@
 require 'uri'
 require 'delegate'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client
     module Hal
       class Links
+        using PactBroker::Client::HashRefinements
+
         def initialize(href, key, links)
           @href = href
           @key = key

data/lib/pact_broker/client/hash_refinements.rb

@@ -13,6 +13,15 @@ module PactBroker
         def compact!
           reject! {|_key, value| value == nil}
         end unless Hash.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
     end
   end

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

@@ -30,7 +30,7 @@ module PactBroker
           if json_output?
             response_entity.response.raw_body
           else
-            green(message = "Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
+            green("Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
           end
         end
 

data/lib/pact_broker/client/publish_pacts.rb

@@ -3,6 +3,7 @@ require 'pact_broker/client/hal_client_methods'
 require 'base64'
 require 'pact_broker/client/publish_pacts_the_old_way'
 require 'pact_broker/client/colorize_notices'
+require 'pact_broker/client/hash_refinements'
 
 module PactBroker
   module Client

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.60.0'
+    VERSION = '1.61.0'
   end
 end

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

@@ -0,0 +1,111 @@
+require "pact_broker/client/base_client"
+require "pact_broker/client/base_command"
+
+module PactBroker
+  module Client
+    class Versions < BaseClient # need to retire the old base client code
+      class Create < PactBroker::Client::BaseCommand
+
+        def do_call
+          if branch_name
+            if branch_versions_supported?
+              create_branch_version
+            else
+              raise PactBroker::Client::Error.new("This version of #{pact_broker_name} does not support branch versions,or you do not have the required permissions to create one. Please ensure you have upgraded to version 2.82.0 or later for branch support.")
+            end
+          end
+
+          if tags
+            create_version_tags
+          end
+
+          if !branch_name && !tags.any?
+            create_version
+          end
+
+          PactBroker::Client::CommandResult.new(true, result_message)
+        end
+
+        private
+
+        def pacticipant_name
+          params.fetch(:pacticipant_name)
+        end
+
+        def version_number
+          params.fetch(:version_number)
+        end
+
+        def branch_name
+          params[:branch_name]
+        end
+
+        def tags
+          params[:tags] || []
+        end
+
+        def branch_versions_supported?
+          index_resource._link("pb:pacticipant-branch-version")
+        end
+
+        def create_branch_version
+          branch_params = {
+            "pacticipant" => pacticipant_name,
+            "version" => version_number,
+            "branch" => branch_name
+          }
+          branch_version_entity = index_resource
+                                ._link("pb:pacticipant-branch-version")
+                                .expand(branch_params)
+                                .put!
+        end
+
+        def create_version_tags
+          tags.each do | tag |
+            tag_params = {
+              "pacticipant" => pacticipant_name,
+              "version" => version_number,
+              "tag" => tag
+            }
+            index_resource
+              ._link("pb:pacticipant-version-tag")
+              .expand(tag_params)
+              .put!
+          end
+        end
+
+        def create_version
+          @version_resource ||= expanded_version_relation.put!
+        end
+
+        def expanded_version_relation
+          version_params = {
+            "pacticipant" => pacticipant_name,
+            "version" => version_number
+          }
+          index_resource
+            ._link("pb:pacticipant-version")
+            .expand(version_params)
+        end
+
+        def result_message
+          if json_output?
+            (@version_resource || expanded_version_relation.get).response.raw_body
+          else
+            message = "Created/updated pacticipant version #{version_number}"
+            if branch_name && tags.any?
+              message = message + " with branch #{branch_name} and tag(s) #{tags.join(", ")}"
+            elsif branch_name
+              message = message + " with branch #{branch_name}"
+            elsif tags.any?
+              message = message + " with tag(s) #{tags.join(", ")}"
+            end
+
+            message = message + " in #{pact_broker_name}"
+            green(message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/versions.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/client/base_client'
 require 'pact_broker/client/versions/describe'
+require 'pact_broker/client/versions/create'
 
 # Old code
 require 'pact_broker/client/pacts'

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

@@ -4,11 +4,14 @@ require 'ostruct'
 require 'json'
 require 'pact_broker/client/command_result'
 require "pact_broker/client/backports"
+require "pact_broker/client/hash_refinements"
 
 module PactBroker
   module Client
     module Webhooks
       class Create
+        using PactBroker::Client::HashRefinements
+
         WEBHOOKS_WITH_OPTIONAL_PACTICICPANTS_NOT_SUPPORTED = "This version of the Pact Broker requires that both consumer and provider are specified for a webhook. Please upgrade your broker to >= 2.22.0 to create a webhook with optional consumer and provider."
         CREATING_WEBHOOK_WITH_UUID_NOT_SUPPORTED = "This version of the Pact Broker does not support creating webhooks with a specified UUID. Please upgrade your broker to >= 2.49.0 or use the create-webhook command."
 

data/script/record-undeployment.sh

@@ -1,4 +1,4 @@
 bundle exec bin/pact-broker record-undeployment \
-   --pacticipant foo-consumer --version 1 --environment prod --broker-base-url http://localhost:9292 --output json --verbose
+   --pacticipant foo-consumer --environment production --broker-base-url http://localhost:9292 --output json --verbose
 
 

data/script/update-cli-usage-in-readme.rb

@@ -58,7 +58,7 @@ def generate_thor_docs
       ["Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
       ["Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
       ["Tags", %w[create-version-tag]],
-      ["Versions", %w[describe-version]],
+      ["Versions", %w[describe-version create-or-update-version]],
       ["Miscellaneous", %w[generate-uuid]]
     ]
 

data/spec/lib/pact_broker/client/versions/create_spec.rb

@@ -0,0 +1,174 @@
+require "pact_broker/client/versions/create"
+
+module PactBroker
+  module Client
+    describe Versions::Create do
+      describe "#call" do
+        let(:index_body) do
+          {
+            "_links" => {
+              "pb:pacticipant-branch-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/branches/{branch}/versions/{version}"
+              },
+              "pb:pacticipant-version-tag" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}/tags/{tag}"
+              },
+              "pb:pacticipant-version" => {
+                "href" => "http://broker/pacticipants/{pacticipant}/versions/{version}"
+              }
+            }
+          }
+        end
+
+        let!(:index_request) do
+          stub_request(:get, "http://broker").to_return(status: 200, body: index_body.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:branch_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/branches/main/versions/1").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:tag_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1/tags/dev").to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:create_version_request) do
+          stub_request(:put, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "created" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let!(:get_version_request) do
+          stub_request(:get, "http://broker/pacticipants/Foo/versions/1").to_return(status: 200, body: { version: "got" }.to_json, headers: { "Content-Type" => "application/hal+json" }  )
+        end
+
+        let(:params) do
+          {
+            pacticipant_name: "Foo",
+            version_number: "1",
+            branch_name: branch_name,
+            tags: tags
+          }
+        end
+
+        let(:branch_name) { "main" }
+        let(:tags) { ["dev"] }
+
+        let(:options) do
+          {
+            verbose: "verbose",
+            output: output
+          }
+        end
+
+        let(:output) { "text" }
+
+        let(:pact_broker_client_options) do
+          {
+            token: "token",
+            pact_broker_base_url: "http://broker"
+          }
+        end
+
+        subject { PactBroker::Client::Versions::Create.call(params, options, pact_broker_client_options)}
+
+        context "with a branch and tags" do
+          it "creates a branch version" do
+            subject
+            expect(branch_request).to have_been_made
+          end
+
+          it "creates the tag" do
+            subject
+            expect(tag_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main and tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only tags" do
+          let(:branch_name) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with tag(s) dev in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with only a branch" do
+          let(:tags) { nil }
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 with branch main in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "got" }.to_json)
+            end
+          end
+        end
+
+        context "with no branch or tags" do
+          let(:tags) { nil }
+          let(:branch_name) { nil }
+
+          it "creates a version" do
+            subject
+            expect(create_version_request).to have_been_made
+          end
+
+          it "returns a message" do
+            expect(subject.message).to include "Created/updated pacticipant version 1 in the Pact Broker"
+            expect(subject.success).to be true
+          end
+
+          context "without output json" do
+            let(:output) { "json" }
+
+            it "returns a json message" do
+              expect(subject.message).to eq({ version: "created" }.to_json)
+            end
+          end
+        end
+
+        context "when the Pact Broker does not support branch versions" do
+          before do
+            index_body["_links"].delete("pb:pacticipant-branch-version")
+          end
+
+          let(:index_body) do
+            {
+              "_links" => {}
+            }
+          end
+
+          it "returns an error" do
+            expect(subject.message).to include "does not support branch versions"
+            expect(subject.success).to be false
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.60.0
+  version: 1.61.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -245,8 +245,10 @@ files:
 - lib/pact_broker/client/cli/deployment_commands.rb
 - lib/pact_broker/client/cli/environment_commands.rb
 - lib/pact_broker/client/cli/matrix_commands.rb
+- lib/pact_broker/client/cli/pact_commands.rb
 - lib/pact_broker/client/cli/pacticipant_commands.rb
 - lib/pact_broker/client/cli/record_deployment_long_desc.txt
+- lib/pact_broker/client/cli/version_commands.rb
 - lib/pact_broker/client/cli/version_selector_options_parser.rb
 - lib/pact_broker/client/cli/webhook_commands.rb
 - lib/pact_broker/client/colorize_notices.rb
@@ -304,6 +306,7 @@ files:
 - lib/pact_broker/client/verification_required.rb
 - lib/pact_broker/client/version.rb
 - lib/pact_broker/client/versions.rb
+- lib/pact_broker/client/versions/create.rb
 - lib/pact_broker/client/versions/describe.rb
 - lib/pact_broker/client/versions/formatter.rb
 - lib/pact_broker/client/versions/json_formatter.rb
@@ -365,6 +368,7 @@ files:
 - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/create_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb
@@ -425,7 +429,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: See description
@@ -472,6 +476,7 @@ test_files:
 - spec/lib/pact_broker/client/publish_pacts_the_old_way_spec.rb
 - spec/lib/pact_broker/client/retry_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/create_spec.rb
 - spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/lib/pact_broker/client/webhooks/create_spec.rb