Docs For Class SimpleReporter

SimpleReporter

Description

Recipient of generated test messages that can display page footers and headers. Also keeps track of the test nesting. This is the main base class on which to build the finished test (page based) displays.

Located in /scorer.php (line 241)

SimpleScorer
   |
   --SimpleReporter

Direct descendents

Class	Description
WebUnitReporter	Sample minimal test displayer. Generates only failure messages and a pass count.
TestDoxReporter	base include file for SimpleTest
JUnitXMLReporter	Reporter which outputs test results in a format compatible with JUnit / Maven XML output. Can be used for integrating test suite with continuous integration servers such as Atlassian Bamboo.
Recorder	Array-based test recorder. Returns an array with timestamp, status, test name and message for each pass and failure.
TreemapRecorder	Collects SimpleReporter messages and constructs a TreemapNode graph.
HtmlReporter	Sample minimal test displayer. Generates only failure messages and a pass count.
TextReporter	Sample minimal test displayer. Generates only
XmlReporter	Creates the XML needed for remote communication by SimpleTest.

Method Summary

static boolean inCli ()

SimpleReporter __construct ()

SimpleDumper getDumper ()

integer getTestCaseCount ()

integer getTestCaseProgress ()

array getTestList ()

void paintCaseEnd (string $test_name)

void paintCaseStart (string $test_name)

void paintFooter (string $test_name)

void paintGroupEnd (string $test_name, integer $progress)

void paintGroupStart (string $test_name, integer $size)

void paintHeader (string $test_name)

void paintMethodEnd (string $test_name)

void paintMethodStart (string $test_name)

Methods

static inCli (line 407)

Static check for running in the comand line.

return: True if CLI.
access: public

static boolean inCli ()

Constructor __construct (line 250)

Starts the display with no results in.

access: public

SimpleReporter __construct ()

Redefinition of:

SimpleScorer::__construct(): Starts the test run with no results.

Redefined in descendants as:

WebUnitReporter::__construct() : Does nothing yet. The first output will be sent on the first test start. For use by a web browser.
TestDoxReporter::__construct()
JUnitXMLReporter::__construct()
Recorder::__construct()
HtmlReporter::__construct() : Does nothing yet. The first output will be sent on the first test start. For use by a web browser.
TextReporter::__construct() : Does nothing yet. The first output will be sent on the first test start.
ColorTextReporter::__construct() : Handle initialization
XmlReporter::__construct() : Sets up indentation and namespace.

getDumper (line 263)

Gets the formatter for privateiables and other small generic data items.

return: Formatter.
access: public

SimpleDumper getDumper ()

getTestCaseCount (line 388)

Accessor for total test size in number of test cases. Null until the first test is started.

return: Total number of cases at start.
access: public

integer getTestCaseCount ()

getTestCaseProgress (line 398)

Accessor for the number of test cases completed so far.

return: Number of ended cases.
access: public

integer getTestCaseProgress ()

getTestList (line 377)

Accessor for internal test stack. For subclasses that need to see the whole test history for display purposes.

return: List of methods in nesting order.
access: public

array getTestList ()

paintCaseEnd (line 324)

Paints the end of a test case. Will paint the page footer if the stack of tests has unwound.

access: public

void paintCaseEnd (string $test_name)

string $test_name: Name of test that is ending.

Redefinition of:

SimpleScorer::paintCaseEnd(): Paints the end of a test case.

Redefined in descendants as:

TestDoxReporter::paintCaseEnd()
JUnitXMLReporter::paintCaseEnd()
TreemapRecorder::paintCaseEnd() : acceptor for end of test case
XmlReporter::paintCaseEnd() : Paints the end of a test case.

paintCaseStart (line 308)

Paints the start of a test case. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.

access: public

void paintCaseStart (string $test_name)

string $test_name: Name of test that is starting.

Redefinition of:

SimpleScorer::paintCaseStart(): Paints the start of a test case.

Redefined in descendants as:

WebUnitReporter::paintCaseStart() : Paints the start of a test case. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.
TestDoxReporter::paintCaseStart()
JUnitXMLReporter::paintCaseStart()
TreemapRecorder::paintCaseStart() : acceptor for start of test case node
XmlReporter::paintCaseStart() : Paints the start of a test case.

paintFooter (line 367)

Paints the test document footer.

abstract:
access: public

void paintFooter (string $test_name)

string $test_name: The top level test.

Redefined in descendants as:

WebUnitReporter::paintFooter() : Paints the end of the test with a summary of the passes and failures.
JUnitXMLReporter::paintFooter() : Paints the end of the test with a summary of the passes and failures.
HtmlReporter::paintFooter() : Paints the end of the test with a summary of the passes and failures.
TextReporter::paintFooter() : Paints the end of the test with a summary of the passes and failures.
ColorTextReporter::paintFooter() : Capture the attempt to display the final test results and insert the ANSI-color codes in place.
XmlReporter::paintFooter() : Paints the test document footer.

paintGroupEnd (line 293)

Paints the end of a group test. Will paint the page footer if the stack of tests has unwound.

access: public

void paintGroupEnd (string $test_name, integer $progress)

string $test_name: Name of test that is ending.
integer $progress: Number of test cases ending.

Redefinition of:

SimpleScorer::paintGroupEnd(): Paints the end of a group test.

Redefined in descendants as:

TreemapRecorder::paintGroupEnd() : acceptor for end of test group. final group pops the collected treemap nodes and assigns it to the internal graph property.
XmlReporter::paintGroupEnd() : Paints the end of a group test.

paintGroupStart (line 276)

Paints the start of a group test. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.

access: public

void paintGroupStart (string $test_name, integer $size)

string $test_name: Name of test that is starting.
integer $size: Number of test cases starting.

Redefinition of:

SimpleScorer::paintGroupStart(): Paints the start of a group test.

Redefined in descendants as:

WebUnitReporter::paintGroupStart() : Paints the start of a group test. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.
TreemapRecorder::paintGroupStart() : acceptor for start of test group node
XmlReporter::paintGroupStart() : Paints the start of a group test.

paintHeader (line 358)

Paints the test document header.

abstract:
access: public

void paintHeader (string $test_name)

string $test_name: First test top level to start.

Redefined in descendants as:

WebUnitReporter::paintHeader() : Paints the top of the web page setting the title to the name of the starting test.
JUnitXMLReporter::paintHeader()
TreemapRecorder::paintHeader() : stashes the title of the test
HtmlReporter::paintHeader() : Paints the top of the web page setting the title to the name of the starting test.
TextReporter::paintHeader() : Paints the title only.
XmlReporter::paintHeader() : Paints the test document header.

paintMethodEnd (line 347)

Paints the end of a test method. Will paint the page footer if the stack of tests has unwound.

access: public

void paintMethodEnd (string $test_name)

string $test_name: Name of test that is ending.

Redefinition of:

SimpleScorer::paintMethodEnd(): Paints the end of a test method.

Redefined in descendants as:

WebUnitReporter::paintMethodEnd() : Paints the end of a test method.
TestDoxReporter::paintMethodEnd()
JUnitXMLReporter::paintMethodEnd()
TreemapRecorder::paintMethodEnd() : acceptor for end of method node
XmlReporter::paintMethodEnd() : Paints the end of a test method.

paintMethodStart (line 337)

Paints the start of a test method.

access: public

void paintMethodStart (string $test_name)

string $test_name: Name of test that is starting.

Redefinition of:

SimpleScorer::paintMethodStart(): Paints the start of a test method.

Redefined in descendants as:

WebUnitReporter::paintMethodStart() : Paints the start of a test method.
TestDoxReporter::paintMethodStart()
JUnitXMLReporter::paintMethodStart()
TreemapRecorder::paintMethodStart() : acceptor for start of test method node
XmlReporter::paintMethodStart() : Paints the start of a test method.

Inherited Methods

Inherited From SimpleScorer

SimpleScorer::__construct()
SimpleScorer::createInvoker()
SimpleScorer::getExceptionCount()
SimpleScorer::getFailCount()
SimpleScorer::getPassCount()
SimpleScorer::getStatus()
SimpleScorer::makeDry()
SimpleScorer::paintCaseEnd()
SimpleScorer::paintCaseStart()
SimpleScorer::paintError()
SimpleScorer::paintException()
SimpleScorer::paintFail()
SimpleScorer::paintFormattedMessage()
SimpleScorer::paintGroupEnd()
SimpleScorer::paintGroupStart()
SimpleScorer::paintMessage()
SimpleScorer::paintMethodEnd()
SimpleScorer::paintMethodStart()
SimpleScorer::paintPass()
SimpleScorer::paintSignal()
SimpleScorer::paintSkip()
SimpleScorer::shouldInvoke()

Documentation generated on Thu, 01 Oct 2009 20:55:43 -0500 by phpDocumentor 1.4.2