pact_broker-client 1.68.0 → 1.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34449d696b8c2dd03158cb963bb29d5a98df30563b1dfc34172a2e0005421824
-  data.tar.gz: 77f60ba7270a1b1fb8f59a41fd97e047d28536d6857d88109a52efedb6b018ff
+  metadata.gz: c39e09b6dd262ec6baa6da53747ac6adfcac1b83e87050973d10624d6d0dbc85
+  data.tar.gz: 817e36de371bb43762e42c8103735f291a1645a782541581cbff501a70b309da
 SHA512:
-  metadata.gz: 62f45e1885ff173605607913f796f87c1dae40b2618c92b240ffca95fd9e2be4cbae2c50d89676ac82fb26b6e0deb610bec00b2f81a23314b4d9a2927f7c9a9b
-  data.tar.gz: 4bac04b4928c5f1846a963f7b8fb27a860332090ae7c69edce1de6537f63974e5a959ed62333a5fa17feda196525503d6dda3c470794303ddb9d03aff9723063
+  metadata.gz: 68d61e0fef6e96bd4acce08bc781aee2895b209cecbb0e3f453fe8e7e3843f417e5f3f62604dfda8ed5bee803c382c49eb552d17cc5fe06101fcab9848e1e34e
+  data.tar.gz: bf36dbe78ff7fdd10af8983be7130928389175c8b6770ee1772f9a31ccac6920d6316890850d33d8c179a8e9ce3dd1467338810e2879dd71079c751bc2e117a4

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+      interval: "monthly"

data/.github/workflows/release_gem.yml

@@ -31,7 +31,7 @@ jobs:
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
-    - uses: pact-foundation/release-gem@v0.0.13
+    - uses: pact-foundation/release-gem@v0.0.14
       id: release
       env:
         GEM_HOST_API_KEY: '${{ secrets.RUBYGEMS_API_KEY }}'

data/.github/workflows/triage.yml

@@ -0,0 +1,15 @@
+name: Triage Issue
+
+on:
+  issues:
+    types:
+      - opened
+      - labeled
+  pull_request:
+    types:
+      - labeled
+
+jobs:
+  call-workflow:
+    uses: pact-foundation/.github/.github/workflows/triage.yml@master
+    secrets: inherit

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="v1.70.0"></a>
+### v1.70.0 (2023-08-29)
+
+#### Features
+
+* sort can-i-deploy table by consumer name, then provider name	 ([83412e7](/../../commit/83412e7))
+* do not accept gzip responses when VERBOSE=true	 ([a72a529](/../../commit/a72a529))
+
+<a name="v1.69.0"></a>
+### v1.69.0 (2023-08-29)
+
+#### Features
+
+* can-i-merge (#117)	 ([badb030](/../../commit/badb030))
+
 <a name="v1.68.0"></a>
 ### v1.68.0 (2023-07-08)
 

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -444,16 +444,24 @@ Options:
   -l, [--latest=[TAG]]
               # Use the latest pacticipant version. Optionally specify a TAG
                 to use the latest version with the specified tag.
-      [--to-environment=ENVIRONMENT]
-              # The environment into which the pacticipant(s) are to be
-                deployed
       [--branch=BRANCH]
               # The branch of the version for which you want to check the
+                verification results.
+      [--main-branch], [--no-main-branch]
+              # Use the latest version of the configured main branch of the
+                pacticipant as the version for which you want to check the
                 verification results
+      [--to-environment=ENVIRONMENT]
+              # The environment into which the pacticipant(s) are to be
+                deployed
       [--to=TAG]
               # The tag that represents the branch or environment of the
                 integrated applications for which you want to check the
                 verification result status.
+      [--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.
   -o, [--output=OUTPUT]
               # json or table
               # Default: table

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

@@ -1,20 +1,25 @@
+require "pact_broker/client/string_refinements"
 module PactBroker
   module Client
     module CLI
       module MatrixCommands
+        using PactBroker::Client::StringRefinements
+
         def self.included(thor)
           thor.class_eval do
 
-            desc "can-i-deploy", ""
+            desc "can-i-deploy", "Checks if the specified pacticipant version is safe to be deployed."
             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. 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 :branch, required: false, desc: "The branch of the version for which you want to check the verification results.", default: nil
+            method_option :main_branch, required: false, type: :boolean, desc: "Use the latest version of the configured main branch of the pacticipant as the version for which you want to check the verification results", default: false
             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
             method_option :to, required: false, banner: "TAG", desc: "The tag that represents the branch or environment of the integrated applications for which you want to check the verification result status.", default: nil
+            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 :output, aliases: "-o", desc: "json or table", default: "table"
             method_option :retry_while_unknown, banner: "TIMES", type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
             method_option :retry_interval, banner: "SECONDS", type: :numeric, default: 10, required: false, desc: "The time between retries in seconds. Use in conjuction with --retry-while-unknown"
@@ -40,6 +45,31 @@ module PactBroker
               exit(can_i_deploy_exit_status) unless result.success
             end
 
+            desc "can-i-merge", "Checks if the specified pacticipant version is safe to merge into the main branch."
+            long_desc "Checks if the specified pacticipant version is compatible with the configured main branch of each of the pacticipants with which it is integrated."
+            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 :output, aliases: "-o", desc: "json or table", default: "table"
+            method_option :retry_while_unknown, banner: "TIMES", type: :numeric, default: 0, required: false, desc: "The number of times to retry while there is an unknown verification result (ie. the provider verification is likely still running)"
+            method_option :retry_interval, banner: "SECONDS", type: :numeric, default: 10, required: false, desc: "The time between retries in seconds. Use in conjuction with --retry-while-unknown"
+            method_option :dry_run, type: :boolean, default: false, desc: "When dry-run is enabled, always exit process with a success code. Can also be enabled by setting the environment variable PACT_BROKER_CAN_I_MERGE_DRY_RUN=true. This mode is useful when setting up your CI/CD pipeline for the first time, or in a 'break glass' situation where you need to knowingly deploy what Pact considers a breaking change. For the second scenario, it is recommended to use the environment variable and just set it for the build required to deploy that particular version, so you don't accidentally leave the dry run mode enabled."
+            shared_authentication_options
+
+            def can_i_merge(*ignored_but_necessary)
+              require "pact_broker/client/cli/version_selector_options_parser"
+              require "pact_broker/client/can_i_deploy"
+
+              validate_credentials
+              selectors = VersionSelectorOptionsParser.call(ARGV)
+              validate_can_i_deploy_selectors(selectors)
+              dry_run = options.dry_run || ENV["PACT_BROKER_CAN_I_MERGE_DRY_RUN"] == "true"
+              can_i_merge_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(selectors, { with_main_branches: true  }, can_i_merge_options, pact_broker_client_options)
+              $stdout.puts result.message
+              $stdout.flush
+              exit(1) unless result.success
+            end
+
             if ENV.fetch("PACT_BROKER_FEATURES", "").include?("verification_required")
 
               method_option :pacticipant, required: true, aliases: "-a", desc: "The pacticipant name. Use once for each pacticipant being checked."
@@ -50,7 +80,7 @@ module PactBroker
               method_option :output, aliases: "-o", desc: "json or table", default: "table"
 
               shared_authentication_options
-              desc "verification-required", "Checks if there is a verification required between the given pacticipant versions"
+              desc "verification-required", "Checks if there is a verification required between the given pacticipant versions."
               def verification_required(*ignored_but_necessary)
                 require "pact_broker/client/cli/version_selector_options_parser"
                 require "pact_broker/client/verification_required"
@@ -78,7 +108,7 @@ module PactBroker
                 end
               end
 
-              def validate_can_i_deploy_selectors selectors
+              def validate_can_i_deploy_selectors(selectors)
                 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

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

@@ -17,6 +17,10 @@ module PactBroker
             when "--latest", "-l"
               selectors << { pacticipant: nil } if selectors.empty?
               selectors.last[:latest] = true
+            when "--main-branch"
+              selectors << { pacticipant: nil } if selectors.empty?
+              selectors.last[:main_branch] = true
+              selectors.last[:latest] = true
             when /^\-/
               nil
             else
@@ -35,6 +39,10 @@ module PactBroker
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:branch] = word
                 selectors.last[:latest] = true
+              when "--main-branch"
+                selectors << { pacticipant: nil } if selectors.empty?
+                selectors.last[:main_branch] = true
+                selectors.last[:latest] = true
               when "--all"
                 selectors << { pacticipant: nil } if selectors.empty?
                 selectors.last[:tag] = word

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

@@ -50,6 +50,7 @@ module PactBroker
           request['Content-Type'] ||= "application/json" if ['Post', 'Put'].include?(http_method)
           request['Content-Type'] ||= "application/merge-patch+json" if ['Patch'].include?(http_method)
           request['Accept'] = "application/hal+json"
+          request['Accept-Encoding'] = nil if verbose?
           headers.each do | key, value |
             request[key] = value
           end

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

@@ -43,6 +43,9 @@ module PactBroker
           if matrix_options[:to_tag]
             opts[:latest] = 'true'
             opts[:tag] = matrix_options[:to_tag]
+          elsif matrix_options[:with_main_branches]
+            opts[:latest] = 'true'
+            opts[:mainBranch] = 'true'
           elsif selectors.size == 1 && !matrix_options[:to_environment]
             opts[:latest] = 'true'
           end
@@ -59,11 +62,11 @@ module PactBroker
               hash[:latest] = 'true' if selector[:latest]
               hash[:tag] = selector[:tag] if selector[:tag]
               hash[:branch] = selector[:branch] if selector[:branch]
+              hash[:mainBranch] = 'true' if selector[:main_branch]
             end
           end
         end
 
-
         def result_message
           if json_output?
             response_entity.response.raw_body

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

@@ -12,11 +12,11 @@ module PactBroker
         Line = Struct.new(:consumer, :consumer_version, :provider, :provider_version, :success, :ref, :ignored)
 
         def self.call(matrix)
-          matrix_rows = matrix[:matrix]
+          matrix_rows = sort_matrix_rows(matrix[:matrix] || [])
           return "" if matrix_rows.size == 0
           data = prepare_data(matrix_rows)
           printer = TablePrint::Printer.new(data, tp_options(data))
-          printer.table_print + verification_result_urls_text(matrix)
+          printer.table_print + verification_result_urls_text(matrix_rows)
         end
 
         def self.prepare_data(matrix_rows)
@@ -55,8 +55,8 @@ module PactBroker
           default
         end
 
-        def self.verification_results_urls_and_successes(matrix)
-          (matrix[:matrix] || []).collect do | row |
+        def self.verification_results_urls_and_successes(matrix_rows)
+          matrix_rows.collect do | row |
             url = row.dig(:verificationResult, :_links, :self, :href)
             if url
               success = row.dig(:verificationResult, :success)
@@ -67,8 +67,8 @@ module PactBroker
           end.compact
         end
 
-        def self.verification_result_urls_text(matrix)
-          text = self.verification_results_urls_and_successes(matrix).each_with_index.collect do |(url, success), i|
+        def self.verification_result_urls_text(matrix_rows)
+          text = self.verification_results_urls_and_successes(matrix_rows).each_with_index.collect do |(url, success), i|
             status = success ? 'success' : 'failure'
             "#{i+1}. #{url} (#{status})"
           end.join("\n")
@@ -83,6 +83,19 @@ module PactBroker
         def self.max_width(data, column, title)
           (data.collect{ |row| row.send(column) } + [title]).compact.collect(&:size).max
         end
+
+        def self.sort_matrix_rows(matrix_rows)
+          matrix_rows&.sort { |row_1, row_2| sortable_attributes(row_1) <=> sortable_attributes(row_2) }
+        end
+
+        def self.sortable_attributes(matrix_row)
+          [
+            matrix_row.dig(:consumer, :name)&.downcase || "",
+            matrix_row.dig(:provider, :name)&.downcase || "",
+            matrix_row.dig(:consumer, :version, :number) || "",
+            matrix_row.dig(:provider, :version, :number) || ""
+          ]
+        end
       end
     end
   end

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.68.0'
+    VERSION = '1.70.0'
   end
 end

data/spec/integration/can_i_merge_spec.rb

@@ -0,0 +1,43 @@
+require "pact_broker/client/cli/broker"
+
+module PactBroker
+  module Client
+    module CLI
+      describe Broker do
+        before do
+          subject.options = OpenStruct.new(minimum_valid_options)
+          allow($stdout).to receive(:puts)
+          allow($stderr).to receive(:puts)
+          allow(Retry).to receive(:sleep)
+
+          stub_const("ARGV", %w[--pacticipant Foo --version 1])
+          stub_request(:get, "http://pact-broker/matrix?latest=true&latestby=cvp&mainBranch=true&q%5B%5D%5Bpacticipant%5D=Foo&q%5B%5D%5Bversion%5D=1").
+            with(
+              headers: {
+              'Accept'=>'application/hal+json',
+              }).
+            to_return(status: 200, body: File.read("spec/support/matrix.json"), headers: { "Content-Type" => "application/hal+json" })
+        end
+
+        let(:minimum_valid_options) do
+          {
+            broker_base_url: 'http://pact-broker',
+            output: 'table',
+            verbose: 'verbose',
+            retry_while_unknown: 1,
+            retry_interval: 2,
+            limit: 1000,
+            dry_run: false
+          }
+        end
+
+        let(:invoke_can_i_merge) { subject.can_i_merge }
+
+        it "sends a matrix query" do
+          expect($stdout).to receive(:puts).with(/Computer says yes/)
+          invoke_can_i_merge
+        end
+      end
+    end
+  end
+end

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

@@ -75,6 +75,12 @@ module PactBroker
           ],[
             ["--branch", "main"],
             [{ pacticipant: nil, branch: "main", latest: true }]
+          ],[
+            ["--pacticipant", "Foo", "--main-branch", "--pacticipant", "Bar", "--version", "1"],
+            [{ pacticipant: "Foo", main_branch: true, latest: true }, { pacticipant: "Bar", version: "1" }]
+          ],[
+            ["--main-branch"],
+            [{ pacticipant: nil, main_branch: true, latest: true }]
           ]
         ]
 

data/spec/lib/pact_broker/client/matrix/text_formatter_spec.rb

@@ -36,9 +36,18 @@ module PactBroker
           line_1 = line_creator.call
           line_2 = line_creator.call
           line_3 = line_creator.call
+
+          # ensure the data is as expected
+          expect(line_1.dig(:consumer, :version, :number)).to_not be nil
+          expect(line_1.dig(:provider, :version, :number)).to_not be nil
+
+          line_1[:consumer][:version][:number] = "4"
+          line_2[:consumer][:version][:number] = "3"
+          line_3[:consumer][:version][:number] = "5"
+
           line_2[:verificationResult] = nil
           line_3[:verificationResult][:success] = false
-          [line_1, line_2, line_3]
+          [line_1, line_2, line_3].shuffle
         end
 
         let(:matrix) { PactBroker::Client::Matrix::Resource.new(matrix: matrix_lines) }

data/spec/support/matrix_with_results.txt

@@ -1,8 +1,8 @@
 CONSUMER | C.VERSION | PROVIDER | P.VERSION | SUCCESS? | RESULT#
 ---------|-----------|----------|-----------|----------|--------
+Foo      | 3         | Bar      | 5         | ???      |
 Foo      | 4         | Bar      | 5         | true     | 1
-Foo      | 4         | Bar      | 5         | ???      |
-Foo      | 4         | Bar      | 5         | false    | 2
+Foo      | 5         | Bar      | 5         | false    | 2
 
 VERIFICATION RESULTS
 --------------------

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.68.0
+  version: 1.70.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -214,9 +214,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/release_gem.yml"
 - ".github/workflows/smartbear-issue-label-added.yml"
 - ".github/workflows/test.yml"
+- ".github/workflows/triage.yml"
 - ".github/workflows/trigger_pact_docs_update.yml"
 - ".gitignore"
 - ".rspec"
@@ -224,6 +226,7 @@ files:
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
+- LICENSE.txt
 - README.md
 - RELEASING.md
 - Rakefile
@@ -353,6 +356,7 @@ files:
 - spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
+- spec/integration/can_i_merge_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/integration/describe_environment_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb
@@ -449,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: See description
@@ -462,6 +466,7 @@ test_files:
 - spec/fixtures/approvals/list_environments.approved.txt
 - spec/fixtures/foo-bar.json
 - spec/integration/can_i_deploy_spec.rb
+- spec/integration/can_i_merge_spec.rb
 - spec/integration/create_version_tag_spec.rb
 - spec/integration/describe_environment_spec.rb
 - spec/lib/pact_broker/client/base_client_spec.rb