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:


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

def initialize name # :nodoc:
  self.name       = name
  self.failures   = []
  self.assertions = 0
end

Instance Attribute Details

#assertionsObject

Number of assertions executed in this run.


266
267
268
# File 'lib/minitest.rb', line 266

def assertions
  @assertions
end

#failuresObject

An assertion raised during the run, if any.


271
272
273
# File 'lib/minitest.rb', line 271

def failures
  @failures
end

#timeObject

The time it took to run.


276
277
278
# File 'lib/minitest.rb', line 276

def time
  @time
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:


1060
1061
1062
1063
# File 'lib/minitest.rb', line 1060

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.


303
304
305
# File 'lib/minitest.rb', line 303

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

.on_signal(name, action) ⇒ Object

:nodoc:


368
369
370
371
372
373
374
375
376
377
378
379
# File 'lib/minitest.rb', line 368

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

.resetObject

:nodoc:


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

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.


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/minitest.rb', line 318

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

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

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

  filtered_methods.delete_if { |m|
    exclude === m || exclude === "#{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.


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

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_methodsObject

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

Raises:

  • (NotImplementedError)

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

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

.runnablesObject

Returns all subclasses of Runnable.


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

def self.runnables
  @@runnables
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:


353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/minitest.rb', line 353

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

#failureObject

:nodoc:


412
413
414
# File 'lib/minitest.rb', line 412

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

#marshal_dumpObject

:nodoc:


398
399
400
401
402
403
404
405
406
# File 'lib/minitest.rb', line 398

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:


408
409
410
# File 'lib/minitest.rb', line 408

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

#nameObject

Name of the run.


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

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.


296
297
298
# File 'lib/minitest.rb', line 296

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)

435
436
437
# File 'lib/minitest.rb', line 435

def passed?
  raise NotImplementedError, "subclass responsibility"
end

#result_codeObject

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

Raises:

  • (NotImplementedError)

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

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#runObject

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError)

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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped?Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)

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

def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time_itObject

:nodoc:


278
279
280
281
282
283
284
# File 'lib/minitest.rb', line 278

def time_it # :nodoc:
  t0 = Minitest.clock_time

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