lib/cucumber/world.rb lib/cucumber/world/pending.rb spec/cucumber/world/pending_spec.rb @@ -15,6 +15,7 @@ require 'cucumber/formatters' require 'cucumber/treetop_parser/feature_parser' require 'cucumber/cli' require 'cucumber/broadcaster' +require 'cucumber/world' module Cucumber LANGUAGE_FILE = File.expand_path(File.dirname(__FILE__) + '/cucumber/languages.yml') lib/cucumber.rb @@ -112,6 +112,9 @@ module Cucumber step.execute_in(@world, regexp, args, proc) @after_step_procs.each{|p| p.call_in(@world, *[])} formatters.step_passed(step, regexp, args) + rescue ForcedPending => e + step.error = e + record_pending_step(step, regexp, args) rescue Pending record_pending_step(step, regexp, args) rescue => e @@ -124,6 +127,9 @@ module Cucumber regexp, args, proc = step.regexp_args_proc(@step_mother) step.execute_in(@world, regexp, args, proc) formatters.step_skipped(step, regexp, args) + rescue ForcedPending => e + step.error = e + record_pending_step(step, regexp, args) rescue Pending record_pending_step(step, regexp, args) rescue Exception @@ -179,6 +185,7 @@ module Cucumber def create_world world = Object.new + world.extend(World::Pending) @world_procs.each do |world_proc| world = world_proc.call(world) end lib/cucumber/executor.rb @@ -18,6 +18,8 @@ module Cucumber @pending_steps = [] @skipped = [] @last_executed_was_row = false + @pending_messages = {} + @forced_pending_step_count = 0 end def feature_executing(feature) @@ -136,6 +138,10 @@ module Cucumber end @io.puts end + if step.forced_to_pending? + @pending_messages[regexp.inspect] ||= "#{step.keyword} #{regexp.inspect} (#{step.error.message}) #{source_comment(step)}" + @forced_pending_step_count += 1 + end end def output_failing_step(step) @@ -150,24 +156,38 @@ module Cucumber def dump @io.puts + print_pending_messages if @pending_messages.any? + @io.puts pending("#{@pending_scenarios.length} scenarios pending") if @pending_scenarios.any? @io.puts passed("#{@passed.length} steps passed") if @passed.any? @io.puts failed("#{@failed.length} steps failed") if @failed.any? @io.puts skipped("#{@skipped.length} steps skipped") if @skipped.any? - @io.puts pending("#{@pending_steps.length} steps pending") if @pending_steps.any? + if @pending_steps.any? + @io.print pending("#{@pending_steps.length} steps pending") + @io.print pending(" (#{number_of_unimplemented_steps} with no step definition)") if number_of_unimplemented_steps > 0 + @io.puts + end @io.print reset print_snippets if @options[:snippets] end + def print_pending_messages + @io.puts "Pending Notes:" + @pending_messages.each_value do |message| + @io.puts message + end + @io.puts + end + def print_snippets snippets = @pending_steps snippets.delete_if {|snippet| snippet.row? || @step_mother.has_step_definition?(snippet.name)} unless snippets.empty? - @io.puts "\nYou can use these snippets to implement pending steps:\n\n" + @io.puts "\nYou can use these snippets to implement pending steps which have no step definition:\n\n" prev_keyword = nil snippets = snippets.map do |step| @@ -184,6 +204,10 @@ module Cucumber private + def number_of_unimplemented_steps + @pending_steps.length - @forced_pending_step_count + end + def escape_regexp_characters(string) Regexp.escape(string).gsub('\ ', ' ').gsub('/', '\/') unless string.nil? end lib/cucumber/formatters/pretty_formatter.rb @@ -4,6 +4,9 @@ module Cucumber class Pending < StandardError end + class ForcedPending < Pending + end + class Duplicate < StandardError end lib/cucumber/step_mother.rb @@ -90,6 +90,11 @@ module Cucumber def padding_length @scenario.step_padding_length(self) end + + def forced_to_pending? + @error.kind_of?(ForcedPending) + end + end class Step < BaseStep lib/cucumber/tree/step.rb @@ -75,6 +75,13 @@ dang world.doit.should == "dunit" world.beatit.should == "beatenit" end + + it "should add support for calling 'pending' from world" do + world = @executor.create_world + + world.should respond_to(:pending) + end + end describe "visiting feature" do @@ -162,6 +169,40 @@ dang end end + + describe "visit forced pending step" do + + before(:each) do + @executor.formatters = mock('formatter', :null_object => true) + end + + it "should store the pending exception with the step" do + mock_step = mock("mock step", :regexp_args_proc => nil) + pending_exception = ForcedPending.new("implement me") + mock_step.stub!(:execute_in).and_raise(pending_exception) + + mock_step.should_receive(:'error=').with(pending_exception) + + @executor.visit_step(mock_step) + end + + describe "after failed/pending step" do + + it "should store the pending exception with the step" do + mock_step_1 = mock("mock step", :null_object => true) + mock_step_2 = mock("mock step", :regexp_args_proc => nil) + pending_exception = ForcedPending.new("implement me") + mock_step_1.stub!(:execute_in).and_raise(StandardError) + mock_step_2.stub!(:execute_in).and_raise(pending_exception) + + mock_step_2.should_receive(:'error=').with(pending_exception) + + @executor.visit_step(mock_step_1) + @executor.visit_step(mock_step_2) + end + + end + end describe "visiting row scenarios" do @@ -293,6 +334,6 @@ dang @executor.visit_features(@features) end end - + end end spec/cucumber/executor_spec.rb @@ -13,9 +13,11 @@ module Cucumber :padding_length => 2, :file => 'test', :line => 1, - :row? => false}.merge(stubs)) + :row? => false, + :forced_to_pending? => false, + :regexp_args_proc => [nil, nil, mock_proc]}.merge(stubs)) end - + def mock_scenario(stubs={}) stub('scenario', { :name => 'test', @@ -36,8 +38,8 @@ module Cucumber :backtrace => 'example backtrace'}.merge(stubs)) end - def mock_proc - stub(Proc, :to_comment_line => '# steps/example_steps.rb:11') + def mock_proc(stubs={}) + stub(Proc, {:to_comment_line => '# steps/example_steps.rb:11'}.merge(stubs)) end it "should print step file and line when passed" do @@ -199,6 +201,74 @@ module Cucumber }.should_not raise_error(TypeError) end + describe "pending messages" do + + before(:each) do + @io = StringIO.new + @formatter = PrettyFormatter.new @io, mock('step_mother') + end + + it "should show pending message for step" do + @formatter.step_pending(mock_step(:keyword => 'Given', :forced_to_pending? => true, :error => ForcedPending.new("please implement me")), /yatta/, nil) + + @formatter.dump + + @io.string.should include("Given /yatta/ (please implement me)") + end + + it "should show pending step's file and line" do + @formatter.step_pending(mock_step(:forced_to_pending? => true, :error => ForcedPending.new("please implement me"), + :regexp_args_proc => [nil, nil, mock_proc(:to_comment_line => "steps/example_steps.rb:11")]), nil, nil) + + @formatter.dump + + @io.string.should include("steps/example_steps.rb:11") + end + + it "should not show duplicates" do + @formatter.step_pending(mock_step(:keyword => 'Given', :forced_to_pending? => true, :error => ForcedPending.new("please implement me")), /yatta/, []) + @formatter.step_pending(mock_step(:forced_to_pending? => true, :error => ForcedPending.new("please implement me"), :row? => true), /yatta/, []) + + @formatter.dump + + @io.string.scan(/please implement me/).length.should_not == 2 + end + + it "should ignore messages from steps that where not forced to pending" do + @formatter.step_pending(mock_step(:keyword => 'Given', :forced_to_pending? => false, :error => Pending.new("do not show me")), nil, []) + + @formatter.dump + + @io.string.should_not include("do not show me") + end + + end + + describe "no pending messages" do + + it "should not show any pending message information" do + io = StringIO.new + formatter = PrettyFormatter.new io, mock('step_mother') + + formatter.dump + + io.string.should_not include("Pending Notes:\n") + end + + end + + it "should show number of pending steps that have no step definition" do + io = StringIO.new + formatter = PrettyFormatter.new io, mock('step_mother') + + formatter.step_pending(mock_step(:error => ForcedPending.new, :forced_to_pending? => true), nil, []) + formatter.step_pending(mock_step(:error => Pending.new, :forced_to_pending? => false), nil, []) + + formatter.dump + + io.string.should include("1 with no step definition") + end + end end end spec/cucumber/formatters/pretty_formatter_spec.rb @@ -43,6 +43,15 @@ module Cucumber end end + + it "should indicate if a forced pending exception occured" do + scenario = Scenario.new(nil, '9', 1) + step = scenario.create_step('Given', '666666', 98) + + step.instance_variable_set("@error", ForcedPending.new) + + step.should be_forced_to_pending + end end end spec/cucumber/tree/step_spec.rb db4696e3240a79a2634d5ca0ebe9aa52f7022017 Joseph Wilk josephwilk@joesniff.co.uk http://github.com/josephwilk/cucumber/commit/ad48ddf031f0cf1d1776c8baed03ffef3b507775 ad48ddf031f0cf1d1776c8baed03ffef3b507775 2008-12-07T11:09:52-08:00 2008-12-07T11:09:52-08:00 Add support for calling 'pending' from step defintions. bc642c5cf4c248d11cea0c94ecd1bbcb7e04b704 Joseph Wilk josephwilk@joesniff.co.uk