Merge pull request #2926 from jaredbeck/warn_about_exit_in_helper

Warn about exit in helper

Author: JonRowe

lib/rspec/core/configuration.rb

@@ -1945,6 +1945,14 @@ def load_file_handling_errors(method, file)
         relative_file = Metadata.relative_path(file)
         reporter.notify_non_example_exception(ex, "An error occurred while loading #{relative_file}.")
         RSpec.world.wants_to_quit = true
+      rescue SystemExit => ex
+        relative_file = Metadata.relative_path(file)
+        reporter.notify_non_example_exception(
+          ex,
+          "While loading #{relative_file} an `exit` / `raise SystemExit` occurred, RSpec will now quit."
+        )
+        RSpec.world.rspec_is_quitting = true
+        raise ex
       end
 
       def handle_suite_hook(scope, meta)

lib/rspec/core/world.rb

@@ -10,6 +10,13 @@ class World
       # Used internally to determine what to do when a SIGINT is received.
       attr_accessor :wants_to_quit
 
+      # Used internally to signify that a SystemExit occurred in
+      # `Configuration#load_file_handling_errors`, and thus examples cannot
+      # be counted accurately. Specifically, we cannot accurately report
+      # "No examples found".
+      # @private
+      attr_accessor :rspec_is_quitting
+
       # Used internally to signal that a failure outside of an example
       # has occurred, and that therefore the exit status should indicate
       # the run failed.
@@ -18,6 +25,7 @@ class World
 
       def initialize(configuration=RSpec.configuration)
         @wants_to_quit = false
+        @rspec_is_quitting = false
         @configuration = configuration
         configuration.world = self
         @example_groups = []
@@ -178,10 +186,12 @@ def announce_filters
         return unless example_count.zero?
 
         example_groups.clear
-        if filter_manager.empty?
-          report_filter_message("No examples found.")
-        elsif exclusion_filter.empty? || inclusion_filter.empty?
-          report_filter_message(everything_filtered_message)
+        unless rspec_is_quitting
+          if filter_manager.empty?
+            report_filter_message("No examples found.")
+          elsif exclusion_filter.empty? || inclusion_filter.empty?
+            report_filter_message(everything_filtered_message)
+          end
         end
       end
 

spec/integration/spec_file_load_errors_spec.rb

@@ -78,6 +78,37 @@
     EOS
   end
 
+  it 'prints a warning when a helper file exits early' do
+    write_file_formatted "helper_with_exit.rb", "exit 999"
+
+    expect {
+      run_command "--require ./helper_with_exit.rb"
+    }.to raise_error(SystemExit)
+    output = normalize_durations(last_cmd_stdout)
+    if defined?(JRUBY_VERSION) && !JRUBY_VERSION.empty?
+      expect(output).to eq unindent(<<-EOS)
+
+        While loading ./helper_with_exit.rb an `exit` / `raise SystemExit` occurred, RSpec will now quit.
+        Failure/Error: Unable to find org/jruby/RubyKernel.java to read failed line
+
+        SystemExit:
+          exit
+        # ./helper_with_exit.rb:1#{spec_line_suffix}
+      EOS
+    else
+      expect(output).to eq unindent(<<-EOS)
+
+        While loading ./helper_with_exit.rb an `exit` / `raise SystemExit` occurred, RSpec will now quit.
+        Failure/Error: exit 999
+
+        SystemExit:
+          exit
+        # ./helper_with_exit.rb:1:in `exit'
+        # ./helper_with_exit.rb:1#{spec_line_suffix}
+      EOS
+    end
+  end
+
   it 'nicely handles load-time errors in user spec files' do
     write_file_formatted "1_spec.rb", "
       boom