class RSpec::Core::Runner

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

Attributes

configuration [R]

@attr_reader @private

options [R]

@attr_reader @private

world [R]

@attr_reader @private

Public Class Methods

autorun ()

@note This is not generally needed. The ‘rspec` command takes care

of running examples for you without involving an `at_exit`
hook. This is only needed if you are running specs using
the `ruby` command, and even then, the normal way to invoke
this is by requiring `rspec/autorun`.

# File rspec-core/lib/rspec/core/runner.rb, line 16
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

autorun_disabled? ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 141
def self.autorun_disabled?
  @autorun_disabled ||= false
end

disable_autorun! ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 136
def self.disable_autorun!
  @autorun_disabled = true
end

handle_interrupt ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 180
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 " \
      "(warning: at_exit hooks will be skipped if you force quit)."
    )
  end
end

installed_at_exit? ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 146
def self.installed_at_exit?
  @installed_at_exit ||= false
end

invoke ()

Runs the suite of specs and exits the process with an appropriate exit code.

# File rspec-core/lib/rspec/core/runner.rb, line 43
def self.invoke
  disable_autorun!
  status = run(ARGV, $stderr, $stdout).to_i
  exit(status) if status != 0
end

new (options, configuration=RSpec.configuration, world=RSpec.world)

# File rspec-core/lib/rspec/core/runner.rb, line 75
def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
  @options       = options
  @configuration = configuration
  @world         = world
end

perform_at_exit ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 29
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

run (args, err=$stderr, out=$stdout)

Run a suite of RSpec examples. Does not exit.

This is used internally by RSpec to run a suite, but is available for use by any other automation tool.

If you want to run this multiple times in the same process, and you want files like ‘spec_helper.rb` to be reloaded, be sure to load `load` instead of `require`.

@param args [Array] command-line-supported arguments @param err [IO] error stream @param out [IO] output stream @return [Fixnum] exit status code. 0 if all specs passed,

or the configured failure exit code (1 by default) if specs
failed.

# File rspec-core/lib/rspec/core/runner.rb, line 64
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

running_in_drb? ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 151
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

trap_interrupt ()

@private

# File rspec-core/lib/rspec/core/runner.rb, line 175
def self.trap_interrupt
  trap('INT') { handle_interrupt }
end

Public Instance Methods

configure (err, out)

@private

# File rspec-core/lib/rspec/core/runner.rb, line 129
def configure(err, out)
  @configuration.error_stream = err
  @configuration.output_stream = out if @configuration.output_stream == $stdout
  @options.configure(@configuration)
end

exit_code (examples_passed=false)

@private

# File rspec-core/lib/rspec/core/runner.rb, line 194
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

run (err, out)

Configures and runs a spec suite.

@param err [IO] error stream @param out [IO] output stream

# File rspec-core/lib/rspec/core/runner.rb, line 85
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

run_specs (example_groups)

Runs the provided example groups.

@param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run @return [Fixnum] exit status code. 0 if all specs passed,

or the configured failure exit code (1 by default) if specs
failed.

# File rspec-core/lib/rspec/core/runner.rb, line 113
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

setup (err, out)

Wires together the various configuration objects and state holders.

@param err [IO] error stream @param out [IO] output stream

# File rspec-core/lib/rspec/core/runner.rb, line 98
def setup(err, out)
  configure(err, out)
  return if RSpec.world.wants_to_quit

  @configuration.load_spec_files
ensure
  @world.announce_filters
end