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:



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

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.



309
310
311
 
# File 'lib/minitest.rb', line 309

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



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

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!



478
479
480
 
# File 'lib/minitest.rb', line 478

def metadata
  @metadata ||= {}
end

#time ⇒ Object

The time it took to run.



319
320
321
 
# File 'lib/minitest.rb', line 319

def time
  @time
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



1156
1157
1158
1159
 
# File 'lib/minitest.rb', line 1156

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



346
347
348
 
# File 'lib/minitest.rb', line 346

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

.on_signal(name, action) ⇒ Object

:nodoc:



415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/minitest.rb', line 415

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:



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

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.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/minitest.rb', line 361

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

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

  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?

  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.



387
388
389
390
 
# File 'lib/minitest.rb', line 387

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) 


432
433
434
 
# File 'lib/minitest.rb', line 432

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

.runnables ⇒ Object

Returns all subclasses of Runnable.



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

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.



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

def self.test_order
  :random
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:



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

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:



459
460
461
 
# File 'lib/minitest.rb', line 459

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

#marshal_dump ⇒ Object

:nodoc:



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

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:



455
456
457
 
# File 'lib/minitest.rb', line 455

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

#metadata? ⇒ Boolean

Returns true if metadata exists.

Returns:

  • (Boolean) 


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

def metadata?
  defined? @metadata
end

#name ⇒ Object

Name of the run.



332
333
334
 
# File 'lib/minitest.rb', line 332

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



339
340
341
 
# File 'lib/minitest.rb', line 339

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) 


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

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) 


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

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


497
498
499
 
# File 'lib/minitest.rb', line 497

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


523
524
525
 
# File 'lib/minitest.rb', line 523

def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time_it ⇒ Object

:nodoc:



321
322
323
324
325
326
327
 
# File 'lib/minitest.rb', line 321

def time_it # :nodoc:
  t0 = Minitest.clock_time

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