treetop 0.1.0 → 1.0.0

data/test/screw/unit/ui/test_runner_mediator.rb

@@ -0,0 +1,58 @@
+module Screw
+  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
+          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)
+          end
+          
+          fault_listener = result.add_listener(TestResult::FAULT) do |fault|
+            notify_listeners(TestResult::FAULT, fault)
+          end
+          
+          @suite.run(result) do |channel, value|
+            notify_listeners(channel, value)
+          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
+        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
+          return TestResult.new
+        end
+      end
+    end
+  end
+end

data/test/screw/unit/ui/test_runner_utilities.rb

@@ -0,0 +1,46 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
+# License:: Ruby license.
+
+module Screw
+  module Unit
+    module UI
+
+      SILENT = 0
+      PROGRESS_ONLY = 1
+      NORMAL = 2
+      VERBOSE = 3
+
+      # Provides some utilities common to most, if not all,
+      # TestRunners.
+      #
+      #--
+      #
+      # Perhaps there ought to be a TestRunner superclass? There
+      # seems to be a decent amount of shared code between test
+      # runners.
+
+      module TestRunnerUtilities
+
+        # Creates a new TestRunner and runs the suite.
+        def run(suite, output_level=NORMAL)
+          return new(suite, output_level).start
+        end
+
+        # Takes care of the ARGV parsing and suite
+        # determination necessary for running one of the
+        # TestRunners from the command line.
+        def start_command_line_test
+          if ARGV.empty?
+            puts "You should supply the name of a test suite file to the runner"
+            exit
+          end
+          require ARGV[0].gsub(/.+::/, '')
+          new(eval(ARGV[0])).start
+        end
+      end
+    end
+  end
+end

data/test/screw/unit/ui/tk/test_runner.rb

@@ -0,0 +1,260 @@
+#--
+#
+# Original Author:: Nathaniel Talbott.
+# Author:: Kazuhiro NISHIYAMA.
+# Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
+# Copyright:: Copyright (c) 2003 Kazuhiro NISHIYAMA. All rights reserved.
+# License:: Ruby license.
+
+require 'tk'
+require 'fancy/unit/ui/test_runnermediator'
+require 'fancy/unit/ui/test_runnerutilities'
+
+module Screw
+  module Unit
+    module UI
+      module Tk
+
+        # Runs a Screw::Unit::TestSuite in a Tk UI. Obviously,
+        # this one requires you to have Tk
+        # and the Ruby Tk extension installed.
+        class TestRunner
+          extend TestRunnerUtilities
+
+          # Creates a new TestRunner for running the passed
+          # suite.
+          def initialize(suite, output_level = NORMAL)
+            if (suite.respond_to?(:suite))
+              @suite = suite.suite
+            else
+              @suite = suite
+            end
+            @result = nil
+
+            @red = false
+            @fault_detail_list = []
+            @runner = Thread.current
+            @restart_signal = Class.new(Exception)
+            @viewer = Thread.start do
+              @runner.join rescue @runner.run
+              ::Tk.mainloop
+            end
+            @viewer.join rescue nil # wait deadlock to handshake
+          end
+
+          # Begins the test run.
+          def start
+            setup_ui
+            setup_mediator
+            attach_to_mediator
+            start_ui
+            @result
+          end
+
+          private
+          def setup_mediator
+            @mediator = TestRunnerMediator.new(@suite)
+            suite_name = @suite.to_s
+            if ( @suite.kind_of?(Module) )
+              suite_name = @suite.name
+            end
+            @suite_name_entry.value = suite_name
+          end
+
+          def attach_to_mediator
+            @run_button.command(method(:run_test))
+            @fault_list.bind('ButtonPress-1', proc{|y|
+              fault = @fault_detail_list[@fault_list.nearest(y)]
+              if fault
+                show_fault(fault)
+              end
+            }, '%y')
+            @mediator.add_listener(TestRunnerMediator::RESET, &method(:reset_ui))
+            @mediator.add_listener(TestResult::FAULT, &method(:add_fault))
+            @mediator.add_listener(TestResult::CHANGED, &method(:result_changed))
+            @mediator.add_listener(TestRunnerMediator::STARTED, &method(:started))
+            @mediator.add_listener(TestCase::STARTED, &method(:test_started))
+            @mediator.add_listener(TestRunnerMediator::FINISHED, &method(:finished))
+          end
+
+          def run_test
+            @runner.raise(@restart_signal)
+          end
+
+          def start_ui
+            @viewer.run
+            running = false
+            begin
+              loop do
+                if (running ^= true)
+                  @run_button.configure('text'=>'Stop')
+                  @mediator.run_suite
+                else
+                  @run_button.configure('text'=>'Run')
+                  @viewer.join
+                  break
+                end
+              end
+            rescue @restart_signal
+              retry
+            rescue
+            end
+          end
+
+          def stop
+            ::Tk.exit
+          end
+
+          def reset_ui(count)
+            @test_total_count = count.to_f
+            @test_progress_bar.configure('background'=>'green')
+            @test_progress_bar.place('relwidth'=>(count.zero? ? 0 : 0/count))
+            @red = false
+
+            @test_count_label.value = 0
+            @assertion_count_label.value = 0
+            @failure_count_label.value = 0
+            @error_count_label.value = 0
+
+            @fault_list.delete(0, 'end')
+            @fault_detail_list = []
+            clear_fault
+          end
+
+          def add_fault(fault)
+            if ( ! @red )
+              @test_progress_bar.configure('background'=>'red')
+              @red = true
+            end
+            @fault_detail_list.push fault
+            @fault_list.insert('end', fault.short_display)
+          end
+
+          def show_fault(fault)
+            raw_show_fault(fault.long_display)
+          end
+
+          def raw_show_fault(string)
+            @detail_text.value = string
+          end
+
+          def clear_fault
+            raw_show_fault("")
+          end
+
+          def result_changed(result)
+            @test_count_label.value = result.run_count
+            @test_progress_bar.place('relwidth'=>result.run_count/@test_total_count)
+            @assertion_count_label.value = result.assertion_count
+            @failure_count_label.value = result.failure_count
+            @error_count_label.value = result.error_count
+          end
+
+          def started(result)
+            @result = result
+            output_status("Started...")
+          end
+
+          def test_started(test_name)
+            output_status("Running #{test_name}...")
+          end
+
+          def finished(elapsed_time)
+            output_status("Finished in #{elapsed_time} seconds")
+          end
+
+          def output_status(string)
+            @status_entry.value = string
+          end
+
+          def setup_ui
+            @status_entry = TkVariable.new
+            l = TkLabel.new(nil, 'textvariable'=>@status_entry, 'relief'=>'sunken')
+            l.pack('side'=>'bottom', 'fill'=>'x')
+
+            suite_frame = TkFrame.new.pack('fill'=>'x')
+
+            @run_button = TkButton.new(suite_frame, 'text'=>'Run')
+            @run_button.pack('side'=>'right')
+
+            TkLabel.new(suite_frame, 'text'=>'Suite:').pack('side'=>'left')
+            @suite_name_entry = TkVariable.new
+            l = TkLabel.new(suite_frame, 'textvariable'=>@suite_name_entry, 'relief'=>'sunken')
+            l.pack('side'=>'left', 'fill'=>'x', 'expand'=>true)
+
+            f = TkFrame.new(nil, 'relief'=>'sunken', 'borderwidth'=>3, 'height'=>20).pack('fill'=>'x', 'padx'=>1)
+            @test_progress_bar = TkFrame.new(f, 'background'=>'green').place('anchor'=>'nw', 'relwidth'=>0.0, 'relheight'=>1.0)
+
+            info_frame = TkFrame.new.pack('fill'=>'x')
+            @test_count_label = create_count_label(info_frame, 'Tests:')
+            @assertion_count_label = create_count_label(info_frame, 'Assertions:')
+            @failure_count_label = create_count_label(info_frame, 'Failures:')
+            @error_count_label = create_count_label(info_frame, 'Errors:')
+
+	    if (::Tk.info('command', TkPanedWindow::TkCommandNames[0]) != "")
+	      # use panedwindow
+	      paned_frame = TkPanedWindow.new("orient"=>"vertical").pack('fill'=>'both', 'expand'=>true)
+
+	      fault_list_frame = TkFrame.new(paned_frame)
+	      detail_frame = TkFrame.new(paned_frame)
+
+	      paned_frame.add(fault_list_frame, detail_frame)
+	    else
+	      # no panedwindow
+	      paned_frame = nil
+	      fault_list_frame = TkFrame.new.pack('fill'=>'both', 'expand'=>true)
+	      detail_frame = TkFrame.new.pack('fill'=>'both', 'expand'=>true)
+	    end
+
+	    TkGrid.rowconfigure(fault_list_frame, 0, 'weight'=>1, 'minsize'=>0)
+	    TkGrid.columnconfigure(fault_list_frame, 0, 'weight'=>1, 'minsize'=>0)
+
+            fault_scrollbar_y = TkScrollbar.new(fault_list_frame)
+            fault_scrollbar_x = TkScrollbar.new(fault_list_frame)
+            @fault_list = TkListbox.new(fault_list_frame)
+            @fault_list.yscrollbar(fault_scrollbar_y)
+            @fault_list.xscrollbar(fault_scrollbar_x)
+
+	    TkGrid.rowconfigure(detail_frame, 0, 'weight'=>1, 'minsize'=>0)
+	    TkGrid.columnconfigure(detail_frame, 0, 'weight'=>1, 'minsize'=>0)
+
+	    ::Tk.grid(@fault_list, fault_scrollbar_y, 'sticky'=>'news')
+	    ::Tk.grid(fault_scrollbar_x, 'sticky'=>'news')
+
+            detail_scrollbar_y = TkScrollbar.new(detail_frame)
+            detail_scrollbar_x = TkScrollbar.new(detail_frame)
+            @detail_text = TkText.new(detail_frame, 'height'=>10, 'wrap'=>'none') {
+              bindtags(bindtags - [TkText])
+	    }
+	    @detail_text.yscrollbar(detail_scrollbar_y)
+	    @detail_text.xscrollbar(detail_scrollbar_x)
+
+	    ::Tk.grid(@detail_text, detail_scrollbar_y, 'sticky'=>'news')
+	    ::Tk.grid(detail_scrollbar_x, 'sticky'=>'news')
+
+	    # rubber-style pane
+	    if paned_frame
+	      ::Tk.update
+	      @height = paned_frame.winfo_height
+	      paned_frame.bind('Configure', proc{|h|
+		paned_frame.sash_place(0, 0, paned_frame.sash_coord(0)[1] * h / @height)
+		@height = h
+	      }, '%h')
+	    end
+          end
+
+          def create_count_label(parent, label)
+            TkLabel.new(parent, 'text'=>label).pack('side'=>'left', 'expand'=>true)
+            v = TkVariable.new(0)
+            TkLabel.new(parent, 'textvariable'=>v).pack('side'=>'left', 'expand'=>true)
+            v
+          end
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  Screw::Unit::UI::Tk::TestRunner.start_command_line_test
+end

data/test/screw/unit/util.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+require File.join(dir, 'util', 'backtrace_filter')
+require File.join(dir, 'util', 'observable')
+require File.join(dir, 'util', 'proc_wrapper')

data/test/screw/unit/util/backtrace_filter.rb

@@ -0,0 +1,40 @@
+module Screw
+  module Unit
+    module Util
+      module BacktraceFilter
+        TESTUNIT_FILE_SEPARATORS = %r{[\\/:]}
+        TESTUNIT_PREFIX = __FILE__.split(TESTUNIT_FILE_SEPARATORS)[0..-3]
+        TESTUNIT_RB_FILE = /\.rb\Z/
+        
+        def filter_backtrace(backtrace, prefix=nil)
+          return ["No backtrace"] unless(backtrace)
+          split_p = if(prefix)
+            prefix.split(TESTUNIT_FILE_SEPARATORS)
+          else
+            TESTUNIT_PREFIX
+          end
+          match = proc do |e|
+            split_e = e.split(TESTUNIT_FILE_SEPARATORS)[0, split_p.size]
+            next false unless(split_e[0..-2] == split_p[0..-2])
+            split_e[-1].sub(TESTUNIT_RB_FILE, '') == split_p[-1]
+          end
+          return backtrace unless(backtrace.detect(&match))
+          found_prefix = false
+          new_backtrace = backtrace.reverse.reject do |e|
+            if(match[e])
+              found_prefix = true
+              true
+            elsif(found_prefix)
+              false
+            else
+              true
+            end
+          end.reverse
+          new_backtrace = (new_backtrace.empty? ? backtrace : new_backtrace)
+          new_backtrace = new_backtrace.reject(&match)
+          new_backtrace.empty? ? backtrace : new_backtrace
+        end
+      end
+    end
+  end
+end

data/test/screw/unit/util/observable.rb

@@ -0,0 +1,82 @@
+module Screw
+  module Unit
+    module Util
+
+      # This is a utility class that allows anything mixing
+      # it in to notify a set of listeners about interesting
+      # events.
+      module Observable
+        # We use this for defaults since nil might mean something
+        NOTHING = "NOTHING/#{__id__}"
+
+        # Adds the passed proc as a listener on the
+        # channel indicated by channel_name. listener_key
+        # is used to remove the listener later; if none is
+        # specified, the proc itself is used.
+        #
+        # Whatever is used as the listener_key is
+        # returned, making it very easy to use the proc
+        # itself as the listener_key:
+        #
+        #  listener = add_listener("Channel") { ... }
+        #  remove_listener("Channel", listener)
+        def add_listener(channel_name, listener_key=NOTHING, &listener) # :yields: value
+          unless(block_given?)
+            raise ArgumentError.new("No callback was passed as a listener")
+          end
+      
+          key = listener_key
+          if (listener_key == NOTHING)
+            listener_key = listener
+            key = ProcWrapper.new(listener)
+          end
+      
+          channels[channel_name] ||= {}
+          channels[channel_name][key] = listener
+          return listener_key
+        end
+
+        # Removes the listener indicated by listener_key
+        # from the channel indicated by
+        # channel_name. Returns the registered proc, or
+        # nil if none was found.
+        def remove_listener(channel_name, listener_key)
+          channel = channels[channel_name]
+          return nil unless (channel)
+          key = listener_key
+          if (listener_key.instance_of?(Proc))
+            key = ProcWrapper.new(listener_key)
+          end
+          if (channel.has_key?(key))
+            return channel.delete(key)
+          end
+          return nil
+        end
+
+        # Calls all the procs registered on the channel
+        # indicated by channel_name. If value is
+        # specified, it is passed in to the procs,
+        # otherwise they are called with no arguments.
+        #
+        #--
+        #
+        # Perhaps this should be private? Would it ever
+        # make sense for an external class to call this
+        # method directly?
+        def notify_listeners(channel_name, *arguments)
+          channel = channels[channel_name]
+          return 0 unless (channel)
+          listeners = channel.values
+          listeners.each { |listener| listener.call(*arguments) }
+          return listeners.size
+        end
+
+        private
+        def channels
+          @channels ||= {}
+          return @channels
+        end
+      end
+    end
+  end
+end