pact 1.28.0 → 1.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5574afeb058510333631c49794bddac105131115
-  data.tar.gz: 89806235aea0cdbee6639a035e2f5a8a31d1111b
+SHA256:
+  metadata.gz: 36cdbcc7291013248a5b691e8dec77f7153fd3c5c75d664e5da651943a8673dc
+  data.tar.gz: 0a75d19524d85f5623f6f8f9b042b1e481f551a5784cb2c48e86633f2d3d7329
 SHA512:
-  metadata.gz: '0390c191e18ee7442e1a72ec3aca47094d1e540f84d7c47c5b4284e0263f177464fb3230892e0266d6aa7c880e28beeabbebb17d394878e644ba339028019728'
-  data.tar.gz: fd382cd61c88b3ad551c0de1c6490567d4f09d5b1f5bf1b1ea58b9ff3b4f77339f74c7b432b53b94355d42aea0f9f1816bd1a3c6f4b7203c461d4352a2333064
+  metadata.gz: faa46bb073cdacca555022ee518d15e13182f286f1b6d75f309f7f5d6d6692674c046ced1d3b8598d10772b7dc25d3157aa556d6ac47453753dc90607ed8575b
+  data.tar.gz: 360a99577f6925e21ab6ce0949bca79a3309c1a16e7dbd21ae72fe20b7c46a87eca0f422d810061d2adc594141b76ca4be831eeb8859aff29eca00fe9227f78e

data/CHANGELOG.md

@@ -1,3 +1,411 @@
+<a name="v1.53.0"></a>
+### v1.53.0 (2020-09-11)
+
+#### Features
+
+* add support for the enable_pending flag	 ([16866f4](/../../commit/16866f4))
+
+<a name="v1.52.0"></a>
+### v1.52.0 (2020-09-10)
+
+#### Features
+
+* support webdav http methods	 ([fa1d712](/../../commit/fa1d712))
+
+<a name="v1.51.1"></a>
+### v1.51.1 (2020-08-12)
+
+#### Bug Fixes
+
+* update thor dependency (#218)	 ([bf3ce69](/../../commit/bf3ce69))
+* bump rake dependency per CVE-2020-8130 (#219)	 ([09feaa6](/../../commit/09feaa6))
+
+<a name="v1.51.0"></a>
+### v1.51.0 (2020-06-24)
+
+
+#### Features
+
+* allow individual interactions to be re-run by setting PACT_BROKER_INTERACTION_ID	 ([a586d80](/../../commit/a586d80))
+
+
+<a name="v1.50.1"></a>
+### v1.50.1 (2020-06-15)
+
+
+#### Bug Fixes
+
+* fix integration with pact-message-ruby (#216)	 ([d2da13e](/../../commit/d2da13e))
+
+
+<a name="v1.50.0"></a>
+### v1.50.0 (2020-04-25)
+
+
+#### Features
+
+* Set expected interactions on mock service but without writing them to pact file (#210)	 ([14f5327](/../../commit/14f5327))
+
+
+<a name="v1.49.3"></a>
+### v1.49.3 (2020-04-22)
+
+
+#### Bug Fixes
+
+* pact selection verification options logging	 ([9ff59f4](/../../commit/9ff59f4))
+
+
+<a name="v1.49.2"></a>
+### v1.49.2 (2020-04-08)
+
+
+#### Bug Fixes
+
+* json parser error for top level JSON values	 ([dafbc35](/../../commit/dafbc35))
+
+
+<a name="v1.49.1"></a>
+### v1.49.1 (2020-03-21)
+
+
+#### Bug Fixes
+
+* ensure diff is included in the json output	 ([0bd9753](/../../commit/0bd9753))
+* ensure the presence of basic auth credentials does not cause an error when displaying the path of a pact on the local filesystem	 ([f6a0b4d](/../../commit/f6a0b4d))
+
+
+<a name="v1.49.0"></a>
+### v1.49.0 (2020-02-18)
+
+
+#### Features
+
+* use environment variables PACT_BROKER_USERNAME and PACT_BROKER_PASSWORD when verifying a pact by URL, if the environment variables are present	 ([308f25d](/../../commit/308f25d))
+
+
+<a name="v1.48.0"></a>
+### v1.48.0 (2020-02-13)
+
+
+#### Features
+
+* use certificates from SSL_CERT_FILE and SSL_CERT_DIR environment variables in HTTP connections	 ([164912b](/../../commit/164912b))
+
+
+<a name="v1.47.0"></a>
+### v1.47.0 (2020-02-08)
+
+
+#### Features
+
+* update json formatter output	 ([376e47a](/../../commit/376e47a))
+* add pact metadata to json formatter	 ([6c6ddb8](/../../commit/6c6ddb8))
+
+
+<a name="v1.46.1"></a>
+### v1.46.1 (2020-01-22)
+
+
+#### Bug Fixes
+
+* send output messages to the correct stream when using the XML formatter	 ([e768a33](/../../commit/e768a33))
+
+
+<a name="v1.46.0"></a>
+### v1.46.0 (2020-01-22)
+
+
+#### Features
+
+* expose full notice object in JSON output	 ([bdc2711](/../../commit/bdc2711))
+
+
+#### Bug Fixes
+
+* remove accidentally committed verbose: true	 ([498518c](/../../commit/498518c))
+
+
+<a name="v1.45.0"></a>
+### v1.45.0 (2020-01-21)
+
+
+#### Features
+
+* use custom json formatter when --format json is specified and send it straight to stdout or the configured file	 ([6c703a1](/../../commit/6c703a1))
+* support pending pacts in json formatter	 ([2c0d20d](/../../commit/2c0d20d))
+
+
+#### Bug Fixes
+
+* show pending test output in yellow instead of red	 ([e8d4a55](/../../commit/e8d4a55))
+
+
+<a name="v1.44.1"></a>
+### v1.44.1 (2020-01-20)
+
+
+#### Bug Fixes
+
+* print notices from 'pacts for verification' response to indicate why pacts are included an/or pending	 ([b107348](/../../commit/b107348))
+
+
+<a name="v1.44.0"></a>
+### v1.44.0 (2020-01-16)
+
+
+#### Features
+
+* **message pact**
+  * add DSL for configuring Message Pact verifications	 ([a5181b6](/../../commit/a5181b6))
+
+
+<a name="v1.43.1"></a>
+### v1.43.1 (2020-01-11)
+
+
+#### Bug Fixes
+
+* use configured credentials when fetching the diff with previous version	 ([b9deb09](/../../commit/b9deb09))
+* use URI.open instead of Kernel.open	 ([7b3ea81](/../../commit/7b3ea81))
+
+
+<a name="v1.43.0"></a>
+### v1.43.0 (2020-01-11)
+
+
+#### Features
+
+* **verify**
+  * allow includePendingStatus to be specified when fetching pacts	 ([1f5fc9c](/../../commit/1f5fc9c))
+
+
+<a name="v1.42.3"></a>
+### v1.42.3 (2019-11-15)
+
+
+#### Bug Fixes
+
+* **verify**
+  * exit with status 0 if all pacts are in pending state	 ([2f7110b](/../../commit/2f7110b))
+
+
+<a name="v1.42.2"></a>
+### v1.42.2 (2019-11-09)
+
+
+#### Bug Fixes
+
+* remove missed &.	 ([be700d8](/../../commit/be700d8))
+
+
+<a name="v1.42.1"></a>
+### v1.42.1 (2019-11-09)
+
+
+#### Bug Fixes
+
+* can't use safe navigation operator because of Ruby 2.2 in Travelling Ruby for the pact-ruby-standalone	 ([3068ceb](/../../commit/3068ceb))
+
+
+<a name="v1.42.0"></a>
+### v1.42.0 (2019-09-26)
+
+
+#### Features
+
+* use new 'pacts for verification' endpoint to retrieve pacts (#199)	 ([55bb935](/../../commit/55bb935))
+
+
+<a name="v1.41.2"></a>
+### v1.41.2 (2019-09-10)
+
+
+#### Bug Fixes
+
+* **pact_helper_locator**
+  * add 'test' dir to file patterns (#196)	 ([746883d](/../../commit/746883d))
+
+* file upload spec	 ([0fe072c](/../../commit/0fe072c))
+
+
+<a name="v1.41.1"></a>
+### v1.41.1 (2019-09-04)
+
+
+#### Bug Fixes
+
+* use to_json instead of JSON.dump because it generates different JSON when used in conjuction with other libraries (eg. Oj)	 ([14566fb](/../../commit/14566fb))
+
+
+<a name="v1.41.0"></a>
+### v1.41.0 (2019-05-22)
+
+
+#### Features
+
+* redact Authorization header from HTTP client debug output	 ([c48c991](/../../commit/c48c991))
+
+
+<a name="v1.40.0"></a>
+### v1.40.0 (2019-02-22)
+
+
+#### Features
+
+* remove ruby 2.2 tests	 ([4a30791](/../../commit/4a30791))
+* add support for bearer token	 ([297268d](/../../commit/297268d))
+
+
+<a name="v1.39.0"></a>
+### v1.39.0 (2019-02-21)
+
+
+#### Features
+
+* allow host of mock service to be specified	 ([de267bd](/../../commit/de267bd))
+
+
+<a name="v1.38.0"></a>
+### v1.38.0 (2019-02-11)
+
+
+#### Features
+
+* unlock rack-test dependency to allow version 1.1.0	 ([b0c40f6](/../../commit/b0c40f6))
+* update http client code	 ([bba3a08](/../../commit/bba3a08))
+
+
+<a name="v1.37.0"></a>
+### v1.37.0 (2018-11-15)
+
+
+#### Features
+
+* **hal client**
+  * ensure meaningful error is displayed when HTTP errors are returned	 ([9244c14](/../../commit/9244c14))
+
+
+#### Bug Fixes
+
+* correct url encoding for expanded HAL links	 ([4abfe7d](/../../commit/4abfe7d))
+
+
+<a name="v1.36.2"></a>
+### v1.36.2 (2018-10-22)
+
+
+#### Bug Fixes
+
+* always execute global and base states	 ([8317fe3](/../../commit/8317fe3))
+
+
+<a name="v1.36.0"></a>
+### v1.36.0 (2018-10-04)
+
+
+#### Features
+
+* **v3**
+  * make provider state params available to set up and tear down blocks	 ([9593730](/../../commit/9593730))
+  * support set up and tear down of multiple provider states	 ([cbad0be](/../../commit/cbad0be))
+
+
+<a name="v1.34.0"></a>
+### v1.34.0 (2018-09-06)
+
+
+#### Features
+
+* **verify**
+  * add request customizer for pact-provider-verifier	 ([4ae0b58](/../../commit/4ae0b58))
+
+
+#### Bug Fixes
+
+* add missing require for net/http	 ([fe2ebb1](/../../commit/fe2ebb1))
+
+
+<a name="v1.33.2"></a>
+### v1.33.2 (2018-09-06)
+
+
+#### Bug Fixes
+
+* add missing requires for pact/errors	 ([0e01451](/../../commit/0e01451))
+
+
+<a name="v1.33.1"></a>
+### v1.33.1 (2018-08-28)
+
+
+#### Features
+
+* rename 'wip pacts' to 'pending pacts'	 ([6a46ebb](/../../commit/6a46ebb))
+
+* **verify cli**
+  * rename --wip to --ignore-failures	 ([8e2dffd](/../../commit/8e2dffd))
+
+
+#### Bug Fixes
+
+* correct version for dependency on pact-mock_service	 ([01c0df7](/../../commit/01c0df7))
+
+
+<a name="v1.33.0"></a>
+### v1.33.0 (2018-08-07)
+
+
+#### Features
+
+* update version of pact-mock_service	 ([25a04fb](/../../commit/25a04fb))
+* add support for multipart/form requests	 ([7a16ab1](/../../commit/7a16ab1))
+
+
+<a name="v1.32.0"></a>
+### v1.32.0 (2018-07-25)
+
+
+#### Features
+
+* add actual pact message contents to results published to Pact Broker	 ([09e9d89](/../../commit/09e9d89))
+
+
+<a name="v1.31.0"></a>
+### v1.31.0 (2018-07-25)
+
+
+#### Features
+
+* publish beta format of individual interaction results to Pact Broker	 ([6742afa](/../../commit/6742afa))
+
+
+<a name="v1.30.0"></a>
+### v1.30.0 (2018-07-24)
+
+
+#### Features
+
+* raise error when an expected HAL relation cannot be found in a resource	 ([5db4134](/../../commit/5db4134))
+
+
+<a name="v1.29.0"></a>
+### v1.29.0 (2018-07-24)
+
+
+#### Features
+
+* return plain string URLs from Pact::PactBroker.fetch_pact_uris	 ([1aa1989](/../../commit/1aa1989))
+* use beta:wip-provider-pacts rather than pb:wip-provider-pacts to fetch WIP pacts	 ([3bb0501](/../../commit/3bb0501))
+* allow WIP pacts to be verified without causing the process to return an non zero exit code	 ([9e6de46](/../../commit/9e6de46))
+
+
+#### Bug Fixes
+
+* add missing require	 ([0aa2d2a](/../../commit/0aa2d2a))
+* default pact specification version to 2	 ([917891a](/../../commit/917891a))
+
+
 <a name="v1.28.0"></a>
 ### v1.28.0 (2018-06-24)
 

data/lib/pact/cli/run_pact_verification.rb

@@ -3,7 +3,6 @@ require 'pact/cli/spec_criteria'
 module Pact
   module Cli
     class RunPactVerification
-
       attr_reader :options
 
       def initialize options
@@ -15,6 +14,7 @@ module Pact
       end
 
       def call
+        configure_output
         initialize_rspec
         setup_load_path
         load_pact_helper
@@ -44,23 +44,32 @@ module Pact
       end
 
       def run_specs
-        exit_code = if options[:pact_uri]
-          run_with_pact_uri
+        exit_code = if options[:pact_uri].is_a?(String)
+          run_with_pact_url_string
+        elsif options[:pact_uri]
+          run_with_pact_uri_object # from pact-provider-verifier
         else
-          run_with_configured_pacts
+          run_with_configured_pacts_from_pact_helper
         end
         exit exit_code
       end
 
-      def run_with_pact_uri
+      def run_with_pact_url_string
         pact_repository_uri_options = {}
+        pact_repository_uri_options[:username] = ENV['PACT_BROKER_USERNAME'] if ENV['PACT_BROKER_USERNAME']
+        pact_repository_uri_options[:password] = ENV['PACT_BROKER_PASSWORD'] if ENV['PACT_BROKER_PASSWORD']
+        pact_repository_uri_options[:token] = ENV['PACT_BROKER_TOKEN']
         pact_repository_uri_options[:username] = options[:pact_broker_username] if options[:pact_broker_username]
         pact_repository_uri_options[:password] = options[:pact_broker_password] if options[:pact_broker_password]
         pact_uri = ::Pact::Provider::PactURI.new(options[:pact_uri], pact_repository_uri_options)
         Pact::Provider::PactSpecRunner.new([pact_uri], pact_spec_options).run
       end
 
-      def run_with_configured_pacts
+      def run_with_pact_uri_object
+        Pact::Provider::PactSpecRunner.new([options[:pact_uri]], pact_spec_options).run
+      end
+
+      def run_with_configured_pacts_from_pact_helper
         pact_urls = Pact.provider_world.pact_urls
         raise "Please configure a pact to verify" if pact_urls.empty?
         Pact::Provider::PactSpecRunner.new(pact_urls, pact_spec_options).run
@@ -71,9 +80,19 @@ module Pact
           full_backtrace: options[:backtrace],
           criteria: SpecCriteria.call(options),
           format: options[:format],
-          out: options[:out]
+          out: options[:out],
+          ignore_failures: options[:ignore_failures],
+          request_customizer: options[:request_customizer]
         }
       end
+
+      def configure_output
+        if options[:format] == 'json' && !options[:out]
+          # Don't want to mess up the JSON parsing with messages to stdout, so send it to stderr
+          require 'pact/configuration'
+          Pact.configuration.output_stream = Pact.configuration.error_stream
+        end
+      end
     end
   end
 end

data/lib/pact/cli/spec_criteria.rb

@@ -6,8 +6,11 @@ module Pact
         criteria = {}
 
         criteria[:description] = Regexp.new(options[:description]) if options[:description]
+        criteria[:_id] = options[:pact_broker_interaction_id] if options[:pact_broker_interaction_id]
+        criteria[:index] = options[:interaction_index] if options[:interaction_index]
 
         provider_state = options[:provider_state]
+
         if provider_state
           if provider_state.length == 0
             criteria[:provider_state] = nil #Allow PACT_PROVIDER_STATE="" to mean no provider state

data/lib/pact/cli.rb

@@ -4,18 +4,25 @@ require 'pact/provider/configuration'
 
 module Pact
   class CLI < Thor
+    def self.exit_on_failure? # Thor 1.0 deprecation guard
+      false
+    end
 
     desc 'verify', "Verify a pact"
     method_option :pact_helper, aliases: "-h", desc: "Pact helper file", :required => true
     method_option :pact_uri, aliases: "-p", desc: "Pact URI"
+    method_option :ignore_failures, type: :boolean, default: false, desc: "Process will always exit with exit code 0", hide: true
     method_option :pact_broker_username, aliases: "-u", desc: "Pact broker user name"
     method_option :pact_broker_password, aliases: "-w", desc: "Pact broker password"
+    method_option :pact_broker_token, aliases: "-k", desc: "Pact broker token"
     method_option :backtrace, aliases: "-b", desc: "Show full backtrace", :default => false, :type => :boolean
     method_option :interactions_replay_order, aliases: "-o",
                   desc: "Interactions replay order: randomised or recorded (default)",
                   default: Pact.configuration.interactions_replay_order
     method_option :description, aliases: "-d", desc: "Interaction description filter"
     method_option :provider_state, aliases: "-s", desc: "Provider state filter"
+    method_option :interaction_index, type: :numeric, desc: "Index filter"
+    method_option :pact_broker_interaction_id, desc: "Pact Broker interaction ID filter"
     method_option :format, aliases: "-f", banner: "FORMATTER", desc: "RSpec formatter. Defaults to custom Pact formatter. [j]son may also be used."
     method_option :out, aliases: "-o", banner: "FILE", desc: "Write output to a file instead of $stdout."
 
@@ -33,6 +40,5 @@ module Pact
       require 'pact/doc/generator'
       Pact::Doc::Generate.call(options[:pact_dir], options[:doc_dir], [Pact::Doc::Markdown::Generator])
     end
-
   end
 end

data/lib/pact/consumer/configuration/dsl.rb

@@ -1,7 +1,6 @@
 require 'pact/consumer/configuration/service_consumer'
 
 module Pact
-
   module Consumer
     module DSL
       def service_consumer name, &block

data/lib/pact/consumer/configuration/mock_service.rb

@@ -11,16 +11,17 @@ module Pact
 
         extend Pact::DSL
 
-        attr_accessor :port, :standalone, :verify, :provider_name, :consumer_name, :pact_specification_version
+        attr_accessor :port, :host, :standalone, :verify, :provider_name, :consumer_name, :pact_specification_version
 
         def initialize name, consumer_name, provider_name
           @name = name
           @consumer_name = consumer_name
           @provider_name = provider_name
           @port = nil
+          @host = "localhost"
           @standalone = false
           @verify = true
-          @pact_specification_version = nil
+          @pact_specification_version = '2'
           @finalized = false
         end
 
@@ -29,6 +30,10 @@ module Pact
             self.port = port
           end
 
+          def host host
+            self.host = host
+          end
+
           def standalone standalone
             self.standalone = standalone
           end
@@ -53,7 +58,7 @@ module Pact
 
         def register_mock_service
           unless standalone
-            url = "http://localhost#{port.nil? ? '' : ":#{port}"}"
+            url = "http://#{host}#{port.nil? ? '' : ":#{port}"}"
             ret = Pact::MockService::AppManager.instance.register_mock_service_for(provider_name, url, mock_service_options)
             raise "pact-mock_service(v#{Pact::MockService::VERSION}) does not support 'find available port' feature" unless ret
             @port = ret
@@ -73,6 +78,7 @@ module Pact
             :provider_name => provider_name,
             :pactfile_write_mode => Pact.configuration.pactfile_write_mode,
             :port => port,
+            :host => host,
             :pact_dir => Pact.configuration.pact_dir
           }
           Pact::Consumer::ConsumerContractBuilder.new consumer_contract_builder_fields

data/lib/pact/consumer/consumer_contract_builder.rb

@@ -21,8 +21,12 @@ module Pact
           pactfile_write_mode: attributes[:pactfile_write_mode].to_s,
           pact_dir: attributes.fetch(:pact_dir)
         }
-        @mock_service_client = Pact::MockService::Client.new(attributes[:port])
-        @mock_service_base_url = "http://localhost:#{attributes[:port]}"
+        @mock_service_client = Pact::MockService::Client.new(attributes[:port], attributes[:host])
+        @mock_service_base_url = "http://#{attributes[:host]}:#{attributes[:port]}"
+      end
+
+      def without_writing_to_pact
+        interaction_builder.without_writing_to_pact
       end
 
       def given(provider_state)

data/lib/pact/consumer/interaction_builder.rb

@@ -13,6 +13,12 @@ module Pact
         @callback = block
       end
 
+      def without_writing_to_pact
+        interaction.metadata ||= {}
+        interaction.metadata[:write_to_pact] = false
+        self
+      end
+
       def upon_receiving description
         @interaction.description = description
         self

data/lib/pact/consumer/spec_hooks.rb

@@ -15,8 +15,8 @@ module Pact
       def before_each example_description
         Pact.consumer_world.register_pact_example_ran
         Pact.configuration.logger.info "Clearing all expectations"
-        Pact::MockService::AppManager.instance.ports_of_mock_services.each do | port |
-          Pact::MockService::Client.clear_interactions port, example_description
+        Pact::MockService::AppManager.instance.urls_of_mock_services.each do | url |
+          Pact::MockService::Client.clear_interactions url, example_description
         end
       end
 
@@ -29,7 +29,7 @@ module Pact
 
       def after_suite
         if Pact.consumer_world.any_pact_examples_ran?
-          Pact.consumer_world.consumer_contract_builders.each { | c | c.write_pact }
+          Pact.consumer_world.consumer_contract_builders.each(&:write_pact)
           Pact::Doc::Generate.call
           Pact::MockService::AppManager.instance.kill_all
           Pact::MockService::AppManager.instance.clear_all
@@ -37,4 +37,4 @@ module Pact
       end
     end
   end
-end
+end

data/lib/pact/doc/sort_interactions.rb

@@ -3,7 +3,7 @@ module Pact
     class SortInteractions
 
       def self.call interactions
-        interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
+        interactions.sort_by { |interaction| sortable_id(interaction) }
       end
 
       private
@@ -11,7 +11,6 @@ module Pact
       def self.sortable_id interaction
         "#{interaction.description.downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
       end
-
     end
   end
-end
+end