123456789_123456789_123456789_123456789_123456789_

Class: Test::Unit::TestSuite

Relationships & Source Files
Inherits: Object
Defined in: lib/test/unit/testsuite.rb

Overview

A collection of tests which can be #run.

Note: It is easy to confuse a TestSuite instance with something that has a static suite method; I know because I have trouble keeping them straight. Think of something that has a suite method as simply providing a way to get a meaningful TestSuite instance.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name = "Unnamed TestSuite", test_case = nil) ⇒ TestSuite

Creates a new TestSuite with the given name.

[ GitHub ] 

  


# File 'lib/test/unit/testsuite.rb', line 34



def initialize(name="Unnamed TestSuite", test_case=nil)
  @name = name
  @tests = []
  @test_case = test_case
  @priority = 0
  @start_time = nil
  @elapsed_time = nil
end


  







Instance Attribute Details



  

    #elapsed_time   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 22



attr_reader :name, :tests, :test_case, :start_time, :elapsed_time


  








  

    #empty?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 86



def empty?
  size.zero?
end


  








  

    #name   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 22



attr_reader :name, :tests, :test_case, :start_time, :elapsed_time


  








  

    #parallel_safe?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 43



def parallel_safe?
  return true if @test_case.nil?
  @test_case.parallel_safe?
end


  








  

    #passed?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 103



def passed?
  @tests.all?(&:passed?)
end


  








  

    #priority   (rw)
  



  

    

::Test suite that has higher priority is ran prior to test suites that have lower priority.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 26



attr_accessor :priority


  








  

    #start_time   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 22



attr_reader :name, :tests, :test_case, :start_time, :elapsed_time


  








  

    #test_case   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 22



attr_reader :name, :tests, :test_case, :start_time, :elapsed_time


  








  

    #tests   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 22



attr_reader :name, :tests, :test_case, :start_time, :elapsed_time


  







Instance Method Details



  

    #<<(test)  
  



  

    

Adds the test to the suite.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 64



def <<(test)
  @tests << test
  self
end


  








  

    #==(other)  
  



  

    

It’s handy to be able to compare TestSuite instances.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 97



def ==(other)
  return false unless(other.kind_of?(self.class))
  return false unless(@name == other.name)
  @tests == other.tests
end


  








  

    #delete(test)  
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 69



def delete(test)
  @tests.delete(test)
end


  








  

    #delete_tests(tests)  
  

  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 73



def delete_tests(tests)
  @tests -= tests
end


  








  

    #run(result, runner_class: nil, &progress_block)  
  



  

    

Runs the tests and/or suites contained in this TestSuite.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 50



def run(result, runner_class: nil, &progress_block)
  runner_class ||= TestSuiteRunner
  runner_class.new(self).run(result) do |event, *args|
    case event
    when STARTED
      @start_time = Time.now
    when FINISHED
      @elapsed_time = Time.now - @start_time
    end
    yield(event, *args)
  end
end


  








  

    #size  
  



  

    

Returns the rolled up number of tests in this suite; i.e. if the suite contains other suites, it counts the tests within those suites, not the suites themselves.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 80



def size
  total_size = 0
  @tests.each { |test| total_size += test.size }
  total_size
end


  








  

    #to_s  
  



  

    

Overridden to return the name given the suite at creation.


  



  [ GitHub ]


  

  


# File 'lib/test/unit/testsuite.rb', line 92



def to_s
  @name
end