Class: TestQueue::Runner

Inherits:
Object
  • Object
show all
Defined in:
lib/test_queue/runner.rb,
lib/test_queue/runner/sample.rb,
lib/test_queue/runner/cucumber.rb,
lib/test_queue/runner/minitest.rb,
lib/test_queue/runner/minitest5.rb,
lib/test_queue/runner/puppet_lint.rb,
lib/test_queue/runner/minitest4.rb,
lib/test_queue/runner/testunit.rb,
lib/test_queue/runner/rspec.rb

Direct Known Subclasses

Cucumber, MiniTest, PuppetLint, RSpec, Sample, TestUnit

Defined Under Namespace

Classes: Cucumber, MiniTest, PuppetLint, RSpec, Sample, TestUnit

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(test_framework, concurrency = nil, socket = nil, relay = nil) ⇒ Runner

Returns a new instance of Runner.



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
 
# File 'lib/test_queue/runner.rb', line 34

def initialize(test_framework, concurrency=nil, socket=nil, relay=nil)
  @test_framework = test_framework
  @stats = Stats.new(stats_file)

  if ENV['TEST_QUEUE_EARLY_FAILURE_LIMIT']
    begin
      @early_failure_limit = Integer(ENV['TEST_QUEUE_EARLY_FAILURE_LIMIT'])
    rescue ArgumentError
      raise ArgumentError, 'TEST_QUEUE_EARLY_FAILURE_LIMIT could not be parsed as an integer'
    end
  end

  @procline = $0

  @whitelist = if forced = ENV['TEST_QUEUE_FORCE']
                 forced.split(/\s*,\s*/)
               else
                 []
               end
  @whitelist.freeze

  all_files = @test_framework.all_suite_files.to_set
  @queue = @stats.all_suites
    .select { |suite| all_files.include?(suite.path) }
    .sort_by { |suite| -suite.duration }
    .map { |suite| [suite.name, suite.path] }

  if @whitelist.any?
    @queue.select! { |suite_name, path| @whitelist.include?(suite_name) }
    @queue.sort_by! { |suite_name, path| @whitelist.index(suite_name) }
  end

  @awaited_suites = Set.new(@whitelist - @queue.map(&:first))
  @original_queue = Set.new(@queue).freeze

  @workers = {}
  @completed = []

  @concurrency =
    concurrency ||
    (ENV['TEST_QUEUE_WORKERS'] && ENV['TEST_QUEUE_WORKERS'].to_i) ||
    if File.exists?('/proc/cpuinfo')
      File.read('/proc/cpuinfo').split("\n").grep(/processor/).size
    elsif RUBY_PLATFORM =~ /darwin/
      `/usr/sbin/sysctl -n hw.activecpu`.to_i
    else
      2
    end
  unless @concurrency > 0
    raise ArgumentError, "Worker count (#{@concurrency}) must be greater than 0"
  end

  @slave_connection_timeout =
    (ENV['TEST_QUEUE_RELAY_TIMEOUT'] && ENV['TEST_QUEUE_RELAY_TIMEOUT'].to_i) ||
    30

  @run_token = ENV['TEST_QUEUE_RELAY_TOKEN'] || SecureRandom.hex(8)

  @socket =
    socket ||
    ENV['TEST_QUEUE_SOCKET'] ||
    "/tmp/test_queue_#{$$}_#{object_id}.sock"

  @relay =
    relay ||
    ENV['TEST_QUEUE_RELAY']

  @slave_message = ENV["TEST_QUEUE_SLAVE_MESSAGE"] if ENV.has_key?("TEST_QUEUE_SLAVE_MESSAGE")

  if @relay == @socket
    STDERR.puts "*** Detected TEST_QUEUE_RELAY == TEST_QUEUE_SOCKET. Disabling relay mode."
    @relay = nil
  elsif @relay
    @queue = []
  end

  @exit_when_done = true
end

Instance Attribute Details

#concurrency ⇒ Object

Returns the value of attribute concurrency.



31
32
33
 
# File 'lib/test_queue/runner.rb', line 31

def concurrency
  @concurrency
end

#exit_when_done ⇒ Object

Returns the value of attribute exit_when_done.



31
32
33
 
# File 'lib/test_queue/runner.rb', line 31

def exit_when_done
  @exit_when_done
end

#stats ⇒ Object (readonly)

Returns the value of attribute stats.



32
33
34
 
# File 'lib/test_queue/runner.rb', line 32

def stats
  @stats
end

Instance Method Details

#abort(message) ⇒ Object

Stop the test run immediately.

message - String message to print to the console when exiting.

Doesn’t return.



540
541
542
543
544
 
# File 'lib/test_queue/runner.rb', line 540

def abort(message)
  @aborting = true
  kill_subprocesses
  Kernel::abort("Aborting: #{message}")
end

#after_fork(num) ⇒ Object

Prepare a worker for executing jobs after a fork.



355
356
 
# File 'lib/test_queue/runner.rb', line 355

def after_fork(num)
end

#after_fork_internal(num, iterator) ⇒ Object 



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/test_queue/runner.rb', line 327

def after_fork_internal(num, iterator)
  srand

  output = File.open("/tmp/test_queue_worker_#{$$}_output", 'w')

  $stdout.reopen(output)
  $stderr.reopen($stdout)
  $stdout.sync = $stderr.sync = true

  $0 = "test-queue worker [#{num}]"
  puts
  puts "==> Starting #$0 (#{Process.pid} on #{Socket.gethostname}) - iterating over #{iterator.sock}"
  puts

  after_fork(num)
end

#around_filter(suite) ⇒ Object 



350
351
352
 
# File 'lib/test_queue/runner.rb', line 350

def around_filter(suite)
  yield
end

#awaiting_suites? ⇒ Boolean

Returns:

  • (Boolean) 


288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/test_queue/runner.rb', line 288

def awaiting_suites?
  case
  when @awaited_suites.any?
    # We're waiting to find all the whitelisted suites so we can run them
    # in the correct order.
    true
  when @queue.empty? && !!@discovering_suites_pid
    # We don't have any suites yet, but we're working on it.
    true
  else
    # It's fine to run any queued suites now.
    false
  end
end

#cleanup_worker ⇒ Object 



370
371
 
# File 'lib/test_queue/runner.rb', line 370

def cleanup_worker
end

#collect_worker_data(worker) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/test_queue/runner.rb', line 395

def collect_worker_data(worker)
  if File.exists?(file = "/tmp/test_queue_worker_#{worker.pid}_output")
    worker.output = IO.binread(file)
    FileUtils.rm(file)
  end

  if File.exists?(file = "/tmp/test_queue_worker_#{worker.pid}_suites")
    worker.suites.replace(Marshal.load(IO.binread(file)))
    FileUtils.rm(file)
  end
end

#connect_to_relay ⇒ Object 



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/test_queue/runner.rb', line 480

def connect_to_relay
  sock = nil
  start = Time.now
  puts "Attempting to connect for #{@slave_connection_timeout}s..."
  while sock.nil?
    begin
      sock = TCPSocket.new(*@relay.split(':'))
    rescue Errno::ECONNREFUSED => e
      raise e if Time.now - start > @slave_connection_timeout
      puts "Master not yet available, sleeping..."
      sleep 0.5
    end
  end
  sock
end

#discover_suites ⇒ Object 



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
 
# File 'lib/test_queue/runner.rb', line 259

def discover_suites
  # Remote masters don't discover suites; the central master does and
  # distributes them to remote masters.
  return if relay?

  # No need to discover suites if all whitelisted suites are already
  # queued.
  return if @whitelist.any? && @awaited_suites.empty?

  @discovering_suites_pid = fork do
    terminate = false
    Signal.trap("INT") { terminate = true }

    $0 = "test-queue suite discovery process"

    @test_framework.all_suite_files.each do |path|
      @test_framework.suites_from_file(path).each do |suite_name, suite|
        Kernel.exit!(0) if terminate

        @server.connect_address.connect do |sock|
          sock.puts("NEW SUITE #{Marshal.dump([suite_name, path])}")
        end
      end
    end

    Kernel.exit! 0
  end
end

#distribute_queue ⇒ Object 



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
 
# File 'lib/test_queue/runner.rb', line 413

def distribute_queue
  return if relay?
  remote_workers = 0

  until !awaiting_suites? && @queue.empty? && remote_workers == 0
    queue_status(@start_time, @queue.size, @workers.size, remote_workers)

    if status = reap_suite_discovery_process(false)
      abort("Discovering suites failed.") unless status.success?
      abort("Failed to discover #{@awaited_suites.sort.join(", ")} specified in TEST_QUEUE_FORCE") if @awaited_suites.any?
    end

    if IO.select([@server], nil, nil, 0.1).nil?
      reap_workers(false) # check for worker deaths
    else
      sock = @server.accept
      cmd = sock.gets.strip
      case cmd
      when /^POP/
        # If we have a slave from a different test run, don't respond, and it will consider the test run done.
        if awaiting_suites?
          sock.write(Marshal.dump("WAIT"))
        elsif obj = @queue.shift
          data = Marshal.dump(obj)
          sock.write(data)
        end
      when /^SLAVE (\d+) ([\w\.-]+) (\w+)(?: (.+))?/
        num = $1.to_i
        slave = $2
        run_token = $3
        slave_message = $4
        if run_token == @run_token
          # If we have a slave from a different test run, don't respond, and it will consider the test run done.
          sock.write("OK\n")
          remote_workers += num
        else
          STDERR.puts "*** Worker from run #{run_token} connected to master for run #{@run_token}; ignoring."
          sock.write("WRONG RUN\n")
        end
        message = "*** #{num} workers connected from #{slave} after #{Time.now-@start_time}s"
        message << " " + slave_message if slave_message
        STDERR.puts message
      when /^WORKER (\d+)/
        data = sock.read($1.to_i)
        worker = Marshal.load(data)
        worker_completed(worker)
        remote_workers -= 1
      when /^NEW SUITE (.+)/
        suite_name, path = Marshal.load($1)
        enqueue_discovered_suite(suite_name, path)
      when /^KABOOM/
        # worker reporting an abnormal number of test failures;
        # stop everything immediately and report the results.
        break
      end
      sock.close
    end
  end
ensure
  stop_master
  reap_workers
end

#enqueue_discovered_suite(suite_name, path) ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/test_queue/runner.rb', line 303

def enqueue_discovered_suite(suite_name, path)
  if @whitelist.any? && !@whitelist.include?(suite_name)
    return
  end

  if @original_queue.include?([suite_name, path])
    # This suite was already added to the queue some other way.
    return
  end

  # We don't know how long new suites will take to run, so we put them at
  # the front of the queue. It's better to run a fast suite early than to
  # run a slow suite late.
  @queue.unshift [suite_name, path]

  if @awaited_suites.delete?(suite_name) && @awaited_suites.empty?
    # We've found all the whitelisted suites. Sort the queue to match the
    # whitelist.
    @queue.sort_by! { |suite_name, path| @whitelist.index(suite_name) }

    kill_suite_discovery_process("INT")
  end
end

#execute ⇒ Object

Run the tests.

If exit_when_done is true, exit! will be called before this method completes. If exit_when_done is false, this method will return an Integer number of failures.



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/test_queue/runner.rb', line 118

def execute
  $stdout.sync = $stderr.sync = true
  @start_time = Time.now

  execute_internal
  exitstatus = summarize_internal

  if exit_when_done
    exit! exitstatus
  else
    exitstatus
  end
end

#execute_internal ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/test_queue/runner.rb', line 182

def execute_internal
  start_master
  prepare(@concurrency)
  @prepared_time = Time.now
  start_relay if relay?
  discover_suites
  spawn_workers
  distribute_queue
ensure
  stop_master

  kill_subprocesses
end

#kill_subprocesses ⇒ Object 



507
508
509
510
 
# File 'lib/test_queue/runner.rb', line 507

def kill_subprocesses
  kill_workers
  kill_suite_discovery_process
end

#kill_suite_discovery_process(signal = "KILL") ⇒ Object 



520
521
522
523
524
 
# File 'lib/test_queue/runner.rb', line 520

def kill_suite_discovery_process(signal="KILL")
  return unless @discovering_suites_pid
  Process.kill signal, @discovering_suites_pid
  reap_suite_discovery_process
end

#kill_workers ⇒ Object 



512
513
514
515
516
517
518
 
# File 'lib/test_queue/runner.rb', line 512

def kill_workers
  @workers.each do |pid, worker|
    Process.kill 'KILL', pid
  end

  reap_workers
end

#prepare(concurrency) ⇒ Object

Run in the master before the fork. Used to create concurrency copies of any databases required by the test workers.



347
348
 
# File 'lib/test_queue/runner.rb', line 347

def prepare(concurrency)
end

#queue_status(start_time, queue_size, local_worker_count, remote_worker_count) ⇒ Object

Subclasses can override to monitor the status of the queue.

For example, you may want to record metrics about how quickly remote workers connect, or abort the build if not enough connect.

This method is called very frequently during the test run, so don’t do anything expensive/blocking.

This method is not called on remote masters when using remote workers, only on the central master.

start_time - Time when the test run began queue_size - Integer number of suites left in the queue local_worker_count - Integer number of active local workers remote_worker_count - Integer number of active remote workers

Returns nothing.



563
564
 
# File 'lib/test_queue/runner.rb', line 563

def queue_status(start_time, queue_size, local_worker_count, remote_worker_count)
end

#reap_suite_discovery_process(blocking = true) ⇒ Object 



526
527
528
529
530
531
532
533
 
# File 'lib/test_queue/runner.rb', line 526

def reap_suite_discovery_process(blocking=true)
  return unless @discovering_suites_pid
  _, status = Process.waitpid2(@discovering_suites_pid, blocking ? 0 : Process::WNOHANG)
  return unless status

  @discovering_suites_pid = nil
  status
end

#reap_workers(blocking = true) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/test_queue/runner.rb', line 378

def reap_workers(blocking=true)
  @workers.delete_if do |_, worker|
    if Process.waitpid(worker.pid, blocking ? 0 : Process::WNOHANG).nil?
      next false
    end

    worker.status = $?
    worker.end_time = Time.now

    collect_worker_data(worker)
    relay_to_master(worker) if relay?
    worker_completed(worker)

    true
  end
end

#relay? ⇒ Boolean

Returns:

  • (Boolean) 


476
477
478
 
# File 'lib/test_queue/runner.rb', line 476

def relay?
  !!@relay
end

#relay_to_master(worker) ⇒ Object 



496
497
498
499
500
501
502
503
504
505
 
# File 'lib/test_queue/runner.rb', line 496

def relay_to_master(worker)
  worker.host = Socket.gethostname
  data = Marshal.dump(worker)

  sock = connect_to_relay
  sock.puts("WORKER #{data.bytesize}")
  sock.write(data)
ensure
  sock.close if sock
end

#run_worker(iterator) ⇒ Object

Entry point for internal runner implementations. The iterator will yield jobs from the shared queue on the master.

Returns an Integer number of failures.



362
363
364
365
366
367
368
 
# File 'lib/test_queue/runner.rb', line 362

def run_worker(iterator)
  iterator.each do |item|
    puts "  #{item.inspect}"
  end

  return 0 # exit status
end

#spawn_workers ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/test_queue/runner.rb', line 241

def spawn_workers
  @concurrency.times do |i|
    num = i+1

    pid = fork do
      @server.close if @server

      iterator = Iterator.new(@test_framework, relay?? @relay : @socket, method(:around_filter), early_failure_limit: @early_failure_limit)
      after_fork_internal(num, iterator)
      ret = run_worker(iterator) || 0
      cleanup_worker
      Kernel.exit! ret
    end

    @workers[pid] = Worker.new(pid, num)
  end
end

#start_master ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/test_queue/runner.rb', line 196

def start_master
  if !relay?
    if @socket =~ /^(?:(.+):)?(\d+)$/
      address = $1 || '0.0.0.0'
      port = $2.to_i
      @socket = "#$1:#$2"
      @server = TCPServer.new(address, port)
    else
      FileUtils.rm(@socket) if File.exists?(@socket)
      @server = UNIXServer.new(@socket)
    end
  end

  desc = "test-queue master (#{relay?? "relaying to #{@relay}" : @socket})"
  puts "Starting #{desc}"
  $0 = "#{desc} - #{@procline}"
end

#start_relay ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/test_queue/runner.rb', line 214

def start_relay
  return unless relay?

  sock = connect_to_relay
  message = @slave_message ? " #{@slave_message}" : ""
  message.gsub!(/(\r|\n)/, "") # Our "protocol" is newline-separated
  sock.puts("SLAVE #{@concurrency} #{Socket.gethostname} #{@run_token}#{message}")
  response = sock.gets.strip
  unless response == "OK"
    STDERR.puts "*** Got non-OK response from master: #{response}"
    sock.close
    exit! 1
  end
  sock.close
rescue Errno::ECONNREFUSED
  STDERR.puts "*** Unable to connect to relay #{@relay}. Aborting.."
  exit! 1
end

#stats_file ⇒ Object 



177
178
179
180
 
# File 'lib/test_queue/runner.rb', line 177

def stats_file
  ENV['TEST_QUEUE_STATS'] ||
  '.test_queue_stats'
end

#stop_master ⇒ Object 



233
234
235
236
237
238
239
 
# File 'lib/test_queue/runner.rb', line 233

def stop_master
  return if relay?

  FileUtils.rm_f(@socket) if @socket && @server.is_a?(UNIXServer)
  @server.close rescue nil if @server
  @socket = @server = nil
end

#summarize ⇒ Object 



174
175
 
# File 'lib/test_queue/runner.rb', line 174

def summarize
end

#summarize_internal ⇒ Object 



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
 
# File 'lib/test_queue/runner.rb', line 132

def summarize_internal
  puts
  puts "==> Summary (#{@completed.size} workers in %.4fs)" % (Time.now-@start_time)
  puts

  @failures = ''
  @completed.each do |worker|
    @stats.record_suites(worker.suites)

    summarize_worker(worker)

    @failures << worker.failure_output if worker.failure_output

    puts "    [%2d] %60s      %4d suites in %.4fs      (pid %d exit %d%s)" % [
      worker.num,
      worker.summary,
      worker.suites.size,
      worker.end_time - worker.start_time,
      worker.pid,
      worker.status.exitstatus,
      worker.host && " on #{worker.host.split('.').first}"
    ]
  end

  unless @failures.empty?
    puts
    puts "==> Failures"
    puts
    puts @failures
  end

  puts

  @stats.save

  summarize

  estatus = @completed.inject(0){ |s, worker| s + worker.status.exitstatus }
  estatus = 255 if estatus > 255
  estatus
end

#summarize_worker(worker) ⇒ Object 



373
374
375
376
 
# File 'lib/test_queue/runner.rb', line 373

def summarize_worker(worker)
  worker.summary = ''
  worker.failure_output = ''
end

#worker_completed(worker) ⇒ Object 



407
408
409
410
411
 
# File 'lib/test_queue/runner.rb', line 407

def worker_completed(worker)
  return if @aborting
  @completed << worker
  puts worker.output if ENV['TEST_QUEUE_VERBOSE'] || worker.status.exitstatus != 0
end