123456789_123456789_123456789_123456789_123456789_

Class: Minitest::Runnable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
BenchSpec, Benchmark, Result, Spec, Test
Inherits: Object
Defined in: lib/minitest.rb,
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 .runnables.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name) ⇒ Runnable

This method is for internal use only.
[ GitHub ] 

  


# File 'lib/minitest.rb', line 555



def initialize name # :nodoc:
  self.name       = name
  self.failures   = []
  self.assertions = 0
  # lazy initializer for metadata
end


  







Class Method Details



  

    .filter_runnable_methods(options = {})  
  



  

    
Returns an array of filtered .runnable_methods. Uses
options (--include arguments) and options
(--exclude arguments) values to filter.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 454



def self.filter_runnable_methods options={}
  pos = options[:include]
  neg = options[:exclude]

  pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
  neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%

  # at most 1-2% slower than a 1-pass version, stop optimizing this
  self.runnable_methods
    .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
    .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }
end


  








  

    .inherited(klass)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 1239



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


  








  

    .methods_matching(re)  
  



  

    
Returns all public instance methods matching the pattern re.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 439



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


  








  

    .on_signal(name, action)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 523



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  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def self.reset # :nodoc:
  @@runnables = []
end


  








  

    .run_order  
  



  

    
Defines the order to run tests (:random by default). Override
this or use a convenience method to change it for your tests.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 513



def self.run_order
  :random
end


  








  

    .runnable_methods  
  



  

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

  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 540



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


  








  

    .runnables  
  



  

    
Returns all subclasses of Runnable.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 547



def self.runnables
  @@runnables
end


  








  

    .with_info_handler(_reporter = nil, &block)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 517



def self.with_info_handler _reporter=nil, &block # :nodoc:
  on_signal ::Minitest.info_signal, @_info_handler, &block
end


  







Instance Attribute Details



  

    #assertions   (rw)
  



  

    
Number of assertions executed in this run.

  



  [ GitHub ]


  

  


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



attr_accessor :assertions


  








  

    #failures   (rw)
  



  

    
An assertion raised during the run, if any.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 407



attr_accessor :failures


  








  

    #metadata   (rw)
  



  

    
Metadata you attach to the test results that get sent to the reporter.


Lazily initializes to a hash, to keep memory down.


NOTE: this data must be plain (read: marshal-able) data!
Hashes! Arrays! Strings!

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 570



def metadata
  @metadata ||= {}
end


  








  

    #metadata=(value)   (rw)
  



  

    
Sets metadata, mainly used for Result.from.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 577



attr_writer :metadata


  








  

    #metadata?  ⇒ Boolean  (rw)
  



  

    
Returns true if metadata exists.

  





  


  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 582



def metadata?
  defined? @metadata
end


  








  

    #name   (rw)
  



  

    
Name of the run.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 425



def name
  @NAME
end


  








  

    #name=(o)   (rw)
  



  

    
Set the name of the run.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 432



def name= o
  @NAME = o
end


  








  

    #passed?  ⇒ Boolean  (readonly)
  



  

    
Did this run pass?


Note: skipped runs are not considered passing, but they don't
cause the process to exit non-zero.

  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 599



def passed?
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #skipped?  ⇒ Boolean  (readonly)
  



  

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

  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 615



def skipped?
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #time   (rw)
  



  

    
The time it took to run.

  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 412



attr_accessor :time


  







Instance Method Details



  

    #failure  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 551



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


  








  

    #result_code  
  



  

    
Returns a single character string to print based on the result
of the run. One of ".", "F",
"E" or "S".

  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 608



def result_code
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #run  
  



  

    
Runs a single method. Needs to return self.

  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 589



def run
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #time_it  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 414



def time_it # :nodoc:
  t0 = Minitest.clock_time

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