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:



515
516
517
518
519
520
 
# File 'lib/minitest.rb', line 515

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.



355
356
357
 
# File 'lib/minitest.rb', line 355

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



360
361
362
 
# File 'lib/minitest.rb', line 360

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!



530
531
532
 
# File 'lib/minitest.rb', line 530

def metadata
  @metadata ||= {}
end

#time ⇒ Object

The time it took to run.



365
366
367
 
# File 'lib/minitest.rb', line 365

def time
  @time
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



1229
1230
1231
1232
 
# File 'lib/minitest.rb', line 1229

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



392
393
394
 
# File 'lib/minitest.rb', line 392

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

.on_signal(name, action) ⇒ Object

:nodoc:



467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/minitest.rb', line 467

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:



396
397
398
 
# File 'lib/minitest.rb', line 396

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.



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

def self.run reporter, options = {}
  pos = options[:filter]
  neg = options[:exclude]

  pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
  neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%

  # at most 1-2% slower than a 1-pass version, stop optimizing this
  filtered_methods = self.runnable_methods
    .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
    .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }

  return if filtered_methods.empty?

  t0 = name = nil

  @_info_handler = lambda do
    unless reporter.passed? then
      warn "Current results:"
      warn reporter.reporters.grep(SummaryReporter).first
    end

    warn "Current: %s#%s %.2fs" % [self, name, Minitest.clock_time - t0]
  end

  with_info_handler reporter do
    filtered_methods.each do |method_name|
      name = method_name
      t0 = Minitest.clock_time

      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.



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

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) 


484
485
486
 
# File 'lib/minitest.rb', line 484

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

.runnables ⇒ Object

Returns all subclasses of Runnable.



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

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.



457
458
459
 
# File 'lib/minitest.rb', line 457

def self.test_order
  :random
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:



461
462
463
 
# File 'lib/minitest.rb', line 461

def self.with_info_handler reporter, &block # :nodoc:
  on_signal ::Minitest.info_signal, @_info_handler, &block
end

Instance Method Details

#failure ⇒ Object

:nodoc:



511
512
513
 
# File 'lib/minitest.rb', line 511

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

#marshal_dump ⇒ Object

:nodoc:



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

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

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

#marshal_load(ary) ⇒ Object

:nodoc:



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

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

#metadata? ⇒ Boolean

Returns true if metadata exists.

Returns:

  • (Boolean) 


542
543
544
 
# File 'lib/minitest.rb', line 542

def metadata?
  defined? @metadata
end

#name ⇒ Object

Name of the run.



378
379
380
 
# File 'lib/minitest.rb', line 378

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



385
386
387
 
# File 'lib/minitest.rb', line 385

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) 


559
560
561
 
# File 'lib/minitest.rb', line 559

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) 


568
569
570
 
# File 'lib/minitest.rb', line 568

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


549
550
551
 
# File 'lib/minitest.rb', line 549

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


575
576
577
 
# File 'lib/minitest.rb', line 575

def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time_it ⇒ Object

:nodoc:



367
368
369
370
371
372
373
 
# File 'lib/minitest.rb', line 367

def time_it # :nodoc:
  t0 = Minitest.clock_time

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