class RSpec::Core::Runner

Provides the main entry point to run a suite of RSpec examples.

def self.autorun

Other tags:
    Note: - This is not generally needed. The `rspec` command takes care
def self.autorun
  if autorun_disabled?
    RSpec.deprecate("Requiring `rspec/autorun` when running RSpec via the `rspec` command")
    return
  elsif installed_at_exit? || running_in_drb?
    return
  end
  at_exit { perform_at_exit }
  @installed_at_exit = true
end

def self.autorun_disabled?

Other tags:
    Private: -
def self.autorun_disabled?
  @autorun_disabled ||= false
end

def self.disable_autorun!

Other tags:
    Private: -
def self.disable_autorun!
  @autorun_disabled = true
end

def self.handle_interrupt

Other tags:
    Private: -
def self.handle_interrupt
  if RSpec.world.wants_to_quit
    exit!(1)
  else
    RSpec.world.wants_to_quit = true
    $stderr.puts "\nRSpec is shutting down and will print the summary report... Interrupt again to force quit."
  end
end

def self.installed_at_exit?

Other tags:
    Private: -
def self.installed_at_exit?
  @installed_at_exit ||= false
end

def self.invoke

code.
Runs the suite of specs and exits the process with an appropriate exit
def self.invoke
  disable_autorun!
  status = run(ARGV, $stderr, $stdout).to_i
  exit(status) if status != 0
end

def self.perform_at_exit

Other tags:
    Private: -
def self.perform_at_exit
  # Don't bother running any specs and just let the program terminate
  # if we got here due to an unrescued exception (anything other than
  # SystemExit, which is raised when somebody calls Kernel#exit).
  return unless $!.nil? || $!.is_a?(SystemExit)
  # We got here because either the end of the program was reached or
  # somebody called Kernel#exit. Run the specs and then override any
  # existing exit status with RSpec's exit status if any specs failed.
  invoke
end

def self.run(args, err=$stderr, out=$stdout)

Returns:
  • (Fixnum) - exit status code. 0 if all specs passed,

Parameters:
  • out (IO) -- output stream
  • err (IO) -- error stream
  • args (Array) -- command-line-supported arguments
def self.run(args, err=$stderr, out=$stdout)
  trap_interrupt
  options = ConfigurationOptions.new(args)
  if options.options[:runner]
    options.options[:runner].call(options, err, out)
  else
    new(options).run(err, out)
  end
end

def self.running_in_drb?

Other tags:
    Private: -
def self.running_in_drb?
  return false unless defined?(DRb)
  server = begin
             DRb.current_server
           rescue DRb::DRbServerNotFound
             return false
           end
  return false unless server && server.alive?
  require 'socket'
  require 'uri'
  local_ipv4 = begin
                 IPSocket.getaddress(Socket.gethostname)
               rescue SocketError
                 return false
               end
  ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
end

def self.trap_interrupt

Other tags:
    Private: -
def self.trap_interrupt
  trap('INT') { handle_interrupt }
end

def configure(err, out)

Other tags:
    Private: -
def configure(err, out)
  @configuration.error_stream = err
  @configuration.output_stream = out if @configuration.output_stream == $stdout
  @options.configure(@configuration)
end

def exit_code(examples_passed=false)

Other tags:
    Private: -
def exit_code(examples_passed=false)
  return @configuration.error_exit_code || @configuration.failure_exit_code if @world.non_example_failure
  return @configuration.failure_exit_code unless examples_passed
  0
end

def initialize(options, configuration=RSpec.configuration, world=RSpec.world)

def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
  @options       = options
  @configuration = configuration
  @world         = world
end

def persist_example_statuses

def persist_example_statuses
  return if @configuration.dry_run
  return unless (path = @configuration.example_status_persistence_file_path)
  ExampleStatusPersister.persist(@world.all_examples, path)
rescue SystemCallError => e
  RSpec.warning "Could not write example statuses to #{path} (configured as " \
                "`config.example_status_persistence_file_path`) due to a " \
                "system error: #{e.inspect}. Please check that the config " \
                "option is set to an accessible, valid file path", :call_site => nil
end

def run(err, out)

Parameters:
  • out (IO) -- output stream
  • err (IO) -- error stream
def run(err, out)
  setup(err, out)
  return @configuration.reporter.exit_early(exit_code) if RSpec.world.wants_to_quit
  run_specs(@world.ordered_example_groups).tap do
    persist_example_statuses
  end
end

def run_specs(example_groups)

Returns:
  • (Fixnum) - exit status code. 0 if all specs passed,

Parameters:
  • example_groups (Array) -- groups to run
def run_specs(example_groups)
  examples_count = @world.example_count(example_groups)
  examples_passed = @configuration.reporter.report(examples_count) do |reporter|
    @configuration.with_suite_hooks do
      if examples_count == 0 && @configuration.fail_if_no_examples
        return @configuration.failure_exit_code
      end
      example_groups.map { |g| g.run(reporter) }.all?
    end
  end
  exit_code(examples_passed)
end

def setup(err, out)

Parameters:
  • out (IO) -- output stream
  • err (IO) -- error stream
def setup(err, out)
  configure(err, out)
  return if RSpec.world.wants_to_quit
  @configuration.load_spec_files
ensure
  @world.announce_filters
end