tapout 0.3.2 → 0.4.0

data/lib/tapout/reporters/pretty_reporter.rb

@@ -1,32 +1,31 @@
 require 'tapout/core_ext'
 require 'tapout/reporters/abstract'
 
-module TapOut
+module Tapout
 
   module Reporters
 
-    # = Pretty Reporter (by Paydro)
+    # Pretty Reporter (by Paydro)
     #
     class PrettyReporter < Abstract
 
       #
       PADDING_SIZE = 4
 
-      PASS  = "PASS".ansi(:green)
-      FAIL  = "FAIL".ansi(:red)
-      ERROR = "ERROR".ansi(:yellow)
+      PASS  = " PASS".ansi(*Tapout.config.pass)
+      TODO  = " TODO".ansi(*Tapout.config.todo)
+      OMIT  = " OMIT".ansi(*Tapout.config.omit)
+      FAIL  = " FAIL".ansi(*Tapout.config.fail)
+      ERROR = "ERROR".ansi(*Tapout.config.error)
 
       #
       def start_suite(suite)
-        #old_sync, @@out.sync = @@out.sync, true if io.respond_to? :sync=
+        super(suite)
         @suite  = suite
-        @time   = Time.now
-        #@stdout = StringIO.new
-        #@stderr = StringIO.new
         #files = suite.collect{ |s| s.file }.join(' ')
-      #puts "Loaded suite #{suite.name}"
-        puts "Suite seed: #{suite['seed']}" if suite['seed']
-        puts "Started"
+        print "Running Suite"  #{suite.name}
+        print " w/ Seed: #{suite['seed']}" if suite['seed']
+        puts
       end
 
       #
@@ -53,75 +52,83 @@ module TapOut
 
       #
       def pass(test)
+        return if config.minimal?
+
+        label = test['label'].to_s.ansi(*config.highlight)
+
         print pad_with_size("#{PASS}")
-        print " #{test['label']}"
+        print " #{label}"
         print " (%.2fs) " % (Time.now - @test_time)
+
         #if message
         #  message = test['source'].ansi(:magenta)
         #  message = message.to_s.tabto(10)
         #  puts(message)
         #end
+
+        # TODO: Is there any reason to show captured output for passing test?
+        #if captured_output?(test)
+        #  puts captured_output(test).tabto(tabsize)
+        #end
       end
 
       #
-      def fail(test)
-        print pad_with_size("#{FAIL}")
-        print " #{test['label']}"
+      def todo(test)
+        label = test['label'].to_s.ansi(*config.highlight)
+
+        print pad_with_size("#{TODO}")
+        print " #{label}"
         print " (%.2fs) " % (Time.now - @test_time)
+      end
+
+      #
+      def omit(test)
+        return if config.minimal?
+
+        label = test['label'].to_s.ansi(*config.highlight)
 
-        #message = assertion.location[0] + "\n" + assertion.message #.gsub("\n","\n")
-        #trace   = MiniTest::filter_backtrace(report[:exception].backtrace).first
+        print pad_with_size("#{OMIT}")
+        print " #{label}"
+        print " (%.2fs) " % (Time.now - @test_time)
+      end
+
+      #
+      def fail(test)
+        label = test['label'].to_s.ansi(*config.highlight)
 
-        message = test['exception']['message']
+        print pad_with_size("#{FAIL}")
+        print " #{label}"
+        print " (%.2fs) " % (Time.now - @test_time)
 
-        if bt = test['exception']['backtrace']
-          _trace = clean_backtrace(bt)
-        else
-          _trace = []
-        end
+        message = test['exception']['message'].to_s
 
-        trace   = _trace.shift
-        depth   = TapOut.trace || trace.size
         tabsize = 10
 
         puts
-        #puts pad(message, tabsize)
         puts message.tabto(tabsize)
-        puts trace.tabto(tabsize)
-        puts _trace[0,depth].map{|l| l.tabto(tabsize) }.join("\n")
-        #show_captured_output
+        puts backtrace_snippets(test).tabto(tabsize)
+
+        print captured_output(test).tabto(tabsize)
       end
 
       #
       def error(test)
+        label = test['label'].to_s.ansi(*config.highlight)
+
         print pad_with_size("#{ERROR}")
-        print " #{test['label']}"
+        print " #{label}"
         print " (%.2fs) " % (Time.now - @test_time)
 
-        #message = exception.to_s.split("\n")[2..-1].join("\n")
+        message = test['exception']['message'].to_s
 
-        message = test['exception']['message']
-
-        if bt = test['exception']['backtrace']
-          _trace = clean_backtrace(bt)
-        else
-          _trace = filter_backtrace(bt)
-        end
-
-        trace   = _trace.shift
-        depth   = TapOut.trace || trace.size
         tabsize = 10
 
         puts
-        puts message.tabto(tabsize)
-        puts trace.tabto(tabsize)
-        puts _trace[0,depth].map{|l| l.tabto(tabsize) }.join("\n")
-      end
+        puts message.tabto(tabsize) unless message.empty?
+        puts backtrace_snippets(test).tabto(tabsize)
 
-      # TODO: skip support
-      #def skip
-      #  puts(pad_with_size("#{SKIP}"))
-      #end
+        print captured_output(test).tabto(tabsize)
+      end
 
       #
       def finish_test(test)
@@ -132,31 +139,7 @@ module TapOut
         #$stderr = STDERR
       end
 
-=begin
-      def show_captured_output
-        show_captured_stdout
-        show_captured_stderr
-      end
-
-      def show_captured_stdout
-        @stdout.rewind
-        return if @stdout.eof?
-        STDOUT.puts(<<-output.tabto(8))
-  \nSTDOUT:
-  #{@stdout.read}
-        output
-      end
-
-      def show_captured_stderr
-        @stderr.rewind
-        return if @stderr.eof?
-        STDOUT.puts(<<-output.tabto(8))
-  \nSTDERR:
-  #{@stderr.read}
-        output
-      end
-=end
-
+      #
       def finish_case(kase)
         #if kase.size == 0
         #  puts pad("(No Tests)")
@@ -167,22 +150,18 @@ module TapOut
       def finish_suite(final)
         #@@out.sync = old_sync if @@out.respond_to? :sync=
 
-        total   = final['counts']['total'] || 0
-        failure = final['counts']['fail']  || 0
-        error   = final['counts']['error'] || 0
-        skip    = final['counts']['skip']  || 0
-        omit    = final['counts']['omit']  || 0
-        #pass    = total - failure - error
+        total, pass, fail, error, todo, omit = count_tally(final)
 
         puts
-        puts "Finished in #{'%.6f' % (Time.now - @time)} seconds."
+        puts "Finished in #{'%.6f' % (Time.now - @start_time)} seconds."
         puts
 
-        print "%d tests, " % total
+        print "%d tests: " % total
         #print "%d assertions, " % suite.count_assertions
-        print ("%d failures" % failure).ansi(:red) + ', '
-        print ("%d errors" % error).ansi(:yellow) + ', '
-        print ("%d pending" % skip).ansi(:cyan)
+        print ("%d failures" % fail).ansi(*config.fail)   + ', '
+        print ("%d errors"   % error).ansi(*config.error) + ', '
+        print ("%d pending"  % todo).ansi(*config.todo)   + ', '
+        print ("%d omitted"  % omit).ansi(*config.omit)
         puts
       end
 

data/lib/tapout/reporters/progress_reporter.rb

@@ -1,7 +1,7 @@
 require 'tapout/reporters/abstract'
 require 'ansi/progressbar'
 
-module TapOut
+module Tapout
 
   module Reporters
 
@@ -10,10 +10,18 @@ module TapOut
     #
     class ProgressReporter < Abstract
 
+      FAIL  = "FAIL".ansi(*Tapout.config.fail)
+      ERROR = "ERROR".ansi(*Tapout.config.error)
+
+      #
       def start_suite(entry)
         @pbar = ::ANSI::Progressbar.new('Testing', entry['count'].to_i + 1)
-        @pbar.style(:bar=>:green)
+        @pbar.style(:bar=>[:invert, *config.pass])
         @pbar.inc
+
+        @i = 0
+
+        super(entry)
       end
 
       def start_case(entry)
@@ -24,54 +32,65 @@ module TapOut
       #end
 
       def pass(entry)
+        @pbar.style(:bar=>config.pass)
         @pbar.inc
       end
 
       #
-      def fail(entry)
+      def fail(test)
         @pbar.clear
 
-        e = entry['exception']
+        err = test['exception']
 
+        label    = test['label'].to_s
+        errclass = err['class']
+        message  = err['message']
+        trace    = backtrace_snippets(test)
+        capture  = captured_output(err)
+
+        parts = [errclass, message, trace, capture].compact.reject{ |x| x.strip.empty? }
+
+        puts "#{@i+=1}. #{FAIL} #{label}"
         puts
-        message = e['message'].strip
-        message = message.ansi(:red)
-        puts(message)
-        puts "#{e['file']}:#{e['line']}"
-        puts
-        puts code_snippet(e)
+        puts parts.join("\n\n").tabto(4)
         puts
 
-        @pbar.style(:bar=>:red)
+        @pbar.style(:bar=>config.fail)
         @pbar.inc
       end
 
       #
-      def error(entry) #message=nil)
+      def error(test)
         @pbar.clear
 
-        e = entry['exception']
+        err = test['exception']
 
+        label    = test['label'].to_s
+        errclass = err['class']
+        message  = err['message']
+        trace    = backtrace_snippets(test)
+        capture  = captured_output(err)
+
+        parts = [errclass, message, trace, capture].compact.reject{ |x| x.strip.empty? }
+
+        puts "#{@i+=1}. #{ERROR} #{label}"
         puts
-        message = [e['class'], e['message']].compact.join(': ').strip
-        message = message.ansi(:red)
-        puts(message)
-        puts "#{e['file']}:#{e['line']}"
-        puts
-        puts code_snippet(e)
+        puts parts.join("\n\n").tabto(4)
         puts
 
-        @pbar.style(:bar=>:yellow)
+        @pbar.style(:bar=>config.error)
         @pbar.inc
       end
 
       #
-      def omit(entry)
+      def todo(entry)
+        @pbar.style(:bar=>config.todo)
         @pbar.inc
       end
 
       #
-      def skip(entry)
+      def omit(entry)
+        @pbar.style(:bar=>config.omit)
         @pbar.inc
       end
 
@@ -79,7 +98,13 @@ module TapOut
       #end
 
       def finish_suite(entry)
+        total, pass, fail, error, todo, omit = count_tally(entry)
+
+        @pbar.style(:bar=>config.pass)  if pass > 0
+        @pbar.style(:bar=>config.error) if error > 0
+        @pbar.style(:bar=>config.fail)  if fail > 0
         @pbar.finish
+
         #post_report(entry)
         puts
         puts tally_message(entry)

data/lib/tapout/reporters/runtime_reporter.rb

@@ -0,0 +1,223 @@
+require 'tapout/core_ext'
+require 'tapout/reporters/abstract'
+
+module Tapout
+
+  module Reporters
+
+    #
+    #
+    class RuntimeReporter < Abstract
+
+      #
+      PADDING_SIZE = 4
+
+      #
+      TABSIZE = 4
+
+      # TODO: Fix ANSI for this
+      WIDTH = `tput cols`.to_i - 1 #::ANSI::Terminal.terminal_width || ENV['COLUMNS'].to_i
+
+      PASS  = " PASS  "
+      SKIP  = " TODO  "
+      OMIT  = " SKIP  "
+      FAIL  = " FAIL  "
+      ERROR = " ERROR "
+
+      #
+      def start_suite(suite)
+        super(suite)
+
+        @suite  = suite
+        @count  = 0
+        @index  = 0
+
+        @suite_size = suite['count'].to_i
+        @case_stack = []
+
+        # pad for index based on how big the index number will get
+        @index_pad = @suite_size.zero? ? '' : @suite_size.to_s.size
+
+        #files = suite['files'].collect{ |s| s.file }.join(' ')
+
+        print "Started Suite (#{@suite_size})" ##{suite.name}"
+        print " w/ Seed: #{suite['seed']}" if suite['seed']
+        puts
+      end
+
+      #
+      def start_case(kase)
+        #return if kase.size == 0  # TODO: Don't have size yet?
+        last = @case_stack.pop
+        while last
+          break if last['level'].to_i <= kase['level'].to_i
+          last = @case_stack.pop
+        end
+
+        @case_stack << kase
+      end
+
+      #
+      def start_test(test)
+        @test_time = Time.now
+        @test  = test
+        @count = @count + 1
+      end
+
+      # TODO: Only show if in verbose mode.
+      def pass(test)
+        stamp_it(test, PASS, :green) unless config.minimal?
+
+        #if message
+        #  message = test['source'].ansi(:magenta)
+        #  message = message.to_s.tabto(10)
+        #  puts(message)
+        #end
+
+        # TODO: Is there any reason to show captured output for passing test?
+        #if captured_output?(test)
+        #  puts captured_output(test).tabto(TABSIZE)
+        #end
+      end
+
+      #
+      def skip(test)
+        stamp_it(test, SKIP, :cyan) #unless config.minimal?
+      end
+
+      #
+      def omit(test)
+        stamp_it(test, OMIT, :blue) unless config.minimal?
+      end
+
+      #
+      def fail(test)
+        stamp_it(test, FAIL, :red)
+
+        #message = assertion.location[0] + "\n" + assertion.message #.gsub("\n","\n")
+        #trace   = MiniTest::filter_backtrace(report[:exception].backtrace).first
+
+        message = test['exception']['message']
+
+        puts
+        if message
+          puts
+          puts message.tabto(TABSIZE)
+        end
+        puts
+
+        puts backtrace_snippets(test).tabto(TABSIZE)
+
+        print captured_output(test).tabto(TABSIZE)
+      end
+
+      #
+      def error(test)
+        stamp_it(test, ERROR, :red)
+
+        message = test['exception']['message']
+
+        puts
+        if message && !message.empty?
+          puts
+          puts message.tabto(TABSIZE)
+        end
+        puts
+
+        puts backtrace_snippets(test).tabto(TABSIZE)
+
+        print captured_output(test).tabto(TABSIZE)
+      end
+
+      #
+      def finish_test(test)
+        puts unless config.minimal?
+      end
+
+      #
+      def finish_case(kase)
+        #if kase.size == 0
+        #  puts pad("(No Tests)")
+        #end
+      end
+
+      #
+      def finish_suite(final)
+        #@@out.sync = old_sync if @@out.respond_to? :sync=
+
+        total, pass, fail, error, todo, omit = count_tally(final)
+
+        time, rate, avg = time_tally(final)
+
+        puts
+        puts "Finished in %.6f seconds. %.3f tests per second." % [time, rate]
+        puts
+
+        print ("%d tests: "  % total)
+        #print "%d assertions, " % suite.count_assertions
+        print ("%d failures" % fail).ansi(*config.fail) + ', '
+        print ("%d errors"   % error).ansi(*config.error) + ', '
+        print ("%d pending"  % todo).ansi(*config.todo) + ', '
+        print ("%d omitted"  % omit).ansi(*config.omit)
+        puts
+      end
+
+    private
+
+      #
+      def pad(str, size=PADDING_SIZE)
+        " " * size + str
+      end
+
+      #
+      def pad_with_size(str)
+        " " * (18 - str.size) + str
+      end
+
+      NOMINAL = []
+
+      #
+      def stamp_it(test, type, *color)
+        @index += 1
+
+        cases  = @case_stack.map{ |k| k['label'] }.join(' ')
+        time  = Time.now
+        delta = time - @test_time
+        #label = test['label']
+        label = [cases, test['label']].join(' ').strip
+
+        indexS = @index
+        prcntS = " %3s%% " % [@count * 100 / @suite_size]
+        ratioS = " #{@count}/#{@suite_size} "
+        deltaS = " %.6f " % [time - @test_time]
+         timeS = " " + duration(time - @start_time) #time.strftime(' %H:%M:%S.%L ')
+         typeS = type.to_s
+
+        width = WIDTH - (ratioS.size + prcntS.size + deltaS.size + timeS.size + indexS.size + typeS.size + 9)
+
+         typeS = typeS.ansi(*color)
+
+        prcntS = prcntS.ansi(*NOMINAL)
+        ratioS = ratioS.ansi(*NOMINAL)
+
+        if delta > 30
+          delteS = deltaS.ansi(:yellow)
+        elsif delta > 60
+          deltaS = deltaS.ansi(:red)
+        else
+          deltaS = deltaS.ansi(*NOMINAL)
+        end
+
+        timeS = timeS.ansi(*NOMINAL)
+
+        stuff = [indexS, typeS, label.ansi(:bold), ratioS, prcntS, deltaS, timeS]
+
+        print " %#{@index_pad}d |%s| %-#{width}s %s|%s|%s|%s" % stuff
+      end
+
+    end
+
+  end
+
+end
+