test-unit 1.2.3 → 2.0.0

data/lib/test/unit/testsuite.rb

@@ -4,6 +4,8 @@
 # Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
+require 'test/unit/error'
+
 module Test
   module Unit
 
@@ -21,18 +23,21 @@ module Test
       FINISHED = name + "::FINISHED"
 
       # Creates a new TestSuite with the given name.
-      def initialize(name="Unnamed TestSuite")
+      def initialize(name="Unnamed TestSuite", test_case=nil)
         @name = name
         @tests = []
+        @test_case = test_case
       end
 
       # Runs the tests and/or suites contained in this
       # TestSuite.
       def run(result, &progress_block)
         yield(STARTED, name)
+        run_startup(result)
         @tests.each do |test|
           test.run(result, &progress_block)
         end
+        run_shutdown(result)
         yield(FINISHED, name)
       end
 
@@ -71,6 +76,35 @@ module Test
         return false unless(@name == other.name)
         @tests == other.tests
       end
+
+      private
+      def run_startup(result)
+        return if @test_case.nil? or !@test_case.respond_to?(:startup)
+        begin
+          @test_case.startup
+        rescue Exception
+          raise unless handle_exception($!, result)
+        end
+      end
+
+      def run_shutdown(result)
+        return if @test_case.nil? or !@test_case.respond_to?(:shutdown)
+        begin
+          @test_case.shutdown
+        rescue Exception
+          raise unless handle_exception($!, result)
+        end
+      end
+
+      def handle_exception(exception, result)
+        case exception
+        when *ErrorHandler::PASS_THROUGH_EXCEPTIONS
+          false
+        else
+          result.add_error(Error.new(@test_case.name, exception))
+          true
+        end
+      end
     end
   end
 end

data/lib/test/unit/ui/console/outputlevel.rb

@@ -0,0 +1,14 @@
+module Test
+  module Unit
+    module UI
+      module Console
+        module OutputLevel
+          SILENT = 0
+          PROGRESS_ONLY = 1
+          NORMAL = 2
+          VERBOSE = 3
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/ui/console/testrunner.rb

@@ -4,8 +4,10 @@
 # Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
+require 'test/unit/color'
+require 'test/unit/ui/testrunner'
 require 'test/unit/ui/testrunnermediator'
-require 'test/unit/ui/testrunnerutilities'
+require 'test/unit/ui/console/outputlevel'
 
 module Test
   module Unit
@@ -13,8 +15,19 @@ module Test
       module Console
 
         # Runs a Test::Unit::TestSuite on the console.
-        class TestRunner
-          extend TestRunnerUtilities
+        class TestRunner < UI::TestRunner
+          include OutputLevel
+
+          COLOR_SCHEMES = {
+            :default => {
+              "success" => Color.new("green", :bold => true),
+              "failure" => Color.new("red", :bold => true),
+              "pending" => Color.new("magenta", :bold => true),
+              "omission" => Color.new("blue", :bold => true),
+              "notification" => Color.new("cyan", :bold => true),
+              "error" => Color.new("yellow", :bold => true),
+            },
+          }
 
           # Creates a new TestRunner for running the passed
           # suite. If quiet_mode is true, the output while
@@ -22,14 +35,14 @@ module Test
           # failures, and the final result. io specifies
           # where runner output should go to; defaults to
           # STDOUT.
-          def initialize(suite, output_level=NORMAL, io=STDOUT)
-            if (suite.respond_to?(:suite))
-              @suite = suite.suite
-            else
-              @suite = suite
-            end
-            @output_level = output_level
-            @io = io
+          def initialize(suite, options={})
+            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 = COLOR_SCHEMES[:default]
+            @reset_color = Color.new("reset")
             @already_outputted = false
             @faults = []
           end
@@ -44,13 +57,15 @@ module Test
           private
           def setup_mediator
             @mediator = create_mediator(@suite)
+            output_setup_end
+          end
+
+          def output_setup_end
             suite_name = @suite.to_s
-            if ( @suite.kind_of?(Module) )
-              suite_name = @suite.name
-            end
+            suite_name = @suite.name if @suite.kind_of?(Module)
             output("Loaded suite #{suite_name}")
           end
-          
+
           def create_mediator(suite)
             return TestRunnerMediator.new(suite)
           end
@@ -69,53 +84,106 @@ module Test
           
           def add_fault(fault)
             @faults << fault
-            output_single(fault.single_character_display, PROGRESS_ONLY)
+            output_single(fault.single_character_display,
+                          fault_color(fault),
+                          PROGRESS_ONLY)
             @already_outputted = true
           end
           
           def started(result)
             @result = result
+            output_started
+          end
+
+          def output_started
             output("Started")
           end
-          
+
           def finished(elapsed_time)
+            nl if output?(NORMAL) and !output?(VERBOSE)
             nl
             output("Finished in #{elapsed_time} seconds.")
             @faults.each_with_index do |fault, index|
               nl
-              output("%3d) %s" % [index + 1, fault.long_display])
+              output_single("%3d) " % (index + 1))
+              label, detail = format_fault(fault).split(/\r?\n/, 2)
+              output(label, fault_color(fault))
+              output(detail)
             end
             nl
-            output(@result)
+            output(@result, result_color)
+          end
+
+          def format_fault(fault)
+            fault.long_display
           end
           
           def test_started(name)
-            output_single(name + ": ", VERBOSE)
+            output_single(name + ": ", nil, VERBOSE)
           end
           
           def test_finished(name)
-            output_single(".", PROGRESS_ONLY) unless (@already_outputted)
+            unless @already_outputted
+              output_single(".", @color_scheme["success"], PROGRESS_ONLY)
+            end
             nl(VERBOSE)
             @already_outputted = false
           end
           
           def nl(level=NORMAL)
-            output("", level)
+            output("", nil, level)
           end
           
-          def output(something, level=NORMAL)
-            @io.puts(something) if (output?(level))
-            @io.flush
+          def output(something, color=nil, level=NORMAL)
+            return unless output?(level)
+            output_single(something, color, level)
+            @output.puts
           end
           
-          def output_single(something, level=NORMAL)
-            @io.write(something) if (output?(level))
-            @io.flush
+          def output_single(something, color=nil, level=NORMAL)
+            return 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
           end
           
           def output?(level)
             level <= @output_level
           end
+
+          def fault_color(fault)
+            @color_scheme[fault.class.name.split(/::/).last.downcase]
+          end
+
+          def result_color
+            if @result.passed?
+              if @result.pending_count > 0
+                @color_scheme["pending"]
+              elsif @result.omission_count > 0
+                @color_scheme["omission"]
+              elsif @result.notification_count > 0
+                @color_scheme["notification"]
+              else
+                @color_scheme["success"]
+              end
+            elsif @result.error_count > 0
+              @color_scheme["error"]
+            elsif @result.failure_count > 0
+              @color_scheme["failure"]
+            end
+          end
+
+          def guess_color_availability
+            return false unless @output.tty?
+            term = ENV["TERM"]
+            return true if term and (/term\z/ =~ term or term == "screen")
+            return true if ENV["EMACS"] == "t"
+            false
+          end
         end
       end
     end

data/lib/test/unit/ui/emacs/testrunner.rb

@@ -0,0 +1,49 @@
+require 'test/unit/ui/console/testrunner'
+
+module Test
+  module Unit
+    module UI
+      module Emacs
+        class TestRunner < Console::TestRunner
+          private
+          def output_setup_end
+          end
+
+          def output_started
+          end
+
+          def format_fault(fault)
+            return super unless fault.respond_to?(:label)
+            format_method_name = "format_fault_#{fault.label.downcase}"
+            if respond_to?(format_method_name, true)
+              send(format_method_name, fault)
+            else
+              super
+            end
+          end
+
+          def format_fault_failure(failure)
+            if failure.location.size == 1
+              location = failure.location[0]
+              location_display = location.sub(/\A(.+:\d+).*/, ' [\\1]')
+            else
+              location_display = "\n" + failure.location.join("\n")
+            end
+            result = "#{failure.label}:\n"
+            result << "#{failure.test_name}#{location_display}:\n"
+            result << failure.message
+            result
+          end
+
+          def format_fault_error(error)
+            result = "#{error.label}:\n"
+            result << "#{error.test_name}:\n"
+            result << "#{error.message}\n"
+            result << error.backtrace.join("\n")
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/ui/testrunner.rb

@@ -0,0 +1,20 @@
+require 'test/unit/ui/testrunnerutilities'
+
+module Test
+  module Unit
+    module UI
+      class TestRunner
+        extend TestRunnerUtilities
+
+        def initialize(suite, options={})
+          if suite.respond_to?(:suite)
+            @suite = suite.suite
+          else
+            @suite = suite
+          end
+          @options = options
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/ui/testrunnermediator.rb

@@ -31,28 +31,31 @@ module Test
         # with.
         def run_suite
           Unit.run = true
-          begin_time = Time.now
-          notify_listeners(RESET, @suite.size)
+
           result = create_result
-          notify_listeners(STARTED, result)
-          result_listener = result.add_listener(TestResult::CHANGED) do |updated_result|
-            notify_listeners(TestResult::CHANGED, updated_result)
+          result_listener = result.add_listener(TestResult::CHANGED) do |*args|
+            notify_listeners(TestResult::CHANGED, *args)
           end
-          
-          fault_listener = result.add_listener(TestResult::FAULT) do |fault|
-            notify_listeners(TestResult::FAULT, fault)
+          fault_listener = result.add_listener(TestResult::FAULT) do |*args|
+            notify_listeners(TestResult::FAULT, *args)
           end
-          
-          @suite.run(result) do |channel, value|
-            notify_listeners(channel, value)
+
+          start_time = Time.now
+          begin
+            notify_listeners(RESET, @suite.size)
+            notify_listeners(STARTED, result)
+
+            @suite.run(result) do |channel, value|
+              notify_listeners(channel, value)
+            end
+          ensure
+            elapsed_time = Time.now - start_time
+            result.remove_listener(TestResult::FAULT, fault_listener)
+            result.remove_listener(TestResult::CHANGED, result_listener)
+            notify_listeners(FINISHED, elapsed_time)
           end
-          
-          result.remove_listener(TestResult::FAULT, fault_listener)
-          result.remove_listener(TestResult::CHANGED, result_listener)
-          end_time = Time.now
-          elapsed_time = end_time - begin_time
-          notify_listeners(FINISHED, elapsed_time) #"Finished in #{elapsed_time} seconds.")
-          return result
+
+          result
         end
 
         private
@@ -60,7 +63,13 @@ module Test
         # should run with. Can be overridden by subclasses if
         # one wants to use a different result.
         def create_result
-          return TestResult.new
+          TestResult.new
+        end
+
+        def measure_time
+          begin_time = Time.now
+          yield
+          Time.now - begin_time
         end
       end
     end

data/lib/test/unit/ui/testrunnerutilities.rb

@@ -8,11 +8,6 @@ module Test
   module Unit
     module UI
 
-      SILENT = 0
-      PROGRESS_ONLY = 1
-      NORMAL = 2
-      VERBOSE = 3
-
       # Provides some utilities common to most, if not all,
       # TestRunners.
       #
@@ -25,8 +20,8 @@ module Test
       module TestRunnerUtilities
 
         # Creates a new TestRunner and runs the suite.
-        def run(suite, output_level=NORMAL)
-          return new(suite, output_level).start
+        def run(suite, options={})
+          return new(suite, options).start
         end
 
         # Takes care of the ARGV parsing and suite

data/lib/test/unit/util/backtracefilter.rb

@@ -5,7 +5,8 @@ module Test
         TESTUNIT_FILE_SEPARATORS = %r{[\\/:]}
         TESTUNIT_PREFIX = __FILE__.split(TESTUNIT_FILE_SEPARATORS)[0..-3]
         TESTUNIT_RB_FILE = /\.rb\Z/
-        
+
+        module_function
         def filter_backtrace(backtrace, prefix=nil)
           return ["No backtrace"] unless(backtrace)
           split_p = if(prefix)

data/lib/test/unit/version.rb

@@ -2,6 +2,6 @@
 # HACK: quick and dirty to get integrated into the new project - ryan
 module Test
   module Unit
-    VERSION = '1.2.3'
+    VERSION = '2.0.0'
   end
 end