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)

Source

# File bundled-src/test-unit-3.7.5/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

Creates a new TestSuite with the given name.

Public Instance Methods

<< (test)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 89
def <<(test)
  @tests << test
  self
end

Adds the test to the suite.

== (other)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 122
def ==(other)
  return false unless(other.kind_of?(self.class))
  return false unless(@name == other.name)
  @tests == other.tests
end

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

delete (test)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 94
def delete(test)
  @tests.delete(test)
end

delete_tests (tests)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 98
def delete_tests(tests)
  @tests -= tests
end

empty? ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 111
def empty?
  size.zero?
end

find (name)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 43
def find(name)
  return self if @name == name
  @tests.each do |test|
    if test.is_a?(self.class)
      t = test.find(name)
      return t if t
    else
      return test if test.name == name
    end
  end
  nil
end

have_fixture? ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 61
def have_fixture?
  return false if @test_case.nil?
  return true if @test_case.method(:startup).owner != TestCase.singleton_class
  return true if @test_case.method(:shutdown).owner != TestCase.singleton_class
  false
end

parallel_safe? ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 56
def parallel_safe?
  return true if @test_case.nil?
  @test_case.parallel_safe?
end

passed? ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 128
def passed?
  @tests.all?(&:passed?)
end

run (worker_context) { |event, *args| ... }

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 70
def run(worker_context, &progress_block)
  run_context = worker_context.run_context
  if run_context
    runner_class = run_context.runner_class
  else
    runner_class = TestSuiteRunner
  end
  runner_class.new(self).run(worker_context) 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

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

size ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 105
def size
  total_size = 0
  @tests.each { |test| total_size += test.size }
  total_size
end

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.

to_s ()

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/testsuite.rb, line 117
def to_s
  @name
end

Overridden to return the name given the suite at creation.