pact-provider-verifier 1.28.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d1650e2874f85a92584bd114367df7d3df6c86030249c7d754ea05553e336cb
-  data.tar.gz: 4ae568f9c7c34942ea6a5245d93d47edbc67d13631535beb35ab8d43c06e55be
+  metadata.gz: c886b7356a0fa2d7750fb31bbbc9f7854788dff7dd8d28749ea4b5c89c5689e6
+  data.tar.gz: 956fb187e48661027ecdcda1197e6ccecd1ebd172b8eba29993a6ddd38b0976c
 SHA512:
-  metadata.gz: 1fbeab699e77f4c6ef85a5b4dfd5ff83165e091dbc3a0f455b363e30cf45f90a25489e65e1d6e7616fd6b698d9022cd97df05a35873a5f248cc8eff934d87fe8
-  data.tar.gz: 331ebcaaa81632a537b94af9582b38ab2b0fbec4c937db0835bf8390ed92d08a12ab03888e8f9f8f81a1e3899edc9bfe0f5560118ebc8c619e3832f7ff8ee55e
+  metadata.gz: 91ea65f6b83fd5940a30d85c40a1c02e3aac44431eb0aa27904752865c9bdc2e0a500d4a2e3c753d617b3a84bb97eddae4bc3ff02ff33110dc6d76f493d730b7
+  data.tar.gz: 166d2b4da14375b27712ed057bef42ee29e5eeeca62702078f26bd03eab1bb91e7c1fcde0170e9696ea0065539c1ecfebecfb0d0c9871e4a615daa33c03676d9

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+<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)
+
+
+#### Features
+
+* add --log-dir and --log-level to CLI	 ([1cf71bb](/../../commit/1cf71bb))
+
+
+<a name="v1.30.1-1"></a>
+### v1.30.1-1 (2020-04-22)
+
+
+#### Bug Fixes
+
+* use symbol names for consumer version selectors	 ([c2c986b](/../../commit/c2c986b))
+* correctly handle multiple parameters specified in the format --name=value	 ([c0852d0](/../../commit/c0852d0))
+
+
+<a name="v1.30.0-1"></a>
+### v1.30.0-1 (2020-02-19)
+
+
+#### Features
+
+* **cli**
+  * add --include-wip-pacts-since (hidden until publicly released)	 ([3109ce2](/../../commit/3109ce2))
+
+
+<a name="v1.29.0-1"></a>
+### v1.29.0-1 (2020-02-18)
+
+
+#### Features
+
+* **cli**
+  * raise an error when basic auth credentials and bearer token are set at the same time	 ([7f4507e](/../../commit/7f4507e))
+
+
 <a name="v1.28.0-1"></a>
 ### v1.28.0-1 (2020-01-22)
 

data/README.md

@@ -17,7 +17,7 @@ binary-like CLI tool.
 
 ### Docker
 
-Take a look at https://github.com/DiUS/pact-provider-verifier-docker or https://github.com/pact-foundation/pact-ruby-cli
+Take a look at https://hub.docker.com/r/pactfoundation/pact-cli
 
 ### Native Installation
 
@@ -41,55 +41,88 @@ 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.
-      [--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.
+          # 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
   -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
+          # 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
 
 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.
+  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 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 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) and 'latest' (true|false). For example '{"tag": "master", "latest":
-  true}'. For a detailed explanation of selectors, see https://pact.io/selectors
+  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/aggregate_pact_configs.rb

@@ -57,7 +57,10 @@ module Pact
       end
 
       def pact_options
-        { include_pending_status: options[:enable_pending] }
+        {
+          include_pending_status: options[:enable_pending],
+          include_wip_pacts_since: options[:include_wip_pacts_since]
+        }
       end
     end
   end

data/lib/pact/provider_verifier/app.rb

@@ -97,6 +97,8 @@ module Pact
           require 'pact/configuration'
           Pact.configuration.output_stream = Pact.configuration.error_stream
         end
+        Pact.configuration.log_dir = options.log_dir if options.log_dir
+        Pact.configuration.logger.level = Kernel.const_get('Logger').const_get(options.log_level.upcase) if options.log_level
       end
 
       def configure_reverse_proxy
@@ -134,7 +136,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
@@ -157,9 +159,6 @@ module Pact
             pact_helper: PROXY_PACT_HELPER,
             pact_uri: pact_uri,
             backtrace: ENV['BACKTRACE'] == 'true',
-            pact_broker_username: options.broker_username,
-            pact_broker_password: options.broker_password,
-            pact_broker_token: options.broker_token,
             format: options.format,
             out: options.out,
             request_customizer: ProviderStates::AddProviderStatesHeader
@@ -191,7 +190,11 @@ module Pact
           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
+          verbose: verbose?
+        }
+        opts = {
+          enable_pending: options.enable_pending,
+          include_wip_pacts_since: options.include_wip_pacts_since
         }
         AggregatePactConfigs.call(
           pact_urls,
@@ -201,8 +204,7 @@ module Pact
           provider_version_tags,
           options.pact_broker_base_url || ENV['PACT_BROKER_BASE_URL'],
           http_client_options,
-          { enable_pending: options.enable_pending }
-          )
+          opts)
       end
 
       def require_pact_project_pact_helper
@@ -229,7 +231,7 @@ module Pact
       end
 
       def parse_consumer_version_selectors consumer_version_selectors
-        consumer_version_selectors.collect{ | string | JSON.parse(string) }
+        consumer_version_selectors.collect{ | string | JSON.parse(string, symbolize_names: true) }
       end
 
       def merge_provider_version_tags(options)
@@ -260,6 +262,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/custom_thor.rb

@@ -45,20 +45,31 @@ module Pact
           def self.turn_muliple_tag_options_into_array argv
             new_argv = []
             opt_name = nil
-            argv.each_with_index do | arg, i |
-              if arg.start_with?('-')
-                opt_name = arg
-                existing = new_argv.find { | a | a.first == opt_name }
-                if !existing
-                  new_argv << [arg]
+            argv.each_with_index do | word, i |
+              if word.start_with?('-')
+                if word.include?('=')
+                  opt_name, opt_value = word.split('=', 2)
+
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if existing
+                    existing << opt_value
+                  else
+                    new_argv << [opt_name, opt_value]
+                  end
+                else
+                  opt_name = word
+                  existing = new_argv.find { | a | a.first == opt_name }
+                  if !existing
+                    new_argv << [word]
+                  end
                 end
               else
                 if opt_name
                   existing = new_argv.find { | a | a.first == opt_name }
-                  existing << arg
+                  existing << word
                   opt_name = nil
                 else
-                  new_argv << [arg]
+                  new_argv << [word]
                 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 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 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

@@ -3,26 +3,16 @@ 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
       class Verify < CustomThor
 
         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"
+        class AuthError < ::Thor::Error; end
 
         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
@@ -31,22 +21,25 @@ module Pact
         method_option :broker_token, aliases: "-k", desc: "Pact Broker bearer token. Can also be set using the environment variable PACT_BROKER_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 :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 :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, 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."
         method_option :ignore_failures, type: :boolean, default: false, desc: "If specified, process will always exit with exit code 0", hide: true
         method_option :pact_urls, aliases: "-u", hide: true, :required => false
         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"
 
         def verify(*pact_urls)
           validate_verify
@@ -80,6 +73,27 @@ module Pact
               raise InvalidArgumentsError, "No value provided for required option '--provider'"
             end
             validate_consumer_version_selectors
+            validate_wip_since_date
+            validate_credentials
+            validate_log_level
+          end
+
+          def validate_credentials
+            if (options.broker_username || ENV['PACT_BROKER_USERNAME']) && (options.broker_token || ENV['PACT_BROKER_TOKEN'])
+              raise AuthError, "You cannot provide both a username/password and a bearer token. If your Pact Broker uses a bearer token, please remove the username and password configuration."
+            end
+          end
+
+          def validate_wip_since_date
+            require 'date'
+
+            if options.include_wip_pacts_since
+              begin
+                DateTime.parse(options.include_wip_pacts_since)
+              rescue ArgumentError
+                raise InvalidArgumentsError, "The value provided for --include-wip-pacts-since could not be parsed to a DateTime. Please provide a value in the format %Y-%m-%d or %Y-%m-%dT%H:%M:%S.000%:z"
+              end
+            end
           end
 
           def validate_consumer_version_selectors
@@ -97,6 +111,15 @@ module Pact
             end
           end
 
+          def validate_log_level
+            if options.log_level
+              valid_log_levels = %w{debug info warn error fatal}
+              if !valid_log_levels.include?(options.log_level.downcase)
+                raise InvalidArgumentsError, "Invalid log level '#{options.log_level}'. Must be one of: #{valid_log_levels.join(", ")}."
+              end
+            end
+          end
+
           def exit_with_non_zero_status
             exit 1
           end

data/lib/pact/provider_verifier/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module ProviderVerifier
-    VERSION = "1.28.0"
+    VERSION = "1.32.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-provider-verifier
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.32.0
 platform: ruby
 authors:
 - Matt Fellows
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-22 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,20 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.46'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.46.1
+        version: '1.49'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.46'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.46.1
+        version: '1.49'
 - !ruby/object:Gem::Dependency
   name: pact-message
   requirement: !ruby/object:Gem::Requirement
@@ -281,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
@@ -302,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
@@ -333,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.1.4
 signing_key: 
 specification_version: 4
 summary: Provides a Pact verification service for use with Pact