pact_broker-client 1.64.0 → 1.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097964adbb5c79d708b5a0a8b74ddef396ad05b5909583dbf07b1857abcca5f1'
-  data.tar.gz: 2f60b1fb9258157889dd6217db2e17ea338903469daec14eb5e3760d90b11cc1
+  metadata.gz: 4264ac61f86c48d574c045f51849e4e02d4ee0238b3561c19d8ae331991d4410
+  data.tar.gz: 78c60a7b425e70a095a1a70fe2ed369ed472f6192dfceb172448d15969ae1e0a
 SHA512:
-  metadata.gz: 67d01a72a39969f0b9a5aba16119a033cf3961a41f4cdaa1f49a286ac5c3376a3d7b77c74da90159e87e29827c4fcfdab4328949a9c24c51ed8e51301417ca19
-  data.tar.gz: 61e4a0ac04368ebdc4d5aea5f1bfeac3d39440cecdcab4df690f6ea3b86ae2fd277e49191d58189e97c6b1c0918d8336471402c63afc2d62778dfd455cc44efa
+  metadata.gz: a36a0807c6bc5d8e5132a1423d5e7ac6cb5a0da6cc99209f368621f19b8dbb86d66746092152ea3686c1988ac7b995c111a390ca65f8a9cefb30479c1cbb6c6e
+  data.tar.gz: 9aa5aa0598056bc73418c1f4d29c2f5556ffe33bece67b7686abda0c5ec135cbb888e02019b918b8867b8bd17dbb263e4576f0ceca25698df956091f2b9b3470

data/.ruby-version

@@ -0,0 +1 @@
+2.7

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+<a name="v1.66.0"></a>
+### v1.66.0 (2022-12-01)
+
+#### Features
+
+* **can-i-deploy**
+  * support specifying --ignore using the environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE	 ([04a0894](/../../commit/04a0894))
+
+* refactor can-i-deploy to use HAL Client instead of HTTParty	 ([d21efe6](/../../commit/d21efe6))
+
+#### Bug Fixes
+
+* found the missing computer arm when computer says no (#120)	 ([7b8ea24](/../../commit/7b8ea24))
+
+* **publish-provider-contract**
+  * raise validation error when pact broker base URL is missing or blank	 ([2d719c3](/../../commit/2d719c3))
+
+<a name="v1.65.0"></a>
+### v1.65.0 (2022-06-24)
+
+#### Features
+
+* add support for automatically detecting the git commit and branch for Azure DevOps	 ([889f83f](/../../commit/889f83f))
+
 <a name="v1.64.0"></a>
 ### v1.64.0 (2022-05-27)
 

data/README.md

@@ -60,13 +60,17 @@ Options:
               # Repository branch of the consumer version
       [--auto-detect-version-properties], [--no-auto-detect-version-properties]
               # Automatically detect the repository branch from known CI
-                environment variables or git CLI.
+                environment variables or git CLI. Supports Buildkite, Circle
+                CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor,
+                GitLab, CodeShip, Bitbucket and Azure DevOps.
   -t, [--tag=TAG]
               # Tag name for consumer version. Can be specified multiple
                 times.
   -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
               # Tag consumer version with the name of the current git branch.
-                Default: false
+                Supports Buildkite, Circle CI, Travis CI, GitHub Actions,
+                Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and
+                Azure DevOps. Default: false
       [--build-url=BUILD_URL]
               # The build URL that created the pact
       [--merge], [--no-merge]
@@ -130,7 +134,7 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                Default: false
+                This is currently informational only. Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -169,7 +173,7 @@ Options:
               # The display name of the environment
       [--production], [--no-production]
               # Whether or not this environment is a production environment.
-                Default: false
+                This is currently informational only. Default: false
       [--contact-name=CONTACT_NAME]
               # The name of the team/person responsible for this environment
       [--contact-email-address=CONTACT_EMAIL_ADDRESS]
@@ -433,7 +437,10 @@ Options:
       [--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.
+                specifying a --version after the pacticipant name option. The
+                environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE may also
+                be used to specify a pacticipant name to ignore, with commas to
+                separate multiple pacticipant names if necessary.
   -l, [--latest=[TAG]]
               # Use the latest pacticipant version. Optionally specify a TAG
                 to use the latest version with the specified tag.
@@ -868,7 +875,7 @@ Options:
 
 Generate a UUID for use when calling create-or-update-webhook
 
-### Provider contracts
+### Provider contracts (Pactflow only)
 
 #### publish-provider-contract
 
@@ -895,7 +902,7 @@ Options:
               # Whether or not the self verification passed successfully.
       [--verification-exit-code=N]
               # The exit code of the verification process. Can be used instead
-                of --verificaiton-success|--no-verification-success for a
+                of --verification-success|--no-verification-success for a
                 simpler build script.
       [--verification-results=VERIFICATION_RESULTS]
               # The path to the file containing the output from the

data/lib/pact_broker/client/can_i_deploy.rb

@@ -4,6 +4,7 @@ require 'pact_broker/client/retry'
 require 'pact_broker/client/matrix/formatter'
 require 'term/ansicolor'
 require 'pact_broker/client/colorize_notices'
+require "pact_broker/client/matrix/query"
 
 module PactBroker
   module Client
@@ -18,12 +19,11 @@ module PactBroker
         end
       end
 
-      def self.call(pact_broker_base_url, version_selectors, matrix_options, options, pact_broker_client_options={})
-        new(pact_broker_base_url, version_selectors, matrix_options, options, pact_broker_client_options).call
+      def self.call(version_selectors, matrix_options, options, pact_broker_client_options={})
+        new(version_selectors, matrix_options, options, pact_broker_client_options).call
       end
 
-      def initialize(pact_broker_base_url, version_selectors, matrix_options, options, pact_broker_client_options)
-        @pact_broker_base_url = pact_broker_base_url
+      def initialize(version_selectors, matrix_options, options, pact_broker_client_options)
         @version_selectors = version_selectors
         @matrix_options = matrix_options
         @options = options
@@ -32,15 +32,13 @@ module PactBroker
 
       def call
         create_result(fetch_matrix_with_retries)
-      rescue PactBroker::Client::Error => e
-        Result.new(dry_run_or_false, for_dry_run(Term::ANSIColor.red(e.message)))
       rescue StandardError => e
         Result.new(dry_run_or_false, for_dry_run(Term::ANSIColor.red("Error retrieving matrix. #{e.class} - #{e.message}") + "\n#{e.backtrace.join("\n")}"))
       end
 
       private
 
-      attr_reader :pact_broker_base_url, :version_selectors, :matrix_options, :options, :pact_broker_client_options
+      attr_reader :version_selectors, :matrix_options, :options, :pact_broker_client_options
 
       def create_result(matrix)
         if matrix.deployable?
@@ -79,7 +77,7 @@ module PactBroker
           if dry_run?
             "Computer says no ¯\\_(ツ)_/¯ (but you're ignoring this by enabling dry run)"
           else
-            Term::ANSIColor.red("Computer says no ¯\_(ツ)_/¯")
+            Term::ANSIColor.red("Computer says no ¯\\_(ツ)_/¯")
           end
         end
       end
@@ -106,7 +104,7 @@ module PactBroker
       end
 
       def fetch_matrix
-        Retry.while_error { pact_broker_client.matrix.get(version_selectors, matrix_options) }
+        Retry.while_error { PactBroker::Client::Matrix::Query.call({ selectors: version_selectors, matrix_options: matrix_options }, options, pact_broker_client_options) }
       end
 
       def fetch_matrix_with_retries
@@ -124,10 +122,6 @@ module PactBroker
         matrix
       end
 
-      def pact_broker_client
-        @pact_broker_client ||= PactBroker::Client::PactBrokerClient.new(base_url: pact_broker_base_url, client_options: pact_broker_client_options)
-      end
-
       def retry_while_unknown?
         options[:retry_while_unknown] > 0
       end

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

@@ -9,7 +9,7 @@ module PactBroker
             def self.shared_environment_options(name_required: false)
               method_option :name, required: name_required, desc: "The uniquely identifying name of the environment as used in deployment code"
               method_option :display_name, desc: "The display name of the environment"
-              method_option :production, type: :boolean, default: false, desc: "Whether or not this environment is a production environment. Default: false"
+              method_option :production, type: :boolean, default: false, desc: "Whether or not this environment is a production environment. This is currently informational only. Default: false"
               method_option :contact_name, required: false, desc: "The name of the team/person responsible for this environment"
               method_option :contact_email_address, required: false, desc: "The email address of the team/person responsible for this environment"
               output_option_json_or_text

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

@@ -2,15 +2,15 @@ module PactBroker
   module Client
     module CLI
       module MatrixCommands
-
         def self.included(thor)
           thor.class_eval do
+
             desc "can-i-deploy", ""
             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."
-            method_option :ignore, required: false, desc: "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."
+            method_option :ignore, required: false, desc: "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. The environment variable PACT_BROKER_CAN_I_DEPLOY_IGNORE may also be used to specify a pacticipant name to ignore, with commas to separate multiple pacticipant names if necessary."
             method_option :latest, required: false, aliases: "-l", banner: "[TAG]", desc: "Use the latest pacticipant version. Optionally specify a TAG to use the latest version with the specified tag."
             method_option :to_environment, required: false, banner: "ENVIRONMENT", desc: "The environment into which the pacticipant(s) are to be deployed", default: nil
             method_option :branch, required: false, desc: "The branch of the version for which you want to check the verification results", default: nil
@@ -29,11 +29,11 @@ module PactBroker
 
               validate_credentials
               selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| !s[:ignore] }
-              ignore_selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| s[:ignore] }
+              ignore_selectors = VersionSelectorOptionsParser.call(ARGV).select { |s| s[:ignore] } + ignore_selectors_from_environment_variable
               validate_can_i_deploy_selectors(selectors)
               dry_run = options.dry_run || ENV["PACT_BROKER_CAN_I_DEPLOY_DRY_RUN"] == "true"
               can_i_deploy_options = { output: options.output, retry_while_unknown: options.retry_while_unknown, retry_interval: options.retry_interval, dry_run: dry_run, verbose: options.verbose }
-              result = CanIDeploy.call(options.broker_base_url, selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit, ignore_selectors: ignore_selectors }, can_i_deploy_options, pact_broker_client_options)
+              result = CanIDeploy.call(selectors, { to_tag: options.to, to_environment: options.to_environment, limit: options.limit, ignore_selectors: ignore_selectors }, can_i_deploy_options, pact_broker_client_options)
               $stdout.puts result.message
               $stdout.flush
               exit(can_i_deploy_exit_status) unless result.success
@@ -81,6 +81,10 @@ module PactBroker
                 pacticipants_without_versions = selectors.select{ |s| s[:version].nil? && s[:latest].nil? && s[:tag].nil? && s[:branch].nil? }.collect{ |s| s[:pacticipant] }
                 raise ::Thor::RequiredArgumentMissingError, "The version must be specified using `--version VERSION`, `--branch BRANCH` `--latest`, `--latest TAG`, or `--all TAG` for pacticipant #{pacticipants_without_versions.join(", ")}" if pacticipants_without_versions.any?
               end
+
+              def ignore_selectors_from_environment_variable
+                ENV.fetch("PACT_BROKER_CAN_I_DEPLOY_IGNORE", "").split(",").collect(&:strip).collect{ |i| { pacticipant: i } }
+              end
             end
           end
         end

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

@@ -14,9 +14,9 @@ module PactBroker
             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 :auto_detect_version_properties, type: :boolean, default: false, desc: "Automatically detect the repository branch from known CI environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps."
             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 :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps. 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

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

@@ -38,10 +38,9 @@ module PactBroker
               run_webhook_commands webhook_url
             end
 
+            desc 'create-or-update-webhook URL', 'Creates or updates a webhook with a provided uuid and using the same switches as a curl request.'
             shared_options_for_webhook_commands
             method_option :uuid, type: :string, required: true, desc: "Specify the uuid for the webhook"
-
-            desc 'create-or-update-webhook URL', 'Creates or updates a webhook with a provided uuid and using the same switches as a curl request.'
             long_desc File.read(File.join(File.dirname(__FILE__), 'create_or_update_webhook_long_desc.txt'))
             def create_or_update_webhook webhook_url
               run_webhook_commands webhook_url

data/lib/pact_broker/client/git.rb

@@ -13,7 +13,7 @@ CI_COMMIT_REF_NAME https://docs.gitlab.com/ee/ci/variables/predefined_variables.
 CI_BRANCH CI_COMMIT_ID https://documentation.codeship.com/pro/builds-and-configuration/environment-variables/
 bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
 BITBUCKET_BRANCH BITBUCKET_COMMIT https://confluence.atlassian.com/bitbucket/variables-in-pipelines-794502608.html
-
+BUILD_SOURCEBRANCHNAME BUILD_SOURCEVERSION Azure
 =end
 
 # Keep in sync with pact-provider-verifier/lib/pact/provider_verifier/git.rb
@@ -25,8 +25,8 @@ module PactBroker
       using PactBroker::Client::HashRefinements
 
       COMMAND = 'git rev-parse --abbrev-ref HEAD'.freeze
-      BRANCH_ENV_VAR_NAMES = %w{GITHUB_HEAD_REF GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH}.freeze
-      COMMIT_ENV_VAR_NAMES = %w{GITHUB_SHA BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT}
+      BRANCH_ENV_VAR_NAMES = %w{GITHUB_HEAD_REF GITHUB_REF BUILDKITE_BRANCH CIRCLE_BRANCH TRAVIS_BRANCH GIT_BRANCH GIT_LOCAL_BRANCH APPVEYOR_REPO_BRANCH CI_COMMIT_REF_NAME BITBUCKET_BRANCH BUILD_SOURCEBRANCHNAME}.freeze
+      COMMIT_ENV_VAR_NAMES = %w{GITHUB_SHA BUILDKITE_COMMIT CIRCLE_SHA1 TRAVIS_COMMIT GIT_COMMIT APPVEYOR_REPO_COMMIT CI_COMMIT_ID BITBUCKET_COMMIT BUILD_SOURCEVERSION}
       BUILD_URL_ENV_VAR_NAMES = %w{BUILDKITE_BUILD_URL CIRCLE_BUILD_URL TRAVIS_BUILD_WEB_URL BUILD_URL }
 
       def self.commit

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

@@ -19,7 +19,7 @@ module PactBroker
         end
 
         def get href, params = {}, headers = {}
-          query = params.collect{ |(key, value)| "#{CGI::escape(key.to_s)}=#{CGI::escape(value.to_s)}" }.join("&")
+          query = build_nested_query(params)
           uri = URI(href)
           uri.query = query
           perform_request(create_request(uri, 'Get', nil, headers), uri)
@@ -130,6 +130,29 @@ module PactBroker
           ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
         end
 
+        # From Rack lib/rack/utils.rb
+        def build_nested_query(value, prefix = nil)
+          case value
+          when Array
+            value.map { |v|
+              build_nested_query(v, "#{prefix}[]")
+            }.join("&")
+          when Hash
+            value.map { |k, v|
+              build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
+            }.delete_if(&:empty?).join('&')
+          when nil
+            prefix
+          else
+            raise ArgumentError, "value must be a Hash" if prefix.nil?
+            "#{prefix}=#{escape(value)}"
+          end
+        end
+
+        def escape(s)
+          URI.encode_www_form_component(s)
+        end
+
         class Response < SimpleDelegator
           def body
             bod = raw_body

data/lib/pact_broker/client/matrix/query.rb

@@ -0,0 +1,77 @@
+require 'pact_broker/client/base_command'
+require "pact_broker/client/matrix/resource"
+require "pact_broker/client/matrix"
+
+module PactBroker
+  module Client
+    class Matrix < BaseClient
+      class Query < PactBroker::Client::BaseCommand
+
+        def call
+          matrix_entity = create_entry_point("#{pact_broker_client_options[:pact_broker_base_url]}/matrix", pact_broker_client_options).get!(query_params)
+          Matrix::Resource.new(JSON.parse(matrix_entity.response.raw_body, symbolize_names: true))
+        end
+
+        private
+
+        attr_reader :action, :response_entity
+
+
+        def selectors
+          params[:selectors]
+        end
+
+        def matrix_options
+          @matrix_options ||= params[:matrix_options] ||{}
+        end
+
+        def query_params
+          latestby = selectors.size == 1 ? 'cvp' : 'cvpv'
+          query = {
+            q: convert_selector_hashes_to_params(selectors),
+            latestby: latestby
+          }.merge(query_options)
+        end
+
+        def query_options
+          opts = {}
+          if matrix_options.key?(:success)
+            opts[:success] = [*matrix_options[:success]]
+          end
+          opts[:limit] = matrix_options[:limit] if matrix_options[:limit]
+          opts[:environment] = matrix_options[:to_environment] if matrix_options[:to_environment]
+          if matrix_options[:to_tag]
+            opts[:latest] = 'true'
+            opts[:tag] = matrix_options[:to_tag]
+          elsif selectors.size == 1 && !matrix_options[:to_environment]
+            opts[:latest] = 'true'
+          end
+          if matrix_options[:ignore_selectors] && matrix_options[:ignore_selectors].any?
+            opts[:ignore] = convert_selector_hashes_to_params(matrix_options[:ignore_selectors])
+          end
+          opts
+        end
+
+        def convert_selector_hashes_to_params(selectors)
+          selectors.collect do |selector|
+            { pacticipant: selector[:pacticipant] }.tap do | hash |
+              hash[:version] = selector[:version] if selector[:version]
+              hash[:latest] = 'true' if selector[:latest]
+              hash[:tag] = selector[:tag] if selector[:tag]
+              hash[:branch] = selector[:branch] if selector[:branch]
+            end
+          end
+        end
+
+
+        def result_message
+          if json_output?
+            response_entity.response.raw_body
+          else
+            green("Pacticipant \"#{params[:name]}\" #{action} in #{pact_broker_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/string_refinements.rb

@@ -5,6 +5,10 @@ module PactBroker
         def blank?
           true
         end
+
+        def not_blank?
+          false
+        end
       end
 
       refine String do

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.64.0'
+    VERSION = '1.66.0'
   end
 end

data/lib/pactflow/client/cli/provider_contract_commands.rb

@@ -1,10 +1,12 @@
 require "pact_broker/client/hash_refinements"
+require "pact_broker/client/string_refinements"
 
 module Pactflow
   module Client
     module CLI
       module ProviderContractCommands
         using PactBroker::Client::HashRefinements
+        using PactBroker::Client::StringRefinements
 
         def self.included(thor)
           thor.class_eval do
@@ -18,7 +20,7 @@ module Pactflow
             method_option :specification, default: "oas", desc: "The contract specification"
             method_option :content_type, desc: "The content type. eg. application/yml"
             method_option :verification_success, type: :boolean, desc: "Whether or not the self verification passed successfully."
-            method_option :verification_exit_code, type: :numeric, desc: "The exit code of the verification process. Can be used instead of --verificaiton-success|--no-verification-success for a simpler build script."
+            method_option :verification_exit_code, type: :numeric, desc: "The exit code of the verification process. Can be used instead of --verification-success|--no-verification-success for a simpler build script."
             method_option :verification_results, desc: "The path to the file containing the output from the verification process"
             method_option :verification_results_content_type, desc: "The content type of the verification output eg. text/plain, application/yaml"
             method_option :verification_results_format, desc: "The format of the verification output eg. junit, text"
@@ -32,6 +34,7 @@ module Pactflow
             def publish_provider_contract(provider_contract_path)
               require "pactflow/client/provider_contracts/publish"
 
+              validate_pact_broker_url
               validate_publish_provider_contract_options(provider_contract_path)
               result = ::Pactflow::Client::ProviderContracts::Publish.call(
                           publish_provider_contract_command_params(provider_contract_path),
@@ -47,6 +50,12 @@ module Pactflow
                 { verbose: options.verbose, output: options.output }
               end
 
+              def validate_pact_broker_url
+                if pact_broker_client_options[:pact_broker_base_url].blank?
+                  raise Thor::Error, "No value provided for required option --broker-base-url or environment variable PACT_BROKER_BASE_URL"
+                end
+              end
+
               def validate_publish_provider_contract_options(provider_contract_path)
                 if !options.verification_success.nil? && options.verification_exit_code
                   raise Thor::Error, "Cannot use both --verification-success|--no-verification-success and --verification-exit-code"

data/spec/lib/pact_broker/client/can_i_deploy_spec.rb

@@ -7,7 +7,7 @@ module PactBroker
       let(:pact_broker_base_url) { 'http://example.org' }
       let(:version_selectors) { [{ pacticipant: "Foo", version: "1" }] }
       let(:matrix_options) { { } }
-      let(:pact_broker_client_options) { { foo: 'bar' } }
+      let(:pact_broker_client_options) { { pact_broker_base_url: pact_broker_base_url, foo: 'bar' } }
       let(:dry_run) { false }
       let(:matrix_client) { instance_double('PactBroker::Client::Matrix') }
       let(:matrix) do
@@ -31,15 +31,14 @@ module PactBroker
 
 
       before do
-        allow_any_instance_of(PactBroker::Client::PactBrokerClient).to receive(:matrix).and_return(matrix_client)
-        allow(matrix_client).to receive(:get).and_return(matrix)
+        allow(PactBroker::Client::Matrix::Query).to receive(:call).and_return(matrix)
         allow(Matrix::Formatter).to receive(:call).and_return('text matrix')
       end
 
-      subject { CanIDeploy.call(pact_broker_base_url, version_selectors, matrix_options, options, pact_broker_client_options) }
+      subject { CanIDeploy.call(version_selectors, matrix_options, options, pact_broker_client_options) }
 
       it "retrieves the matrix from the pact broker" do
-        expect(matrix_client).to receive(:get).with(version_selectors, matrix_options)
+        expect(PactBroker::Client::Matrix::Query).to receive(:call).with({ selectors: version_selectors, matrix_options: matrix_options }, options, pact_broker_client_options)
         subject
       end
 
@@ -193,7 +192,7 @@ module PactBroker
 
       context "when a PactBroker::Client::Error is raised" do
         before do
-          allow(matrix_client).to receive(:get).and_raise(PactBroker::Client::Error.new('error text'))
+          allow(PactBroker::Client::Matrix::Query).to receive(:call).and_raise(PactBroker::Client::Error.new('error text'))
         end
 
         it "returns a failure response" do
@@ -222,7 +221,7 @@ module PactBroker
         before do
           allow(Retry).to receive(:while_error) { |&block| block.call }
           allow($stderr).to receive(:puts)
-          allow(matrix_client).to receive(:get).and_raise(StandardError.new('error text'))
+          allow(PactBroker::Client::Matrix::Query).to receive(:call).and_raise(StandardError.new('error text'))
         end
 
         it "returns a failure response" do

data/spec/lib/pact_broker/client/cli/broker_can_i_deploy_spec.rb

@@ -38,7 +38,7 @@ module PactBroker
         end
 
         it "invokes the CanIDeploy service" do
-          expect(CanIDeploy).to receive(:call).with('http://pact-broker', version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2, dry_run: false, verbose: "verbose"}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
+          expect(CanIDeploy).to receive(:call).with(version_selectors, { to_tag: nil, to_environment: nil, limit: 1000, ignore_selectors: []}, {output: 'table', retry_while_unknown: 1, retry_interval: 2, dry_run: false, verbose: "verbose"}, { pact_broker_base_url: 'http://pact-broker', verbose: 'verbose' })
           invoke_can_i_deploy
         end
 
@@ -56,7 +56,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: 'prod', to_environment: nil, limit: 1000, ignore_selectors: []}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, {to_tag: 'prod', to_environment: nil, limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -67,7 +67,7 @@ module PactBroker
           end
 
           it "passes the value as the matrix options" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, {to_tag: nil, to_environment: 'prod', limit: 1000, ignore_selectors: []}, anything, anything)
+            expect(CanIDeploy).to receive(:call).with(anything, {to_tag: nil, to_environment: 'prod', limit: 1000, ignore_selectors: []}, anything, anything)
             invoke_can_i_deploy
           end
         end
@@ -79,7 +79,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, { pact_broker_base_url: 'http://pact-broker', basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, { pact_broker_base_url: 'http://pact-broker', basic_auth: {username: "foo", password: "bar"}, verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end
@@ -90,7 +90,7 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with the basic auth credentials" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, anything, {pact_broker_base_url: 'http://pact-broker', token: "some token", verbose: 'verbose'})
+            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, {pact_broker_base_url: 'http://pact-broker', token: "some token", verbose: 'verbose'})
             invoke_can_i_deploy
           end
         end
@@ -102,7 +102,19 @@ module PactBroker
           end
 
           it "invokes the CanIDeploy service with dry_run set to true" do
-            expect(CanIDeploy).to receive(:call).with(anything, anything, anything, hash_including(dry_run: true), anything)
+            expect(CanIDeploy).to receive(:call).with(anything, anything, hash_including(dry_run: true), anything)
+            invoke_can_i_deploy
+          end
+        end
+
+        context "when PACT_BROKER_CAN_I_DEPLOY_IGNORE=Some Service" do
+          before do
+            allow(ENV).to receive(:fetch).and_call_original
+            allow(ENV).to receive(:fetch).with("PACT_BROKER_CAN_I_DEPLOY_IGNORE", "").and_return("Some Service, Some Other Service")
+          end
+
+          it "invokes the CanIDeploy service with ignore selectors" do
+            expect(CanIDeploy).to receive(:call).with(anything, hash_including(ignore_selectors: [ { pacticipant: "Some Service" }, { pacticipant: "Some Other Service" } ]), anything, anything)
             invoke_can_i_deploy
           end
         end

data/spec/service_providers/pact_broker_client_matrix_ignore_spec.rb

@@ -88,7 +88,7 @@ module PactBroker::Client
           )
       end
 
-      subject { PactBroker::Client::CanIDeploy.call(broker_base_url, selectors, matrix_options, options, {})}
+      subject { PactBroker::Client::CanIDeploy.call(selectors, matrix_options, options, { pact_broker_base_url: broker_base_url })}
 
       it 'returns the CLI output' do
         Approvals.verify(subject.message, :name => "can_i_deploy_ignore", format: :txt)

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -1,5 +1,6 @@
 require_relative 'pact_helper'
 require 'pact_broker/client'
+require "pact_broker/client/matrix/query"
 
 module PactBroker::Client
   describe Matrix, :pact => true do
@@ -10,6 +11,9 @@ module PactBroker::Client
       let(:matrix_response_body) { Pact.like(matrix) }
       let(:matrix) { JSON.parse(File.read('spec/support/matrix.json')) }
       let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3" }, { pacticipant: "Bar", version: "4.5.6" }] }
+      let(:options) { {} }
+
+      subject { PactBroker::Client::Matrix::Query.call({ selectors: selectors, options: options }, {}, { pact_broker_base_url: pact_broker.mock_service_base_url }) }
 
       context "when results are found" do
         before do
@@ -29,7 +33,7 @@ module PactBroker::Client
         end
 
         it 'returns the pact matrix' do
-          matrix = pact_broker_client.matrix.get(selectors)
+          matrix = subject
           expect(matrix[:matrix].size).to eq 1
         end
       end
@@ -54,7 +58,7 @@ module PactBroker::Client
         let(:selectors) { [{ pacticipant: "Foo Thing", version: "1.2.3" }, { pacticipant: "Bar", version: "4.5.6" }] }
 
         it 'incorrectly escapes the spaces but it still seems to work' do
-          matrix = pact_broker_client.matrix.get(selectors)
+          matrix = subject
           expect(matrix[:matrix].size).to eq 1
         end
       end
@@ -79,7 +83,7 @@ module PactBroker::Client
         let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3" }] }
 
         it 'returns the row with the lastest verification for version 1.2.3' do
-          matrix = pact_broker_client.matrix.get(selectors)
+          matrix = subject
           expect(matrix[:matrix].size).to eq 1
         end
       end
@@ -108,7 +112,7 @@ module PactBroker::Client
         let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3" }, { pacticipant: "Bar", version: "9.9.9" }] }
 
         it 'does not raise an error' do
-          pact_broker_client.matrix.get(selectors)
+          subject
         end
       end
 
@@ -134,8 +138,8 @@ module PactBroker::Client
 
         it 'raises an error' do
           expect {
-            pact_broker_client.matrix.get(selectors)
-          }.to raise_error PactBroker::Client::Error, "an error message"
+            subject
+          }.to raise_error PactBroker::Client::Hal::ErrorResponseReturned, /an error message/
         end
       end
 
@@ -161,7 +165,7 @@ module PactBroker::Client
         let(:selectors) { [{ pacticipant: "Foo" }, { pacticipant: "Bar" }] }
 
         it "returns multiple rows" do
-          matrix = pact_broker_client.matrix.get(selectors)
+          matrix = subject
           expect(matrix[:matrix].size).to eq 2
         end
       end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'webmock/rspec'
 require 'rspec/its'
 
+ENV["PACT_BROKER_CAN_I_DEPLOY_IGNORE"] = nil
+
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require "./spec/support/shared_context.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.64.0
+  version: 1.66.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -213,6 +213,7 @@ files:
 - ".github/workflows/trigger_pact_docs_update.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -286,6 +287,7 @@ files:
 - lib/pact_broker/client/matrix/abbreviate_version_number.rb
 - lib/pact_broker/client/matrix/formatter.rb
 - lib/pact_broker/client/matrix/json_formatter.rb
+- lib/pact_broker/client/matrix/query.rb
 - lib/pact_broker/client/matrix/resource.rb
 - lib/pact_broker/client/matrix/text_formatter.rb
 - lib/pact_broker/client/merge_pacts.rb
@@ -438,7 +440,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: See description