Class: RSpec::Core::Runner
- Inherits:
-
Object
- Object
- RSpec::Core::Runner
- Defined in:
- lib/rspec/core/runner.rb
Overview
Provides the main entry point to run a suite of RSpec examples.
Class Method Summary (collapse)
-
+ (void) autorun
Register an
at_exit
hook that runs the suite when the process exits. -
+ (void) invoke
Runs the suite of specs and exits the process with an appropriate exit code.
-
+ (Fixnum) run(args, err = $stderr, out = $stdout)
Run a suite of RSpec examples.
Instance Method Summary (collapse)
-
- (Runner) initialize(options, configuration = RSpec.configuration, world = RSpec.world)
constructor
A new instance of Runner.
-
- (void) run(err, out)
Configures and runs a spec suite.
-
- (Fixnum) run_specs(example_groups)
Runs the provided example groups.
-
- (void) setup(err, out)
Wires together the various configuration objects and state holders.
Constructor Details
- (Runner) initialize(options, configuration = RSpec.configuration, world = RSpec.world)
Returns a new instance of Runner
74 75 76 77 78 |
# File 'lib/rspec/core/runner.rb', line 74 def initialize(, configuration=RSpec.configuration, world=RSpec.world) @options = @configuration = configuration @world = world end |
Class Method Details
+ (void) autorun
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.
36 37 38 39 40 |
# File 'lib/rspec/core/runner.rb', line 36 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
.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/rspec/core/runner.rb', line 57 def self.run(args, err=$stderr, out=$stdout) trap_interrupt = ConfigurationOptions.new(args) if .[:drb] require 'rspec/core/drb' begin DRbRunner.new().run(err, out) rescue DRb::DRbConnError err.puts "No DRb server is running. Running in local process instead ..." new().run(err, out) end else new().run(err, out) end end |
Instance Method Details
- (void) run(err, out)
Configures and runs a spec suite.
84 85 86 87 |
# File 'lib/rspec/core/runner.rb', line 84 def run(err, out) setup(err, out) run_specs(@world.ordered_example_groups) end |
- (Fixnum) run_specs(example_groups)
Runs the provided example groups.
107 108 109 110 111 112 113 |
# File 'lib/rspec/core/runner.rb', line 107 def run_specs(example_groups) @configuration.reporter.report(@world.example_count(example_groups)) do |reporter| @configuration.with_suite_hooks do example_groups.map { |g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code end end end |
- (void) setup(err, out)
Wires together the various configuration objects and state holders.
93 94 95 96 97 98 99 |
# File 'lib/rspec/core/runner.rb', line 93 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 |