require 'pact/provider/print_missing_provider_states' require 'rspec/core/formatters' require 'term/ansicolor' 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 Pact::RSpec.with_rspec_3 do ::RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished, :example_passed, :example_pending, :example_failed end C = ::Term::ANSIColor def example_group_started(notification) # This is the metadata on the top level "Verifying a pact between X and Y" describe block if @group_level == 0 Pact.configuration.output_stream.puts pact_uri = notification.group.metadata[:pactfile_uri] ::RSpec.configuration.failure_color = pact_uri.metadata[:pending] ? :yellow : :red if pact_uri.metadata[:notices] pact_uri.metadata[:notices].before_verification_notices_text.each do | text | Pact.configuration.output_stream.puts("DEBUG: #{text}") end end criteria = notification.group.metadata[:pact_criteria] Pact.configuration.output_stream.puts "DEBUG: Filtering interactions by: #{criteria}" if criteria && criteria.any? end super end def dump_summary(summary) output.puts "\n" + colorized_totals_line(summary) return if summary.failure_count == 0 print_rerun_commands summary print_failure_message print_missing_provider_states end private def interactions_count(summary) summary.examples.collect{ |e| interaction_unique_key(e) }.uniq.size end def failed_interactions_count(summary) failed_interaction_examples(summary).size end def pending_interactions_count(summary) pending_interaction_examples(summary).size end def failure_title summary ::RSpec::Core::Formatters::Helpers.pluralize(failed_interactions_count(summary), "failure") end def totals_line summary line = ::RSpec::Core::Formatters::Helpers.pluralize(interactions_count(summary), "interaction") line << ", " << failure_title(summary) pending_count = pending_interactions_count(summary) line << ", " << "#{pending_count} pending" if pending_count > 0 line end def colorized_totals_line(summary) colorizer.wrap(totals_line(summary), color_for_summary(summary)) end def color_for_summary summary summary.failure_count > 0 ? ::RSpec.configuration.failure_color : ::RSpec.configuration.success_color end def print_rerun_commands summary if pending_interactions_count(summary) > 0 set_rspec_failure_color(:yellow) output.puts("\nPending interactions: (Failures listed here are expected and do not affect your suite's status)\n\n") interaction_rerun_commands(pending_interaction_examples(summary)).each do | message | output.puts(message) end set_rspec_failure_color(:red) end if failed_interactions_count(summary) > 0 output.puts("\nFailed interactions:\n\n") interaction_rerun_commands(failed_interaction_examples(summary)).each do | message | output.puts(message) end end end def print_missing_provider_states if executing_with_ruby? PrintMissingProviderStates.call Pact.provider_world.provider_states.missing_provider_states, output end end def pending_interaction_examples(summary) one_failed_example_per_interaction(summary).select do | example | example.metadata[:pactfile_uri].metadata[:pending] end end def failed_interaction_examples(summary) one_failed_example_per_interaction(summary).select do | example | !example.metadata[:pactfile_uri].metadata[:pending] end end def one_failed_example_per_interaction(summary) summary.failed_examples.group_by{| e| interaction_unique_key(e)}.values.collect(&:first) end def interaction_rerun_commands examples examples.collect do |example| interaction_rerun_command_for example end.compact.uniq end def interaction_unique_key(example) # pending is just to make the counting easier, it isn't required for the unique key { pactfile_uri: example.metadata[:pactfile_uri], index: example.metadata[:pact_interaction].index, } end def interaction_rerun_command_for example example_description = example.metadata[:pact_interaction_example_description] _id = example.metadata[:pact_interaction]._id index = example.metadata[:pact_interaction].index provider_state = example.metadata[:pact_interaction].provider_state description = example.metadata[:pact_interaction].description pactfile_uri = example.metadata[:pactfile_uri] if _id && ENV['PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER'] cmd = String.new(ENV['PACT_INTERACTION_RERUN_COMMAND_FOR_BROKER']) cmd.gsub!("", example.metadata[:pactfile_uri].to_s) cmd.gsub!("", "#{_id}") colorizer.wrap("#{cmd} ", ::RSpec.configuration.failure_color) + colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color) elsif ENV['PACT_INTERACTION_RERUN_COMMAND'] cmd = String.new(ENV['PACT_INTERACTION_RERUN_COMMAND']) cmd.gsub!("", pactfile_uri.to_s) cmd.gsub!("", description) cmd.gsub!("", "#{provider_state}") cmd.gsub!("", "#{index}") colorizer.wrap("#{cmd} ", ::RSpec.configuration.failure_color) + colorizer.wrap("# #{example_description}", ::RSpec.configuration.detail_color) else message = if _id "* #{example_description} (to re-run just this interaction, set environment variable PACT_BROKER_INTERACTION_ID=\"#{_id}\")" else "* #{example_description} (to re-run just this interaction, set environment variables PACT_DESCRIPTION=\"#{description}\" PACT_PROVIDER_STATE=\"#{provider_state}\")" end colorizer.wrap(message, ::RSpec.configuration.failure_color) end end def print_failure_message output.puts(failure_message) if executing_with_ruby? end def failure_message "\n" + Pact::Provider::Help::PromptText.() + "\n" end def colorizer @colorizer ||= ::RSpec::Core::Formatters::ConsoleCodes end def executing_with_ruby? ENV['PACT_EXECUTING_LANGUAGE'] == 'ruby' end def set_rspec_failure_color color ::RSpec.configuration.failure_color = color end end end end end