pact_broker-client 1.63.0 → 1.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c364b3a4f6acc4007f18baf2812262423988555e78e03617641e557ebbb3402
-  data.tar.gz: f741a0a0ad6ad08e4b0ef9f80cc02b07f409b6eaf84fcf609419644d7f9c6255
+  metadata.gz: '097964adbb5c79d708b5a0a8b74ddef396ad05b5909583dbf07b1857abcca5f1'
+  data.tar.gz: 2f60b1fb9258157889dd6217db2e17ea338903469daec14eb5e3760d90b11cc1
 SHA512:
-  metadata.gz: 14252b9713e0f0ab18a5f4418f697757acdd8cccb572658b5655a073105abd00996ba37d2b7c467135a906df1f9c10b8ebb25a2ecdafde2901e219bc521e5b16
-  data.tar.gz: fc6eb7836d4ba0f1016538fa03134e44b00679458f8d5a17a091779de8698e04de64497468ea335ca0fc5e74ed3080baf06ae766a8080381eaf492b01de0a78a
+  metadata.gz: 67d01a72a39969f0b9a5aba16119a033cf3961a41f4cdaa1f49a286ac5c3376a3d7b77c74da90159e87e29827c4fcfdab4328949a9c24c51ed8e51301417ca19
+  data.tar.gz: 61e4a0ac04368ebdc4d5aea5f1bfeac3d39440cecdcab4df690f6ea3b86ae2fd277e49191d58189e97c6b1c0918d8336471402c63afc2d62778dfd455cc44efa

data/.github/workflows/test.yml

@@ -9,19 +9,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ["2.2", "2.7"]
+        ruby_version: ["2.7", "3.0", "3.1"]
         experimental: [false]
-        include:
-          - ruby_version: "3.0"
-            experimental: true
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby_version }}
       - run: "bundle install"
-      - if: failure()
-        run: cat /opt/hostedtoolcache/Ruby/2.2.10/x64/lib/ruby/gems/2.2.0/extensions/x86_64-linux/2.2.0/approvals-0.0.25/gem_make.out && exit 1
       - run: "bundle exec rake"
   pact:
     runs-on: "ubuntu-latest"

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+<a name="v1.64.0"></a>
+### v1.64.0 (2022-05-27)
+
+#### Features
+
+* remove feature flag for publish-provider-contract	 ([146a2d8](/../../commit/146a2d8))
+* add pactflow specific message for environment not found when recording a release/deployment	 ([6667cbb](/../../commit/6667cbb))
+
 <a name="v1.63.0"></a>
 ### v1.63.0 (2022-05-10)
 

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.6-alpine3.12
+FROM ruby:3.1-alpine
 
 RUN apk add --no-cache -X http://dl-cdn.alpinelinux.org/alpine/edge/testing hub
 RUN apk add --update --no-cache git openssh bash

data/README.md

@@ -1,6 +1,6 @@
 # Pact Broker Client
 
-A client for the [Pact Broker](https://docs.pact.io/pact_broker/). Publishes and retrieves pacts, verification results, pacticipants, pacticipant versions and tags. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
+A client for the [Pact Broker](https://docs.pact.io/pact_broker/) and [Pactflow](https://pactflow.io/?utm_source=ossdocs&utm_campaign=pact_broker_client_readme). Publishes and retrieves pacts, pacticipants, pacticipant versions, environments, deployments and releases. Supports publishing provider contracts for Pactflow. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image](https://hub.docker.com/r/pactfoundation/pact-cli).
 
 ![Build status](https://github.com/pact-foundation/pact_broker-client/workflows/Test/badge.svg)
 
@@ -32,6 +32,8 @@ To connect to a Pact Broker that uses custom SSL cerificates, set the environmen
 
 ## Usage - CLI
 
+All commands prefixed with `pact-broker` can be used with the OSS Pact Broker and Pactflow. Commands prefixed with `pactflow` can only be used with Pactflow.
+
 The Pact Broker base URL can be specified either using the environment variable `$PACT_BROKER_BASE_URL` or the `-b` or `--broker-base-url` parameters.
 
 Pact Broker authentication can be performed either using basic auth or a bearer token.
@@ -460,7 +462,13 @@ Options:
       [--dry-run], [--no-dry-run]
               # 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_DEPLOY_DRY_RUN=true.
+                PACT_BROKER_CAN_I_DEPLOY_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.
   -b, --broker-base-url=BROKER_BASE_URL
               # The base URL of the Pact Broker
   -u, [--broker-username=BROKER_USERNAME]
@@ -860,6 +868,64 @@ Options:
 
 Generate a UUID for use when calling create-or-update-webhook
 
+### Provider contracts
+
+#### publish-provider-contract
+
+```
+Usage:
+  pactflow publish-provider-contract CONTRACT_FILE ... --provider=PROVIDER -a, --provider-app-version=PROVIDER_APP_VERSION -b, --broker-base-url=BROKER_BASE_URL
+
+Options:
+      --provider=PROVIDER
+              # The provider name
+  -a, --provider-app-version=PROVIDER_APP_VERSION
+              # The provider application version
+  -h, [--branch=BRANCH]
+              # Repository branch of the provider version
+  -t, [--tag=TAG]
+              # Tag name for provider version. Can be specified multiple
+                times.
+      [--specification=SPECIFICATION]
+              # The contract specification
+              # Default: oas
+      [--content-type=CONTENT_TYPE]
+              # The content type. eg. application/yml
+      [--verification-success], [--no-verification-success]
+              # 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
+                simpler build script.
+      [--verification-results=VERIFICATION_RESULTS]
+              # The path to the file containing the output from the
+                verification process
+      [--verification-results-content-type=VERIFICATION_RESULTS_CONTENT_TYPE]
+              # The content type of the verification output eg. text/plain,
+                application/yaml
+      [--verification-results-format=VERIFICATION_RESULTS_FORMAT]
+              # The format of the verification output eg. junit, text
+      [--verifier=VERIFIER]
+              # The tool used to verify the provider contract
+      [--verifier-version=VERIFIER_VERSION]
+              # The version of the tool used to verify the provider contract
+  -o, [--output=OUTPUT]
+              # json or text
+              # Default: text
+  -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
+```
+
+Publish provider contract to Pactflow
+
 <!-- end-autogenerated-docs -->
 
 ## Usage - Ruby

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

@@ -20,7 +20,7 @@ module PactBroker
             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"
             # Allow limit to be set manually until https://github.com/pact-foundation/pact_broker-client/issues/53 is fixed
             method_option :limit, hide: true
-            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_DEPLOY_DRY_RUN=true."
+            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_DEPLOY_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_deploy(*ignored_but_necessary)

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

@@ -64,7 +64,11 @@ module PactBroker
           if environment_exists?
             "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}."
           else
-            "No environment found with name '#{environment_name}'."
+            if is_pactflow?
+              "Environment '#{environment_name}' is not an available option for recording a deployment of #{pacticipant_name}. The environment may not exist, or you may not have the required permissions or team associations to view it."
+            else
+              "No environment found with name '#{environment_name}'."
+            end
           end
         end
 

data/lib/pact_broker/client/version.rb

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

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

@@ -8,77 +8,73 @@ module Pactflow
 
         def self.included(thor)
           thor.class_eval do
+            desc 'publish-provider-contract CONTRACT_FILE ...', "Publish provider contract to Pactflow"
+            method_option :provider, required: true, desc: "The provider name"
+            method_option :provider_app_version, required: true, aliases: "-a", desc: "The provider application version"
+            method_option :branch, aliases: "-h", desc: "Repository branch of the provider 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 provider 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 :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_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"
+            method_option :verifier, desc: "The tool used to verify the provider contract"
+            method_option :verifier_version, desc: "The version of the tool used to verify the provider contract"
+            #method_option :build_url, desc: "The build URL that created the pact"
 
-            if ENV.fetch("PACTFLOW_FEATURES", "").include?("publish-provider-contract")
+            output_option_json_or_text
+            shared_authentication_options
 
-              desc 'publish-provider-contract CONTRACT_FILE ...', "Publish provider contract to Pactflow"
-              method_option :provider, required: true, desc: "The provider name"
-              method_option :provider_app_version, required: true, aliases: "-a", desc: "The provider application version"
-              method_option :branch, aliases: "-h", desc: "Repository branch of the provider 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 provider 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 :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_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"
-              method_option :verifier, desc: "The tool used to verify the provider contract"
-              method_option :verifier_version, desc: "The version of the tool used to verify the provider contract"
-              #method_option :build_url, desc: "The build URL that created the pact"
+            def publish_provider_contract(provider_contract_path)
+              require "pactflow/client/provider_contracts/publish"
 
-              output_option_json_or_text
-              shared_authentication_options
-
-              def publish_provider_contract(provider_contract_path)
-                require "pactflow/client/provider_contracts/publish"
+              validate_publish_provider_contract_options(provider_contract_path)
+              result = ::Pactflow::Client::ProviderContracts::Publish.call(
+                          publish_provider_contract_command_params(provider_contract_path),
+                          command_options,
+                          pact_broker_client_options
+                        )
+              $stdout.puts result.message
+              exit(1) unless result.success
+            end
 
-                validate_publish_provider_contract_options(provider_contract_path)
-                result = ::Pactflow::Client::ProviderContracts::Publish.call(
-                            publish_provider_contract_command_params(provider_contract_path),
-                            command_options,
-                            pact_broker_client_options
-                          )
-                $stdout.puts result.message
-                exit(1) unless result.success
+            no_commands do
+              def command_options
+                { verbose: options.verbose, output: options.output }
               end
 
-              no_commands do
-                def command_options
-                  { verbose: options.verbose, output: options.output }
-                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"
-                  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"
                 end
+              end
 
-                def publish_provider_contract_command_params(provider_contract_path)
-                  success = !options.verification_success.nil? ? options.verification_success : ( options.verification_exit_code && options.verification_exit_code == 0 )
+              def publish_provider_contract_command_params(provider_contract_path)
+                success = !options.verification_success.nil? ? options.verification_success : ( options.verification_exit_code && options.verification_exit_code == 0 )
 
-                  {
-                    provider_name: options.provider.strip,
-                    provider_version_number: options.provider_app_version.strip,
-                    branch_name: options.branch && options.branch.strip,
-                    tags: (options.tag && options.tag.collect(&:strip)) || [],
-                    contract: {
-                      content: File.read(provider_contract_path),
-                      content_type: options.content_type,
-                      specification: options.specification
-                    },
-                    verification_results: {
-                      success: success,
-                      content: options.verification_results ? File.read(options.verification_results) : nil,
-                      content_type: options.verification_results_content_type,
-                      format: options.verification_results_format,
-                      verifier: options.verifier,
-                      verifier_version: options.verifier_version
-                    }
+                {
+                  provider_name: options.provider.strip,
+                  provider_version_number: options.provider_app_version.strip,
+                  branch_name: options.branch && options.branch.strip,
+                  tags: (options.tag && options.tag.collect(&:strip)) || [],
+                  contract: {
+                    content: File.read(provider_contract_path),
+                    content_type: options.content_type,
+                    specification: options.specification
+                  },
+                  verification_results: {
+                    success: success,
+                    content: options.verification_results ? File.read(options.verification_results) : nil,
+                    content_type: options.verification_results_content_type,
+                    format: options.verification_results_format,
+                    verifier: options.verifier,
+                    verifier_version: options.verifier_version
                   }
-                end
+                }
               end
             end
           end

data/lib/pactflow/client/provider_contracts/publish.rb

@@ -23,7 +23,7 @@ module Pactflow
         def do_call
           create_branch_version_and_tags
           create_contract
-          PactBroker::Client::CommandResult.new(true, green("Successfully published provider contract for #{provider_name} version #{provider_version_number}"))
+          PactBroker::Client::CommandResult.new(true, green("Successfully published provider contract for #{provider_name} version #{provider_version_number} to Pactflow"))
         end
 
         def create_branch_version_and_tags
@@ -58,10 +58,10 @@ module Pactflow
                                         }.compact
 
           body_params = {
-                    content: encode_content(contract[:content]),
-                    contractType: contract[:specification],
-                    contentType: contract[:content_type],
-                  }.compact
+                          content: encode_content(contract[:content]),
+                          contractType: contract[:specification],
+                          contentType: contract[:content_type],
+                        }.compact
 
           if verification_results_params.any?
             body_params[:verificationResults] = verification_results_params

data/script/publish-provider-contract.sh

@@ -1,5 +1,4 @@
 export PACT_BROKER_BASE_URL=${PACT_BROKER_BASE_URL:-"http://localhost:9292"}
-export PACTFLOW_FEATURES=publish-provider-contract
 bundle exec bin/pactflow publish-provider-contract  \
   script/oas.yml \
   --provider Foo \

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

@@ -1,12 +1,30 @@
 #!/usr/bin/env ruby
 require "stringio"
 require "pact_broker/client/cli/broker"
+require "pactflow/client/cli/pactflow"
 
 ENV["THOR_COLUMNS"] = "160"
 START_MARKER = "<!-- start-autogenerated-docs -->"
 END_MARKER = "<!-- end-autogenerated-docs -->"
 TERMINAL_WIDTH = 80
 
+PACT_BROKER_COMMAND_GROUPS = [
+  [PactBroker::Client::CLI::Broker, "Pacts", %w[publish list-latest-pact-versions] ],
+  [PactBroker::Client::CLI::Broker, "Environments", %w[create-environment update-environment describe-environment delete-environment list-environments]],
+  [PactBroker::Client::CLI::Broker, "Deployments", %w[record-deployment record-undeployment]],
+  [PactBroker::Client::CLI::Broker, "Releases", %w[record-release record-support-ended]],
+  [PactBroker::Client::CLI::Broker, "Matrix", %w[can-i-deploy]],
+  [PactBroker::Client::CLI::Broker, "Pacticipants", %w[create-or-update-pacticipant describe-pacticipant list-pacticipants]],
+  [PactBroker::Client::CLI::Broker, "Webhooks", %w[create-webhook create-or-update-webhook test-webhook]],
+  [PactBroker::Client::CLI::Broker, "Tags", %w[create-version-tag]],
+  [PactBroker::Client::CLI::Broker, "Versions", %w[describe-version create-or-update-version]],
+  [PactBroker::Client::CLI::Broker, "Miscellaneous", %w[generate-uuid]]
+]
+
+PACTFLOW_COMMAND_GROUPS = [
+  [Pactflow::Client::CLI::Pactflow, "Provider contracts (Pactflow only)", %w[publish-provider-contract]]
+]
+
 def print_wrapped(message, options = {})
   out = StringIO.new
   indent = options[:indent] || 0
@@ -44,29 +62,16 @@ def format_banner(banner)
   banner_lines
 end
 
-def generate_thor_docs
+def generate_thor_docs(command_groups)
   begin
     out = StringIO.new
     $stdout = out
 
-    command_groups = [
-      ["Pacts", %w[publish list-latest-pact-versions] ],
-      ["Environments", %w[create-environment update-environment describe-environment delete-environment list-environments]],
-      ["Deployments", %w[record-deployment record-undeployment]],
-      ["Releases", %w[record-release record-support-ended]],
-      ["Matrix", %w[can-i-deploy]],
-      ["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 create-or-update-version]],
-      ["Miscellaneous", %w[generate-uuid]]
-    ]
-
-    command_groups.collect do | group, commands |
+    command_groups.collect do | cli, group, commands |
       puts "### #{group}\n\n"
       commands.each do | command |
         puts "#### #{command}\n\n"
-        PactBroker::Client::CLI::Broker.start(["help", command])
+        cli.start(["help", command])
         puts "\n"
       end
     end
@@ -110,7 +115,7 @@ end
 @current_state = :start
 @old_state = nil
 
-def reformat_docs(generated_thor_docs)
+def reformat_docs(generated_thor_docs, command)
   generated_thor_docs.split("\n").collect do | line |
     @old_state = @current_state
 
@@ -142,7 +147,7 @@ def reformat_docs(generated_thor_docs)
     .collect { | line | line.gsub(/\s+$/, "") }
     .join("\n")
     .gsub("/go/", "/")
-    .gsub(File.basename(__FILE__), "pact-broker")
+    .gsub(File.basename(__FILE__), command)
 end
 
 def update_readme(usage_docs)
@@ -153,4 +158,7 @@ def update_readme(usage_docs)
   File.open("README.md", "w") { |file| file << new_readme_text }
 end
 
-update_readme(reformat_docs(generate_thor_docs))
+pact_broker_docs = reformat_docs(generate_thor_docs(PACT_BROKER_COMMAND_GROUPS), "pact-broker")
+pactflow_docs = reformat_docs(generate_thor_docs(PACTFLOW_COMMAND_GROUPS), "pactflow")
+
+update_readme(pact_broker_docs + "\n\n" + pactflow_docs)

data/spec/lib/pact_broker/client/deployments/record_deployment_spec.rb

@@ -164,6 +164,15 @@ module PactBroker
                 expect(subject.success).to be false
                 expect(subject.message).to include "No environment found with name 'test'. Available options: prod"
               end
+
+              context "when the server is Pactflow" do
+                let(:index_headers) { { "Content-Type" => "application/hal+json", "X-Pactflow-Sha" => "123" } }
+
+                it "returns a customised message" do
+                  expect(subject.message).to include "Environment 'test' is not an available option for recording a deployment of Foo"
+                  expect(subject.message).to include "permissions"
+                end
+              end
             end
 
             context "when the environment does exist" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.63.0
+  version: 1.64.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -438,7 +438,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: See description