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:



366
367
368
369
370
 
# File 'lib/minitest.rb', line 366

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

Instance Attribute Details

#assertions ⇒ Object

Number of assertions executed in this run.



240
241
242
 
# File 'lib/minitest.rb', line 240

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



245
246
247
 
# File 'lib/minitest.rb', line 245

def failures
  @failures
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



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

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



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

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

.on_signal(name, action) ⇒ Object

:nodoc:



326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/minitest.rb', line 326

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:



273
274
275
 
# File 'lib/minitest.rb', line 273

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.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/minitest.rb', line 284

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.



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

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


343
344
345
 
# File 'lib/minitest.rb', line 343

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

.runnables ⇒ Object

Returns all subclasses of Runnable.



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

def self.runnables
  @@runnables
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:



311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/minitest.rb', line 311

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

#failure ⇒ Object

:nodoc:



362
363
364
 
# File 'lib/minitest.rb', line 362

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

#marshal_dump ⇒ Object

:nodoc:



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

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

#marshal_load(ary) ⇒ Object

:nodoc:



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

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

#name ⇒ Object

Name of the run.



250
251
252
 
# File 'lib/minitest.rb', line 250

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



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

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) 


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

def passed?
  raise NotImplementedError, "subclass responsibility"
end

#result_code ⇒ Object

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

Raises:

  • (NotImplementedError) 


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

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


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

def skipped?
  raise NotImplementedError, "subclass responsibility"
end