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:


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

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

Instance Attribute Details

#assertionsObject

Number of assertions executed in this run.


257
258
259
# File 'lib/minitest.rb', line 257

def assertions
  @assertions
end

#failuresObject

An assertion raised during the run, if any.


262
263
264
# File 'lib/minitest.rb', line 262

def failures
  @failures
end

#timeObject

The time it took to run.


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

def time
  @time
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:


1047
1048
1049
1050
# File 'lib/minitest.rb', line 1047

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.


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

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

.on_signal(name, action) ⇒ Object

:nodoc:


359
360
361
362
363
364
365
366
367
368
369
370
# File 'lib/minitest.rb', line 359

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:


298
299
300
# File 'lib/minitest.rb', line 298

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.


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/minitest.rb', line 309

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.


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

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)

376
377
378
# File 'lib/minitest.rb', line 376

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

.runnablesObject

Returns all subclasses of Runnable.


383
384
385
# File 'lib/minitest.rb', line 383

def self.runnables
  @@runnables
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:


344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/minitest.rb', line 344

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:


403
404
405
# File 'lib/minitest.rb', line 403

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

#marshal_dumpObject

:nodoc:


389
390
391
392
393
394
395
396
397
# File 'lib/minitest.rb', line 389

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:


399
400
401
# File 'lib/minitest.rb', line 399

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

#nameObject

Name of the run.


280
281
282
# File 'lib/minitest.rb', line 280

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.


287
288
289
# File 'lib/minitest.rb', line 287

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)

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

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)

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

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#runObject

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError)

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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped?Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)

442
443
444
# File 'lib/minitest.rb', line 442

def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time_itObject

:nodoc:


269
270
271
272
273
274
275
# File 'lib/minitest.rb', line 269

def time_it # :nodoc:
  t0 = Minitest.clock_time

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