newbamboo-evented-rspec 1.1.12

data/spec/spec/runner/formatter/html_formatter_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+begin
+  require 'nokogiri' # Needed to compare generated with wanted HTML
+rescue LoadError
+  warn "nokogiri not loaded -- skipping HtmlFormatter specs"
+  return
+end
+require 'spec/runner/formatter/html_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe HtmlFormatter do
+        ['--diff', '--dry-run'].each do |opt|
+          it "should produce HTML identical to the one we designed manually with #{opt}" do
+            root = File.expand_path(File.dirname(__FILE__) + '/../../../..')
+            suffix = jruby? ? '-jruby' : ''
+            expected_file = File.dirname(__FILE__) + "/html_formatted-#{::RUBY_VERSION}#{suffix}.html"
+            raise "There is no HTML file with expected content for this platform: #{expected_file}" unless File.file?(expected_file)
+            expected_html = File.read(expected_file)
+
+            Dir.chdir(root) do
+              args = ['examples/failing/mocking_example.rb', 'examples/failing/diffing_spec.rb', 'examples/passing/stubbing_example.rb',  'examples/passing/pending_example.rb', '--format', 'html', opt]
+              err = StringIO.new
+              out = StringIO.new
+              run_with ::Spec::Runner::OptionParser.parse(args, err, out)
+
+              seconds = /\d+\.\d+ seconds/
+              html = out.string.gsub seconds, 'x seconds'
+              expected_html.gsub! seconds, 'x seconds'
+
+              if opt == '--diff'
+                # Uncomment this line temporarily in order to overwrite the expected with actual.
+                # Use with care!!!
+                # File.open(expected_file, 'w') {|io| io.write(html)}
+
+                doc = Nokogiri::HTML(html)
+                backtraces = doc.search("div.backtrace").collect {|e| e.at("pre").inner_html}
+                doc.css("div.backtrace").remove
+
+                expected_doc = Nokogiri::HTML(expected_html)
+                expected_backtraces = expected_doc.search("div.backtrace").collect {|e| e.at("pre").inner_html}
+                expected_doc.search("div.backtrace").remove
+
+                doc.inner_html.should == expected_doc.inner_html
+
+                expected_backtraces.each_with_index do |expected_line, i|
+                  expected_path, expected_line_number, expected_suffix = expected_line.split(':')
+                  actual_path, actual_line_number, actual_suffix = backtraces[i].split(':')
+                  File.expand_path(actual_path).should == File.expand_path(expected_path)
+                  actual_line_number.should == expected_line_number
+                end
+              else
+                html.should =~ /This was a dry-run/m
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/nested_text_formatter_spec.rb

@@ -0,0 +1,318 @@
+require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/nested_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe NestedTextFormatter do
+        with_sandboxed_options do
+          attr_reader :io, :options, :formatter, :example_group
+          before(:each) do
+            @io = StringIO.new
+            options.stub!(:dry_run).and_return(false)
+            options.stub!(:colour).and_return(false)
+            @formatter = NestedTextFormatter.new(options, io)
+            @example_group = ::Spec::Example::ExampleGroup.describe("ExampleGroup") do
+              specify "example" do
+              end
+            end
+          end
+
+          describe "where ExampleGroup has no superclasss with a description" do
+            before do
+              add_example_group
+            end
+
+            def add_example_group
+              formatter.add_example_group(example_group)
+            end
+
+            describe "#dump_summary" do
+              it "should produce standard summary without pending when pending has a 0 count" do
+                formatter.dump_summary(3, 2, 1, 0)
+                io.string.should == <<-OUT
+ExampleGroup
+
+Finished in 3 seconds
+
+2 examples, 1 failure
+OUT
+              end
+
+              it "should produce standard summary" do
+                formatter.dump_summary(3, 2, 1, 4)
+                io.string.should == <<-OUT
+ExampleGroup
+
+Finished in 3 seconds
+
+2 examples, 1 failure, 4 pending
+OUT
+              end
+            end
+
+            describe "#add_example_group" do
+              describe "when ExampleGroup has description_args" do
+                before do
+                  example_group.description_args.should_not be_nil
+                end
+
+                describe "when ExampleGroup has no parents with description args" do
+                  before do
+                    example_group.superclass.description_args.should be_empty
+                  end
+
+                  it "should push ExampleGroup name" do
+                    io.string.should eql("ExampleGroup\n")
+                  end
+                end
+
+                describe "when ExampleGroup has one parent with description args" do
+                  attr_reader :child_example_group
+                  def add_example_group
+                    example_group.description_args.should_not be_nil
+                    @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                  end
+
+                  describe "and parent ExampleGroups have not been printed" do
+                    before do
+                      formatter.add_example_group(child_example_group)
+                    end
+
+                    it "should push ExampleGroup name with two spaces of indentation" do
+                      io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+OUT
+                    end
+                  end
+
+                  describe "and parent ExampleGroups have been printed" do
+                    before do
+                      formatter.add_example_group(example_group)
+                      io.string = ""
+                      formatter.add_example_group(child_example_group)
+                    end
+
+                    it "should print only the indented ExampleGroup" do
+                      io.string.should == <<-OUT
+  Child ExampleGroup
+OUT
+                    end
+                  end
+                end
+
+                describe "when ExampleGroup has two parents with description args" do
+                  attr_reader :child_example_group, :grand_child_example_group
+                  def add_example_group
+                    example_group.description_args.should_not be_nil
+                    @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                    @grand_child_example_group = Class.new(child_example_group).describe("GrandChild ExampleGroup")
+                  end
+
+                  describe "and parent ExampleGroups have not been printed" do
+                    before do
+                      formatter.add_example_group(grand_child_example_group)
+                    end
+
+                    it "should print the entire nested ExampleGroup heirarchy" do
+                      io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+OUT
+                    end
+                  end
+
+                  describe "and parent ExampleGroups have been printed" do
+                    before do
+                      formatter.add_example_group(child_example_group)
+                      io.string = ""
+                      formatter.add_example_group(grand_child_example_group)
+                    end
+
+                    it "should print only the indented ExampleGroup" do
+                      io.string.should == <<-OUT
+    GrandChild ExampleGroup
+OUT
+                    end
+                  end
+                end
+              end
+
+              describe "when ExampleGroup description_args is nil" do
+                attr_reader :child_example_group
+
+                describe "and parent ExampleGroups have not been printed" do
+                  def add_example_group
+                    @child_example_group = Class.new(example_group)
+                    child_example_group.description_args.should be_empty
+                    formatter.add_example_group(child_example_group)
+                  end
+
+                  it "should render only the parent ExampleGroup" do
+                    io.string.should == <<-OUT
+ExampleGroup
+OUT
+                  end
+                end
+
+                describe "and parent ExampleGroups have been printed" do
+                  def add_example_group
+                    @child_example_group = Class.new(example_group)
+                    child_example_group.description_args.should be_empty
+                    formatter.add_example_group(example_group)
+                    io.string = ""
+                    formatter.add_example_group(child_example_group)
+                  end
+
+                  it "should not render anything" do
+                    io.string.should == ""
+                  end
+                end
+              end
+
+              describe "when ExampleGroup description_args is empty" do
+                def add_example_group
+                  example_group.set_description
+                  example_group.description_args.should be_empty
+                  super
+                end
+
+                it "should not render anything" do
+                  io.string.should == ""
+                end
+              end
+            end
+
+            describe "#example_failed" do
+              describe "where ExampleGroup has no superclasss with a description" do
+                describe "when having an error" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("c s", RuntimeError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  spec (ERROR - 98)
+OUT
+                  end
+                end
+
+                describe "when having an expectation failure" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  spec (FAILED - 98)
+OUT
+                  end
+                end
+              end
+
+              describe "where ExampleGroup has two superclasses with a description" do
+                attr_reader :child_example_group, :grand_child_example_group
+
+                def add_example_group
+                  @child_example_group = Class.new(example_group).describe("Child ExampleGroup")
+                  @grand_child_example_group = Class.new(child_example_group).describe("GrandChild ExampleGroup")
+                  formatter.add_example_group(grand_child_example_group)
+                end
+
+                describe "when having an error" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      grand_child_example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("c s", RuntimeError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+      spec (ERROR - 98)
+OUT
+                  end
+                end
+
+                describe "when having an expectation" do
+                  it "should push failing spec name and failure number" do
+                    formatter.example_failed(
+                      grand_child_example_group.it("spec"),
+                      98,
+                      ::Spec::Runner::Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new)
+                    )
+                    io.string.should == <<-OUT
+ExampleGroup
+  Child ExampleGroup
+    GrandChild ExampleGroup
+      spec (FAILED - 98)
+OUT
+                  end
+                end
+              end
+            end
+
+            describe "#start" do
+              it "should push nothing on start" do
+                formatter.start(5)
+                io.string.should == <<-OUT
+ExampleGroup
+OUT
+              end
+            end
+
+            describe "#start_dump" do
+              it "should push nothing on start dump" do
+                formatter.start_dump
+                io.string.should == <<-OUT
+ExampleGroup
+OUT
+              end
+            end
+
+            describe "#example_passed" do
+              it "should push passing spec name" do
+                formatter.example_passed(example_group.it("spec"))
+                io.string.should == <<-OUT
+ExampleGroup
+  spec
+OUT
+              end
+            end
+
+            describe "#example_pending" do
+              it "should push pending example name and message" do
+                formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}")
+                io.string.should == <<-OUT
+ExampleGroup
+  example (PENDING: reason)
+OUT
+              end
+
+              it "should dump pending" do
+                formatter.example_pending(example_group.examples.first, 'reason', "#{__FILE__}:#{__LINE__}")
+                io.rewind
+                formatter.dump_pending
+                io.string.should =~ /Pending\:\n\nExampleGroup example \(reason\)\n/
+              end
+            end
+
+            def have_single_level_example_group_output(expected_output)
+              expected = "ExampleGroup\n  #{expected_output}"
+              ::Spec::Matchers::SimpleMatcher.new(expected) do |actual|
+                actual == expected
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/profile_formatter_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/profile_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe ProfileFormatter do
+        attr_reader :io, :formatter
+        before(:each) do
+          @io = StringIO.new
+          options = mock('options')
+          options.stub!(:colour).and_return(true)
+          @formatter = ProfileFormatter.new(options, io)
+        end
+        
+        it "should print a heading" do
+          formatter.start(0)
+          io.string.should eql("Profiling enabled.\n")
+        end
+        
+        it "should record the current time when starting a new example" do
+          now = Time.now
+          Time.stub!(:now).and_return(now)
+          formatter.example_started('should foo')
+          formatter.instance_variable_get("@time").should == now
+        end
+        
+        it "should correctly record a passed example" do
+          now = Time.now
+          Time.stub!(:now).and_return(now)
+          parent_example_group = Class.new(::Spec::Example::ExampleGroupDouble).describe('Parent')
+          child_example_group = Class.new(parent_example_group).describe('Child')
+
+          formatter.add_example_group(child_example_group)
+          
+          formatter.example_started('when foo')
+          Time.stub!(:now).and_return(now+1)
+          formatter.example_passed(stub('foo', :description => 'i like ice cream'))
+
+          formatter.start_dump
+          io.string.should include('Parent Child')
+        end
+        
+        it "should sort the results in descending order" do
+          formatter.instance_variable_set("@example_times", [['a', 'a', 0.1], ['b', 'b', 0.3], ['c', 'c', 0.2]])
+          formatter.start_dump
+          formatter.instance_variable_get("@example_times").should == [ ['b', 'b', 0.3], ['c', 'c', 0.2], ['a', 'a', 0.1]]
+        end
+        
+        it "should print the top 10 results" do
+          example_group = Class.new(::Spec::Example::ExampleGroup).describe("ExampleGroup")
+          formatter.add_example_group(example_group)
+          formatter.instance_variable_set("@time", Time.now)
+          
+          15.times do 
+            formatter.example_passed(stub('foo', :description => 'i like ice cream'))
+          end
+          
+          io.should_receive(:print).exactly(10)
+          formatter.start_dump
+        end
+      end
+    end
+  end
+end

data/spec/spec/runner/formatter/progress_bar_formatter_spec.rb

@@ -0,0 +1,145 @@
+require File.dirname(__FILE__) + '/../../../spec_helper.rb'
+require 'spec/runner/formatter/progress_bar_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      describe ProgressBarFormatter do
+        before(:each) do
+          @io = StringIO.new
+          @options = mock('options')
+          @options.stub!(:dry_run).and_return(false)
+          @options.stub!(:colour).and_return(false)
+          @formatter = ProgressBarFormatter.new(@options, @io)
+        end
+
+        it "should produce line break on start dump" do
+          @formatter.start_dump
+          @io.string.should eql("\n")
+        end
+
+        it "should produce standard summary without pending when pending has a 0 count" do
+          @formatter.dump_summary(3, 2, 1, 0)
+          @io.string.should eql("\nFinished in 3 seconds\n\n2 examples, 1 failure\n")
+        end
+        
+        it "should produce standard summary" do
+          example_group = ExampleGroup.describe("example_group") do
+            specify "example" do
+            end
+          end
+          example = example_group.examples.first
+          @formatter.example_pending(example, "message", "#{__FILE__}:#{__LINE__}")
+          @io.rewind
+          @formatter.dump_summary(3, 2, 1, 1)
+          @io.string.should eql(%Q|
+Finished in 3 seconds
+
+2 examples, 1 failure, 1 pending
+|)
+        end
+
+        it "should push green dot for passing spec" do
+          @io.should_receive(:tty?).and_return(true)
+          @options.should_receive(:colour).and_return(true)
+          @formatter.example_passed("spec")
+          @io.string.should == "\e[32m.\e[0m"
+        end
+
+        it "should push red F for failure spec" do
+          @io.should_receive(:tty?).and_return(true)
+          @options.should_receive(:colour).and_return(true)
+          @formatter.example_failed("spec", 98, Spec::Runner::Reporter::Failure.new("c s", Spec::Expectations::ExpectationNotMetError.new))
+          @io.string.should eql("\e[31mF\e[0m")
+        end
+
+        it "should push magenta F for error spec" do
+          @io.should_receive(:tty?).and_return(true)
+          @options.should_receive(:colour).and_return(true)
+          @formatter.example_failed("spec", 98, Spec::Runner::Reporter::Failure.new("c s", RuntimeError.new))
+          @io.string.should eql("\e[35mF\e[0m")
+        end
+
+        it "should push blue F for fixed pending spec" do
+          @io.should_receive(:tty?).and_return(true)
+          @options.should_receive(:colour).and_return(true)
+          @formatter.example_failed("spec", 98, Spec::Runner::Reporter::Failure.new("c s", Spec::Example::PendingExampleFixedError.new))
+          @io.string.should eql("\e[34mF\e[0m")
+        end
+
+        it "should push nothing on start" do
+          @formatter.start(4)
+          @io.string.should eql("")
+        end
+
+        it "should ensure two ':' in the first backtrace" do
+          backtrace = ["/tmp/x.rb:1", "/tmp/x.rb:2", "/tmp/x.rb:3"]
+          @formatter.format_backtrace(backtrace).should eql(<<-EOE.rstrip)
+/tmp/x.rb:1:
+/tmp/x.rb:2:
+/tmp/x.rb:3:
+EOE
+
+          backtrace = ["/tmp/x.rb:1: message", "/tmp/x.rb:2", "/tmp/x.rb:3"]
+          @formatter.format_backtrace(backtrace).should eql(<<-EOE.rstrip)
+/tmp/x.rb:1: message
+/tmp/x.rb:2:
+/tmp/x.rb:3:
+EOE
+        end
+        
+        it "should dump pending with file and line number" do
+          example_group = ExampleGroup.describe("example_group") do
+            specify "example" do
+            end
+          end
+          example = example_group.examples.first
+          file = __FILE__
+          line = __LINE__ + 1
+          @formatter.example_pending(example, "message", "#{__FILE__}:#{__LINE__}")
+          @formatter.dump_pending
+          @io.string.should ==(<<-HERE)
+*
+Pending:
+
+example_group example (message)
+#{file}:#{line}
+HERE
+        end
+      end
+      
+      describe "ProgressBarFormatter outputting to custom out" do
+        before(:each) do
+          @out = mock("out")
+          @options = mock('options')
+          @out.stub!(:puts)
+          @formatter = ProgressBarFormatter.new(@options, @out)
+          @formatter.class.__send__ :public, :output_to_tty?
+        end
+
+        after(:each) do
+          @formatter.class.__send__ :protected, :output_to_tty?
+        end
+
+        it "should not throw NoMethodError on output_to_tty?" do
+          @out.should_receive(:tty?).and_raise(NoMethodError)
+          @formatter.output_to_tty?.should be_false
+        end
+      end
+
+      describe ProgressBarFormatter, "dry run" do
+        before(:each) do
+          @io = StringIO.new
+          options = mock('options')
+          options.stub!(:dry_run).and_return(true)
+          @formatter = ProgressBarFormatter.new(options, @io)
+        end
+      
+        it "should not produce summary on dry run" do
+          @formatter.dump_summary(3, 2, 1, 0)
+          @io.string.should eql("")
+        end
+      end
+    end
+  end
+end