Class: Test::Unit::TestSuite

Inherits:
Object
  • Object
show all
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

STARTED =
name + "::STARTED"
STARTED_OBJECT =
name + "::STARTED::OBJECT"
FINISHED =
name + "::FINISHED"
FINISHED_OBJECT =
name + "::FINISHED::OBJECT"

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (TestSuite) initialize(name = "Unnamed TestSuite", test_case = nil)

Creates a new TestSuite with the given name.



33
34
35
36
37
38
39
40
41
42
# File '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

Instance Attribute Details

- (Object) elapsed_time (readonly)

Returns the value of attribute elapsed_time



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

def elapsed_time
  @elapsed_time
end

- (Object) name (readonly)

Returns the value of attribute name



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

def name
  @name
end

- (Object) priority

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



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

def priority
  @priority
end

- (Object) start_time (readonly)

Returns the value of attribute start_time



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

def start_time
  @start_time
end

- (Object) test_case (readonly)

Returns the value of attribute test_case



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

def test_case
  @test_case
end

- (Object) tests (readonly)

Returns the value of attribute tests



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

def tests
  @tests
end

Instance Method Details

- (Object) <<(test)

Adds the test to the suite.



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

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

- (Object) ==(other)

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



97
98
99
100
101
# 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

- (Object) delete(test)



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

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

- (Object) delete_tests(tests)



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

def delete_tests(tests)
  @tests -= tests
end

- (Boolean) empty?

Returns:

  • (Boolean)


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

def empty?
  size.zero?
end

- (Boolean) passed?

Returns:

  • (Boolean)


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

def passed?
  @passed
end

- (Object) run(result, &progress_block)

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File '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
  run_shutdown(result)
ensure
  @elapsed_time = Time.now - @start_time
  yield(FINISHED, name)
  yield(FINISHED_OBJECT, self)
end

- (Object) size

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.



80
81
82
83
84
# File 'lib/test/unit/testsuite.rb', line 80

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

- (Object) to_s

Overridden to return the name given the suite at creation.



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

def to_s
  @name
end