Class: Test::Unit::TestSuite (Ruby 2.7.5)
Description: Class : Test::Unit::TestSuite - Ruby 2.7.5

### Home Classes Methods

### In Files

- test-unit-3.3.4/lib/test/unit/testsuite.rb
- test-unit-3.3.4/lib/test/unit/ui/console/testrunner.rb
- test-unit-3.3.4/lib/test/unit/ui/xml/testrunner.rb

### Parent

Object

### Methods

- ::new
- #<<
- #==
- #delete
- #delete_tests
- #empty?
- #passed?
- #run
- #size
- #to_s

### Class/Module Index

Quicksearch

- Object
- Test
- Test::Unit
- Test::Unit::AssertionFailedError
- Test::Unit::Assertions
- Test::Unit::Assertions::AssertExceptionHelper
- Test::Unit::Assertions::AssertExceptionHelper::WrappedException
- Test::Unit::Assertions::AssertionMessage
- Test::Unit::Assertions::AssertionMessage::ArrayInspector
- Test::Unit::Assertions::AssertionMessage::DelayedLiteral
- Test::Unit::Assertions::AssertionMessage::HashInspector
- Test::Unit::Assertions::AssertionMessage::Inspector
- Test::Unit::Assertions::AssertionMessage::Literal
- Test::Unit::Assertions::AssertionMessage::MaybeContainer
- Test::Unit::Assertions::AssertionMessage::NumericInspector
- Test::Unit::Assertions::AssertionMessage::Template
- Test::Unit::Assertions::ThrowTagExtractor
- Test::Unit::Attribute
- Test::Unit::Attribute::BaseClassMethods
- Test::Unit::Attribute::ClassMethods
- Test::Unit::Attribute::StringifyKeyHash
- Test::Unit::AttributeMatcher
- Test::Unit::AutoRunner
- Test::Unit::AutoRunner::StopOnFailureListener
- Test::Unit::AutoRunnerLoader
- Test::Unit::CodeSnippetFetcher
- Test::Unit::Collector
- Test::Unit::Collector::Descendant
- Test::Unit::Collector::Dir
- Test::Unit::Collector::Load
- Test::Unit::Collector::ObjectSpace
- Test::Unit::Collector::XML
- Test::Unit::Collector::XML::Listener
- Test::Unit::Color
- Test::Unit::Color::Error
- Test::Unit::Color::ParseError
- Test::Unit::ColorScheme
- Test::Unit::Data
- Test::Unit::Data::ClassMethods
- Test::Unit::Data::ClassMethods::Loader
- Test::Unit::DataSets
- Test::Unit::Diff
- Test::Unit::Diff::Differ
- Test::Unit::Diff::ReadableDiffer
- Test::Unit::Diff::SequenceMatcher
- Test::Unit::Diff::UTF8Line
- Test::Unit::Diff::UnifiedDiffer
- Test::Unit::Error
- Test::Unit::ErrorHandler
- Test::Unit::ExceptionHandler
- Test::Unit::ExceptionHandler::ClassMethods
- Test::Unit::Failure
- Test::Unit::FailureHandler
- Test::Unit::FaultLocationDetector
- Test::Unit::Fixture
- Test::Unit::Fixture::ClassMethods
- Test::Unit::Fixture::Fixture
- Test::Unit::Fixture::HookPoint
- Test::Unit::MixColor
- Test::Unit::Notification
- Test::Unit::NotificationHandler
- Test::Unit::NotifiedError
- Test::Unit::NullResultContainerInitializer
- Test::Unit::Omission
- Test::Unit::OmissionHandler
- Test::Unit::OmittedError
- Test::Unit::PendedError
- Test::Unit::Pending
- Test::Unit::PendingHandler
- Test::Unit::Priority
- Test::Unit::Priority::Checker
- Test::Unit::Priority::ClassMethods
- Test::Unit::TestCase
- Test::Unit::TestCase::InternalData
- Test::Unit::TestCaseNotificationSupport
- Test::Unit::TestCaseOmissionSupport
- Test::Unit::TestCasePendingSupport
- Test::Unit::TestResult
- Test::Unit::TestResultErrorSupport
- Test::Unit::TestResultFailureSupport
- Test::Unit::TestResultNotificationSupport
- Test::Unit::TestResultOmissionSupport
- Test::Unit::TestResultPendingSupport
- Test::Unit::TestSuite
- Test::Unit::UI
- Test::Unit::UI::Console
- Test::Unit::UI::Console::ColorizedReadableDiffer
- Test::Unit::UI::Console::OutputLevel
- Test::Unit::UI::Console::TestRunner
- Test::Unit::UI::Emacs
- Test::Unit::UI::Emacs::TestRunner
- Test::Unit::UI::TestRunner
- Test::Unit::UI::TestRunnerMediator
- Test::Unit::UI::TestRunnerUtilities
- Test::Unit::UI::XML
- Test::Unit::UI::XML::TestRunner
- Test::Unit::Util
- Test::Unit::Util::BacktraceFilter
- Test::Unit::Util::MethodOwnerFinder
- Test::Unit::Util::Observable
- Test::Unit::Util::Output
- Test::Unit::Util::ProcWrapper

No matching classes.

# 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.3.4/lib/test/unit/testsuite.rb, line 33
    def initialize(name="Unnamed TestSuite", test_case=nil)
      @name = name
      @tests = []
      @test_case = test_case
      @n_tests = 0
      @priority = 0
      @start_time = nil
      @elapsed_time = nil
      @passed = true
    end

### Public Instance Methods

<<(test) click to toggle source

Adds the test to the suite.

                   # File test-unit-3.3.4/lib/test/unit/testsuite.rb, line 67
    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.3.4/lib/test/unit/testsuite.rb, line 100
    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.3.4/lib/test/unit/testsuite.rb, line 72
    def delete(test)
      @tests.delete(test)
    end

delete_tests(tests) click to toggle source

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

empty?() click to toggle source

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

passed?() click to toggle source

                   # File test-unit-3.3.4/lib/test/unit/testsuite.rb, line 106
    def passed?
      @passed
    end

run(result, &progress_block) click to toggle source

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

                   # File test-unit-3.3.4/lib/test/unit/testsuite.rb, line 46
    def run(result, &progress_block)
      @start_time = Time.now
      yield(STARTED, name)
      yield(STARTED_OBJECT, self)
      run_startup(result)
      while test = @tests.shift
        @n_tests += test.size
        run_test(test, result, &progress_block)
        @passed = false unless test.passed?
      end
    ensure
      begin
        run_shutdown(result)
      ensure
        @elapsed_time = Time.now - @start_time
        yield(FINISHED, name)
        yield(FINISHED_OBJECT, self)
      end
    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-3.3.4/lib/test/unit/testsuite.rb, line 83
    def size
      total_size = @n_tests
      @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.3.4/lib/test/unit/testsuite.rb, line 95
    def to_s
      @name
    end