turn 0.8.2 → 0.9.7

data/lib/turn/command.rb

@@ -1,34 +1,40 @@
 require 'optparse'
 
 module Turn
-  require 'turn/controller'
 
   # Turn - Pretty Unit Test Runner for Ruby
-  #
+  #  
   # SYNOPSIS
-  #   turn [OPTIONS] [RUN MODE] [OUTPUT MODE] [test globs...]
-  #
-  # OPTIONS
-  #   -h --help             display this help information
-  #      --live             don't use loadpath
-  #      --log              log results to a file
-  #   -n --name=PATTERN     only run tests that match regexp PATTERN
-  #   -I --loadpath=PATHS   add given PATHS to the $LOAD_PATH
-  #   -r --requires=LIBS    require given LIBS before running tests
-  #   -m --minitest         Force use of MiniTest framework.
-  #
+  #   turn [OPTIONS] [RUN MODE] [OUTPUT MODE] [TEST GLOBS ...]
+  #  
+  # GENERAL OPTIONS
+  #     -I, --loadpath=PATHS             add paths to $LOAD_PATH
+  #     -r, --require=LIBS               require libraries
+  #     -n, --name=PATTERN               only run tests that match PATTERN
+  #     -c, --case=PATTERN               only run test cases that match PATTERN
+  #     -b, --backtrace, --trace INT     Limit the number of lines of backtrace.
+  #         --natural                    Show natualized test names.
+  #         --[no-]ansi                  Force use of ANSI codes on or off.
+  #         --log                        log results to a file
+  #         --live                       do not use local load path
+  #  
   # RUN MODES
-  #      --normal      run all tests in a single process [default]
-  #      --solo        run each test in a separate process
-  #      --cross       run each pair of test files in a separate process
-  #
+  #         --normal                     run all tests in a single process [default]
+  #         --solo                       run each test in a separate process
+  #         --cross                      run each pair of test files in a separate process
+  #  
   # OUTPUT MODES
-  #   -O --outline     turn's original case/test outline mode [default]
-  #   -P --progress    indicates progress with progress bar
-  #   -D --dotted      test/unit's traditonal dot-progress mode
-  #      --pretty      new pretty reporter
-  #   -M --marshal     dump output as YAML (normal run mode only)
-  #   -Q --queued      interactive testing
+  #     -O, --outline                    turn's original case/test outline mode
+  #     -P, --progress                   indicates progress with progress bar
+  #     -D, --dot, --dotted              test-unit's traditonal dot-progress mode
+  #     -R, -T, --pretty                 new pretty output mode [default]
+  #     -C, --cue                        cue for action on each failure/error
+  #     -M, --marshal                    dump output as YAML (normal run mode only)
+  #  
+  # COMMAND OPTIONS
+  #         --debug                      turn debug mode on
+  #         --version                    display version
+  #     -h, --help                       display this help information
   #
   class Command
 
@@ -56,7 +62,7 @@ module Turn
     attr :requires
 
     # Framework to use, :minitest or :testunit.
-    attr :framework
+    #attr :framework
 
     # Run mode.
     attr :runmode
@@ -64,6 +70,24 @@ module Turn
     # Output mode.
     attr :outmode
 
+    # Decorator mode.
+    attr :decmode
+
+    # Enable full backtrace
+    attr :trace
+
+    # Use natural test case names.
+    attr :natural
+
+    # Show extra information.
+    attr :verbose
+
+    # Show extra information.
+    attr :mark
+
+    # Force ANSI use on or off.
+    attr :ansi
+
     #
     def initialize
       @live      = nil
@@ -74,7 +98,12 @@ module Turn
       @requires  = []
       @runmode   = nil
       @outmode   = nil
-      @framework = RUBY_VERSION >= "1.9" ? :minitest : :testunit
+      @decmode   = nil
+      @trace     = nil
+      @natural   = false
+      @verbose   = false
+      @mark      = nil
+      @ansi      = nil
     end
 
     #
@@ -106,7 +135,7 @@ module Turn
           end
         end
 
-        opts.on('-t', '--testcase=PATTERN', "only run testcases that match PATTERN") do |pattern|
+        opts.on('-c', '--case=PATTERN', "only run test cases that match PATTERN") do |pattern|
           if pattern =~ /\/(.*)\//
             @matchcase = Regexp.new($1)
           else
@@ -114,8 +143,24 @@ module Turn
           end
         end
 
-        opts.on('-m', '--minitest', "Force use of MiniTest framework") do
-          @framework = :minitest
+        opts.on('-m', '--mark=SECONDS', "Mark test if it exceeds runtime threshold.") do |int|
+          @mark = int.to_i
+        end
+
+        opts.on('-b', '--backtrace', '--trace INT', "Limit the number of lines of backtrace.") do |int|
+          @trace = int
+        end
+
+        opts.on('--natural', "Show natualized test names.") do |bool|
+          @natural = bool
+        end
+
+        opts.on('-v', '--verbose', "Show extra information.") do |bool|
+          @verbose = bool
+        end
+
+        opts.on('--[no-]ansi', "Force use of ANSI codes on or off.") do |bool|
+          @ansi = bool
         end
 
         # Turn does not support Test::Unit 2.0+
@@ -152,7 +197,7 @@ module Turn
         opts.separator " "
         opts.separator "OUTPUT MODES"
 
-        opts.on('--outline', '-O', "turn's original case/test outline mode [default]") do
+        opts.on('--outline', '-O', "turn's original case/test outline mode") do
           @outmode = :outline
         end
 
@@ -160,11 +205,11 @@ module Turn
           @outmode = :progress
         end
 
-        opts.on('--dotted', '-D', "test-unit's traditonal dot-progress mode") do
-          @outmode = :dotted
+        opts.on('--dot', '--dotted', '-D', "test-unit's traditonal dot-progress mode") do
+          @outmode = :dot
         end
 
-        opts.on('--pretty', '-T', "new pretty output mode") do
+        opts.on('--pretty', '-R', '-T', "new pretty output mode [default]") do
           @outmode = :pretty
         end
 
@@ -177,12 +222,22 @@ module Turn
           @outmode = :marshal
         end
 
+        opts.separator " "
+        opts.separator "DECORATOR MODES"
+
+        opts.on('--topten', "show only top ten slowest tests") do
+          @decmode = :topten
+        end
+
         opts.separator " "
         opts.separator "COMMAND OPTIONS"
 
         opts.on('--debug', "turn debug mode on") do
+          $DEBUG = true
+        end
+
+        opts.on('--warn', "turn warnings on") do
           $VERBOSE = true
-          $DEBUG   = true
         end
 
         opts.on_tail('--version', "display version") do
@@ -190,7 +245,7 @@ module Turn
           exit
         end
 
-        opts.on_tail('--help', '-h', "display this help information") do
+        opts.on_tail('-h', '--help', "display this help information") do
           puts opts
           exit
         end
@@ -203,9 +258,10 @@ module Turn
 
       @loadpath = ['lib'] if loadpath.empty?
 
-      tests = ARGV.empty? ? nil : ARGV.dup
+      tests = ARGV.empty? ? nil : argv.dup
 
-      controller = Turn::Controller.new do |c|
+      #config = Turn::Configuration.new do |c|
+      config = Turn.config do |c|
         c.live      = live
         c.log       = log
         c.loadpath  = loadpath
@@ -213,17 +269,24 @@ module Turn
         c.tests     = tests
         c.runmode   = runmode
         c.format    = outmode
+        c.mode      = decmode
         c.pattern   = pattern
         c.matchcase = matchcase
-        c.framework = framework
+        c.trace     = trace
+        c.natural   = natural
+        c.verbose   = verbose
+        c.mark      = mark
+        c.ansi      = ansi unless ansi.nil?
       end
 
+      controller = Turn::Controller.new(config)
+
       result = controller.start
 
       if result
-        exit result.passed?
+        exit (result.passed? ? 0 : -1)
       else # no tests
-        exit
+        exit -1
       end
     end
 

data/lib/turn/components/case.rb

@@ -23,7 +23,7 @@ module Turn
     attr_accessor :count_assertions
 
     # Holds dump of test output (optional depending on runner).
-    attr_accessor :message
+    attr_writer :message
 
     # Command used to run test (optional depending on runner).
     #attr_accessor :command
@@ -86,9 +86,14 @@ module Turn
       sum = 0; tests.each{ |t| sum += 1 if t.pass? }; sum
     end
 
+    def count_skips
+      # Why not use tests.select(&:skip?).size ?
+      sum = 0; tests.each{ |t| sum += 1 if t.skip? }; sum
+    end
+
     #
     def counts
-      return count_tests, count_assertions, count_failures, count_errors
+      return count_tests, count_assertions, count_failures, count_errors, count_skips
     end
 
     def message

data/lib/turn/components/method.rb

@@ -12,27 +12,38 @@ module Turn
       @name      = name
       @fail      = false
       @error     = false
+      @skip      = false
       @raised    = nil
       @message   = nil
       @backtrace = []
     end
 
     def fail!(assertion)
-      @fail, @error = true, false
+      @fail, @error, @skip = true, false, false
       @raised    = assertion
       @message   = assertion.message
       @backtrace = assertion.backtrace
     end
 
     def error!(exception)
-      @fail, @error = false, true
+      @fail, @error, @skip = false, true, false
       @raised    = exception
       @message   = exception.message
       @backtrace = exception.backtrace
     end
 
+    def skip!(assertion)
+      @fail, @error, @skip = false, false, true
+      @raised    = assertion
+      @message   = assertion.message
+      @backtrace = assertion.backtrace
+    end
+
     def fail?  ; @fail  ; end
     def error? ; @error ; end
+    def skip?  ; @skip  ; end
+
+    # TODO: should this include `or @skip`?
     def pass?  ; !(@fail or @error) ; end
 
     def to_s ; name ; end

data/lib/turn/components/suite.rb

@@ -6,18 +6,19 @@ module Turn
     include Enumerable
 
     attr_accessor :name
-    attr_accessor :size
     attr_accessor :cases
+    attr_accessor :seed
 
     # This one can be set manually since it
     # is not calculatable (beyond the case level).
-    attr_accessor :count_assertions
+    attr_writer :count_assertions
 
     #
     def initialize(name=nil)
       @name  = name
-      @size  = nil
       @cases = []
+      @size  = nil
+      @seed  = nil
 
       #@count_tests      = nil
       #@count_assertions = nil
@@ -63,9 +64,13 @@ module Turn
       #)
     end
 
+    def count_skips
+      sum = 0; each{ |c| sum += c.count_skips }; sum
+    end
+
     # Convenience methods --this is what is typcially wanted.
     def counts
-      return count_tests, count_assertions, count_failures, count_errors #,count_skips
+      return count_tests, count_assertions, count_failures, count_errors ,count_skips
     end
 
     def each(&block)
@@ -76,10 +81,14 @@ module Turn
       @size ||= @cases.size
     end
 
+    # Why the size would ever have to overridden... well who can say.
+    def size=(number)
+      @size = number.to_i
+    end
+
     def passed?
       (count_failures == 0 && count_errors == 0)
     end
   end
 
-end
-
+end

data/lib/turn/components.rb

@@ -0,0 +1,4 @@
+require 'turn/components/suite'
+require 'turn/components/case'
+require 'turn/components/method'
+

data/lib/turn/configuration.rb

@@ -0,0 +1,271 @@
+module Turn
+
+  # Configure Turn
+  def self.config(&block)
+    @config ||= Configuration.new
+    block.call(@config) if block
+    @config
+  end
+
+  # TODO: Support for test run loggging ?
+
+  # Central interface for Turn configuration.
+  #
+  class Configuration
+
+    # List of if file names or glob pattern of tests to run.
+    attr_reader :tests
+
+    # List of file names or globs to exclude from +tests+ list.
+    attr_reader :exclude
+
+    # Regexp pattern that all test name's must
+    # match to be eligible to run.
+    attr_accessor :pattern
+
+    # Regexp pattern that all test cases must
+    # match to be eligible to run.
+    attr_accessor :matchcase
+
+    # Add these folders to the $LOAD_PATH.
+    attr_reader :loadpath
+
+    # Libs to require when running tests.
+    attr_reader :requires
+
+    # Reporter type.
+    attr_accessor :format
+
+    # Report modifier. These act as decorators on the reporter class.
+    attr_accessor :mode
+
+    # Run mode, which defaults to `nil`, but can also be `:solo`,
+    # `:cross` or `:marshal`.
+    attr_accessor :runmode
+
+    # Test against live install (i.e. Don't use loadpath option)
+    attr_accessor :live
+
+    # Log results? May be true/false or log file name. (TODO)
+    attr_accessor :log
+
+    # Verbose output?
+    attr_accessor :verbose
+
+    # Runtime threshold.
+    attr_accessor :mark
+
+    # Test framework, either `:minitest` or `:testunit`.
+    # TODO: Is this used any more?
+    attr_accessor :framework
+
+    # Enable full backtrace
+    attr_accessor :trace
+
+    # Use natural language case names.
+    attr_accessor :natural
+
+    #
+    def verbose?
+      @verbose
+    end
+
+    #
+    def live?
+      @live
+    end
+
+    #
+    def natural?
+      @natural
+    end
+
+    #
+    def ansi?
+      @ansi
+    end
+
+  private
+
+    #
+    def initialize
+      yield(self) if block_given?
+      initialize_defaults
+    end
+
+    #
+    def initialize_defaults
+      @loadpath  ||= ['lib']
+      @tests     ||= ["test/**/{test,}*{,test}.rb"]
+      @exclude   ||= []
+      @requires  ||= []
+      @live      ||= false
+      @log       ||= true
+      #@runner   ||= RUBY_VERSION >= "1.9" ? MiniRunner : TestRunner
+      @matchcase ||= nil
+      @pattern   ||= /.*/
+      @natural   ||= false
+      @verbose   ||= false
+      @format    ||= environment_format
+      @mode      ||= environment_mode
+      @trace     ||= environment_trace
+      @ansi      ||= environment_ansi
+
+      @files = nil  # reset files just in case
+    end
+
+    # Collect test configuation.
+    #def test_configuration(options={})
+    #  #options = configure_options(options, 'test')
+    #  #options['loadpath'] ||= metadata.loadpath
+    #  options['tests']    ||= self.tests
+    #  options['loadpath'] ||= self.loadpath
+    #  options['requires'] ||= self.requires
+    #  options['live']     ||= self.live
+    #  options['exclude']  ||= self.exclude
+    #  #options['tests']    = list_option(options['tests'])
+    #  options['loadpath'] = list_option(options['loadpath'])
+    #  options['exclude']  = list_option(options['exclude'])
+    #  options['require']  = list_option(options['require'])
+    #  return options
+    #end
+
+    #
+    def list_option(list)
+      case list
+      when nil
+        []
+      when Array
+        list
+      else
+        list.split(/[:;]/)
+      end
+    end
+
+  public
+
+    def ansi=(boolean)
+      @ansi = boolean ? true : false
+    end
+
+    def tests=(paths)
+      @tests = list_option(paths)
+    end
+
+    def loadpath=(paths)
+      @loadpath = list_option(paths)
+    end
+
+    def exclude=(paths)
+      @exclude = list_option(paths)
+    end
+
+    def requires=(paths)
+      @requires = list_option(paths)
+    end
+
+    # Test files.
+    def files
+      @files ||= (
+        fs = tests.map do |t|
+          File.directory?(t) ? Dir[File.join(t, '**', '*')] : Dir[t]
+        end
+        fs = fs.flatten.reject{ |f| File.directory?(f) }
+
+        ex = exclude.map do |x|
+          File.directory?(x) ? Dir[File.join(x, '**', '*')] : Dir[x]
+        end
+        ex = ex.flatten.reject{ |f| File.directory?(f) }
+
+        (fs - ex).uniq.map{ |f| File.expand_path(f) }
+      ).flatten
+    end
+
+    # TODO: Better name ?
+    def suite_name
+      files.map{ |path| File.dirname(path).sub(Dir.pwd+'/','') }.uniq.join(',')
+    end
+
+    # Get selected reporter with any mode decorator.
+    def reporter
+      @reporter ||= decorate_reporter(reporter_class.new($stdout, reporter_options))
+    end
+
+    # Load reporter based on output mode and return its class.
+    def reporter_class
+      rpt_format = format || :pretty
+      class_name = rpt_format.to_s.capitalize + "Reporter"
+
+      path = "turn/reporters/#{rpt_format}_reporter"
+
+      [File.expand_path('~'), Dir.pwd].each do |dir|
+        file = File.join(dir, ".turn", "reporters", "#{rpt_format}_reporter.rb")
+        path = file if File.exist?(file)
+      end
+
+      require path
+
+      Turn.const_get(class_name)
+    end
+
+    #
+    def decorate_reporter(reporter)
+      if mode
+        decorator_class.new(reporter)
+      else
+        reporter
+      end
+    end
+
+    #
+    def decorator_class
+      return nil unless mode
+
+      class_name = mode.to_s.capitalize + "Decorator"
+
+      path = "turn/decorators/#{mode}_decorator"
+      [File.expand_path('~'), Dir.pwd].each do |dir|
+        file = File.join(dir, ".turn", "decorators", "#{mode}_reporter.rb")
+        path = file if File.exist?(file)
+      end
+
+      require path
+
+      Turn.const_get(class_name)
+    end
+
+    #
+    def reporter_options
+      { :trace=>trace, :natural=>natural?, :verbose=>verbose?, :mark=>mark }
+    end
+
+    #
+    def environment_format
+      ENV['rpt']
+    end
+
+    #
+    def environment_mode
+      ENV['mode']
+    end
+
+    #
+    def environment_trace
+      (ENV['backtrace'] ? ENV['backtrace'].to_i : nil)
+    end
+
+    #
+    def environment_ansi
+      case ENV['ansi']
+      when 'true','yes','on'
+        true
+      when 'false','no','off'
+        false
+      else
+        nil
+      end
+    end
+
+  end
+
+end