rspec-core 2.99.2 → 3.0.0.beta1

data/spec/rspec/core/backtrace_formatter_spec.rb

@@ -0,0 +1,216 @@
+require "spec_helper"
+
+module RSpec::Core
+  describe BacktraceFormatter do
+    def make_backtrace_formatter(exclusion_patterns=nil, inclusion_patterns=nil)
+      BacktraceFormatter.new.tap do |bc|
+        bc.exclusion_patterns = exclusion_patterns if exclusion_patterns
+        bc.inclusion_patterns = inclusion_patterns if inclusion_patterns
+      end
+    end
+
+    describe "defaults" do
+      it "excludes rspec files" do
+        expect(make_backtrace_formatter.exclude?("lib/rspec/core.rb")).to be true
+        expect(make_backtrace_formatter.exclude?("lib/rspec/core/foo.rb")).to be true
+        expect(make_backtrace_formatter.exclude?("lib/rspec/expectations/foo.rb")).to be true
+        expect(make_backtrace_formatter.exclude?("lib/rspec/matchers/foo.rb")).to be true
+        expect(make_backtrace_formatter.exclude?("lib/rspec/mocks/foo.rb")).to be true
+      end
+
+      it "excludes java files (for JRuby)" do
+        expect(make_backtrace_formatter.exclude?("org/jruby/RubyArray.java:2336")).to be true
+      end
+
+      it "excludes files within installed gems" do
+        expect(make_backtrace_formatter.exclude?('ruby-1.8.7-p334/gems/mygem-2.3.0/lib/mygem.rb')).to be true
+      end
+
+      it "includes files in projects containing 'gems' in the name" do
+        expect(make_backtrace_formatter.exclude?('code/my-gems-plugin/lib/plugin.rb')).to be false
+      end
+
+      it "includes something in the current working directory" do
+        expect(make_backtrace_formatter.exclude?("#{Dir.getwd}/arbitrary")).to be false
+      end
+
+      it "includes something in the current working directory even with a matching exclusion pattern" do
+        formatter = make_backtrace_formatter([/foo/])
+        expect(formatter.exclude? "#{Dir.getwd}/foo").to be false
+      end
+    end
+
+    describe "#format_backtrace" do
+      it "excludes lines from rspec libs by default", :unless => RSpec.windows_os? do
+        backtrace = [
+          "/path/to/rspec-expectations/lib/rspec/expectations/foo.rb:37",
+          "/path/to/rspec-expectations/lib/rspec/matchers/foo.rb:37",
+          "./my_spec.rb:5",
+          "/path/to/rspec-mocks/lib/rspec/mocks/foo.rb:37",
+          "/path/to/rspec-core/lib/rspec/core/foo.rb:37"
+        ]
+
+        expect(BacktraceFormatter.new.format_backtrace(backtrace)).to eq(["./my_spec.rb:5"])
+      end
+
+      it "excludes lines from rspec libs by default", :if => RSpec.windows_os? do
+        backtrace = [
+          "\\path\\to\\rspec-expectations\\lib\\rspec\\expectations\\foo.rb:37",
+          "\\path\\to\\rspec-expectations\\lib\\rspec\\matchers\\foo.rb:37",
+          ".\\my_spec.rb:5",
+          "\\path\\to\\rspec-mocks\\lib\\rspec\\mocks\\foo.rb:37",
+          "\\path\\to\\rspec-core\\lib\\rspec\\core\\foo.rb:37"
+        ]
+
+        expect(BacktraceFormatter.new.format_backtrace(backtrace)).to eq([".\\my_spec.rb:5"])
+      end
+
+      it "excludes lines that come before at_exit autorun hook" do
+        backtrace = [
+          "./spec/my_spec.rb:7",
+          "./spec/my_spec.rb:5",
+          RSpec::Core::Runner::AT_EXIT_HOOK_BACKTRACE_LINE,
+          "./spec/my_spec.rb:3"
+        ]
+        expect(BacktraceFormatter.new.format_backtrace(backtrace)).to eq(["./spec/my_spec.rb:7", "./spec/my_spec.rb:5"])
+      end
+
+      context "when every line is filtered out" do
+        let(:backtrace) do
+          [
+            "/path/to/rspec-expectations/lib/rspec/expectations/foo.rb:37",
+            "/path/to/rspec-expectations/lib/rspec/matchers/foo.rb:37",
+            "/path/to/rspec-mocks/lib/rspec/mocks/foo.rb:37",
+            "/path/to/rspec-core/lib/rspec/core/foo.rb:37"
+          ]
+        end
+
+        it "includes full backtrace" do
+          expect(BacktraceFormatter.new.format_backtrace(backtrace).take(4)).to eq backtrace
+        end
+
+        it "adds a message explaining everything was filtered" do
+          expect(BacktraceFormatter.new.format_backtrace(backtrace).drop(4).join).to match(/Showing full backtrace/)
+        end
+      end
+    end
+
+    describe "#full_backtrace=true" do
+      it "sets full_backtrace true" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        expect(formatter.full_backtrace?).to be true
+      end
+
+      it "preserves exclusion and inclusion patterns" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        expect(formatter.exclusion_patterns).to eq [/discard/]
+        expect(formatter.inclusion_patterns).to eq [/keep/]
+      end
+
+      it "keeps all lines, even those that match exclusions" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        expect(formatter.exclude? "discard").to be false
+      end
+    end
+
+    describe "#full_backtrace=false (after it was true)" do
+      it "sets full_backtrace false" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        formatter.full_backtrace = false
+        expect(formatter.full_backtrace?).to be false
+      end
+
+      it "preserves exclusion and inclusion patterns" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        formatter.full_backtrace = false
+        expect(formatter.exclusion_patterns).to eq [/discard/]
+        expect(formatter.inclusion_patterns).to eq [/keep/]
+      end
+
+      it "excludes lines that match exclusions" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        formatter.full_backtrace = true
+        formatter.full_backtrace = false
+        expect(formatter.exclude? "discard").to be true
+      end
+    end
+
+    describe "#backtrace_line" do
+      let(:formatter) { BacktraceFormatter.new }
+
+      it "trims current working directory" do
+        expect(formatter.__send__(:backtrace_line, File.expand_path(__FILE__))).to eq("./spec/rspec/core/backtrace_formatter_spec.rb")
+      end
+
+      it "preserves the original line" do
+        original_line = File.expand_path(__FILE__)
+        formatter.__send__(:backtrace_line, original_line)
+        expect(original_line).to eq(File.expand_path(__FILE__))
+      end
+
+      it "deals gracefully with a security error" do
+        safely do
+          formatter.__send__(:backtrace_line, __FILE__)
+          # on some rubies, this doesn't raise a SecurityError; this test just
+          # assures that if it *does* raise an error, the error is caught inside
+        end
+      end
+    end
+
+    context "with no patterns" do
+      it "keeps all lines" do
+        lines = ["/tmp/a_file", "some_random_text", "hello\330\271!"]
+        formatter = make_backtrace_formatter([], [])
+        expect(lines.all? {|line| formatter.exclude? line}).to be false
+      end
+
+      it "is considered a full backtrace" do
+        expect(make_backtrace_formatter([], []).full_backtrace?).to be true
+      end
+    end
+
+    context "with an exclusion pattern but no inclusion patterns" do
+      it "excludes lines that match the exclusion pattern" do
+        formatter = make_backtrace_formatter([/discard/],[])
+        expect(formatter.exclude? "discard me").to be true
+      end
+
+      it "keeps lines that do not match the exclusion pattern" do
+        formatter = make_backtrace_formatter([/discard/],[])
+        expect(formatter.exclude? "apple").to be false
+      end
+
+      it "is considered a partial backtrace" do
+        formatter = make_backtrace_formatter([/discard/],[])
+        expect(formatter.full_backtrace?).to be false
+      end
+    end
+
+    context "with an exclusion pattern and an inclusion pattern" do
+      it "excludes lines that match the exclusion pattern but not the inclusion pattern" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        expect(formatter.exclude? "discard").to be true
+      end
+
+      it "keeps lines that match both patterns" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        expect(formatter.exclude? "discard/keep").to be false
+      end
+
+      it "keeps lines that match neither pattern" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        expect(formatter.exclude? "fish").to be false
+      end
+
+      it "is considered a partial backtrace" do
+        formatter = make_backtrace_formatter([/discard/],[/keep/])
+        expect(formatter.full_backtrace?).to be false
+      end
+    end
+  end
+end

data/spec/rspec/core/command_line_spec.rb

@@ -3,7 +3,7 @@ require "stringio"
 require 'tmpdir'
 
 module RSpec::Core
-  describe Runner do
+  describe CommandLine do
 
     let(:out)    { StringIO.new         }
     let(:err)    { StringIO.new         }
@@ -13,22 +13,30 @@ module RSpec::Core
     before { config.stub :run_hook }
 
     it "configures streams before command line options" do
-      config.stub(:reporter => double.as_null_object)
+      stdout = StringIO.new
       config.stub :load_spec_files
+      config.stub(:reporter => double.as_null_object)
+      config.output_stream = $stdout
 
       # this is necessary to ensure that color works correctly on windows
       config.should_receive(:error_stream=).ordered
       config.should_receive(:output_stream=).ordered
       config.should_receive(:force).at_least(:once).ordered
 
-      runner = build_runner
-      runner.run err, out
+      command_line = build_command_line
+      command_line.run err, stdout
+    end
+
+    it "assigns ConfigurationOptions built from Array of options to @options" do
+      config_options = ConfigurationOptions.new(%w[--color])
+      command_line   = CommandLine.new(%w[--color])
+      expect(command_line.instance_eval { @options.options }).to eq(config_options.parse_options)
     end
 
     it "assigns submitted ConfigurationOptions to @options" do
       config_options = ConfigurationOptions.new(%w[--color])
-      runner   = Runner.new(config_options)
-      expect(runner.instance_eval { @options }).to be(config_options)
+      command_line   = CommandLine.new(config_options)
+      expect(command_line.instance_eval { @options }).to be(config_options)
     end
 
     describe "#run" do
@@ -36,18 +44,18 @@ module RSpec::Core
         include_context "spec files"
 
         it "returns 0 if spec passes" do
-          runner = build_runner passing_spec_filename
-          expect(runner.run(err, out)).to eq 0
+          command_line = build_command_line passing_spec_filename
+          expect(command_line.run(err, out)).to eq 0
         end
 
         it "returns 1 if spec fails" do
-          runner = build_runner failing_spec_filename
-          expect(runner.run(err, out)).to eq 1
+          command_line = build_command_line failing_spec_filename
+          expect(command_line.run(err, out)).to eq 1
         end
 
         it "returns 2 if spec fails and --failure-exit-code is 2" do
-          runner = build_runner failing_spec_filename, "--failure-exit-code", "2"
-          expect(runner.run(err, out)).to eq 2
+          command_line = build_command_line failing_spec_filename, "--failure-exit-code", "2"
+          expect(command_line.run(err, out)).to eq 2
         end
       end
 
@@ -56,22 +64,22 @@ module RSpec::Core
 
         it "runs before suite hooks" do
           config.should_receive(:run_hook).with(:before, :suite)
-          runner = build_runner
-          runner.run err, out
+          command_line = build_command_line
+          command_line.run err, out
         end
 
         it "runs after suite hooks" do
           config.should_receive(:run_hook).with(:after, :suite)
-          runner = build_runner
-          runner.run err, out
+          command_line = build_command_line
+          command_line.run err, out
         end
 
         it "runs after suite hooks even after an error" do
           config.should_receive(:run_hook).with(:before, :suite).and_raise "this error"
           config.should_receive(:run_hook).with(:after , :suite)
           expect do
-            runner = build_runner
-            runner.run err, out
+            command_line = build_command_line
+            command_line.run err, out
           end.to raise_error
         end
       end
@@ -80,18 +88,18 @@ module RSpec::Core
     describe "#run with custom output" do
       before { config.stub :files_to_run => [] }
 
-      let(:output_file) { File.new("#{Dir.tmpdir}/runner_spec_output.txt", 'w') }
+      let(:output_file) { File.new("#{Dir.tmpdir}/command_line_spec_output.txt", 'w') }
 
       it "doesn't override output_stream" do
         config.output_stream = output_file
-        runner = build_runner
-        runner.run err, out
-        expect(runner.instance_eval { @configuration.output_stream }).to eq output_file
+        command_line = build_command_line
+        command_line.run err, nil
+        expect(command_line.instance_eval { @configuration.output_stream }).to eq output_file
       end
     end
 
-    def build_runner *args
-      Runner.new build_config_options(*args)
+    def build_command_line *args
+      CommandLine.new build_config_options(*args)
     end
 
     def build_config_options *args
@@ -100,28 +108,4 @@ module RSpec::Core
       options
     end
   end
-
-  describe CommandLine do
-    it 'is a subclass of `Runner` so that it inherits the same behavior' do
-      expect(CommandLine.superclass).to be(Runner)
-    end
-
-    it 'prints a deprecation when instantiated' do
-      expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /RSpec::Core::CommandLine/)
-      CommandLine.new(ConfigurationOptions.new([]))
-    end
-
-    context "when given an array as the first arg" do
-      it 'parses it into configuration options' do
-        cl = CommandLine.new(%w[ --require foo ])
-        options = cl.instance_eval { @options }
-        expect(options.options).to include(:requires => ['foo'])
-      end
-
-      it 'issues a deprecation about the array arg' do
-        expect_deprecation_with_call_site(__FILE__, __LINE__ + 1, /array/)
-        CommandLine.new(%w[ --require foo ])
-      end
-    end
-  end
 end

data/spec/rspec/core/configuration_options_spec.rb

@@ -7,9 +7,8 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
 
   it "warns when HOME env var is not set", :unless => (RUBY_PLATFORM == 'java') do
     without_env_vars 'HOME' do
-      coo = RSpec::Core::ConfigurationOptions.new([])
-      coo.should_receive(:warn)
-      coo.parse_options
+      expect_warning_with_call_site(__FILE__, __LINE__ + 1)
+      RSpec::Core::ConfigurationOptions.new([]).parse_options
     end
   end
 
@@ -75,7 +74,7 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       expect(config.exclusion_filter).to have_key(:slow)
     end
 
-    it "forces color" do
+    it "forces color_enabled" do
       opts = config_options_object(*%w[--color])
       config = RSpec::Core::Configuration.new
       config.should_receive(:force).with(:color => true)
@@ -92,7 +91,7 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       ["--drb-port", "37", :drb_port, 37]
     ].each do |cli_option, cli_value, config_key, config_value|
       it "forces #{config_key}" do
-        opts = config_options_object(*[cli_option, cli_value].compact)
+        opts = config_options_object(cli_option, cli_value)
         config = RSpec::Core::Configuration.new
         config.should_receive(:force) do |pair|
           expect(pair.keys.first).to eq(config_key)
@@ -102,13 +101,6 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       end
     end
 
-    it "sets debug directly" do
-      opts = config_options_object("--debug")
-      config = RSpec::Core::Configuration.new
-      config.should_receive(:debug=).with(:cli)
-      opts.configure(config)
-    end
-
     it "merges --require specified by multiple configuration sources" do
       with_env_vars 'SPEC_OPTS' => "--require file_from_env" do
         opts = config_options_object(*%w[--require file_from_opts])
@@ -222,13 +214,6 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
     end
   end
 
-  describe "--debug, -d" do
-    it "sets :debug => true" do
-      expect(parse_options("--debug")).to include(:debug => :cli)
-      expect(parse_options("-d")).to include(:debug => :cli)
-    end
-  end
-
   describe "--fail-fast" do
     it "defaults to false" do
       expect(parse_options[:fail_fast]).to be_falsey
@@ -237,6 +222,10 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
     it "sets fail_fast on config" do
       expect(parse_options("--fail-fast")[:fail_fast]).to be_truthy
     end
+
+    it "sets fail_fast on config" do
+      expect(parse_options("--no-fail-fast")[:fail_fast]).to be_falsey
+    end
   end
 
   describe "--failure-exit-code" do
@@ -251,6 +240,16 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
     end
   end
 
+  describe "--dry-run" do
+    it "defaults to false" do
+      expect(parse_options[:dry_run]).to be_falsey
+    end
+
+    it "sets dry_run on config" do
+      expect(parse_options("--dry-run")[:dry_run]).to be_truthy
+    end
+  end
+
   describe "--options" do
     it "sets :custom_options_file" do
       expect(parse_options(*%w[-O my.opts])).to include(:custom_options_file => "my.opts")
@@ -259,38 +258,9 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
   end
 
   describe "--drb, -X" do
-    context "combined with --debug" do
-      it "turns off the debugger if --drb is specified first" do
-        expect(config_options_object("--drb", "--debug").drb_argv).not_to include("--debug")
-        expect(config_options_object("--drb", "-d"     ).drb_argv).not_to include("--debug")
-        expect(config_options_object("-X",    "--debug").drb_argv).not_to include("--debug")
-        expect(config_options_object("-X",    "-d"     ).drb_argv).not_to include("--debug")
-      end
-
-      it "turns off the debugger option if --drb is specified later" do
-        expect(config_options_object("--debug", "--drb").drb_argv).not_to include("--debug")
-        expect(config_options_object("-d",      "--drb").drb_argv).not_to include("--debug")
-        expect(config_options_object("--debug", "-X"   ).drb_argv).not_to include("--debug")
-        expect(config_options_object("-d",      "-X"   ).drb_argv).not_to include("--debug")
-      end
-
-      it "turns off the debugger option if --drb is specified in the options file" do
-        File.open("./.rspec", "w") {|f| f << "--drb"}
-        expect(config_options_object("--debug").drb_argv).not_to include("--debug")
-        expect(config_options_object("-d"     ).drb_argv).not_to include("--debug")
-      end
-
-      it "turns off the debugger option if --debug is specified in the options file" do
-        File.open("./.rspec", "w") {|f| f << "--debug"}
-        expect(config_options_object("--drb").drb_argv).not_to include("--debug")
-        expect(config_options_object("-X"   ).drb_argv).not_to include("--debug")
-      end
-    end
-
     it "does not send --drb back to the parser after parsing options" do
       expect(config_options_object("--drb", "--color").drb_argv).not_to include("--drb")
     end
-
   end
 
   describe "--no-drb" do
@@ -352,11 +322,10 @@ describe RSpec::Core::ConfigurationOptions, :isolated_directory => true, :isolat
       File.open("./.rspec", "w") {|f| f << "--line 37"}
       File.open("./.rspec-local", "w") {|f| f << "--format global"}
       File.open(File.expand_path("~/.rspec"), "w") {|f| f << "--color"}
-      with_env_vars 'SPEC_OPTS' => "--debug --example 'foo bar'" do
+      with_env_vars 'SPEC_OPTS' => "--example 'foo bar'" do
         options = parse_options("--drb")
         expect(options[:color]).to be_truthy
         expect(options[:line_numbers]).to eq(["37"])
-        expect(options[:debug]).to be_truthy
         expect(options[:full_description]).to eq([/foo\ bar/])
         expect(options[:drb]).to be_truthy
         expect(options[:formatters]).to eq([['global']])