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
-
.autorun ⇒ void
Register an
at_exit
hook that runs the suite when the process exits. -
.invoke ⇒ void
Runs the suite of specs and exits the process with an appropriate exit code.
-
.run(args, err = $stderr, out = $stdout) ⇒ Fixnum
Run a suite of RSpec examples.
Instance Method Summary collapse
-
#initialize(options, configuration = RSpec.configuration, world = RSpec.world) ⇒ Runner
constructor
A new instance of Runner.
-
#run(err, out) ⇒ void
Configures and runs a spec suite.
-
#run_specs(example_groups) ⇒ Fixnum
Runs the provided example groups.
-
#setup(err, out) ⇒ void
Wires together the various configuration objects and state holders.
Constructor Details
#initialize(options, configuration = RSpec.configuration, world = RSpec.world) ⇒ Runner
Returns a new instance of Runner.
75 76 77 78 79 |
# File 'lib/rspec/core/runner.rb', line 75 def initialize(, configuration=RSpec.configuration, world=RSpec.world) @options = @configuration = configuration @world = world end |
Class Method Details
.autorun ⇒ void
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.
16 17 18 19 20 21 22 23 24 25 26 |
# File '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 |
.invoke ⇒ void
Runs the suite of specs and exits the process with an appropriate exit code.
43 44 45 46 47 |
# File '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 |
.run(args, err = $stderr, out = $stdout) ⇒ Fixnum
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
.
64 65 66 67 68 69 70 71 72 73 |
# File 'lib/rspec/core/runner.rb', line 64 def self.run(args, err=$stderr, out=$stdout) trap_interrupt = ConfigurationOptions.new(args) if .[:runner] .[:runner].call(, err, out) else new().run(err, out) end end |
Instance Method Details
#run(err, out) ⇒ void
Configures and runs a spec suite.
85 86 87 88 89 90 91 92 |
# File '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) ⇒ Fixnum
Runs the provided example groups.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File '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) ⇒ void
Wires together the various configuration objects and state holders.
98 99 100 101 102 103 104 105 |
# File '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 |