pact-provider-verifier 1.25.2 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ff87fe21756ab67a80de863c8902f41f9302844a3b3e3e5808bb5cd7da59a8
-  data.tar.gz: 902737cbe85072fe7bc8c4c53957079455b3742bf7a35d247af12a77c5bbdea2
+  metadata.gz: 2353417f47f75fbb238b3401c5ddbfa5dc98766f83ac1e78105a246420549636
+  data.tar.gz: abc6c780757ba1153318867cd8869883c6bbae1bee245a0504d3ed4b39708704
 SHA512:
-  metadata.gz: 73c8224015d7656ed468b72591006fe49f7492aa38ed91282f0bd9263382a2f3e4679c96719a82548234be50049f65fd05708c947f1f5881491f21d406e915db
-  data.tar.gz: 238530cf7fd77aa900157813d6c9428ebec74c166d60a0889a7719c25f549e354d418c891d1bce8b9e5589c7f4e1297cf87c0b836bbfbeee29df849336974854
+  metadata.gz: b700edfe49387ab05780793f5fb9c515041633e6e345ee4bd30a8d4fbe0e9a64f1a0a55dd1c9daef12ad03fcd9d497c0eef4cabb16a7090d999bea6f996700fe
+  data.tar.gz: 4ac919f6e3f8fa1e6fa15719b67c5cb6406c7de62e2b26cb67f828afdc872dbe1c75f695b1b43885ebb2b08a66f72672041b4740ef21e4fb5f1acc8d863d91a0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="v1.26.0-1"></a>
+### v1.26.0-1 (2020-01-11)
+
+
+#### Features
+
+* **cli**
+  * allow publishing of verification results to be enabled by setting the environment variable PACT_BROKER_PUBLISH_VERIFICATION_RESULTS=true	 ([14e37f0](/../../commit/14e37f0))
+  * add --enable-pending parameter to CLI	 ([0b32a1c](/../../commit/0b32a1c))
+  * add --consumer-version-selector parameter	 ([2526590](/../../commit/2526590))
+  * add long description	 ([905ab8d](/../../commit/905ab8d))
+
+
 <a name="v1.25.1-1"></a>
 ### v1.25.1-1 (2019-11-10)
 

data/README.md

@@ -40,24 +40,56 @@ Usage:
   pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
 
 Options:
-  -h, --provider-base-url=PROVIDER_BASE_URL                                  # Provider host URL
-  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]                # Base URL to setup the provider   states at
-      [--pact-broker-base-url=PACT_BROKER_BASE_URL]                          # Base URL of the Pact Broker from   which to retrieve the pacts.
-  -n, [--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
+  -h, --provider-base-url=PROVIDER_BASE_URL
+            # Provider host URL
+  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]
+            # Base URL to setup the provider states at
+      [--pact-broker-base-url=PACT_BROKER_BASE_URL]
+            # Base URL of the Pact Broker from which to retrieve the pacts.
+  -n, [--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
       [--provider=PROVIDER]
-      [--consumer-version-tag=TAG]                                           # Retrieve the latest pacts with   this consumer version tag. Used in conjunction with --provider. May be specified multiple times.
-      [--provider-version-tag=TAG]                                           # Tag to apply to the provider   application version. May be specified multiple times.
-  -a, [--provider-app-version=PROVIDER_APP_VERSION]                          # Provider application version,   required when publishing verification results
-  -r, [--publish-verification-results], [--no-publish-verification-results]  # Publish verification results to   the broker
-      [--custom-provider-header=CUSTOM_PROVIDER_HEADER]                      # Header to add to provider state   set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple   times.
-      [--custom-middleware=FILE]                                             # Ruby file containing a class   implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before   replaying. Use with caution!
-  -v, [--verbose=VERBOSE]                                                    # Verbose output
-  -f, [--format=FORMATTER]                                                   # RSpec formatter. Defaults to   custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml).
-  -o, [--out=FILE]                                                           # Write output to a file instead   of $stdout.
-      [--wait=SECONDS]                                                       # The number of seconds to poll for the provider to become available before running the verification
-                                                                           # Default: 0
+      [--consumer-version-tag=TAG]
+            # Retrieve the latest pacts with this consumer version tag. Used in conjunction with --provider. May be specified multiple times.
+      [--consumer-version-selector=SELECTOR]
+            # JSON string specifying a selector that identifies which pacts to verify. May be specified multiple times. See below for further documentation.
+      [--provider-version-tag=TAG]
+            # Tag to apply to the provider application version. May be specified multiple times.
+  -a, [--provider-app-version=PROVIDER_APP_VERSION]
+            # Provider application version, required when publishing verification results
+  -r, [--publish-verification-results], [--no-publish-verification-results]
+            # Publish verification results to the broker. This can also be enabled by setting the environment variable PACT_BROKER_PUBLISH_VERIFICATION_RESULTS=true
+      [--enable-pending], [--no-enable-pending]
+            # Allow pacts which are in pending state to be verified without causing the overall task to fail. For more information, see https://pact.io/pending
+      [--custom-provider-header=CUSTOM_PROVIDER_HEADER]
+            # Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.
+      [--custom-middleware=FILE]
+            # Ruby file containing a class implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before replaying. Use with caution!
+  -v, [--verbose=VERBOSE]
+            # Verbose output
+  -f, [--format=FORMATTER]
+            # RSpec formatter. Defaults to custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml).
+  -o, [--out=FILE]
+            # Write output to a file instead of $stdout.
+      [--wait=SECONDS]
+            # The number of seconds to poll for the provider to become available before running the verification
+
+            # Default: 0
+
+Description:
+  To verify a pact from a known URL, specify one or more PACT_URL arguments. If the pact is
+  hosted in a Pact Broker that uses authentication, specify the relevant
+  --broker-username/--broker-password or --broker-token fields. To dynamically fetch pacts
+  from a Pact Broker based on the provider name, specify the --pact-broker-base-url,
+  --provider and relevant authentication fields.
+
+  Selectors: These are specified using JSON strings. The keys are 'tag' (the name of the consumer
+  version tag) and 'latest' (true|false). For example '{"tag": "master", "latest": true}'.
+  For a detailed explanation of selectors, see https://pact.io/selectors
 ```
 
 ## Examples

data/lib/pact/provider_verifier/aggregate_pact_configs.rb

@@ -6,17 +6,19 @@ module Pact
   module ProviderVerifier
     class AggregatePactConfigs
 
-      def self.call(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options)
-        new(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options).call
+      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
       end
 
-      def initialize(pact_urls, provider_name, consumer_version_tags, provider_version_tags, pact_broker_base_url, http_client_options)
+      def initialize(pact_urls, provider_name, consumer_version_tags, consumer_version_selectors, 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_tags = provider_version_tags
         @pact_broker_base_url = pact_broker_base_url
         @http_client_options = http_client_options
+        @options = options
       end
 
       def call
@@ -25,7 +27,7 @@ module Pact
 
       private
 
-      attr_reader :pact_urls, :provider_name, :consumer_version_tags, :provider_version_tags, :pact_broker_base_url, :http_client_options
+      attr_reader :pact_urls, :provider_name, :consumer_version_tags, :consumer_version_selectors, :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) }
@@ -40,11 +42,22 @@ module Pact
       end
 
       def pacts_for_verification
-        @pacts_for_verification ||= Pact::PactBroker.fetch_pact_uris_for_verification(provider_name, consumer_version_selectors, provider_version_tags, pact_broker_base_url, http_client_options)
+        @pacts_for_verification ||= Pact::PactBroker.fetch_pact_uris_for_verification(
+          provider_name,
+          aggregated_consumer_version_selectors,
+          provider_version_tags,
+          pact_broker_base_url,
+          http_client_options,
+          pact_options
+        )
       end
 
-      def consumer_version_selectors
-        consumer_version_tags.collect{ |tag| { tag: tag, latest: true } }
+      def aggregated_consumer_version_selectors
+        consumer_version_selectors + consumer_version_tags.collect{ |tag| { tag: tag, latest: true } }
+      end
+
+      def pact_options
+        { include_pending_status: options[:enable_pending] }
       end
     end
   end

data/lib/pact/provider_verifier/app.rb

@@ -17,13 +17,15 @@ module Pact
       include Pact::WaitUntilServerAvailable
 
       PROXY_PACT_HELPER = File.expand_path(File.join(File.dirname(__FILE__), "pact_helper.rb"))
-      attr_reader :pact_urls, :options, :consumer_version_tags, :provider_version_tags
+      attr_reader :pact_urls, :options, :consumer_version_tags, :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] || []
         @provider_version_tags = options[:provider_version_tag] || []
+        @consumer_version_selectors = parse_consumer_version_selectors(options[:consumer_version_selector] || [])
+        @publish_verification_results = options.publish_verification_results || ENV['PACT_BROKER_PUBLISH_VERIFICATION_RESULTS'] == 'true'
       end
 
       def self.call pact_urls, options
@@ -82,7 +84,7 @@ module Pact
             app_version_tags this.provider_version_tags
           end
 
-          publish_verification_results this.options.publish_verification_results
+          publish_verification_results this.publish_verification_results
         end
       end
 
@@ -174,7 +176,16 @@ module Pact
 
       def all_pact_urls
         http_client_options = { username: options.broker_username, password: options.broker_password, token: options.broker_token, verbose: options.verbose }
-        AggregatePactConfigs.call(pact_urls, options.provider, consumer_version_tags, provider_version_tags, options.pact_broker_base_url, http_client_options)
+        AggregatePactConfigs.call(
+          pact_urls,
+          options.provider,
+          consumer_version_tags,
+          consumer_version_selectors,
+          provider_version_tags,
+          options.pact_broker_base_url,
+          http_client_options,
+          { enable_pending: options.enable_pending }
+          )
       end
 
       def require_pact_project_pact_helper
@@ -200,6 +211,10 @@ module Pact
         end
       end
 
+      def parse_consumer_version_selectors consumer_version_selectors
+        consumer_version_selectors.collect{ | string | JSON.parse(string) }
+      end
+
       def print_deprecation_note
         if options.provider_states_url
           $stderr.puts "WARN: The --provider-states-url option is deprecated and the URL endpoint can be removed from the application"

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

@@ -3,6 +3,12 @@ require 'socket'
 require 'pact/provider_verifier/app'
 require 'pact/provider_verifier/cli/custom_thor'
 
+# verify --consumer-version-selector '{ all: true, tag: "feat-x", fallback: "master" }' --consumer-version-tag master
+
+#
+# tags "master", { all: true, tag: "feat-x", fallback: "master" }
+#
+
 module Pact
   module ProviderVerifier
     module CLI
@@ -10,7 +16,13 @@ module Pact
 
         class InvalidArgumentsError < ::Thor::Error; end
 
+        SELECTOR_DOCS = "Selectors: These are specified using JSON strings. The keys are 'tag' (the name of the consumer version tag) and 'latest' (true|false). " +
+          "For example '{\"tag\": \"master\", \"latest\": true}'. For a detailed explanation of selectors, see https://pact.io/selectors"
+
         desc 'PACT_URL ...', "Verify pact(s) against a provider. Supports local and networked (http-based) files."
+        long_desc "To verify a pact from a known URL, specify one or more PACT_URL arguments. If the pact is hosted in a Pact Broker that uses authentication, specify the relevant --broker-username/--broker-password or --broker-token fields. " +
+                  "To dynamically fetch pacts from a Pact Broker based on the provider name, specify the --pact-broker-base-url, --provider and relevant authentication fields." +
+                  "\n\n" + SELECTOR_DOCS
         method_option :provider_base_url, aliases: "-h", desc: "Provider host URL", :required => true
         method_option :provider_states_setup_url, aliases: "-c", desc: "Base URL to setup the provider states at", :required => false
         method_option :pact_broker_base_url, desc: "Base URL of the Pact Broker from which to retrieve the pacts.", :required => false
@@ -19,9 +31,11 @@ module Pact
         method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token", :required => false
         method_option :provider, required: false
         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, 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_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", required: false, type: :boolean, default: 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
+        method_option :enable_pending, desc: "Allow pacts which are in pending state to be verified without causing the overall task to fail. For more information, see https://pact.io/pending", required: false, type: :boolean, default: false
         method_option :custom_provider_header, type: :array, banner: 'CUSTOM_PROVIDER_HEADER', desc: "Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.", :required => false
         method_option :custom_middleware, type: :array, banner: 'FILE', desc: "Ruby file containing a class implementing Pact::ProviderVerifier::CustomMiddleware. This allows the response to be modified before replaying. Use with caution!", :required => false
         method_option :monkeypatch, hide: true, type: :array, :required => false
@@ -64,6 +78,22 @@ module Pact
             if options.pact_broker_base_url && (options.provider.nil? || options.provider == "")
               raise InvalidArgumentsError, "No value provided for required option '--provider'"
             end
+            validate_consumer_version_selectors
+          end
+
+          def validate_consumer_version_selectors
+            error_messages = (options.consumer_version_selector || []).collect do | string |
+              begin
+                JSON.parse(string)
+                nil
+              rescue
+                "Invalid JSON string provided for --consumer-version-selector: #{string}"
+              end
+            end.compact
+
+            if error_messages.any?
+              raise InvalidArgumentsError, error_messages.join("\n")
+            end
           end
 
           def exit_with_non_zero_status

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.25.2"
+    VERSION = "1.26.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.25.2
+  version: 1.26.0
 platform: ruby
 authors:
 - Matt Fellows
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,20 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.42'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.42.3
+        version: '1.43'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.42'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.42.3
+        version: '1.43'
 - !ruby/object:Gem::Dependency
   name: pact-message
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement