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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Runnable

:nodoc:



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

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.



233
234
235
 
# File 'lib/minitest.rb', line 233

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



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

def failures
  @failures
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



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

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



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

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

.on_signal(name, action) ⇒ Object

:nodoc:



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

def self.on_signal name, action # :nodoc:
  supported = Signal.list[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:



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

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.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/minitest.rb', line 277

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

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

  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 



292
293
294
 
# File 'lib/minitest.rb', line 292

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) 


326
327
328
 
# File 'lib/minitest.rb', line 326

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

.runnables ⇒ Object

Returns all subclasses of Runnable.



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

def self.runnables
  @@runnables
end

.with_info_handler(reporter, &block) ⇒ Object

:nodoc:



296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/minitest.rb', line 296

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:



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

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

#marshal_dump ⇒ Object

:nodoc:



337
338
339
 
# File 'lib/minitest.rb', line 337

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

#marshal_load(ary) ⇒ Object

:nodoc:



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

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

#name ⇒ Object

Name of the run.



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

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



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

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) 


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

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) 


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

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


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

def skipped?
  raise NotImplementedError, "subclass responsibility"
end