tapout 0.2.3 → 0.3.0

data/lib/tapout/reporters/{tap.rb → tap_reporter.rb}

@@ -3,7 +3,7 @@ require 'tapout/reporters/abstract'
 module TapOut::Reporters
 
   # Tap Reporter
-  class Tap < Abstract
+  class TapReporter < Abstract
 
     #
     def start_suite(entry)
@@ -54,7 +54,7 @@ module TapOut::Reporters
     end
 
     #
-    def err(entry)
+    def error(entry)
       super(entry)
 
       @i += 1

data/lib/tapout/reporters/turn_reporter.rb

@@ -0,0 +1,178 @@
+require 'tapout/reporters/abstract'
+require 'stringio'
+
+module TapOut
+
+  module Reporters
+
+    # The test report format made famous by Tim Piece and his Turn project.
+    #
+    #--
+    # TODO: Should we fit reporter output to width of console?
+    # TODO: Running percentages?
+    #++
+    class TurnReporter < Abstract #Reporter
+
+      PASS  = "PASS".ansi(:green)
+      FAIL  = "FAIL".ansi(:red)
+      ERROR = "ERROR".ansi(:yellow)
+
+      #
+      def start_suite(suite)
+        @io     = $stdout
+        @suite  = suite
+        @time   = Time.now
+        @stdout = StringIO.new
+        @stderr = StringIO.new
+        #files = suite.collect{ |s| s.file }.join(' ')
+        puts "LOADED SUITE" # #{suite.name}"
+        #puts "Started"
+      end
+
+      #
+      def start_case(kase)
+        puts("#{kase['label']}".ansi(:bold))
+      end
+
+      #
+      def start_test(test)
+        #if @file != test.file
+        #  @file = test.file
+        #  puts(test.file)
+        #end
+
+        name = if @natural
+                 " #{test['label'].gsub("test_", "").gsub(/_/, " ")}" 
+               else
+                 " #{test['label']}"
+               end
+
+        print "    %-69s" % name
+
+        @stdout.rewind
+        @stderr.rewind
+
+        $stdout = @stdout
+        $stderr = @stderr unless $DEBUG
+      end
+
+      #
+      def pass(doc)
+        puts " #{PASS}"
+        #if message
+        #  message = Colorize.magenta(message)
+        #  message = message.to_s.tabto(8)
+        #  puts(message)
+        #end
+      end
+
+      #
+      def fail(doc)
+        message   = doc['exception']['message'].to_s
+        backtrace = clean_backtrace(doc['exception']['backtrace'] || [])
+
+        puts(" #{FAIL}")
+        puts message.ansi(:bold).tabto(8)
+
+        unless backtrace.empty?
+          label = "Assertion at "
+          tabsize = 8
+          backtrace1 = label + backtrace.shift
+          puts(backtrace1.tabto(tabsize))
+          if trace = TapOut.trace
+            puts backtrace[0,depth].map{|l| l.tabto(label.length + tabsize) }.join("\n")
+          end
+        end
+        show_captured_output
+      end
+
+      # TODO: TAP-Y/J needs a field for the error class
+      def error(doc)
+        message = doc['exception']['message'].to_s
+        #backtrace = "Exception `#{exception.class}' at " + clean_backtrace(exception.backtrace).join("\n")
+        backtrace = "Exception at " + clean_backtrace(doc['exception']['backtrace'] || []).join("\n")
+        message = message.ansi(:bold)
+        puts("#{ERROR}")
+        puts(message.tabto(8))
+        puts "STDERR:".tabto(8)
+        puts(backtrace.tabto(8))
+        show_captured_output
+      end
+
+      #
+      def finish_test(test)
+        $stdout = STDOUT
+        $stderr = STDERR
+      end
+
+      #
+      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
+
+# No longer used b/c of error messages are fairly extraneous.
+=begin
+    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)
+      #end
+
+      #
+      def finish_suite(suite)
+        total   = suite['counts']['total']
+        pass    = suite['counts']['pass']
+        failure = suite['counts']['fail']
+        error   = suite['counts']['error']
+        #pass    = total - failure - error
+
+        bar = '=' * 78
+        if $ansi
+          bar = if pass == total then bar.ansi(:green)
+                else bar.ansi(:red) end
+        end
+
+        #tally = [total, suite.count_assertions]
+        tally = [total]
+
+        puts bar
+        puts "  pass: %d,  fail: %d,  error: %d" % [pass, failure, error]
+        #puts "  total: %d tests with %d assertions in #{Time.new - @time} seconds" % tally
+        puts "  total: %d tests in #{Time.new - @time} seconds" % tally
+        puts bar
+      end
+
+      #
+      def puts(str)
+        @io.puts(str)
+      end
+
+      #
+      def print(str)
+        @io.print(str)
+      end
+
+    end
+
+  end
+
+end

data/lib/tapout/version.rb

@@ -1,7 +1,20 @@
 module TapOut
-  # Current version of TAPOUT project.
-  VERSION = "0.2.3"
-
   # The current revision of the TAP-Y/J format.
-  REVISION = "2"
+  REVISION = "3"
+
+  # Project metadata.
+  #
+  # @return [Hash] metadata from .ruby file
+  def self.metadata
+    @metadata ||= (
+      require 'yaml'
+      YAML.load_file(File.join(File.dirname(__FILE__), 'tapout.yml'))
+    )
+  end
+
+  # Any missing constant will be looked for in 
+  # project metadata.
+  def self.const_missing(name)
+    metadata[name.to_s.downcase] || super(name)
+  end
 end

data/spec/applique/env.rb

@@ -0,0 +1,5 @@
+require 'stringio'
+
+When 'Given a legacy TAP stream' do |text|
+  @tap = text
+end

data/spec/perl_adapter.rdoc

@@ -0,0 +1,68 @@
+= TAP Parser
+
+  require 'tapout'
+
+Given a legacy TAP stream:
+
+  1..3
+  ok 1 - Example A
+  not ok 2 - Example B
+    ---
+    file:        foo.rb
+    line:        45
+    description: this is that
+    found:       this
+    wanted:      that
+    raw_test:    assert_equal('that', 'this')
+    extensions:
+      THAC0:     16
+    ...
+  ok 3
+
+The PerlAdapter can convert the stream into TAP-Y.
+
+  stream = StringIO.new(@tap)
+
+  adapter = TapOut::PerlAdapter.new(stream)
+
+  entries = adapter.to_a
+
+Once converted, there should five entries --a header and footer, two
+passing tests and one failing test.
+
+  entries.size.assert == 5
+
+Or pipe the converted stream directly to another stream.
+
+  stream = StringIO.new(@tap)
+
+  adapter = TapOut::PerlAdapter.new(stream)
+
+  output = ""
+
+  tapy = adapter | output
+
+Given a legacy TAP stream:
+
+  1..5
+  # test by equality
+  ok 1 - pass-thru 1
+  ok 2 - pass-thru 2
+  ok 3 - pass-thru 3
+  ok 4 - pass-thru 4
+  ok 5 - pass-thru 5
+  1..5
+
+Let's see if this works.
+
+  stream = StringIO.new(@tap)
+
+  adapter = TapOut::PerlAdapter.new(stream)
+
+  entries = adapter.to_a
+
+Once converted, there should eight entries --a header and footer, one note
+and five passing tests.
+
+  entries.size.assert == 8
+

data/spec/reporters/applique/cli.rb

@@ -0,0 +1,13 @@
+require 'tapout'
+
+When 'Using the following TAP-Y sample' do |text|
+  @tapy = text
+end
+
+When '(((\w+))) reporter should run without error' do |format|
+  $stdin  = StringIO.new(@tapy)
+  $stdout = StringIO.new(out = '')
+
+  TapOut.cli(format)
+end
+

data/spec/reporters/fixtures/tapy.yml

@@ -0,0 +1,78 @@
+---
+type: suite
+start: '2011-10-06 18:48:08'
+count: 3
+seed: 36440
+rev: 2
+---
+type: case
+subtype: ''
+label: ExampleTestCase
+level: 0
+---
+type: test
+subtype: ''
+status: error
+label: test_error
+exception:
+  message: ! 'RuntimeError:'
+  file: example.rb
+  line: 10
+  snippet:
+  - 8: ''
+  - 9: ! '  def test_error'
+  - 10: ! '    raise'
+  - 11: ! '  end'
+  - 12: ''
+  backtrace:
+  - example.rb:10
+time: 0.001054606
+---
+type: test
+subtype: ''
+status: fail
+label: test_failing
+exception:
+  message: ! "Expected: \"1\"\n  Actual: \"2\""
+  file: example.rb
+  line: 14
+  snippet:
+  - 12: ''
+  - 13: ! '  def test_failing'
+  - 14: ! '    assert_equal(''1'', ''2'')'
+  - 15: ! '  end'
+  - 16: ''
+  backtrace:
+  - example.rb:14
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:456
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:103
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:88
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:73
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:146
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:72
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:48
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:47
+  - /home/trans/com/programs/rubyworks/minitap/lib/minitap.rb:47
+time: 0.046170916
+---
+type: test
+subtype: ''
+status: pass
+label: test_passing
+time: 1.04997403
+---
+type: tally
+time: 1.000800203
+counts:
+  total: 3
+  pass: 1
+  fail: 1
+  error: 1
+  omit: 0
+  todo: 0
+...
+

data/spec/reporters/reporters.rdoc

@@ -0,0 +1,86 @@
+== Reporters
+
+Using the following TAP-Y sample:
+
+  ---
+  type: suite
+  start: '2011-10-06 18:48:08'
+  count: 3
+  seed: 36440
+  rev: 2
+  ---
+  type: case
+  subtype: ''
+  label: ExampleTestCase
+  level: 0
+  ---
+  type: test
+  subtype: ''
+  status: error
+  label: test_error
+  exception:
+    message: ! 'RuntimeError:'
+    file: example.rb
+    line: 10
+    snippet:
+    - 8: ''
+    - 9: ! '  def test_error'
+    - 10: ! '    raise'
+    - 11: ! '  end'
+    - 12: ''
+    backtrace:
+    - example.rb:10
+  time: 0.001054606
+  ---
+  type: test
+  subtype: ''
+  status: fail
+  label: test_failing
+  exception:
+    message: ! "Expected: \"1\"\n  Actual: \"2\""
+    file: example.rb
+    line: 14
+    snippet:
+    - 12: ''
+    - 13: ! '  def test_failing'
+    - 14: ! '    assert_equal(''1'', ''2'')'
+    - 15: ! '  end'
+    - 16: ''
+    backtrace:
+    - example.rb:14
+  time: 0.046170916
+  ---
+  type: test
+  subtype: ''
+  status: pass
+  label: test_passing
+  time: 1.04997403
+  ---
+  type: tally
+  time: 1.000800203
+  counts:
+    total: 3
+    pass: 1
+    fail: 1
+    error: 1
+    omit: 0
+    todo: 0
+  ...
+
+
+The dot reporter should run without error.
+
+The progress reporter should run without error.
+
+The html reporter should run without error.
+
+The outline reporter should run without error.
+
+The breakdown reporter should run without error.
+
+The tap reporter should run without error.
+
+The turn reporter should run without error.
+
+The pretty reporter should run without error.
+