Class: Minitest::HeatReporter

Inherits:
AbstractReporter
  • Object
show all
Defined in:
lib/minitest/heat_reporter.rb

Overview

Custom minitest reporter to proactively identify likely culprits in test failures by focusing on

the files and line numbers with the most issues and that were most recently modified. It also
visually emphasizes results based on the most significant problems.
1. Errors - Anything that raised an exception could have significant ripple effects.
2. Failures - Assuming no exceptions, these are kind of important.
-- Everything else...
3. Coverage (If using Simplecov) - If things are passing but coverage isn't up to par
4. Skips - Don't want to skip tests.
5. Slows (If everything good, but there's )

  • Colorize the Output

  • What files had the most errors?

  • Show the most impacted areas first.

  • Show lowest-level (most nested code) frist.

Pulls from existing reporters:

https://github.com/seattlerb/minitest/blob/master/lib/minitest.rb#L554

Lots of insight from:

http://www.monkeyandcrow.com/blog/reading_ruby_minitest_plugin_system/

And a good example available at:

https://github.com/adamsanderson/minitest-snail

Pulls from minitest-color as well:

https://github.com/teoljungberg/minitest-color/blob/master/lib/minitest/color_plugin.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(io = $stdout, options = {}) ⇒ HeatReporter

Returns a new instance of HeatReporter.



37
38
39
40
41
42
43
44
45
 
# File 'lib/minitest/heat_reporter.rb', line 37

def initialize(io = $stdout, options = {})
  super()

  @options = options

  @timer =    Heat::Timer.new
  @results =  Heat::Results.new
  @output =   Heat::Output.new(io)
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



32
33
34
 
# File 'lib/minitest/heat_reporter.rb', line 32

def options
  @options
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



32
33
34
 
# File 'lib/minitest/heat_reporter.rb', line 32

def output
  @output
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



32
33
34
 
# File 'lib/minitest/heat_reporter.rb', line 32

def results
  @results
end

#timer ⇒ Object (readonly)

Returns the value of attribute timer.



32
33
34
 
# File 'lib/minitest/heat_reporter.rb', line 32

def timer
  @timer
end

Instance Method Details

#display_exception_guidance(exception) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/minitest/heat_reporter.rb', line 81

def display_exception_guidance(exception)
  output.newline
  puts 'Sorry, but Minitest Heat encountered an exception recording an issue. Disabling Minitest Heat will get you back on track.'
  puts 'Please use the following exception details to submit an issue at https://github.com/garrettdimon/minitest-heat/issues'
  puts "#{exception.message}:"
  exception.backtrace.each do |line|
    puts "  #{line}"
  end
  output.newline
end

#passed? ⇒ Boolean

Did this run pass?

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/minitest/heat_reporter.rb', line 112

def passed?
  results.errors.empty? && results.failures.empty?
end

#prerecord(klass, name) ⇒ Object

About to start running a test. This allows a reporter to show that it is starting or that we are in the middle of a test run.



58
 
# File 'lib/minitest/heat_reporter.rb', line 58

def prerecord(klass, name); end

#record(result) ⇒ Object

Records the data from a result.

Minitest::Result source:

https://github.com/seattlerb/minitest/blob/f4f57afaeb3a11bd0b86ab0757704cb78db96cf4/lib/minitest.rb#L504



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/minitest/heat_reporter.rb', line 64

def record(result)
  # Convert a Minitest Result into an "issue" to more consistently expose the data needed to
  # adjust the failure output to the type of failure
  issue = Heat::Issue.from_result(result)

  # Note the number of assertions for the performance summary
  timer.increment_counts(issue.assertions)

  # Record the issue to show details later
  results.record(issue)

  # Show the marker
  output.marker(issue.type)
rescue StandardError => e
  display_exception_guidance(e)
end

#report ⇒ Object

Outputs the summary of the run.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/minitest/heat_reporter.rb', line 93

def report
  timer.stop!

  # The list of individual issues and their associated details
  output.issues_list(results)

  # Display a short summary of the total issue counts for each category as well as performance
  # details for the test suite as a whole
  output.compact_summary(results, timer)

  # If there were issues, shows a short heat map summary of which files and lines were the most
  # common sources of issues
  output.heat_map(results)

  output.newline
  output.newline
end

#start ⇒ Object

Starts reporting on the run.



48
49
50
51
52
53
54
 
# File 'lib/minitest/heat_reporter.rb', line 48

def start
  timer.start!

  # A couple of blank lines to create some breathing room
  output.newline
  output.newline
end