123456789_123456789_123456789_123456789_123456789_

Class: Minitest::Runnable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
BenchSpec, Benchmark, Result, Spec, Test, Unit::TestCase
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 407



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


  







Class Method Details



  

    .inherited(klass)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  








  

    .methods_matching(re)  
  



  

    

Returns all instance methods matching the pattern re.


  



  [ GitHub ]


  

  


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



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 359



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 298



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


  








  

    .run(reporter, options = {})  
  



  

    

Responsible for running all runnable methods in a given class, each in its own instance. Each instance is passed to the reporter to record.


  



  [ GitHub ]


  

  


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



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

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

  exclude = options[:exclude]
  exclude = Regexp.new $1 if exclude =~ %r%/(.*)/%

  filtered_methods.delete_if { |m|
    exclude === m || exclude === "#{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)  
  



  

    

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.


  



  [ GitHub ]


  

  


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



def self.run_one_method klass, method_name, reporter
  reporter.prerecord klass, method_name
  reporter.record Minitest.run_one_method(klass, method_name)
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 376



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


  








  

    .runnables  
  



  

    

Returns all subclasses of Runnable.


  



  [ GitHub ]


  

  


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



def self.runnables
  @@runnables
end


  








  

    .with_info_handler(reporter, &block)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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 ::Minitest.info_signal, handler, &block
end


  







Instance Attribute Details



  

    #assertions   (rw)
  



  

    

Number of assertions executed in this run.


  



  [ GitHub ]


  

  


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



attr_accessor :assertions


  








  

    #failures   (rw)
  



  

    

An assertion raised during the run, if any.


  



  [ GitHub ]


  

  


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



attr_accessor :failures


  








  

    #name   (rw)
  



  

    

Name of the run.


  



  [ GitHub ]


  

  


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



def name
  @NAME
end


  








  

    #name=(o)   (rw)
  



  

    

Set the name of the run.


  



  [ GitHub ]


  

  


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



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 426



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 442



def skipped?
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #time   (rw)
  



  

    

The time it took to run.


  



  [ GitHub ]


  

  


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



attr_accessor :time


  







Instance Method Details



  

    #failure  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



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


  








  

    #marshal_dump  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def marshal_dump # :nodoc:
  unless @@marshal_dump_warned then
    warn ["Minitest::Runnable#marshal_dump is deprecated.",
          "You might be violating internals. From", caller.first].join " "
    @@marshal_dump_warned = true
  end

  [self.name, self.failures, self.assertions, self.time]
end


  








  

    #marshal_load(ary)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def marshal_load ary # :nodoc:
  self.name, self.failures, self.assertions, self.time = ary
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 435



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 416



def run
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #time_it  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


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



def time_it # :nodoc:
  t0 = Minitest.clock_time

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