activegroonga 0.0.1

data/test-unit/lib/test/unit/testsuite.rb

@@ -0,0 +1,110 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
+# License:: Ruby license.
+
+require 'test/unit/error'
+
+module Test
+  module Unit
+
+    # A collection of tests which can be #run.
+    #
+    # Note: It is easy to confuse a TestSuite instance with
+    # something that has a static suite method; I know because _I_
+    # have trouble keeping them straight. Think of something that
+    # has a suite method as simply providing a way to get a
+    # meaningful TestSuite instance.
+    class TestSuite
+      attr_reader :name, :tests
+      
+      STARTED = name + "::STARTED"
+      FINISHED = name + "::FINISHED"
+
+      # Creates a new TestSuite with the given name.
+      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
+
+      # Adds the test to the suite.
+      def <<(test)
+        @tests << test
+        self
+      end
+
+      def delete(test)
+        @tests.delete(test)
+      end
+
+      # Retuns the rolled up number of tests in this suite;
+      # i.e. if the suite contains other suites, it counts the
+      # tests within those suites, not the suites themselves.
+      def size
+        total_size = 0
+        @tests.each { |test| total_size += test.size }
+        total_size
+      end
+      
+      def empty?
+        tests.empty?
+      end
+
+      # Overridden to return the name given the suite at
+      # creation.
+      def to_s
+        @name
+      end
+      
+      # It's handy to be able to compare TestSuite instances.
+      def ==(other)
+        return false unless(other.kind_of?(self.class))
+        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/test-unit/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/test-unit/lib/test/unit/ui/console/testrunner.rb

@@ -0,0 +1,220 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
+# License:: Ruby license.
+
+require 'test/unit/color-scheme'
+require 'test/unit/ui/testrunner'
+require 'test/unit/ui/testrunnermediator'
+require 'test/unit/ui/console/outputlevel'
+
+module Test
+  module Unit
+    module UI
+      module Console
+
+        # Runs a Test::Unit::TestSuite on the console.
+        class TestRunner < UI::TestRunner
+          include OutputLevel
+
+          # 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.
+          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 = @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
+            @already_outputted = false
+            @faults = []
+          end
+
+          # Begins the test run.
+          def start
+            setup_mediator
+            attach_to_mediator
+            return start_mediator
+          end
+
+          private
+          def setup_mediator
+            @mediator = create_mediator(@suite)
+            output_setup_end
+          end
+
+          def output_setup_end
+            suite_name = @suite.to_s
+            suite_name = @suite.name if @suite.kind_of?(Module)
+            output("Loaded suite #{suite_name}")
+          end
+
+          def create_mediator(suite)
+            return TestRunnerMediator.new(suite)
+          end
+          
+          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, &method(:test_started))
+            @mediator.add_listener(TestCase::FINISHED, &method(:test_finished))
+          end
+          
+          def start_mediator
+            return @mediator.run_suite
+          end
+          
+          def add_fault(fault)
+            @faults << fault
+            output_progress(fault.single_character_display, fault_color(fault))
+            @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_single("%3d) " % (index + 1))
+              label, detail = format_fault(fault).split(/\r?\n/, 2)
+              output(label, fault_color(fault))
+              output(detail)
+            end
+            nl
+            output(@result, result_color)
+          end
+
+          def format_fault(fault)
+            fault.long_display
+          end
+          
+          def test_started(name)
+            output_single(name + ": ", nil, VERBOSE)
+          end
+          
+          def test_finished(name)
+            unless @already_outputted
+              output_progress(".", color("success"))
+            end
+            nl(VERBOSE)
+            @already_outputted = false
+          end
+          
+          def nl(level=NORMAL)
+            output("", nil, level)
+          end
+          
+          def output(something, color=nil, level=NORMAL)
+            return unless output?(level)
+            output_single(something, color, level)
+            @output.puts
+          end
+          
+          def output_single(something, color=nil, level=NORMAL)
+            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
+
+          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
+
+          def output?(level)
+            level <= @output_level
+          end
+
+          def color(name)
+            @color_scheme[name] || ColorScheme.default[name]
+          end
+
+          def fault_color(fault)
+            color(fault.class.name.split(/::/).last.downcase)
+          end
+
+          def result_color
+            if @result.passed?
+              if @result.pending_count > 0
+                color("pending")
+              elsif @result.omission_count > 0
+                color("omission")
+              elsif @result.notification_count > 0
+                color("notification")
+              else
+                color("success")
+              end
+            elsif @result.error_count > 0
+              color("error")
+            elsif @result.failure_count > 0
+              color("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
+
+          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
+
+          def guess_term_width
+            Integer(ENV["TERM_WIDTH"] || 0)
+          rescue ArgumentError
+            0
+          end
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  Test::Unit::UI::Console::TestRunner.start_command_line_test
+end

data/test-unit/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/test-unit/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/test-unit/lib/test/unit/ui/testrunnermediator.rb

@@ -0,0 +1,77 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
+# License:: Ruby license.
+
+require 'test/unit'
+require 'test/unit/util/observable'
+require 'test/unit/testresult'
+
+module Test
+  module Unit
+    module UI
+
+      # Provides an interface to write any given UI against,
+      # hopefully making it easy to write new UIs.
+      class TestRunnerMediator
+        RESET = name + "::RESET"
+        STARTED = name + "::STARTED"
+        FINISHED = name + "::FINISHED"
+        
+        include Util::Observable
+        
+        # Creates a new TestRunnerMediator initialized to run
+        # the passed suite.
+        def initialize(suite)
+          @suite = suite
+        end
+
+        # Runs the suite the TestRunnerMediator was created
+        # with.
+        def run_suite
+          Unit.run = true
+
+          result = create_result
+          result_listener = result.add_listener(TestResult::CHANGED) do |*args|
+            notify_listeners(TestResult::CHANGED, *args)
+          end
+          fault_listener = result.add_listener(TestResult::FAULT) do |*args|
+            notify_listeners(TestResult::FAULT, *args)
+          end
+
+          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
+        end
+
+        private
+        # A factory method to create the result the mediator
+        # should run with. Can be overridden by subclasses if
+        # one wants to use a different result.
+        def create_result
+          TestResult.new
+        end
+
+        def measure_time
+          begin_time = Time.now
+          yield
+          Time.now - begin_time
+        end
+      end
+    end
+  end
+end