1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
module RSpec
module Core
# Provides the main entry point to run a suite of RSpec examples.
class Runner
# @attr_reader
# @private
attr_reader :options, :configuration, :world
# Register an `at_exit` hook that runs the suite when the process exits.
#
# @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`.
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
# @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
# Runs the suite of specs and exits the process with an appropriate exit
# code.
def self.invoke
disable_autorun!
status = run(ARGV, $stderr, $stdout).to_i
exit(status) if status != 0
end
# 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.
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)
return
rescue DRb::DRbConnError
err.puts "No DRb server is running. Running in local process instead ..."
end
end
new(options).run(err, out)
end
def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
@options = options
@configuration = configuration
@world = world
end
# Configures and runs a spec suite.
#
# @param err [IO] error stream
# @param out [IO] output stream
def run(err, out)
setup(err, out)
run_specs(@world.ordered_example_groups).tap do
persist_example_statuses
end
end
# Wires together the various configuration objects and state holders.
#
# @param err [IO] error stream
# @param out [IO] output stream
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
# 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.
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
private
def persist_example_statuses
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
# @private
def self.disable_autorun!
@autorun_disabled = true
end
# @private
def self.autorun_disabled?
@autorun_disabled ||= false
end
# @private
def self.installed_at_exit?
@installed_at_exit ||= false
end
# @private
# rubocop:disable Lint/EnsureReturn
def self.running_in_drb?
if defined?(DRb) && DRb.current_server
require 'socket'
require 'uri'
local_ipv4 = IPSocket.getaddress(Socket.gethostname)
local_drb = ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
end
rescue DRb::DRbServerNotFound
ensure
return local_drb || false
end
# rubocop:enable Lint/EnsureReturn
# @private
def self.trap_interrupt
trap('INT') { handle_interrupt }
end
# @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
end
end
end
|
