pact-provider-verifier 1.31.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44c17f0743c806ca23c26957d6011ed92fa7374cf25c2077e2d8fac967695d97
-  data.tar.gz: edd33bd8d49c5a74fb5ddac57f71cd9639963d207a24efe52638d0242a567c2c
+  metadata.gz: 40aec54d6032b2a63f96e834a0308e98f6093af635bf5450b6575d05eb7a8549
+  data.tar.gz: f445fbe3035fc931018214d5bad5f8e616e8dda0ba682a8051081505503796a6
 SHA512:
-  metadata.gz: 5e651daba957e5270412987777d03b253b54e662ee2205085f62a090eaaa405ab8fa6ecfc50db986365cbf35146c5f6568c4abb7d923f4146d9614e172eece82
-  data.tar.gz: d325e9aca5995fe88bba89b7fc6cd10e4a858a3c5cd3d540ae5e9b03b78454ad80d5ea6b46142cfbaa797c5ce7a59e77863e64773719b4a173ffad2bc2ab6031
+  metadata.gz: 6d9941c91fed0ca20106fc24077c20556ea3757aa3ca176718e50d1c903e5d6608620c5160916c5396908e30ecd01fa58e4c4a1e25654cbbe26cfaf1da312c61
+  data.tar.gz: 1317675953ae4ebecaa9c289deac2a7f09fda5ef3778f6dfada6651d5bc52a49ae5629fa8b55b63ea1d0755942be26b151ec0ad0a7ac6687d1f8b5bb77f2e036

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+<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)
+
+#### Features
+
+* Allow for newer versions of faraday	 ([c37f04f](/../../commit/c37f04f))
+
+<a name="v1.33.0"></a>
+### v1.33.0 (2021-01-27)
+
+#### Features
+
+* pass through verbose flag to verification	 ([a091705](/../../commit/a091705))
+
+<a name="v1.32.1"></a>
+### v1.32.1 (2020-07-18)
+
+
+#### Bug Fixes
+
+* change rake to a development dependency	 ([6249a03](/../../commit/6249a03))
+
+
+<a name="v1.32.0"></a>
+### v1.32.0 (2020-07-16)
+
+
+#### Features
+
+* allow verbose to be turned on by setting VERBOSE=true	 ([8a72b13](/../../commit/8a72b13))
+
+
 <a name="v1.31.0-1"></a>
 ### v1.31.0-1 (2020-06-23)
 

data/README.md

@@ -41,53 +41,90 @@ Usage:
 
 Options:
   -h, --provider-base-url=PROVIDER_BASE_URL
-              # Provider host URL
+          # Provider host URL
   -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]
-              # Base URL to setup the provider states at
+          # 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. Can also be set using the environment variable PACT_BROKER_BASE_URL.
+          # Base URL of the Pact Broker from which to retrieve the pacts. Can also be set
+            using the environment variable PACT_BROKER_BASE_URL.
   -n, [--broker-username=BROKER_USERNAME]
-              # Pact Broker basic auth username. Can also be set using the environment variable PACT_BROKER_USERNAME.
+          # Pact Broker basic auth username. Can also be set using the environment
+            variable PACT_BROKER_USERNAME.
   -p, [--broker-password=BROKER_PASSWORD]
-              # Pact Broker basic auth password. Can also be set using the environment variable PACT_BROKER_PASSWORD.
+          # Pact Broker basic auth password. Can also be set using the environment
+            variable PACT_BROKER_PASSWORD.
   -k, [--broker-token=BROKER_TOKEN]
-              # Pact Broker bearer token. Can also be set using the environment variable PACT_BROKER_TOKEN.
+          # Pact Broker bearer token. Can also be set using the environment variable
+            PACT_BROKER_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.
+          # 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.
+          # Tag to apply to the provider application version. May be specified multiple times.
   -g, [--tag-with-git-branch], [--no-tag-with-git-branch]
-              # Tag provider version with the name of the current git branch. Default: false
+          # Tag provider version with the name of the current git branch. Default: false
   -a, [--provider-app-version=PROVIDER_APP_VERSION]
-              # Provider application version, required when publishing verification results
+          # 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
+          # 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.
+          # 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!
+          # 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
+          # Verbose output. Can also be set by setting the environment variable VERBOSE=true.
   -f, [--format=FORMATTER]
-              # RSpec formatter. Defaults to custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml).
+          # 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.
+          # 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
+          # The number of seconds to poll for the provider to become available before
+            running the verification
 
-              # Default: 0
+          # Default: 0
+      [--log-dir=LOG_DIR]
+          # The directory for the pact.log file
+      [--log-level=LOG_LEVEL]
+          # The log level
+
+          # Default: debug
+      [--fail-if-no-pacts-found]
+          # If specified, will fail when no pacts are found
 
 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
+  The parameters used when fetching pacts dynamically from a Pact Broker are:
+
+  --pact-broker-base-url (REQUIRED)
+  --provider (REQUIRED)
+  --broker-username/--broker-password or --broker-token
+  --consumer-version-tag or --consumer-version-selector
+  --enable-pending
+  --include-wip-pacts-since
+
+  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:
+
+  --publish-verification-results (REQUIRED)
+  --provider-app-version (REQUIRED)
+  --provider-version-tag or --tag-with-git-branch
+
+
+  Selectors: These are specified using JSON strings. The keys are 'tag' (the name of the consumer
+  version tag), 'latest' (true|false), 'consumer', and 'fallbackTag'. For example '{\"tag\":
+\"master\", \"latest\": true}'. For
+  a detailed explanation of selectors, see https://pact.io/selectors#consumer-version-selectors
 ```
 
 ## Examples

data/lib/pact/provider_verifier/app.rb

@@ -36,18 +36,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
@@ -136,7 +141,7 @@ module Pact
 
       def require_custom_middlware
         options.custom_middleware.each do |file|
-          $stdout.puts "DEBUG: Requiring custom middleware file #{file}" if options.verbose
+          $stdout.puts "DEBUG: Requiring custom middleware file #{file}" if verbose?
           begin
             require file
           rescue LoadError => e
@@ -159,6 +164,7 @@ module Pact
             pact_helper: PROXY_PACT_HELPER,
             pact_uri: pact_uri,
             backtrace: ENV['BACKTRACE'] == 'true',
+            verbose: verbose?,
             format: options.format,
             out: options.out,
             request_customizer: ProviderStates::AddProviderStatesHeader
@@ -186,25 +192,34 @@ 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: options.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_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
@@ -262,6 +277,10 @@ module Pact
           ENV['PACT_BROKER_TOKEN'] = options.broker_token
         end
       end
+
+      def verbose?
+        options.verbose || ENV['VERBOSE'] == 'true'
+      end
     end
   end
 end

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

@@ -0,0 +1,19 @@
+The parameters used when fetching pacts dynamically from a Pact Broker are:
+
+--pact-broker-base-url (REQUIRED)
+--provider (REQUIRED)
+--broker-username/--broker-password or --broker-token
+--consumer-version-tag or --consumer-version-selector
+--enable-pending
+--include-wip-pacts-since
+
+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:
+
+--publish-verification-results (REQUIRED)
+--provider-app-version (REQUIRED)
+--provider-version-tag or --tag-with-git-branch
+
+
+Selectors: These are specified using JSON strings. The keys are 'tag' (the name of the consumer version tag), 'latest' (true|false), 'consumer', and 'fallbackTag'. For example '{\"tag\": \"master\", \"latest\": true}'. For a detailed explanation of selectors, see https://pact.io/selectors#consumer-version-selectors

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

@@ -1,14 +1,6 @@
 require 'thor'
-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
@@ -17,13 +9,8 @@ module Pact
         class InvalidArgumentsError < ::Thor::Error; end
         class AuthError < ::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
+        long_desc File.read(File.join(File.dirname(__FILE__), 'long_desc.txt')).gsub("\n", "\x5")
         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. Can also be set using the environment variable PACT_BROKER_BASE_URL.", :required => false
@@ -37,12 +24,12 @@ module Pact
         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
-        method_option :enable_pending, hide: true, 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 :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 :include_wip_pacts_since, desc: "", hide: true
         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
-        method_option :verbose, aliases: "-v", desc: "Verbose output", :required => false
+        method_option :verbose, aliases: "-v", desc: "Verbose output. Can also be set by setting the environment variable VERBOSE=true.", :required => false
         method_option :provider_states_url, aliases: "-s", :required => false, hide: true
         method_option :format, banner: "FORMATTER", aliases: "-f", desc: "RSpec formatter. Defaults to custom Pact formatter. Other options are json and RspecJunitFormatter (which outputs xml)."
         method_option :out, aliases: "-o", banner: "FILE", desc: "Write output to a file instead of $stdout."
@@ -51,8 +38,11 @@ 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'
+          require 'socket'
           validate_verify
           print_deprecation_warnings
           success = Pact::ProviderVerifier::App.call(merged_urls(pact_urls), options)

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.31.0"
+    VERSION = "1.35.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Matt Fellows
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: '1.55'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: '1.55'
 - !ruby/object:Gem::Dependency
   name: pact-message
   requirement: !ruby/object:Gem::Requirement
@@ -57,36 +57,42 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -116,53 +122,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-reverse-proxy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-reverse-proxy
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
+        version: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -275,6 +275,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: word_wrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   A cross-platform Pact verification tool to validate API Providers.
                         Used in the pact-js-provider project to simplify development
@@ -296,6 +310,7 @@ files:
 - lib/pact/provider_verifier/aggregate_pact_configs.rb
 - lib/pact/provider_verifier/app.rb
 - lib/pact/provider_verifier/cli/custom_thor.rb
+- lib/pact/provider_verifier/cli/long_desc.txt
 - lib/pact/provider_verifier/cli/verify.rb
 - lib/pact/provider_verifier/custom_middleware.rb
 - lib/pact/provider_verifier/error.rb
@@ -327,8 +342,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Provides a Pact verification service for use with Pact