pact 1.44.1 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4377cccb8581a6f7215bf6f451bf97ac5b32d9d2a2c1f0a1fd05925ae5dd2f83
-  data.tar.gz: e4b78191ae99e50678b1034843168edc125b1ba1a4fb2686bc25e50609b0c4dc
+  metadata.gz: 021b58b1630e4e9943572668e342498886c0373a728d88bb0acba4f2f05f8a73
+  data.tar.gz: ca7709d98dd311e2ded9d210b0ff4c51ecd38f62f278728f511d689a638055e9
 SHA512:
-  metadata.gz: cb2ae0b2b047c760b8336401fe4c82e01df60f2f3b8c3ec8cc217b99f443269713fc7f57d425e684a4b6e59a90ce17664a1eff08653eb9d440805ebb2873e27e
-  data.tar.gz: 5aceeb5ae1f627fa20635cd0d1bb6d6fcc6774df37ca9bb7d083cd4b72a7ac724c55b2c96258ee11d75ab11625fb720a023974c407c1c289afe6d106abe02192
+  metadata.gz: 21df8b8dc7ad42d9128ebdd174001d2a013b8eedf815222a54279b78f2b48ea5bdd8fc1e39e5d9c38ce2e881f650b0bde027914a11ccb55cfa7558bca2de8dd2
+  data.tar.gz: 15218777fc8b7560508c00eb50f297732d7cb8458411e777390ad4a9b0e68f21b12ba84630021e5110c144f8c2c05154f205f6d890d4b43dd3122a5f6033d63b

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+<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)
 

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
@@ -83,6 +83,14 @@ module Pact
           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/provider/pact_spec_runner.rb

@@ -9,9 +9,8 @@ require 'pact/provider/pact_source'
 require 'pact/provider/help/write'
 require 'pact/provider/verification_results/publish_all'
 require 'pact/provider/rspec/pact_broker_formatter'
-
-require_relative 'rspec'
-
+require 'pact/provider/rspec/json_formatter'
+require 'pact/provider/rspec'
 
 module Pact
   module Provider
@@ -91,7 +90,7 @@ module Pact
           ::RSpec::Core::CommandLine.new(NoConfigurationOptions.new)
             .run(::RSpec.configuration.output_stream, ::RSpec.configuration.error_stream)
         end
-        (all_pacts_pending? || options[:ignore_failures]) ? 0 : exit_code
+        pending_mode? ? 0 : exit_code
       end
 
       def rspec_runner_options
@@ -118,12 +117,12 @@ module Pact
 
       def initialize_specs
         pact_sources.each do | pact_source |
-          options = {
-            criteria: @options[:criteria],
-            ignore_failures: @options[:ignore_failures],
-            request_customizer: @options[:request_customizer]
+          spec_options = {
+            criteria: options[:criteria],
+            ignore_failures: options[:ignore_failures],
+            request_customizer: options[:request_customizer]
           }
-          honour_pactfile pact_source.uri, ordered_pact_json(pact_source.pact_json), options
+          honour_pactfile pact_source.uri, ordered_pact_json(pact_source.pact_json), spec_options
         end
       end
 
@@ -134,10 +133,13 @@ module Pact
 
         output = options[:out] || Pact.configuration.output_stream
         if options[:format]
-          ::RSpec.configuration.add_formatter options[:format], output
-          if !options[:out]
-            # Don't want to mess up the JSON parsing with messages to stdout, so send it to stderr
-            Pact.configuration.output_stream = Pact.configuration.error_stream
+          if options[:format] == 'json'
+            # To avoid mixing JSON and logging, the output_stream will be set to the error_stream
+            # in the pact-provider-verifier.
+            # Send JSON to a file if configured, or straight to $stdout
+            ::RSpec.configuration.add_formatter Pact::Provider::RSpec::JsonFormatter, options[:out] || $stdout
+          else
+            ::RSpec.configuration.add_formatter options[:format], output
           end
         else
           # Sometimes the formatter set in the cli.rb get set with an output of StringIO.. don't know why
@@ -148,7 +150,7 @@ module Pact
 
         ::RSpec.configuration.full_backtrace = @options[:full_backtrace]
 
-        ::RSpec.configuration.failure_color = :yellow if @options[:ignore_failures]
+        ::RSpec.configuration.failure_color = :yellow if pending_mode?
       end
 
       def ordered_pact_json(pact_json)
@@ -169,6 +171,10 @@ module Pact
         false
       end
 
+      def pending_mode?
+        (all_pacts_pending? || options[:ignore_failures])
+      end
+
       def executing_with_ruby?
         ENV['PACT_EXECUTING_LANGUAGE'] == 'ruby'
       end

data/lib/pact/provider/rspec/formatter_rspec_3.rb

@@ -6,13 +6,13 @@ require 'pact/provider/help/prompt_text'
 module Pact
   module Provider
     module RSpec
-
       class Formatter < ::RSpec::Core::Formatters::DocumentationFormatter
 
         class NilFormatter < ::RSpec::Core::Formatters::BaseFormatter
           Pact::RSpec.with_rspec_3 do
             ::RSpec::Core::Formatters.register self, :start, :example_group_started, :close
           end
+
           def dump_summary(summary)
           end
         end

data/lib/pact/provider/rspec/json_formatter.rb

@@ -0,0 +1,86 @@
+require 'rspec/core/formatters/json_formatter'
+
+module Pact
+  module Provider
+    module RSpec
+      class JsonFormatter < ::RSpec::Core::Formatters::JsonFormatter
+        ::RSpec::Core::Formatters.register self, :message, :dump_summary, :dump_profile, :stop, :seed, :close
+
+        def dump_summary(summary)
+          super(create_custom_summary(summary))
+          output_hash[:summary][:notices] = pact_broker_notices(summary)
+        end
+
+        def format_example(example)
+          {
+            :id => example.id,
+            :description => example.description,
+            :full_description => example.full_description,
+            :status => calculate_status(example),
+            :file_path => example.metadata[:file_path],
+            :line_number  => example.metadata[:line_number],
+            :run_time => example.execution_result.run_time,
+            :mismatches => extract_differences(example)
+          }
+        end
+
+        def stop(notification)
+          output_hash[:examples] = notification.examples.map do |example|
+            format_example(example).tap do |hash|
+              e = example.exception
+              # No point providing a backtrace for a mismatch, too much noise
+              if e && ! e.is_a?(::RSpec::Expectations::ExpectationNotMetError)
+                hash[:exception] =  {
+                  :class => e.class.name,
+                  :message => e.message,
+                  :backtrace => e.backtrace,
+                }
+              end
+            end
+          end
+        end
+
+        def calculate_status(example)
+          if example.execution_result.status == :failed && example.metadata[:pact_ignore_failures]
+            'pending'
+          else
+            example.execution_result.status.to_s
+          end
+        end
+
+        # There will most likely be only one pact associated with this RSpec execution, because
+        # the most likely user of this formatter is the Go implementation that parses the JSON
+        # and builds Go tests from them.
+        # If the JSON formatter is used by someone else and they have multiple pacts, all the notices
+        # for the pacts will be mushed together in one collection, so it will be hard to know which notice
+        # belongs to which pact.
+        def pact_broker_notices(summary)
+          pact_uris(summary).collect{ |pact_uri| pact_uri.metadata[:notices] }.compact.flatten
+        end
+
+        def pact_uris(summary)
+          summary.examples.collect(&:metadata).collect{ |metadata| metadata[:pact_uri] }.uniq
+        end
+
+        def create_custom_summary(summary)
+          ::RSpec::Core::Notifications::SummaryNotification.new(
+            summary.duration,
+            summary.examples,
+            summary.examples.select{ | example | example.execution_result.status == :failed && !example.metadata[:pact_ignore_failures] },
+            summary.examples.select{ | example | example.execution_result.status == :failed && example.metadata[:pact_ignore_failures] },
+            summary.load_time,
+            summary.errors_outside_of_examples_count
+          )
+        end
+
+        def extract_differences(example)
+          if example.metadata[:pact_diff]
+            Pact::Matchers::ExtractDiffMessages.call(example.metadata[:pact_diff]).to_a
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact/provider/rspec/pact_broker_formatter.rb

@@ -66,7 +66,7 @@ module Pact
             if example.metadata[:pact_diff]
               hash[:differences] = Pact::Matchers::ExtractDiffMessages.call(example.metadata[:pact_diff])
                                     .to_a
-                                    .collect{ | description | {description: description} }
+                                    .collect{ | description | { description: description } }
             end
           end
         end

data/lib/pact/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.44.1"
+  VERSION = "1.45.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.44.1
+  version: 1.45.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -361,6 +361,7 @@ files:
 - lib/pact/provider/rspec/custom_options_file
 - lib/pact/provider/rspec/formatter_rspec_2.rb
 - lib/pact/provider/rspec/formatter_rspec_3.rb
+- lib/pact/provider/rspec/json_formatter.rb
 - lib/pact/provider/rspec/matchers.rb
 - lib/pact/provider/rspec/pact_broker_formatter.rb
 - lib/pact/provider/state/provider_state.rb