Class: Minitest::Runnable

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

Overview

Represents anything “runnable”, like Test, Spec, Benchmark, or whatever you can dream up.

Subclasses of this are automatically registered and available in Runnable.runnables.

Direct Known Subclasses

Test

Constant Summary collapse

SIGNALS =

:nodoc:

Signal.list

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Runnable

:nodoc:


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

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

Instance Attribute Details

#assertionsObject

Number of assertions executed in this run.


237
238
239
# File 'lib/minitest.rb', line 237

def assertions
  @assertions
end

#failuresObject

An assertion raised during the run, if any.


242
243
244
# File 'lib/minitest.rb', line 242

def failures
  @failures
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:


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

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.


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

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

.on_signal(name, action) ⇒ Object

:nodoc:


323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/minitest.rb', line 323

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:


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

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.


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/minitest.rb', line 281

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

  filtered_methods = self.runnable_methods.find_all { |m|
    filter === m || filter === "#{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.


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

def self.run_one_method klass, method_name, reporter
  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)

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

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

.runnablesObject

Returns all subclasses of Runnable.


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

def self.runnables
  @@runnables
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:


308
309
310
311
312
313
314
315
316
317
318
319
# File 'lib/minitest.rb', line 308

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 "INFO", handler, &block
end

Instance Method Details

#failureObject

:nodoc:


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

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

#marshal_dumpObject

:nodoc:


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

def marshal_dump # :nodoc:
  [self.name, self.failures, self.assertions]
end

#marshal_load(ary) ⇒ Object

:nodoc:


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

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

#nameObject

Name of the run.


247
248
249
# File 'lib/minitest.rb', line 247

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.


254
255
256
# File 'lib/minitest.rb', line 254

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)

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

def passed?
  raise NotImplementedError, "subclass responsibility"
end

#result_codeObject

Returns a single character string to print based on the result of the run. Eg “.”, “F”, or “E”.

Raises:

  • (NotImplementedError)

390
391
392
# File 'lib/minitest.rb', line 390

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#runObject

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError)

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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped?Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)

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

def skipped?
  raise NotImplementedError, "subclass responsibility"
end