Class: RSpec::Core::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/runner.rb

Overview

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Runner) initialize(options, configuration = RSpec.configuration, world = RSpec.world)

Returns a new instance of Runner

73
74
75
76
77
 
# File 'lib/rspec/core/runner.rb', line 73
def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
  @options       = options
  @configuration = configuration
  @world         = world
end

Class Method Details

+ (void) 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.

Register an at_exit hook that runs the suite when the process exits.

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/rspec/core/runner.rb', line 12
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 do
    # 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).
    next 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
  @installed_at_exit = true
end

+ (void) invoke

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

35
36
37
38
39
 
# File 'lib/rspec/core/runner.rb', line 35
def self.invoke
  disable_autorun!
  status = run(ARGV, $stderr, $stdout).to_i
  exit(status) if status != 0
end

+ (Fixnum) 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.

Parameters:

  • args (Array) —

    command-line-supported arguments

  • err (IO) (defaults to: $stderr) —

    error stream

  • out (IO) (defaults to: $stdout) —

    output stream

Returns:

  • (Fixnum) —

    exit status code. 0 if all specs passed, or the configured failure exit code (1 by default) if specs failed.

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rspec/core/runner.rb', line 56
def self.run(args, err=$stderr, out=$stdout)
  trap_interrupt
  options = ConfigurationOptions.new(args)
  if options.options[:drb]
    require 'rspec/core/drb'
    begin
      DRbRunner.new(options).run(err, out)
    rescue DRb::DRbConnError
      err.puts "No DRb server is running. Running in local process instead ..."
      new(options).run(err, out)
    end
  else
    new(options).run(err, out)
  end
end

Instance Method Details

- (void) run(err, out)

Configures and runs a spec suite.

Parameters:

  • err (IO) —

    error stream

  • out (IO) —

    output stream

83
84
85
86
 
# File 'lib/rspec/core/runner.rb', line 83
def run(err, out)
  setup(err, out)
  run_specs(@world.ordered_example_groups)
end

- (Fixnum) run_specs(example_groups)

Runs the provided example groups.

Parameters:

Returns:

  • (Fixnum) —

    exit status code. 0 if all specs passed, or the configured failure exit code (1 by default) if specs failed.

106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/rspec/core/runner.rb', line 106
def run_specs(example_groups)
  @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
    begin
      hook_context = SuiteHookContext.new
      @configuration.hooks.run(:before, :suite, hook_context)
      example_groups.map { |g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code
    ensure
      @configuration.hooks.run(:after, :suite, hook_context)
    end
  end
end

- (void) setup(err, out)

Wires together the various configuration objects and state holders.

Parameters:

  • err (IO) —

    error stream

  • out (IO) —

    output stream

92
93
94
95
96
97
98
 
# File 'lib/rspec/core/runner.rb', line 92
def setup(err, out)
  @configuration.error_stream = err
  @configuration.output_stream = out if @configuration.output_stream == $stdout
  @options.configure(@configuration)
  @configuration.load_spec_files
  @world.announce_filters
end