Class: Minitest::Runnable

Inherits:
Object show all
Defined in:
lib/minitest.rb,
lib/minitest.rb

Overview

re-open

Direct Known Subclasses

Result, Test

Constant Summary collapse

SIGNALS =

:nodoc:

Signal.list
@@marshal_dump_warned = 
false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Runnable

:nodoc:



448
449
450
451
452
453
 
# File 'lib/minitest.rb', line 448

def initialize name # :nodoc:
  self.name       = name
  self.failures   = []
  self.assertions = 0
  # lazy initializer for metadata
end

Instance Attribute Details

#assertions ⇒ Object

Number of assertions executed in this run.



284
285
286
 
# File 'lib/minitest.rb', line 284

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



289
290
291
 
# File 'lib/minitest.rb', line 289

def failures
  @failures
end

#metadata ⇒ Object

Metadata you attach to the test results that get sent to the reporter.

Lazily initializes to a hash, to keep memory down.

NOTE: this data must be plain (read: marshal-able) data! Hashes! Arrays! Strings!



463
464
465
 
# File 'lib/minitest.rb', line 463

def metadata
  @metadata ||= {}
end

#time ⇒ Object

The time it took to run.



294
295
296
 
# File 'lib/minitest.rb', line 294

def time
  @time
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



1112
1113
1114
1115
 
# File 'lib/minitest.rb', line 1112

def self.inherited klass # :nodoc:
  self.runnables << klass
  super
end

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



321
322
323
 
# File 'lib/minitest.rb', line 321

def self.methods_matching re
  public_instance_methods(true).grep(re).map(&:to_s)
end

.on_signal(name, action) ⇒ Object

:nodoc:



400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/minitest.rb', line 400

def self.on_signal name, action # :nodoc:
  supported = SIGNALS[name]

  old_trap = trap name do
    old_trap.call if old_trap.respond_to? :call
    action.call
  end if supported

  yield
ensure
  trap name, old_trap if supported
end

.reset ⇒ Object

:nodoc:



325
326
327
 
# File 'lib/minitest.rb', line 325

def self.reset # :nodoc:
  @@runnables = []
end

.run(reporter, options = {}) ⇒ Object

Responsible for running all runnable methods in a given class, each in its own instance. Each instance is passed to the reporter to record.



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
 
# File 'lib/minitest.rb', line 336

def self.run reporter, options = {}
  filtered_methods = if options[:filter]
    filter = options[:filter]
    filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%

    self.runnable_methods.find_all { |m|
      filter === m || filter === "#{self}##{m}"
    }
  else
    self.runnable_methods
  end

  if options[:exclude]
    exclude = options[:exclude]
    exclude = Regexp.new $1 if exclude =~ %r%/(.*)/%

    filtered_methods.delete_if { |m|
      exclude === m || exclude === "#{self}##{m}"
    }
  end

  return if filtered_methods.empty?

  with_info_handler reporter do
    filtered_methods.each do |method_name|
      run_one_method self, method_name, reporter
    end
  end
end

.run_one_method(klass, method_name, reporter) ⇒ Object

Runs a single method and has the reporter record the result. This was considered internal API but is factored out of run so that subclasses can specialize the running of an individual test. See Minitest::ParallelTest::ClassMethods for an example.



372
373
374
375
 
# File 'lib/minitest.rb', line 372

def self.run_one_method klass, method_name, reporter
  reporter.prerecord klass, method_name
  reporter.record Minitest.run_one_method(klass, method_name)
end

.runnable_methods ⇒ Object

Each subclass of Runnable is responsible for overriding this method to return all runnable methods. See #methods_matching.

Raises:

  • (NotImplementedError) 


417
418
419
 
# File 'lib/minitest.rb', line 417

def self.runnable_methods
  raise NotImplementedError, "subclass responsibility"
end

.runnables ⇒ Object

Returns all subclasses of Runnable.



424
425
426
 
# File 'lib/minitest.rb', line 424

def self.runnables
  @@runnables
end

.test_order ⇒ Object

Defines the order to run tests (:random by default). Override this or use a convenience method to change it for your tests.



381
382
383
 
# File 'lib/minitest.rb', line 381

def self.test_order
  :random
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:



385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/minitest.rb', line 385

def self.with_info_handler reporter, &block # :nodoc:
  handler = lambda do
    unless reporter.passed? then
      warn "Current results:"
      warn ""
      warn reporter.reporters.first
      warn ""
    end
  end

  on_signal ::Minitest.info_signal, handler, &block
end

Instance Method Details

#failure ⇒ Object

:nodoc:



444
445
446
 
# File 'lib/minitest.rb', line 444

def failure # :nodoc:
  self.failures.first
end

#marshal_dump ⇒ Object

:nodoc:



430
431
432
433
434
435
436
437
438
 
# File 'lib/minitest.rb', line 430

def marshal_dump # :nodoc:
  unless @@marshal_dump_warned then
    warn ["Minitest::Runnable#marshal_dump is deprecated.",
          "You might be violating internals. From", caller.first].join " "
    @@marshal_dump_warned = true
  end

  [self.name, self.failures, self.assertions, self.time]
end

#marshal_load(ary) ⇒ Object

:nodoc:



440
441
442
 
# File 'lib/minitest.rb', line 440

def marshal_load ary # :nodoc:
  self.name, self.failures, self.assertions, self.time = ary
end

#metadata? ⇒ Boolean

Returns true if metadata exists.

Returns:

  • (Boolean) 


475
476
477
 
# File 'lib/minitest.rb', line 475

def metadata?
  defined? @metadata
end

#name ⇒ Object

Name of the run.



307
308
309
 
# File 'lib/minitest.rb', line 307

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



314
315
316
 
# File 'lib/minitest.rb', line 314

def name= o
  @NAME = o
end

#passed? ⇒ Boolean

Did this run pass?

Note: skipped runs are not considered passing, but they don’t cause the process to exit non-zero.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


492
493
494
 
# File 'lib/minitest.rb', line 492

def passed?
  raise NotImplementedError, "subclass responsibility"
end

#result_code ⇒ Object

Returns a single character string to print based on the result of the run. One of ".", "F", "E" or "S".

Raises:

  • (NotImplementedError) 


501
502
503
 
# File 'lib/minitest.rb', line 501

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


482
483
484
 
# File 'lib/minitest.rb', line 482

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

Was this run skipped? See #passed? for more information.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


508
509
510
 
# File 'lib/minitest.rb', line 508

def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time_it ⇒ Object

:nodoc:



296
297
298
299
300
301
302
 
# File 'lib/minitest.rb', line 296

def time_it # :nodoc:
  t0 = Minitest.clock_time

  yield
ensure
  self.time = Minitest.clock_time - t0
end