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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
|
require 'rspec/core/drb'
require 'support/runner_support'
module RSpec::Core
RSpec.describe Runner do
describe 'invocation' do
before do
# Simulate invoking the suite like exe/rspec does.
allow(RSpec::Core::Runner).to receive(:run)
RSpec::Core::Runner.invoke
end
it 'does not autorun after having been invoked' do
expect(RSpec::Core::Runner).not_to receive(:at_exit)
RSpec::Core::Runner.autorun
end
it 'prints a warning when autorun is attempted' do
expect_deprecation_with_call_site(__FILE__, __LINE__ + 1)
RSpec::Core::Runner.autorun
end
end
describe '.autorun' do
before do
@original_ivars = Hash[ Runner.instance_variables.map do |ivar|
[ivar, Runner.instance_variable_get(ivar)]
end ]
end
after do
(@original_ivars.keys | Runner.instance_variables).each do |ivar|
if @original_ivars.key?(ivar)
Runner.instance_variable_set(ivar, @original_ivars[ivar])
else
# send is necessary for 1.8.7
Runner.send(:remove_instance_variable, ivar)
end
end
end
it 'sets an at_exit hook if none is already set' do
Runner.instance_eval do
@autorun_disabled = false
@installed_at_exit = false
end
allow(RSpec::Core::Runner).to receive(:running_in_drb?).and_return(false)
allow(RSpec::Core::Runner).to receive(:invoke)
expect(RSpec::Core::Runner).to receive(:at_exit)
RSpec::Core::Runner.autorun
end
it 'does not set the at_exit hook if it is already set' do
Runner.instance_eval do
@autorun_disabled = false
@installed_at_exit = true
end
allow(RSpec::Core::Runner).to receive(:running_in_drb?).and_return(false)
expect(RSpec::Core::Runner).to receive(:at_exit).never
RSpec::Core::Runner.autorun
end
end
describe "at_exit hook" do
before { allow(Runner).to receive(:invoke) }
it 'normally runs the spec suite' do
Runner.perform_at_exit
expect(Runner).to have_received(:invoke)
end
it 'does not run the suite if an error triggered the exit' do
begin
raise "boom"
rescue
Runner.perform_at_exit
end
expect(Runner).not_to have_received(:invoke)
end
it 'stil runs the suite if a `SystemExit` occurs since that is caused by `Kernel#exit`' do
begin
exit
rescue SystemExit
Runner.perform_at_exit
end
expect(Runner).to have_received(:invoke)
end
end
describe "interrupt handling" do
before { allow(Runner).to receive(:exit!) }
it 'prints a message the first time, then exits the second time' do
expect {
Runner.handle_interrupt
}.to output(/shutting down/).to_stderr_from_any_process &
change { RSpec.world.wants_to_quit }.from(a_falsey_value).to(true)
expect(Runner).not_to have_received(:exit!)
expect {
Runner.handle_interrupt
}.not_to output.to_stderr_from_any_process
expect(Runner).to have_received(:exit!)
end
end
describe "interrupt catching" do
let(:interrupt_handlers) { [] }
before do
allow(Runner).to receive(:trap).with("INT", any_args) do |&block|
interrupt_handlers << block
end
end
def interrupt
interrupt_handlers.each(&:call)
end
it "adds a handler for SIGINT" do
expect(interrupt_handlers).to be_empty
Runner.send(:trap_interrupt)
expect(interrupt_handlers.size).to eq(1)
end
context "with SIGINT once" do
it "aborts processing" do
Runner.send(:trap_interrupt)
expect(Runner).to receive(:handle_interrupt)
interrupt
end
it "does not exit immediately, but notifies the user" do
Runner.send(:trap_interrupt)
expect(Runner).not_to receive(:exit)
expect(Runner).not_to receive(:exit!)
expect { interrupt }.to output(/RSpec is shutting down/).to_stderr
end
end
context "with SIGINT twice" do
it "exits immediately" do
Runner.send(:trap_interrupt)
expect(Runner).to receive(:exit!).with(1)
expect { interrupt }.to output(//).to_stderr
interrupt
end
end
end
# This is intermittently slow because this method calls out to the network
# interface.
describe ".running_in_drb?", :slow do
subject { RSpec::Core::Runner.running_in_drb? }
before do
allow(::DRb).to receive(:current_server) { drb_server }
# To deal with some network weirdness at my workplace, I had to
# configure my network adapter in a non-standard way that causes
# `IPSocket.getaddress(Socket.gethostname)` to raise
# `SocketError: getaddrinfo: nodename nor servname provided, or not known`
# I'm not sure why this happens, but to keep the specs here passing,
# I have to stub this out :(.
allow(IPSocket).to receive(:getaddress) { "127.0.0.1" }
end
context "when drb server is started with 127.0.0.1" do
let(:drb_server) do
instance_double(::DRb::DRbServer, :uri => "druby://127.0.0.1:0000/", :alive? => true)
end
it { should be_truthy }
end
context "when drb server is started with localhost" do
let(:drb_server) do
instance_double(::DRb::DRbServer, :uri => "druby://localhost:0000/", :alive? => true)
end
it { should be_truthy }
end
context "when drb server is started with another local ip address" do
let(:drb_server) do
instance_double(::DRb::DRbServer, :uri => "druby://192.168.0.1:0000/", :alive? => true)
end
before do
allow(::IPSocket).to receive(:getaddress).and_return("192.168.0.1")
end
it { should be_truthy }
end
context "when drb server is started with 127.0.0.1 but not alive" do
let(:drb_server) do
instance_double(::DRb::DRbServer, :uri => "druby://127.0.0.1:0000/", :alive? => false)
end
it { should be_falsey }
end
context "when IPSocket cannot resolve the current hostname" do
let(:drb_server) do
instance_double(::DRb::DRbServer, :uri => "druby://localhost:0000/", :alive? => true)
end
before do
allow(::IPSocket).to receive(:getaddress).and_raise(
SocketError, "getaddrinfo: nodename nor servname provided, or not known"
)
end
it { should be_falsey }
end
context "when no drb server is running" do
let(:drb_server) do
raise ::DRb::DRbServerNotFound
end
it { should be_falsey }
end
end
describe '#exit_code' do
let(:world) { World.new }
let(:config) { Configuration.new }
let(:runner) { Runner.new({}, config, world) }
it 'defaults to 1' do
expect(runner.exit_code).to eq 1
end
it 'is failure_exit_code by default' do
config.failure_exit_code = 2
expect(runner.exit_code).to eq 2
end
it 'is failure_exit_code when world is errored by default' do
world.non_example_failure = true
config.failure_exit_code = 2
expect(runner.exit_code).to eq 2
end
it 'is error_exit_code when world is errored by and both are defined' do
world.non_example_failure = true
config.failure_exit_code = 2
config.error_exit_code = 3
expect(runner.exit_code).to eq 3
end
it 'is error_exit_code when world is errored by and failure exit code is not defined' do
world.non_example_failure = true
config.error_exit_code = 3
expect(runner.exit_code).to eq 3
end
it 'can be given success' do
config.error_exit_code = 3
expect(runner.exit_code(true)).to eq 0
end
it 'can be given success, but non_example_failure=true will still cause an error code' do
world.non_example_failure = true
config.error_exit_code = 3
expect(runner.exit_code(true)).to eq 3
end
end
describe ".invoke" do
let(:runner) { RSpec::Core::Runner }
it "runs the specs via #run" do
allow(runner).to receive(:exit)
expect(runner).to receive(:run)
runner.invoke
end
it "doesn't exit on success" do
allow(runner).to receive(:run) { 0 }
expect(runner).to_not receive(:exit)
runner.invoke
end
it "exits with #run's status on failure" do
allow(runner).to receive(:run) { 123 }
expect(runner).to receive(:exit).with(123)
runner.invoke
end
end
describe ".run" do
let(:args) { double(:args) }
let(:err) { StringIO.new }
let(:out) { StringIO.new }
let(:options) { { } }
let(:configuration_options) { double(:configuration_options, :options => options) }
before(:each) do
allow(RSpec::Core::ConfigurationOptions).to receive(:new).and_return(configuration_options)
end
context 'when the options contain a runner callable' do
let(:runner) { double(:runner, :call => nil) }
let(:options) { { :runner => runner } }
it 'invokes the runner callable' do
RSpec::Core::Runner.run([], err, out)
expect(runner).to have_received(:call).with(configuration_options, err, out)
end
end
context 'when no runner callable is set' do
it 'instantiates a Runner instance and runs it' do
process_proxy = double(RSpec::Core::Runner, :run => 0)
allow(RSpec::Core::Runner).to receive(:new).and_return(process_proxy)
RSpec::Core::Runner.run([], err, out)
expect(RSpec::Core::Runner).to have_received(:new)
expect(process_proxy).to have_received(:run).with(err, out)
end
end
end
context "when run" do
include_context "Runner support"
before do
allow(config.hooks).to receive(:run)
end
it "configures streams before command line options" do
allow(RSpec).to receive(:deprecate) # remove this and should_receive when ordered
stdout = StringIO.new
allow(config).to receive(:load_spec_files)
allow(config).to receive(:reporter).and_return(double.as_null_object)
config.output_stream = $stdout
# this is necessary to ensure that color works correctly on windows
expect(config).to receive(:error_stream=).ordered
expect(config).to receive(:output_stream=).ordered
expect(config).to receive(:force).at_least(:once).ordered
runner = build_runner
runner.setup err, stdout
end
it "assigns submitted ConfigurationOptions to @options" do
config_options = ConfigurationOptions.new(%w[--color])
runner = Runner.new(config_options)
expect(runner.instance_exec { @options }).to be(config_options)
end
describe "#run" do
it 'supports a test-queue like subclass that can perform setup once and run different sets of example groups multiple times' do
order = []
RSpec.describe("group 1") do
before { order << :group_1 }
example("passing") { expect(1).to eq(1) }
end
RSpec.describe("group 2") do
before { order << :group_2 }
example("failed") { expect(1).to eq(2) }
end
subclass = Class.new(Runner) do
define_method :run_specs do |example_groups|
set_1, set_2 = example_groups.partition { |g| g.description.include?('1') }
order << :start_set_1
super(set_1)
order << :start_set_2
super(set_2)
end
end
expect(config).to receive(:load_spec_files).once
subclass.new(ConfigurationOptions.new([]), config, world).run(err, out)
expect(order).to eq([:start_set_1, :group_1, :start_set_2, :group_2])
end
it 'reports the expected example count accurately, even when subclasses filter example groups' do
RSpec.describe("group 1") do
example("1") { }
context "nested" do
4.times { example { } }
end
end
RSpec.describe("group 2") do
example("2") { }
example("3") { }
context "nested" do
4.times { example { } }
end
end
subclass = Class.new(Runner) do
define_method :run_specs do |example_groups|
super(example_groups.select { |g| g.description == 'group 2' })
end
end
my_formatter = instance_double(Formatters::BaseFormatter).as_null_object
config.output_stream = out
config.deprecation_stream = err
config.reporter.register_listener(my_formatter, :start)
allow(config).to receive(:load_spec_files)
subclass.new(ConfigurationOptions.new([]), config, world).run(err, out)
expect(my_formatter).to have_received(:start) do |notification|
expect(notification.count).to eq(6)
end
end
describe "persistence of example statuses" do
let(:all_examples) { [double("example")] }
def run
allow(world).to receive(:all_examples).and_return(all_examples)
allow(config).to receive(:load_spec_files)
class_spy(ExampleStatusPersister, :load_from => []).as_stubbed_const
runner = build_runner
runner.run(err, out)
end
context "when `example_status_persistence_file_path` is configured" do
it 'persists the status of all loaded examples' do
config.example_status_persistence_file_path = "examples.txt"
run
expect(ExampleStatusPersister).to have_received(:persist).with(all_examples, "examples.txt")
end
end
context "with --dry-run" do
it "doesn't persist example status" do
config.example_status_persistence_file_path = "examples.txt"
config.dry_run = true
run
expect(ExampleStatusPersister).not_to have_received(:persist)
end
end
context "when `example_status_persistence_file_path` is not configured" do
it "doesn't persist example status" do
config.example_status_persistence_file_path = nil
run
expect(ExampleStatusPersister).not_to have_received(:persist)
end
end
end
context "running files" do
include_context "spec files"
it "returns 0 if spec passes" do
runner = build_runner passing_spec_filename
expect(runner.run(err, out)).to eq 0
end
it "returns 1 if spec fails" do
runner = build_runner failing_spec_filename
expect(runner.run(err, out)).to eq 1
end
it "returns 2 if spec fails and --failure-exit-code is 2" do
runner = build_runner failing_spec_filename, "--failure-exit-code", "2"
expect(runner.run(err, out)).to eq 2
end
end
end
describe "#run with custom output" do
before { allow(config).to receive_messages :files_to_run => [] }
let(:output_file) { File.new("#{Dir.tmpdir}/runner_spec_output.txt", 'w') }
it "doesn't override output_stream" do
config.output_stream = output_file
runner = build_runner
runner.run err, nil
expect(runner.instance_exec { @configuration.output_stream }).to eq output_file
end
end
end
end
end
|