pact-provider-verifier 1.34.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f4e0f7b4b4f8daf7cb3960ce80e52a23119f2409abde541f51b64c653ae93a
-  data.tar.gz: 6126a5247e221ca0fc05e2e4dd829023f75c8c3682e4a20ed497a629b24d4651
+  metadata.gz: 8a78bbf0bd6a02f5ae8601da7624b20ad1721c68ab63f8522519861eeeb43b4b
+  data.tar.gz: 8d7cba4856e310898b110697d9835f6787ce4f9900047d8318f1fb87bff3e431
 SHA512:
-  metadata.gz: 7640a18b5a9d83766ca30138172d43521e543c8509325c2566867aab51afeccccdad472b8cafef12d701b0f28f16950fddaf7d697b664d6742a024b307d137a2
-  data.tar.gz: 762afb591b585af8a3a178f277e2084676df0a2b9336d39bd4ba89d078527d50b9d1134e0df41af212c8425dff1761aa0d4d26e72b0434c6fd89c0ae8296fa05
+  metadata.gz: 9bf7bd254fe9003ce19a89222757c4f8b890e97dadd9044391a0431b0d6e92163b607d66306abe1f7540fba3101b2e3e4dfaecb61f6db793b356e0474d319160
+  data.tar.gz: 505923346b53a1f8331db747bc43d8a6f7819263829a57eb38878d486e1ef3bb9e0829a32b56d843fd6d3abae139ea05795b1f82edacc4a939fb4ce8a19f3965

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+<a name="v1.36.0"></a>
+### v1.36.0 (2021-09-09)
+
+#### Features
+
+* add support for specifying the provider version branch	 ([7f53206](/../../commit/7f53206))
+
+<a name="v1.35.2"></a>
+### v1.35.2 (2021-09-09)
+
+#### Bug Fixes
+
+* lock pact gem to compatible version	 ([b4db21e](/../../commit/b4db21e))
+
+<a name="v1.35.1"></a>
+### v1.35.1 (2021-07-01)
+
+#### Bug Fixes
+
+* exit with correct exit code on failure	 ([a8a2144](/../../commit/a8a2144))
+
+<a name="v1.35.0"></a>
+### v1.35.0 (2021-03-20)
+
+#### Features
+
+* Optionally fail when no pacts are found	 ([772e8fb](/../../commit/772e8fb))
+
 <a name="v1.34.0"></a>
 ### v1.34.0 (2021-02-01)
 

data/README.md

@@ -10,7 +10,7 @@ binary-like CLI tool.
 
 * Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/pact-foundation/pact_broker)
 * Verify local `*.json` Pacts on the file system
-* Works with Pact [provider states](https://docs.pact.io/documentation/provider_states.html) should you need them
+* Works with Pact [provider states](https://docs.pact.io/getting_started/provider_states) should you need them
 * Publishes the verification results back to the pact broker if the pact was retrieved from a broker.
 
 ## Installation
@@ -97,6 +97,8 @@ Options:
           # The log level
 
           # Default: debug
+      [--fail-if-no-pacts-found]
+          # If specified, will fail when no pacts are found
 
 Description:
   The parameters used when fetching pacts dynamically from a Pact Broker are:
@@ -108,9 +110,9 @@ Description:
   --enable-pending
   --include-wip-pacts-since
 
-  To fetch a pact from a known URL (eg. when a
-  verification is triggered by a 'contract content changed' webhook), pass in the pact URL(s) as
-the first argument(s) to the command.
+  To verify a pact at a known URL (eg. when a verification is triggered by a 'contract content changed'
+  webhook), pass in the pact URL(s) as the first argument(s) to the command, and do NOT set any of the 
+  other parameters apart from the base URL and credentials.
 
   To publish verification results for either of the above scenarios, set:
 
@@ -159,7 +161,7 @@ Modification of the request headers is sometimes necessary, but be aware that an
 
 ### API with Provider States
 
-Read the [Provider States section on docs.pact.io](https://docs.pact.io/documentation/provider_states.html) for an introduction to provider states.
+Read the [Provider States section on docs.pact.io](https://docs.pact.io/getting_started/provider_states) for an introduction to provider states.
 
 To allow the correct data to be set up before each interaction is replayed, you will need to create a dev/test only HTTP endpoint that accepts a JSON document that looks like:
 

data/lib/pact/provider_verifier/aggregate_pact_configs.rb

@@ -6,15 +6,16 @@ module Pact
   module ProviderVerifier
     class AggregatePactConfigs
 
-      def self.call(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_tags, pact_broker_base_url, http_client_options, options)
-        new(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_tags, pact_broker_base_url, http_client_options, options).call
+      def self.call(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_branch, provider_version_tags, pact_broker_base_url, http_client_options, options)
+        new(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_branch, provider_version_tags, pact_broker_base_url, http_client_options, options).call
       end
 
-      def initialize(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_tags, pact_broker_base_url, http_client_options, options)
+      def initialize(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, provider_version_branch, provider_version_tags, pact_broker_base_url, http_client_options, options)
         @pact_urls = pact_urls
         @provider_name = provider_name
         @consumer_version_tags = consumer_version_tags
         @consumer_version_selectors = consumer_version_selectors
+        @provider_version_branch = provider_version_branch
         @provider_version_tags = provider_version_tags
         @pact_broker_base_url = pact_broker_base_url
         @http_client_options = http_client_options
@@ -27,7 +28,7 @@ module Pact
 
       private
 
-      attr_reader :pact_urls, :provider_name, :consumer_version_tags, :consumer_version_selectors, :provider_version_tags, :pact_broker_base_url, :http_client_options, :options
+      attr_reader :pact_urls, :provider_name, :consumer_version_tags, :consumer_version_selectors, :provider_version_branch, :provider_version_tags, :pact_broker_base_url, :http_client_options, :options
 
       def specified_pact_uris
         pact_urls.collect{ | url | Pact::PactBroker.build_pact_uri(url, http_client_options) }
@@ -45,6 +46,7 @@ module Pact
         @pacts_for_verification ||= Pact::PactBroker.fetch_pact_uris_for_verification(
           provider_name,
           aggregated_consumer_version_selectors,
+          provider_version_branch,
           provider_version_tags,
           pact_broker_base_url,
           http_client_options,

data/lib/pact/provider_verifier/app.rb

@@ -19,13 +19,14 @@ module Pact
 
       PROXY_PACT_HELPER = File.expand_path(File.join(File.dirname(__FILE__), "pact_helper.rb"))
       EMPTY_ARRAY = [].freeze
-      attr_reader :pact_urls, :options, :consumer_version_tags, :provider_version_tags, :consumer_version_selectors, :publish_verification_results
+      attr_reader :pact_urls, :options, :consumer_version_tags, :provider_version_branch, :provider_version_tags, :consumer_version_selectors, :publish_verification_results
 
       def initialize pact_urls, options = {}
         @pact_urls = pact_urls
         @options = options
         @consumer_version_tags = options.consumer_version_tag || EMPTY_ARRAY
         @provider_version_tags = merge_provider_version_tags(options)
+        @provider_version_branch = options.provider_version_branch
         @consumer_version_selectors = parse_consumer_version_selectors(options.consumer_version_selector || EMPTY_ARRAY)
         @publish_verification_results = options.publish_verification_results || ENV['PACT_BROKER_PUBLISH_VERIFICATION_RESULTS'] == 'true'
       end
@@ -36,18 +37,23 @@ module Pact
 
       def call
         setup
-
-        pact_urls = all_pact_urls
+        warn_empty_pact_set
         wait_until_provider_available
-        exit_statuses = pact_urls.collect do |pact_uri|
+        pacts_pass_verification?
+      end
+
+      private
+
+      def pacts_pass_verification?
+        return false if all_pact_urls.empty? && options.fail_if_no_pacts_found
+
+        exit_statuses = all_pact_urls.collect do |pact_uri|
           verify_pact pact_uri
         end
 
         exit_statuses.all?{ | status | status == 0 }
       end
 
-      private
-
 
       def setup
         configure_output
@@ -187,25 +193,35 @@ module Pact
       end
 
       def all_pact_urls
-        http_client_options = {
-          username: options.broker_username || ENV['PACT_BROKER_USERNAME'],
-          password: options.broker_password || ENV['PACT_BROKER_PASSWORD'],
-          token: options.broker_token || ENV['PACT_BROKER_TOKEN'],
-          verbose: verbose?
-        }
-        opts = {
-          enable_pending: options.enable_pending,
-          include_wip_pacts_since: options.include_wip_pacts_since
-        }
-        AggregatePactConfigs.call(
-          pact_urls,
-          options.provider,
-          consumer_version_tags,
-          consumer_version_selectors,
-          provider_version_tags,
-          options.pact_broker_base_url || ENV['PACT_BROKER_BASE_URL'],
-          http_client_options,
-          opts)
+        @all_pact_urls ||= begin
+          http_client_options = {
+            username: options.broker_username || ENV['PACT_BROKER_USERNAME'],
+            password: options.broker_password || ENV['PACT_BROKER_PASSWORD'],
+            token: options.broker_token || ENV['PACT_BROKER_TOKEN'],
+            verbose: verbose?
+          }
+          opts = {
+            enable_pending: options.enable_pending,
+            include_wip_pacts_since: options.include_wip_pacts_since
+          }
+          AggregatePactConfigs.call(
+            pact_urls,
+            options.provider,
+            consumer_version_tags,
+            consumer_version_selectors,
+            provider_version_branch,
+            provider_version_tags,
+            options.pact_broker_base_url || ENV['PACT_BROKER_BASE_URL'],
+            http_client_options,
+            opts)
+        end
+      end
+
+      def warn_empty_pact_set
+        if all_pact_urls.empty?
+          level = options.fail_if_no_pacts_found ? "ERROR" : "WARN"
+          $stderr.puts  "#{level}: No pacts were found for the consumer versions selected"
+        end
       end
 
       def require_pact_project_pact_helper

data/lib/pact/provider_verifier/cli/long_desc.txt

@@ -7,7 +7,7 @@ The parameters used when fetching pacts dynamically from a Pact Broker are:
 --enable-pending
 --include-wip-pacts-since
 
-To fetch a pact from a known URL (eg. when a verification is triggered by a 'contract content changed' webhook), pass in the pact URL(s) as the first argument(s) to the command.
+To verify a pact at a known URL (eg. when a verification is triggered by a 'contract content changed' webhook), pass in the pact URL(s) as the first argument(s) to the command, and do NOT set any of the other parameters apart from the base URL and credentials.
 
 To publish verification results for either of the above scenarios, set:
 

data/lib/pact/provider_verifier/cli/verify.rb

@@ -21,6 +21,7 @@ module Pact
         method_option :consumer_version_tag, type: :array, banner: "TAG", desc: "Retrieve the latest pacts with this consumer version tag. Used in conjunction with --provider. May be specified multiple times.", :required => false
         method_option :consumer_version_selector, hide: true, type: :array, banner: "SELECTOR", desc: "JSON string specifying a selector that identifies which pacts to verify. May be specified multiple times. See below for further documentation.", :required => false
         method_option :provider_version_tag, type: :array, banner: "TAG", desc: "Tag to apply to the provider application version. May be specified multiple times.", :required => false
+        method_option :provider_version_branch, banner: "BRANCH", desc: "The name of the branch the provider version belongs to.", :required => false
         method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag provider version with the name of the current git branch. Default: false"
         method_option :provider_app_version, aliases: "-a", desc: "Provider application version, required when publishing verification results", :required => false
         method_option :publish_verification_results, aliases: "-r", desc: "Publish verification results to the broker. This can also be enabled by setting the environment variable PACT_BROKER_PUBLISH_VERIFICATION_RESULTS=true", required: false, type: :boolean, default: false
@@ -38,6 +39,7 @@ module Pact
         method_option :wait, banner: "SECONDS", required: false, type: :numeric, desc: "The number of seconds to poll for the provider to become available before running the verification", default: 0
         method_option :log_dir, desc: "The directory for the pact.log file"
         method_option :log_level, desc: "The log level", default: "debug"
+        method_option :fail_if_no_pacts_found, desc: "If specified, will fail when no pacts are found", required: false, type: :boolean, default: false
 
         def verify(*pact_urls)
           require 'pact/provider_verifier/app'
@@ -124,7 +126,7 @@ module Pact
             exit 1
           end
 
-          def exit_on_failure?
+          def self.exit_on_failure?
             true
           end
         end

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.34.0"
+    VERSION = "1.36.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Matt Fellows
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.55'
+        version: '1.59'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.55'
+        version: '1.59'
 - !ruby/object:Gem::Dependency
   name: pact-message
   requirement: !ruby/object:Gem::Requirement
@@ -342,7 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.27
 signing_key: 
 specification_version: 4
 summary: Provides a Pact verification service for use with Pact