Class: Test::Unit::UI::Console::TestRunner
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
|
|
Instance Chain:
|
|
Inherits: |
Test::Unit::UI::TestRunner
|
Defined in: | lib/test/unit/ui/console/testrunner.rb |
Overview
Runs a ::Test::Unit::TestSuite on the console.
Constant Summary
OutputLevel - Included
IMPORTANT_FAULTS_ONLY, NORMAL, PROGRESS_ONLY, SILENT, VERBOSE
Class Method Summary
-
.new(suite, options = {}) ⇒ TestRunner
constructor
Creates a new
TestRunner
for running the passed suite.
::Test::Unit::UI::TestRunner - Inherited
::Test::Unit::UI::TestRunnerUtilities - Extended
run | Creates a new |
start_command_line_test | Takes care of the ARGV parsing and suite determination necessary for running one of the TestRunners from the command line. |
Instance Attribute Summary
- #ruby_2_0_or_later? ⇒ Boolean readonly private
- #windows? ⇒ Boolean readonly private
::Test::Unit::UI::TestRunner - Inherited
Instance Method Summary
- #add_fault(fault) private
- #attach_to_mediator private
- #categorize_fault(fault) private
- #categorize_faults private
- #change_output_level(level) private
- #color(name) private
- #fault_class_color_name(fault_class) private
- #fault_color(fault) private
- #fault_marker_color(fault) private
- #finished(elapsed_time) private
- #format_fault(fault) private
- #guess_color_availability private
- #guess_progress_row_max private
- #guess_term_width private
- #guess_term_width_from_env private
- #guess_term_width_from_io private
- #indent private
- #max_digit(max_number) private
- #nl(level = nil) private
- #output(something, color = nil, level = nil) private
- #output?(level) ⇒ Boolean private
- #output_code_snippet(file, line_number, target_line_color = nil) private
- #output_failure_message(failure) private
- #output_fault_backtrace(fault) private
- #output_fault_in_detail(fault) private
- #output_fault_in_short(fault) private
- #output_fault_message(fault) private
- #output_faults private
- #output_faults_in_detail(faults) private
- #output_faults_in_short(label, fault_class, faults) private
- #output_progress(mark, color = nil) private
- #output_progress_in_detail(fault) private
- #output_progress_in_detail_marker(fault) private
- #output_setup_end private
- #output_single(something, color = nil, level = nil) private
- #output_started private
- #output_statistics(elapsed_time) private
- #output_summary_marker private
- #setup_mediator private
- #started(result) private
- #suite_name(prefix, suite) private
- #summary_marker_color private
- #test_finished(test) private
- #test_started(test) private
- #test_suite_finished(suite) private
- #test_suite_started(suite) private
::Test::Unit::UI::TestRunner - Inherited
#start | Begins the test run. |
#attach_listeners, #diff_target_string?, #prepare_for_diff, #setup_mediator, #start_mediator |
Constructor Details
.new(suite, options = {}) ⇒ TestRunner
Creates a new TestRunner
for running the passed suite. If quiet_mode is true, the output while running is limited to progress dots, errors and failures, and the final result. io specifies where runner output should go to; defaults to STDOUT.
# File 'lib/test/unit/ui/console/testrunner.rb', line 37
def initialize(suite, ={}) super @output_level = @options[:output_level] || NORMAL @output = @options[:output] || STDOUT @use_color = @options[:use_color] @use_color = guess_color_availability if @use_color.nil? @color_scheme = @options[:color_scheme] || ColorScheme.default @reset_color = Color.new("reset") @progress_row = 0 @progress_row_max = @options[:progress_row_max] @progress_row_max ||= guess_progress_row_max @show_detail_immediately = @options[:show_detail_immediately] @show_detail_immediately = true if @show_detail_immediately.nil? @already_outputted = false @indent = 0 @top_level = true @current_output_level = NORMAL @faults = [] @code_snippet_fetcher = CodeSnippetFetcher.new @test_suites = [] end
Instance Attribute Details
#ruby_2_0_or_later? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/test/unit/ui/console/testrunner.rb', line 504
def ruby_2_0_or_later? RUBY_VERSION >= "2.0.0" end
#windows? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/test/unit/ui/console/testrunner.rb', line 500
def windows? /mswin|mingw/ === RUBY_PLATFORM end
Instance Method Details
#add_fault(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 95
def add_fault(fault) @faults << fault output_progress(fault.single_character_display, fault_marker_color(fault)) output_progress_in_detail(fault) if @show_detail_immediately @already_outputted = true if fault.critical? end
#attach_to_mediator (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 78
def attach_to_mediator @mediator.add_listener(TestResult::FAULT, &method(:add_fault)) @mediator.add_listener(TestRunnerMediator::STARTED, &method(:started)) @mediator.add_listener(TestRunnerMediator::FINISHED, &method(:finished)) @mediator.add_listener(TestCase::STARTED_OBJECT, &method(:test_started)) @mediator.add_listener(TestCase::FINISHED_OBJECT, &method(:test_finished)) @mediator.add_listener(TestSuite::STARTED_OBJECT, &method(:test_suite_started)) @mediator.add_listener(TestSuite::FINISHED_OBJECT, &method(:test_suite_finished)) end
#categorize_fault(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 168
def categorize_fault(fault) case fault when Omission :omissions when Notification :notifications else :need_detail_faults end end
#categorize_faults (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 158
def categorize_faults faults = {} @faults.each do |fault| category = categorize_fault(fault) faults[category] ||= [] faults[category] << fault end faults end
#change_output_level(level) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 60
def change_output_level(level) old_output_level = @current_output_level @current_output_level = level yield @current_output_level = old_output_level end
#color(name) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 465
def color(name) _color = @color_scheme[name] _color ||= @color_scheme["success"] if name == "pass" _color ||= ColorScheme.default[name] _color end
#fault_class_color_name(fault_class) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 472
def fault_class_color_name(fault_class) fault_class.name.split(/::/).last.downcase end
#fault_color(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 476
def fault_color(fault) color(fault_class_color_name(fault.class)) end
#fault_marker_color(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 480
def fault_marker_color(fault) color("#{fault_class_color_name(fault.class)}-marker") end
#finished(elapsed_time) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 112
def finished(elapsed_time) nl if output?(NORMAL) and !output?(VERBOSE) output_faults unless @show_detail_immediately nl(PROGRESS_ONLY) change_output_level(IMPORTANT_FAULTS_ONLY) do output_statistics(elapsed_time) end end
#format_fault(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 311
def format_fault(fault) fault.long_display end
#guess_color_availability (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 488
def guess_color_availability return false unless @output.tty? return true if windows? and ruby_2_0_or_later? case ENV["TERM"] when /(?:term|screen)(?:-(?:256)?color)?\z/ true else return true if ENV["EMACS"] == "t" false end end
#guess_progress_row_max (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 508
def guess_progress_row_max term_width = guess_term_width if term_width.zero? if ENV["EMACS"] == "t" -1 else 79 end else term_width end end
#guess_term_width (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 521
def guess_term_width guess_term_width_from_io || guess_term_width_from_env || 0 end
#guess_term_width_from_env (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 537
def guess_term_width_from_env env = ENV["COLUMNS"] || ENV["TERM_WIDTH"] return nil if env.nil? begin Integer(env) rescue ArgumentError nil end end
#guess_term_width_from_io (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 525
def guess_term_width_from_io if @output.respond_to?(:winsize) begin @output.winsize[1] rescue SystemCallError nil end else nil end end
#indent (private)
[ GitHub ]#max_digit(max_number) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 132
def max_digit(max_number) (Math.log10(max_number) + 1).truncate end
#nl(level = nil) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 407
def nl(level=nil) output("", nil, level) end
#output(something, color = nil, level = nil) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 411
def output(something, color=nil, level=nil) return unless output?(level) output_single(something, color, level) @output.puts end
#output?(level) ⇒ Boolean
(private)
# File 'lib/test/unit/ui/console/testrunner.rb', line 461
def output?(level) (level || @current_output_level) <= @output_level end
#output_code_snippet(file, line_number, target_line_color = nil) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 231
def output_code_snippet(file, line_number, target_line_color=nil) lines = @code_snippet_fetcher.fetch(file, line_number) return false if lines.empty? max_n = lines.collect {|n, line, attributes| n}.max digits = (Math.log10(max_n) + 1).truncate lines.each do |n, line, attributes| if attributes[:target_line?] line_color = target_line_color current_line_mark = "=>" else line_color = nil current_line_mark = "" end output(" %2s %*d: %s" % [current_line_mark, digits, n, line], line_color) end true end
#output_failure_message(failure) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 251
def (failure) if failure.expected.respond_to?(:encoding) and failure.actual.respond_to?(:encoding) and failure.expected.encoding != failure.actual.encoding need_encoding = true else need_encoding = false end output(failure. ) if failure. output_single("<") output_single(failure.inspected_expected, color("pass")) output_single(">") if need_encoding output_single("(") output_single(failure.expected.encoding.name, color("pass")) output_single(")") end output(" expected but was") output_single("<") output_single(failure.inspected_actual, color("failure")) output_single(">") if need_encoding output_single("(") output_single(failure.actual.encoding.name, color("failure")) output_single(")") end output("") from, to = prepare_for_diff(failure.expected, failure.actual) if from and to if need_encoding unless from.valid_encoding? from = from.dup.force_encoding("ASCII-8BIT") end unless to.valid_encoding? to = to.dup.force_encoding("ASCII-8BIT") end end from_lines = from.split(/\r?\n/) to_lines = to.split(/\r?\n/) if need_encoding from_lines << "" to_lines << "" from_lines << "Encoding: #{failure.expected.encoding.name}" to_lines << "Encoding: #{failure.actual.encoding.name}" end differ = ColorizedReadableDiffer.new(from_lines, to_lines, self) if differ.need_diff? output("") output("diff:") differ.diff end end end
#output_fault_backtrace(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 214
def output_fault_backtrace(fault) snippet_is_shown = false detector = FaultLocationDetector.new(fault, @code_snippet_fetcher) backtrace = fault.location # workaround for test-spec. :< # see also GitHub:#22 backtrace ||= [] backtrace.each_with_index do |entry, i| output(entry) next if snippet_is_shown next unless detector.target?(entry) file, line_number, = detector.split_backtrace_entry(entry) snippet_is_shown = output_code_snippet(file, line_number, fault_color(fault)) end end
#output_fault_in_detail(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 179
def output_fault_in_detail(fault) if fault.is_a?(Failure) and fault.inspected_expected and fault.inspected_actual output_single("#{fault.label}: ") output(fault.test_name, fault_color(fault)) output_fault_backtrace(fault) (fault) else if fault.is_a?(Error) output_single("#{fault.label}: ") output_single(fault.test_name, fault_color(fault)) (fault) else output_single(fault.label, fault_color(fault)) (fault) output(fault.test_name) end output_fault_backtrace(fault) end end
#output_fault_in_short(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 305
def output_fault_in_short(fault) output_single(fault., fault_color(fault)) output(" [#{fault.test_name}]") output(fault.location.first) end
#output_fault_message(fault) (private)
[ GitHub ]#output_faults (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 121
def output_faults categorized_faults = categorize_faults change_output_level(IMPORTANT_FAULTS_ONLY) do output_faults_in_detail(categorized_faults[:need_detail_faults]) end output_faults_in_short("Omissions", Omission, categorized_faults[:omissions]) output_faults_in_short("Notifications", Notification, categorized_faults[:notifications]) end
#output_faults_in_detail(faults) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 136
def output_faults_in_detail(faults) return if faults.nil? digit = max_digit(faults.size) faults.each_with_index do |fault, index| nl output_single("%#{digit}d) " % (index + 1)) output_fault_in_detail(fault) end end
#output_faults_in_short(label, fault_class, faults) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 146
def output_faults_in_short(label, fault_class, faults) return if faults.nil? digit = max_digit(faults.size) nl output_single(label, fault_class_color(fault_class)) output(":") faults.each_with_index do |fault, index| output_single("%#{digit}d) " % (index + 1)) output_fault_in_short(fault) end end
#output_progress(mark, color = nil) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 429
def output_progress(mark, color=nil) if output_single(mark, color, PROGRESS_ONLY) return unless @progress_row_max > 0 @progress_row += mark.size if @progress_row >= @progress_row_max nl unless @output_level == VERBOSE @progress_row = 0 end end end
#output_progress_in_detail(fault) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 448
def output_progress_in_detail(fault) return if @output_level == SILENT nl output_progress_in_detail_marker(fault) if categorize_fault(fault) == :need_detail_faults output_fault_in_detail(fault) else output_fault_in_short(fault) end output_progress_in_detail_marker(fault) @progress_row = 0 end
#output_progress_in_detail_marker(fault) (private)
[ GitHub ]#output_setup_end (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 72
def output_setup_end suite_name = @suite.to_s suite_name = @suite.name if @suite.kind_of?(Module) output("Loaded suite #{suite_name}") end
#output_single(something, color = nil, level = nil) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 417
def output_single(something, color=nil, level=nil) return false unless output?(level) if @use_color and color something = "%s%s%s" % [color.escape_sequence, something, @reset_color.escape_sequence] end @output.write(something) @output.flush true end
#output_started (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 108
def output_started output("Started") end
#output_statistics(elapsed_time) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 315
def output_statistics(elapsed_time) output("Finished in #{elapsed_time} seconds.") output_summary_marker output(@result) output("%g%% passed" % @result.pass_percentage) unless elapsed_time.zero? output_summary_marker test_throughput = @result.run_count / elapsed_time assertion_throughput = @result.assertion_count / elapsed_time throughput = [ "%.2f tests/s" % test_throughput, "%.2f assertions/s" % assertion_throughput, ] output(throughput.join(", ")) end end
#output_summary_marker (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 332
def output_summary_marker term_width = guess_term_width if term_width.zero? marker_width = 6 else marker_width = term_width end output("-" * marker_width, summary_marker_color) end
#setup_mediator (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 67
def setup_mediator super output_setup_end end
#started(result) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 103
def started(result) @result = result output_started end
#suite_name(prefix, suite) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 365
def suite_name(prefix, suite) name = suite.name if name.nil? "(anonymous)" else name.sub(/\A#{Regexp.escape(prefix)}/, "") end end
#summary_marker_color (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 484
def summary_marker_color color("#{@result.status}-marker") end
#test_finished(test) (private)
[ GitHub ]#test_started(test) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 342
def test_started(test) return unless output?(VERBOSE) name = test.name.sub(/\(.+?\)\z/, '') right_space = 8 * 2 left_space = @progress_row_max - right_space left_space = left_space - indent.size - name.size tab_stop = "\t" * ([left_space - 1, 0].max / 8) output_single("#{indent}#{name}:#{tab_stop}", nil, VERBOSE) @test_start = Time.now end
#test_suite_finished(suite) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 394
def test_suite_finished(suite) @indent -= 2 @test_suites.pop end
#test_suite_started(suite) (private)
[ GitHub ]# File 'lib/test/unit/ui/console/testrunner.rb', line 374
def test_suite_started(suite) last_test_suite = @test_suites.last @test_suites << suite if @top_level @top_level = false return end output_single(indent, nil, VERBOSE) if suite.test_case.nil? _color = color("suite") else _color = color("case") end prefix = "#{last_test_suite.name}::" output_single(suite_name(prefix, suite), _color, VERBOSE) output(": ", nil, VERBOSE) @indent += 2 end