Class: Minitest::StatisticsReporter

Inherits:
Reporter show all
Defined in:
lib/minitest.rb

Overview

A reporter that gathers statistics about a test run. Does not do any IO because meant to be used as a parent class for a reporter that does.

If you want to create an entirely different type of output (eg, CI, HTML, etc), this is the place to start.

Example:

class JenkinsCIReporter < StatisticsReporter
  def report
    super  # Needed to calculate some statistics

    print "<testsuite "
    print "tests='#{count}' "
    print "failures='#{failures}' "
    # Remaining XML...
  end
end

Direct Known Subclasses

SummaryReporter

Instance Attribute Summary collapse

Attributes inherited from Reporter

#io, #options

Instance Method Summary collapse

Methods inherited from AbstractReporter

#prerecord

Constructor Details

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

:nodoc:


708
709
710
711
712
713
714
715
716
717
718
719
# File 'lib/minitest.rb', line 708

def initialize io = $stdout, options = {} # :nodoc:
  super

  self.assertions = 0
  self.count      = 0
  self.results    = []
  self.start_time = nil
  self.total_time = nil
  self.failures   = nil
  self.errors     = nil
  self.skips      = nil
end

Instance Attribute Details

#assertionsObject

Total number of assertions.


668
669
670
# File 'lib/minitest.rb', line 668

def assertions
  @assertions
end

#countObject

Total number of test cases.


673
674
675
# File 'lib/minitest.rb', line 673

def count
  @count
end

#errorsObject

Total number of tests that erred.


701
702
703
# File 'lib/minitest.rb', line 701

def errors
  @errors
end

#failuresObject

Total number of tests that failed.


696
697
698
# File 'lib/minitest.rb', line 696

def failures
  @failures
end

#resultsObject

An Array of test cases that failed or were skipped.


678
679
680
# File 'lib/minitest.rb', line 678

def results
  @results
end

#skipsObject

Total number of tests that where skipped.


706
707
708
# File 'lib/minitest.rb', line 706

def skips
  @skips
end

#start_timeObject

Time the test run started. If available, the monotonic clock is used and this is a Float, otherwise it's an instance of Time.


685
686
687
# File 'lib/minitest.rb', line 685

def start_time
  @start_time
end

#total_timeObject

Test run time. If available, the monotonic clock is used and this is a Float, otherwise it's an instance of Time.


691
692
693
# File 'lib/minitest.rb', line 691

def total_time
  @total_time
end

Instance Method Details

#passed?Boolean

:nodoc:

Returns:

  • (Boolean)

721
722
723
# File 'lib/minitest.rb', line 721

def passed? # :nodoc:
  results.all?(&:skipped?)
end

#record(result) ⇒ Object

:nodoc:


729
730
731
732
733
734
# File 'lib/minitest.rb', line 729

def record result # :nodoc:
  self.count += 1
  self.assertions += result.assertions

  results << result if not result.passed? or result.skipped?
end

#reportObject

Report on the tracked statistics.


739
740
741
742
743
744
745
746
747
# File 'lib/minitest.rb', line 739

def report
  aggregate = results.group_by { |r| r.failure.class }
  aggregate.default = [] # dumb. group_by should provide this

  self.total_time = Minitest.clock_time - start_time
  self.failures   = aggregate[Assertion].size
  self.errors     = aggregate[UnexpectedError].size
  self.skips      = aggregate[Skip].size
end

#startObject

:nodoc:


725
726
727
# File 'lib/minitest.rb', line 725

def start # :nodoc:
  self.start_time = Minitest.clock_time
end