Docs For Class TestSuite

Description

This is a composite test class for combining test cases and other RunnableTest classes into a group test.

Located in /test_case.php (line 476)

Method Summary

static void getBaseTestCase (string $class)

TestSuite TestSuite ([string $label = false])

void add (SimpleTestCase $test_case)

void addFile (string $test_file)

void collect (string $path, SimpleCollector $collector)

string getLabel ()

integer getSize ()

void run (SimpleReporter $reporter)

Methods

static getBaseTestCase (line 594)

Test to see if a class is derived from the SimpleTestCase class.

access: public

static void getBaseTestCase (string $class)

string $class: Class name.

Constructor TestSuite (line 486)

Sets the name of the test suite.

access: public

TestSuite TestSuite ([string $label = false])

string $label: Name sent at the start and end of the test.

add (line 514)

Adds a test into the suite by instance or class. The class will be instantiated if it's a test suite.

access: public

void add (SimpleTestCase $test_case)

SimpleTestCase $test_case: Suite or individual test case implementing the runnable test interface.

addFile (line 531)

Builds a test suite from a library of test cases.

The new suite is composed into this one.

access: public

void addFile (string $test_file)

string $test_file: File name of library with test case classes.

collect (line 543)

Delegates to a visiting collector to add test files.

access: public

void collect (string $path, SimpleCollector $collector)

string $path: Path to scan from.
SimpleCollector $collector: Directory scanner.

getLabel (line 497)

Accessor for the test name for subclasses. If the suite wraps a single test case the label defaults to the name of that test.

return: Name of the test.
access: public

string getLabel ()

getSize (line 574)

Number of contained test cases.

return: Total count of cases in the group.
access: public

integer getSize ()

run (line 553)

Invokes run() on all of the held test cases, instantiating them if necessary.

access: public

void run (SimpleReporter $reporter)

SimpleReporter $reporter: Current test reporter.