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:



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

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.



205
206
207
 
# File 'lib/minitest.rb', line 205

def assertions
  @assertions
end

#failures ⇒ Object

An assertion raised during the run, if any.



210
211
212
 
# File 'lib/minitest.rb', line 210

def failures
  @failures
end

Class Method Details

.inherited(klass) ⇒ Object

:nodoc:



226
227
228
229
 
# File 'lib/minitest.rb', line 226

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

.methods_matching(re) ⇒ Object

Returns all instance methods matching the pattern re.



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

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

.reset ⇒ Object

:nodoc:



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

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.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/minitest.rb', line 249

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}"
  }

  filtered_methods.each do |method_name|
    result = self.new(method_name).run
    raise "#{self}#run _must_ return self" unless self === result
    reporter.record result
  end
end

.runnable_methods ⇒ Object

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

Raises:

  • (NotImplementedError) 


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

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

.runnables ⇒ Object

Returns all subclasses of Runnable.



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

def self.runnables
  @@runnables
end

Instance Method Details

#dup ⇒ Object

:nodoc:



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

def dup # :nodoc:
  obj = self.class.new self.name

  obj.name       = self.name
  obj.failures   = self.failures.dup
  obj.assertions = self.assertions

  obj
end

#failure ⇒ Object

:nodoc:



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

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

#name ⇒ Object

Name of the run.



215
216
217
 
# File 'lib/minitest.rb', line 215

def name
  @NAME
end

#name=(o) ⇒ Object

Set the name of the run.



222
223
224
 
# File 'lib/minitest.rb', line 222

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) 


312
313
314
 
# File 'lib/minitest.rb', line 312

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) 


320
321
322
 
# File 'lib/minitest.rb', line 320

def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run ⇒ Object

Runs a single method. Needs to return self.

Raises:

  • (NotImplementedError) 


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

def run
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ Boolean

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

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError) 


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

def skipped?
  raise NotImplementedError, "subclass responsibility"
end