treetop 0.1.0 → 1.0.0

data/test/screw/unit/failure.rb

@@ -0,0 +1,45 @@
+module Screw
+  module Unit
+
+    # Encapsulates a test failure. Created by Screw::Unit::TestCase
+    # when an assertion fails.
+    class Failure
+      attr_reader :test_name, :location, :message
+      
+      SINGLE_CHARACTER = 'F'
+
+      # Creates a new Failure with the given location and
+      # message.
+      def initialize(test_name, location, message)
+        @test_name = test_name
+        @location = location
+        @message = message
+      end
+      
+      # Returns a single character representation of a failure.
+      def single_character_display
+        SINGLE_CHARACTER
+      end
+
+      # Returns a brief version of the error description.
+      def short_display
+        "#@test_name: #{@message.split("\n")[0]}"
+      end
+
+      # Returns a verbose version of the error description.
+      def long_display
+        location_display = if(location.size == 1)
+          location[0].sub(/\A(.+:\d+).*/, ' [\\1]')
+        else
+          "\n    [#{location.join("\n     ")}]"
+        end
+        "Failure:\n#@test_name#{location_display}:\n#@message"
+      end
+
+      # Overridden to return long_display.
+      def to_s
+        long_display
+      end
+    end
+  end
+end

data/test/screw/unit/sugar.rb

@@ -0,0 +1,25 @@
+class Object
+  def context(description, options = {}, &block)
+    superclass = options[:extend] || Screw::Unit::TestCase
+    test_case_class = Class.new(superclass, &block)
+    test_case_class.test_case_description = description
+    Object.send(:const_set, unique_test_case_name(description.sanitize.camelize), test_case_class)
+  end
+  
+  def unique_test_case_name(name, n=1)
+    candidate_name = (n > 1 ? "#{name}#{n}" : name).to_sym
+    if Object.const_defined?(candidate_name)
+      unique_test_case_name(name, n + 1)
+    else
+      candidate_name
+    end
+  end
+  
+  alias :describe :context
+end
+
+class String
+  def sanitize
+    self.gsub(/[^\w]+/, "_")
+  end
+end

data/test/screw/unit/test_case.rb

@@ -0,0 +1,176 @@
+module Screw
+  module Unit
+
+    # Ties everything together. If you subclass and add your own
+    # test methods, it takes care of making them into tests and
+    # wrapping those tests into a suite. It also does the
+    # nitty-gritty of actually running an individual test and
+    # collecting its results into a Screw::Unit::TestResult object.
+    class TestCase
+      class << self
+        
+        attr_writer :test_case_description
+        
+        def test_case_description
+          @test_case_description || self.to_s
+        end
+        
+        # Rolls up all of the test* methods in the fixture into
+        # one suite, creating a new instance of the fixture for
+        # each method.
+        def suite
+          method_names = public_instance_methods(true)
+          tests = method_names.delete_if {|method_name| method_name !~ /^test./}
+          suite = TestSuite.new(name)
+          tests.sort.each do
+            |test|
+            catch(:invalid_test) do
+              suite << new(test)
+            end
+          end
+          return suite
+        end
+        
+        def test_names
+          @test_names ||= Hash.new
+        end
+        
+        # Creates a test method by prefixing string with 'test_' and replacing non word characters with underbars
+        def test(name_string, &block)        
+          method_name = unique_test_name("test_" + name_string.sanitize)
+          test_names[method_name] = name_string
+          define_method(method_name, &block)
+        end
+        
+        def unique_test_name(name, n=1)
+          candidate_name = (n > 1 ? "#{name}#{n}" : name).to_sym
+          if method_defined?(candidate_name)
+            unique_test_name(name, n + 1)
+          else
+            candidate_name
+          end
+        end
+        
+        
+        alias :it :test
+      end
+      
+      
+      include Assertions
+      include Spec::Matchers
+      include Util::BacktraceFilter
+      
+      attr_reader :method_name
+      
+      STARTED = name + "::STARTED"
+      FINISHED = name + "::FINISHED"
+
+      ##
+      # These exceptions are not caught by #run.
+
+      PASSTHROUGH_EXCEPTIONS = [NoMemoryError, SignalException, Interrupt,
+                                SystemExit]
+
+      # Creates a new instance of the fixture for running the
+      # test represented by test_method_name.
+      def initialize(test_method_name)
+        unless(respond_to?(test_method_name) and
+               (method(test_method_name).arity == 0 ||
+                method(test_method_name).arity == -1))
+          throw :invalid_test
+        end
+        @method_name = test_method_name
+        @test_passed = true
+      end
+
+      # Runs the individual test method represented by this
+      # instance of the fixture, collecting statistics, failures
+      # and errors in result.
+      def run(result)
+        yield(STARTED, name)
+        @_result = result
+        begin
+          setup
+          __send__(@method_name)
+        rescue AssertionFailedError => e
+          add_failure(e.message, e.backtrace)
+        rescue Exception
+          raise if PASSTHROUGH_EXCEPTIONS.include? $!.class
+          add_error($!)
+        ensure
+          begin
+            teardown
+          rescue AssertionFailedError => e
+            add_failure(e.message, e.backtrace)
+          rescue Exception
+            raise if PASSTHROUGH_EXCEPTIONS.include? $!.class
+            add_error($!)
+          end
+        end
+        result.add_run
+        yield(FINISHED, name)
+      end
+
+      # Called before every test method runs. Can be used
+      # to set up fixture information.
+      def setup
+      end
+
+      # Called after every test method runs. Can be used to tear
+      # down fixture information.
+      def teardown
+      end
+      
+      def default_test
+        flunk("No tests were specified")
+      end
+
+      # Returns whether this individual test passed or
+      # not. Primarily for use in teardown so that artifacts
+      # can be left behind if the test fails.
+      def passed?
+        return @test_passed
+      end
+      private :passed?
+
+      def size
+        1
+      end
+
+      def add_assertion
+        @_result.add_assertion
+      end
+      private :add_assertion
+
+      def add_failure(message, all_locations=caller())
+        @test_passed = false
+        @_result.add_failure(Failure.new(name, filter_backtrace(all_locations), message))
+      end
+      private :add_failure
+
+      def add_error(exception)
+        @test_passed = false
+        @_result.add_error(Error.new(name, exception))
+      end
+      private :add_error
+
+      # Returns a human-readable name for the specific test that
+      # this instance of TestCase represents.
+      def name
+        "#{self.class.test_case_description}: #{self.class.test_names[@method_name] || @method_name}"
+      end
+
+      # Overridden to return #name.
+      def to_s
+        name
+      end
+      
+      # It's handy to be able to compare TestCase instances.
+      def ==(other)
+        return false unless(other.kind_of?(self.class))
+        return false unless(@method_name == other.method_name)
+        self.class == other.class
+      end
+    end
+  end
+end

data/test/screw/unit/test_result.rb

@@ -0,0 +1,73 @@
+module Screw
+  module Unit
+
+    # Collects Screw::Unit::Failure and Screw::Unit::Error so that
+    # they can be displayed to the user. To this end, observers
+    # can be added to it, allowing the dynamic updating of, say, a
+    # UI.
+    class TestResult
+      include Util::Observable
+
+      CHANGED = "CHANGED"
+      FAULT = "FAULT"
+
+      attr_reader(:run_count, :assertion_count)
+
+      # Constructs a new, empty TestResult.
+      def initialize
+        @run_count, @assertion_count = 0, 0
+        @failures, @errors = Array.new, Array.new
+      end
+
+      # Records a test run.
+      def add_run
+        @run_count += 1
+        notify_listeners(CHANGED, self)
+      end
+
+      # Records a Screw::Unit::Failure.
+      def add_failure(failure)
+        @failures << failure
+        notify_listeners(FAULT, failure)
+        notify_listeners(CHANGED, self)
+      end
+
+      # Records a Screw::Unit::Error.
+      def add_error(error)
+        @errors << error
+        notify_listeners(FAULT, error)
+        notify_listeners(CHANGED, self)
+      end
+
+      # Records an individual assertion.
+      def add_assertion
+        @assertion_count += 1
+        notify_listeners(CHANGED, self)
+      end
+
+      # Returns a string contain the recorded runs, assertions,
+      # failures and errors in this TestResult.
+      def to_s
+        "#{run_count} tests, #{assertion_count} assertions, #{failure_count} failures, #{error_count} errors"
+      end
+
+      # Returns whether or not this TestResult represents
+      # successful completion.
+      def passed?
+        return @failures.empty? && @errors.empty?
+      end
+
+      # Returns the number of failures this TestResult has
+      # recorded.
+      def failure_count
+        return @failures.size
+      end
+
+      # Returns the number of errors this TestResult has
+      # recorded.
+      def error_count
+        return @errors.size
+      end
+    end
+  end
+end

data/test/screw/unit/test_suite.rb

@@ -0,0 +1,70 @@
+module Screw
+  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")
+        @name = name
+        @tests = []
+      end
+      
+      # Runs the tests and/or suites contained in this
+      # TestSuite.
+      def run(result, &progress_block)
+        yield(STARTED, name)
+        @tests.each do |test|
+          test.run(result, &progress_block)
+        end
+        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
+    end
+  end
+end

data/test/screw/unit/ui.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+require File.join(dir, 'ui', 'test_runner_mediator')
+require File.join(dir, 'ui', 'test_runner_utilities')
+#require File.join(dir, 'ui', 'console', 'test_runner')

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

@@ -0,0 +1,118 @@
+module Screw
+  module Unit
+    module UI
+      module Console
+
+        # Runs a Screw::Unit::TestSuite on the console.
+        class TestRunner
+          extend TestRunnerUtilities
+
+          # 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, output_level=NORMAL, io=STDOUT)
+            if (suite.respond_to?(:suite))
+              @suite = suite.suite
+            else
+              @suite = suite
+            end
+            @output_level = output_level
+            @io = io
+            @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)
+            suite_name = @suite.to_s
+            if ( @suite.kind_of?(Module) )
+              suite_name = @suite.name
+            end
+            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_single(fault.single_character_display, PROGRESS_ONLY)
+            @already_outputted = true
+          end
+          
+          def started(result)
+            @result = result
+            output("Started")
+          end
+          
+          def finished(elapsed_time)
+            nl
+            output("Finished in #{elapsed_time} seconds.")
+            @faults.each_with_index do |fault, index|
+              nl
+              output("%3d) %s" % [index + 1, fault.long_display])
+            end
+            nl
+            output(@result)
+          end
+          
+          def test_started(name)
+            output_single(name + ": ", VERBOSE)
+          end
+          
+          def test_finished(name)
+            output_single(".", PROGRESS_ONLY) unless (@already_outputted)
+            nl(VERBOSE)
+            @already_outputted = false
+          end
+          
+          def nl(level=NORMAL)
+            output("", level)
+          end
+          
+          def output(something, level=NORMAL)
+            @io.puts(something) if (output?(level))
+            @io.flush
+          end
+          
+          def output_single(something, level=NORMAL)
+            @io.write(something) if (output?(level))
+            @io.flush
+          end
+          
+          def output?(level)
+            level <= @output_level
+          end
+        end
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  Screw::Unit::UI::Console::TestRunner.start_command_line_test
+end