turnip_formatter 0.6.0.pre.beta.2 → 0.6.0.pre.beta.3

data/lib/turnip_formatter/resource/scenario/failure.rb

@@ -0,0 +1,50 @@
+require 'turnip_formatter/resource/scenario/base'
+
+module TurnipFormatter
+  module Resource
+    module Scenario
+      class Failure < Base
+        #
+        # Return steps
+        #
+        # example:
+        #
+        #   When foo
+        #    And bar
+        #    And baz  <= failed line
+        #   Then piyo
+        #
+        #   #<Step 'foo'>.status = :passed
+        #   #<Step 'bar'>.status = :passed
+        #   #<Step 'baz'>.status = :failed
+        #   #<Step 'piyo'>.status = :unexecute
+        #
+        #
+        # @todo failed_at_before_hook, failed_at_after_hook GH-67
+        #
+        def steps
+          steps = super
+
+          arys = steps.group_by { |s| (s.line <=> failed_line_number).to_s }
+          arys['-1'].each { |s| s.status = :passed    } unless arys['-1'].nil?
+          arys['0'].each  { |s| s.status = :failed    } unless arys['0'].nil?
+          arys['1'].each  { |s| s.status = :unexecute } unless arys['1'].nil?
+
+          steps
+        end
+
+        private
+
+        def failed_line_number
+          @failed_line_number ||= (
+            filepath = File.basename(feature_file_path)
+            line = example.exception.backtrace.find do |backtrace|
+              backtrace.match(/#{filepath}:(\d+)/)
+            end
+            Regexp.last_match[1].to_i if line
+          )
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/resource/scenario/pass.rb

@@ -0,0 +1,10 @@
+require 'turnip_formatter/resource/scenario/base'
+
+module TurnipFormatter
+  module Resource
+    module Scenario
+      class Pass < Base
+      end
+    end
+  end
+end

data/lib/turnip_formatter/resource/scenario/pending.rb

@@ -0,0 +1,42 @@
+require 'turnip_formatter/resource/scenario/base'
+
+module TurnipFormatter
+  module Resource
+    module Scenario
+      class Pending < Base
+        #
+        # Return steps
+        #
+        # example:
+        #
+        #   When foo
+        #    And bar
+        #    And baz  <= pending line
+        #   Then piyo
+        #
+        #   #<Step 'foo'>.status = :passed
+        #   #<Step 'bar'>.status = :passed
+        #   #<Step 'baz'>.status = :pending
+        #   #<Step 'piyo'>.status = :unexecute
+        #
+        def steps
+          steps = super
+
+          arys = steps.group_by { |s| (s.line <=> pending_line_number).to_s }
+
+          arys['-1'].each { |s| s.status = :passed    } unless arys['-1'].nil?
+          arys['0'].each  { |s| s.status = :pending   } unless arys['0'].nil?
+          arys['1'].each  { |s| s.status = :unexecute } unless arys['1'].nil?
+
+          steps
+        end
+
+        private
+
+        def pending_line_number
+          example.metadata[:line_number]
+        end
+      end
+    end
+  end
+end

data/lib/turnip_formatter/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module TurnipFormatter
-  VERSION = '0.6.0-beta.2'
+  VERSION = '0.6.0-beta.3'
 end

data/lib/turnip_formatter.rb

@@ -1,5 +1,6 @@
 require 'turnip_formatter/version'
 require 'turnip'
+require 'turnip_formatter/renderer/html'
 
 module TurnipFormatter
   class << self
@@ -21,7 +22,7 @@ module TurnipFormatter
       stylesheets = [stylesheets] if stylesheets.is_a? String
 
       stylesheets.each do |s|
-        TurnipFormatter::Template.add_stylesheet(s)
+        TurnipFormatter::Renderer::Html.add_stylesheet(s)
       end
     end
 
@@ -29,7 +30,7 @@ module TurnipFormatter
       scripts = [scripts] if scripts.is_a? String
 
       scripts.each do |s|
-        TurnipFormatter::Template.add_javascript(s)
+        TurnipFormatter::Renderer::Html.add_javascript(s)
       end
     end
 
@@ -43,11 +44,9 @@ module TurnipFormatter
   end
 
   require 'rspec/core/formatters/turnip_formatter'
-  require 'turnip_formatter/template'
   require 'turnip_formatter/step_template/exception'
   require 'turnip_formatter/step_template/source'
   require 'turnip_formatter/ext/turnip/rspec'
-  require 'turnip_formatter/printer/index'
 end
 
 RSpecTurnipFormatter = RSpec::Core::Formatters::TurnipFormatter
@@ -55,3 +54,8 @@ RSpecTurnipFormatter = RSpec::Core::Formatters::TurnipFormatter
 TurnipFormatter.configure do |config|
   config.title = 'Turnip'
 end
+
+(File.dirname(__FILE__) + '/turnip_formatter/renderer/html/assets').tap do |dirname|
+  TurnipFormatter::Renderer::Html.add_stylesheet(dirname + '/turnip_formatter.css')
+  TurnipFormatter::Renderer::Html.add_javascript(dirname + '/turnip_formatter.js')
+end

data/test/helper.rb

@@ -1,5 +1,7 @@
 require 'test/unit'
 require 'oga'
+require 'tempfile'
+require 'turnip_formatter/ext/turnip/rspec'
 
 def html_parse(str)
   Oga.parse_xml(str)
@@ -7,25 +9,75 @@ end
 
 module TurnipFormatter
   module TestHelper
-    @@sample_feature = nil
-
-    def sample_step
-      sample_feature.scenarios[0].steps[0]
+    class NoopObject
+      def method_missing(name, *args, &block)
+        # nooooooop
+      end
     end
 
-    def sample_step_with_docstring
-      sample_feature.scenarios[0].steps[1]
+    #
+    # @param text [String]  feature text
+    # @return [Turnip::Node::Feature]
+    #
+    def feature_build(text)
+      Tempfile.create(['turnip_formatter_test', '.feature']) do |f|
+        f.write(text)
+        f.flush
+        Turnip::Builder.build(f.path)
+      end
     end
 
-    def sample_step_with_datatable
-      sample_feature.scenarios[0].steps[2]
+    #
+    # Override Turnip::Execute#step
+    #
+    module ExecuteWrapper
+      def step(s)
+        case s.text
+        when /^\[ERROR\]/
+          expect(true).to be false
+        when /^\[PENDING\]/
+          raise Turnip::Pending
+        else
+          expect(true).to be true
+        end
+      end
     end
 
-    def sample_feature
-      return @@sample_feature if @@sample_feature
+    #
+    # Emulate Turnip::RSpec#run_feature
+    #
+    # @param  feature [Turnip::Node::Feature]
+    # @param  failed_at [Array<Interger>] Line numbers to assume that test fails
+    # @param  feature_file_path [String]
+    #
+    # @return [Array<RSpec::Core::Example>] Array of example for scenarios.
+    #
+    #  e.g.:
+    #
+    #    Feature: ...
+    #      Scenario: xxx
+    #        When I
+    #        Then do
+    #      Scenario: yyy
+    #        When He
+    #        Then do
+    #
+    #    # => [<RSpec::Core::Example "I->do">, <RSpec::Core::Example "He->do">]
+    #
+    # @see {Turnip::RSpec.run_feature}
+    #
+    def run_feature(feature, filename)
+      rspec_context = ::RSpec::Core::ExampleGroup.describe(feature.name)
+      rspec_context.include(Turnip::RSpec::Execute)
+      rspec_context.include(ExecuteWrapper)
+
+      Turnip::RSpec.__send__(:run_feature, rspec_context, feature, filename)
+      rspec_context.run(NoopObject.new)
+      Turnip::RSpec.update_metadata(feature, rspec_context)
 
-      filename = File.expand_path('./sample.feature', File.dirname(__FILE__))
-      @@sample_feature = Turnip::Builder.build(filename)
+      rspec_context.children.map do |scenario|
+        scenario.examples.first
+      end
     end
   end
 end

data/test/turnip_formatter/renderer/html/test_index.rb

@@ -0,0 +1,102 @@
+require 'helper'
+require 'turnip_formatter/renderer/html/index'
+require 'turnip_formatter/resource/scenario/pass'
+require 'turnip_formatter/resource/scenario/failure'
+require 'turnip_formatter/resource/scenario/pending'
+
+module TurnipFormatter::Renderer::Html
+  class TestIndex < Test::Unit::TestCase
+    include TurnipFormatter::TestHelper
+
+    def setup
+      @renderer = Index.new(index_params)
+    end
+
+    def test_style_links
+      assert_equal(String, @renderer.style_links.class)
+    end
+
+    def test_style_codes
+      assert_equal(String, @renderer.style_codes.class)
+    end
+
+    def test_script_links
+      assert_equal(String, @renderer.script_links.class)
+    end
+
+    def test_script_codes
+      assert_equal(String, @renderer.script_codes.class)
+    end
+
+    def test_title
+      mock(TurnipFormatter::Renderer::Html).project_name { 'Perfect Turnip' }
+      assert_equal('Perfect Turnip report', @renderer.title)
+    end
+
+    def test_scenarios_html
+      assert_equal(String, @renderer.scenarios_html.class)
+    end
+
+    def test_statistics_feature_html
+      assert_equal(String, @renderer.statistics_feature_html.class)
+    end
+
+    def test_statistics_tag_html
+      assert_equal(String, @renderer.statistics_tag_html.class)
+    end
+
+    def test_statistics_speed_html
+      assert_equal(String, @renderer.statistics_speed_html.class)
+    end
+
+    def test_result_status
+      assert_equal('3 Scenario (1 failed 1 pending)', @renderer.result_status)
+    end
+
+    def test_total_time
+      assert_equal("20.0", @renderer.total_time)
+    end
+
+    def test_turnip_version
+      assert_equal(Turnip::VERSION, @renderer.turnip_version)
+    end
+
+    private
+
+    def index_params
+      {
+        scenarios: scenarios,
+        failed_count: 1,
+        pending_count: 1,
+        total_time: 20.0
+      }
+    end
+
+    def scenarios
+      @@scenarios ||= (
+        ss = []
+
+        feature = feature_build(feature_text)
+        examples = run_feature(feature, '/path/to/test1.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        ss << TurnipFormatter::Resource::Scenario::Failure.new(examples[1])
+        ss << TurnipFormatter::Resource::Scenario::Pending.new(examples[2])
+        ss
+      )
+    end
+
+    def feature_text
+      <<-EOS
+      Feature: Feature
+        Scenario: Pass Scenario
+          When A
+
+        Scenario: Failure Scenario
+          When [ERROR] B
+
+        Scenario: Pending Scenario
+          When [PENDING] C
+      EOS
+    end
+  end
+end

data/test/turnip_formatter/renderer/html/test_runtime_error.rb

@@ -0,0 +1,40 @@
+require 'helper'
+require 'turnip_formatter/renderer/html/runtime_error'
+require 'turnip_formatter/resource/scenario/pass'
+
+module TurnipFormatter::Renderer::Html
+  class TestRuntimeError < Test::Unit::TestCase
+    include TurnipFormatter::TestHelper
+
+    def setup
+      @renderer = RuntimeError.new([exception, scenario])
+    end
+
+    def test_runtime_exception
+      assert_equal(exception, @renderer.runtime_exception)
+    end
+
+    def test_scenario
+      assert_equal(scenario, @renderer.scenario)
+    end
+
+    private
+
+    def exception
+      @@exception ||= Exception.new('TFERROR')
+    end
+
+    def scenario
+      @@scenario ||= (
+        feature = feature_build(<<-EOS)
+          Feature: F
+            Scenario: S
+              When I attack it
+        EOS
+
+        scenario_example = run_feature(feature, '/path/to/test.feature').first
+        TurnipFormatter::Resource::Scenario::Pass.new(scenario_example)
+      )
+    end
+  end
+end

data/test/turnip_formatter/renderer/html/test_statistics_feature.rb

@@ -0,0 +1,102 @@
+require 'helper'
+require 'turnip_formatter/renderer/html/statistics_feature'
+require 'turnip_formatter/resource/scenario/pass'
+require 'turnip_formatter/resource/scenario/failure'
+require 'turnip_formatter/resource/scenario/pending'
+
+module TurnipFormatter::Renderer::Html
+  class TestStatisticsFeature < Test::Unit::TestCase
+    include TurnipFormatter::TestHelper
+
+
+    def setup
+      @renderer = StatisticsFeature.new(scenarios)
+    end
+
+    def test_results
+      fa = @renderer.results[0]
+      assert_equal(['A', 2, 1, 1, 0, :failed], actual(fa))
+
+      fb = @renderer.results[1]
+      assert_equal(['B', 1, 0, 0, 1, :pending], actual(fb))
+
+      fc = @renderer.results[2]
+      assert_equal(['C', 2, 2, 0, 0, :passed], actual(fc))
+    end
+
+    private
+
+    def actual(f)
+      [f.name, f.scenario_count, f.passed_count, f.failed_count, f.pending_count, f.status]
+    end
+
+    #
+    # name      | scenario | passed | failed | pending | result
+    # --------- | -------- | ------ | ------ | ------- | ------
+    # Feature A |        2 |      1 |      1 |       0 | failed
+    # Feature B |        1 |      0 |      0 |       1 | pending
+    # Feature C |        2 |      2 |      0 |       0 | passed
+    #
+    def scenarios
+      @@scenarios ||= (
+        ss = []
+
+        feature = feature_build(feature_a)
+        examples = run_feature(feature, '/path/to/test1.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        ss << TurnipFormatter::Resource::Scenario::Failure.new(examples[1])
+
+        feature = feature_build(feature_b)
+        examples = run_feature(feature, '/path/to/test2.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pending.new(examples[0])
+
+        feature = feature_build(feature_c)
+        examples = run_feature(feature, '/path/to/test3.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[1])
+
+        ss
+      )
+    end
+
+    def feature_a
+      <<-EOS
+      Feature: A
+        Scenario: Pass Scenario
+          When A
+          Then B
+           And C
+
+        Scenario: Failure Scenario
+          When A
+          Then [ERROR] B
+           And C
+      EOS
+    end
+
+    def feature_b
+      <<-EOS
+      Feature: B
+        Scenario: Pending Scenario
+          When A
+          Then [PENDING] B
+           And C
+      EOS
+    end
+
+    def feature_c
+      <<-EOS
+      Feature: C
+        Scenario: Pass Scenario 1
+          When A
+          Then B
+           And C
+
+        Scenario: Pass Scenario 2
+          When A
+          Then B
+           And C
+      EOS
+    end
+  end
+end

data/test/turnip_formatter/renderer/html/test_statistics_speed.rb

@@ -0,0 +1,77 @@
+require 'helper'
+require 'test/unit/rr'
+require 'turnip_formatter/renderer/html/statistics_speed'
+require 'turnip_formatter/resource/scenario/pass'
+require 'turnip_formatter/resource/scenario/failure'
+require 'turnip_formatter/resource/scenario/pending'
+
+module TurnipFormatter::Renderer::Html
+  class TestStatisticsSpeed < Test::Unit::TestCase
+    include TurnipFormatter::TestHelper
+
+    def setup
+      @renderer = StatisticsSpeed.new(scenarios)
+    end
+
+    def test_results
+      results = @renderer.results
+
+      assert_equal(3, results.size)
+      assert_equal(['B',  3.0], [results[0].name, results[0].run_time])
+      assert_equal(['E',  4.0], [results[1].name, results[1].run_time])
+      assert_equal(['A', 10.0], [results[2].name, results[2].run_time])
+    end
+
+    private
+
+    #
+    # name | duration | in ranking
+    # ---- | -------- | ----------
+    #    C |      1.0 | false (failed)
+    #    B |      3.0 | true
+    #    E |      4.0 | true
+    #    D |      5.0 | false (pending)
+    #    A |     10.0 | true
+    #
+    def scenarios
+      @@scenarios ||= (
+        examples = run_feature(feature_build(feature), '/path/to/test.feature')
+
+        s1 = TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        s2 = TurnipFormatter::Resource::Scenario::Pass.new(examples[1])
+        s3 = TurnipFormatter::Resource::Scenario::Failure.new(examples[2])
+        s4 = TurnipFormatter::Resource::Scenario::Pending.new(examples[3])
+        s5 = TurnipFormatter::Resource::Scenario::Pass.new(examples[4])
+
+        stub(s1).run_time { 10.0 }
+        stub(s2).run_time {  3.0 }
+        stub(s3).run_time {  1.0 }
+        stub(s4).run_time {  5.0 }
+        stub(s5).run_time {  4.0 }
+
+        [s1, s2, s3, s4, s5]
+      )
+    end
+
+    def feature
+      <<-EOS
+      Feature: A
+
+        Scenario: A
+          When A
+
+        Scenario: B
+          When B
+
+        Scenario: C
+          When [ERROR] C
+
+        Scenario: D
+          When [PENDING] D
+
+        Scenario: E
+          When E
+      EOS
+    end
+  end
+end

data/test/turnip_formatter/renderer/html/test_statistics_tag.rb

@@ -0,0 +1,112 @@
+require 'helper'
+require 'turnip_formatter/renderer/html/statistics_tag'
+require 'turnip_formatter/resource/scenario/pass'
+require 'turnip_formatter/resource/scenario/failure'
+require 'turnip_formatter/resource/scenario/pending'
+
+module TurnipFormatter::Renderer::Html
+  class TestStatisticsTag < Test::Unit::TestCase
+    include TurnipFormatter::TestHelper
+
+    def setup
+      @renderer = StatisticsTag.new(scenarios)
+    end
+
+    def test_results
+      ta = @renderer.results[0]
+      assert_equal(['@bar', 2, 1, 1, 0, :failed], actual(ta))
+
+      tb = @renderer.results[1]
+      assert_equal(['@baz', 2, 1, 0, 1, :pending], actual(tb))
+
+      tc = @renderer.results[2]
+      assert_equal(['@foo', 2, 2, 0, 0, :passed], actual(tc))
+
+      td = @renderer.results[3]
+      assert_equal(['no_tag', 1, 1, 0, 0, :passed], actual(td))
+    end
+
+    private
+
+    def actual(f)
+      [f.name, f.scenario_count, f.passed_count, f.failed_count, f.pending_count, f.status]
+    end
+
+    #
+    #  name  | scenario | passed | failed | pending | result
+    # ------ | -------- | ------ | ------ | ------- | -------
+    #  @bar  |        2 |      1 |      1 |       0 | failed
+    #  @baz  |        2 |      1 |      0 |       1 | pending
+    #  @foo  |        2 |      2 |      0 |       0 | passed
+    # no_tag |        1 |      1 |      0 |       0 | passed
+    #
+    def scenarios
+      @@scenarios ||= (
+        ss = []
+
+        feature = feature_build(feature_a)
+        examples = run_feature(feature, '/path/to/test1.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        ss << TurnipFormatter::Resource::Scenario::Failure.new(examples[1])
+
+        feature = feature_build(feature_b)
+        examples = run_feature(feature, '/path/to/test2.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pending.new(examples[0])
+
+        feature = feature_build(feature_c)
+        examples = run_feature(feature, '/path/to/test3.feature')
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[0])
+        ss << TurnipFormatter::Resource::Scenario::Pass.new(examples[1])
+
+        ss
+      )
+    end
+
+    def feature_a
+      <<-EOS
+      Feature: A
+
+        Scenario: Pass Scenario
+          When A
+          Then B
+           And C
+
+        @bar
+        Scenario: Failure Scenario
+          When A
+          Then [ERROR] B
+           And C
+      EOS
+    end
+
+    def feature_b
+      <<-EOS
+      @baz
+      Feature: B
+        Scenario: Pending Scenario
+          When A
+          Then [PENDING] B
+           And C
+      EOS
+    end
+
+    def feature_c
+      <<-EOS
+      @foo
+      Feature: C
+
+        @bar
+        Scenario: Pass Scenario 1
+          When A
+          Then B
+           And C
+
+        @baz
+        Scenario: Pass Scenario 2
+          When A
+          Then B
+           And C
+      EOS
+    end
+  end
+end