Extended maintenance of Ruby versions 1.8.7 and 1.9.2 will end on July 31, 2014. Read more

In Files

  • test/unit/testsuite.rb

Test::Unit::TestSuite

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.

Constants

FINISHED
STARTED

Attributes

name[R]
tests[R]

Public Class Methods

new(name="Unnamed TestSuite") click to toggle source

Creates a new TestSuite with the given name.

 
               # File test/unit/testsuite.rb, line 24
def initialize(name="Unnamed TestSuite")
  @name = name
  @tests = []
end
            

Public Instance Methods

<<(test) click to toggle source

Adds the test to the suite.

 
               # File test/unit/testsuite.rb, line 40
def <<(test)
  @tests << test
  self
end
            
==(other) click to toggle source

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

 
               # File test/unit/testsuite.rb, line 69
def ==(other)
  return false unless(other.kind_of?(self.class))
  return false unless(@name == other.name)
  @tests == other.tests
end
            
delete(test) click to toggle source
 
               # File test/unit/testsuite.rb, line 45
def delete(test)
  @tests.delete(test)
end
            
empty?() click to toggle source
 
               # File test/unit/testsuite.rb, line 58
def empty?
  tests.empty?
end
            
run(result, &progress_block) click to toggle source

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

 
               # File test/unit/testsuite.rb, line 31
def run(result, &progress_block)
  yield(STARTED, name)
  @tests.each do |test|
    test.run(result, &progress_block)
  end
  yield(FINISHED, name)
end
            
size() click to toggle source

Retuns 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.

 
               # File test/unit/testsuite.rb, line 52
def size
  total_size = 0
  @tests.each { |test| total_size += test.size }
  total_size
end
            
to_s() click to toggle source

Overridden to return the name given the suite at creation.

 
               # File test/unit/testsuite.rb, line 64
def to_s
  @name
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus