class Test::Unit::TestSuite - test-unit: Ruby Standard Library Documentation

# class 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
FINISHED_OBJECT
STARTED
STARTED_OBJECT

### Attributes

elapsed_time[R]
name[R]
priority[RW]

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

start_time[R]
test_case[R]
tests[R]

### Public Class Methods

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

Creates a new `TestSuite` with the given name.

    # File test-unit-3.6.7/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

### Public Instance Methods

<<(test) click to toggle source

Adds the test to the suite.

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 64
    def <<(test)
      @tests << test
      self
    end

==(other) click to toggle source

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

    # File test-unit-3.6.7/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) click to toggle source

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 69
    def delete(test)
      @tests.delete(test)
    end

delete_tests(tests) click to toggle source

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 73
    def delete_tests(tests)
      @tests -= tests
    end

empty?() click to toggle source

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 86
    def empty?
      size.zero?
    end

parallel_safe?() click to toggle source

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 43
    def parallel_safe?
      return true if @test_case.nil?
      @test_case.parallel_safe?
    end

passed?() click to toggle source

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 103
    def passed?
      @tests.all?(&:passed?)
    end

run(result, runner_class: nil) { |event, *args| ... } click to toggle source

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

    # File test-unit-3.6.7/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() click to toggle source

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.

    # File test-unit-3.6.7/lib/test/unit/testsuite.rb, line 80
    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-3.6.7/lib/test/unit/testsuite.rb, line 92
    def to_s
      @name
    end