Mac Dev Center Mac OS X Reference Library IDEs CPlusTest Reference

Overview

TestObserver that logs the execution of a test run as text.

Discussion

A TestLog is a TestObserver that has a std::ostream on which it logs the executon of a test run as text. It writes a line of text for test start, test stop, test failure, test suite start, and test suite stop. When it writes a line of text for test failure, it outputs that line in a compiler-like format so the failure information can be easily parsed.

Functions

testDidFail

Logs that the input Test failed execution.

testDidStart

Logs that the input Test started execution.

testDidStop

Logs that the input Test completed execution.

TestLog

Constructor for the TestLog class, takes the stream to log to.

testSuiteDidStart

Logs that the input TestSuite started execution.

testSuiteDidStop

Logs that the input TestSuite completed execution.

~TestLog

Destructor for the TestLog class.

Logs that the input Test failed execution.

public

virtual void testDidFail(
    Test& test,
    const TestFailure& failure); 

Parameters

Discussion

Logs that the input Test failed execution, and includes information about the failure. This information is formatted in a compiler-like format including the source code file name and line number, followed by an informative message.

Logs that the input Test started execution.

public

virtual void testDidStart(
    Test& test); 

Parameters

Discussion

Logs that the input Test started execution.

Logs that the input Test completed execution.

public

virtual void testDidStop(
    Test& test); 

Parameters

Discussion

Logs that the input Test completed execution. Tests either complete or fail, they don't do both.

Constructor for the TestLog class, takes the stream to log to.

public

explicit TestLog(
    std::ostream& stream); 

Parameters

Discussion

Constructor for the TestLog class. Its parameter is the stream to log test execution to.

Logs that the input TestSuite started execution.

public

virtual void testSuiteDidStart(
    TestSuite& testSuite); 

Parameters

Discussion

Logs that the input TestSuite started execution.

Logs that the input TestSuite completed execution.

public

virtual void testSuiteDidStop(
    TestSuite& testSuite); 

Parameters

Discussion

Logs that the input TestSuite completed execution. TestSuites always complete, regardless of whether any of their compenent tests fail.

Destructor for the TestLog class.

public

virtual ~TestLog(); 

Discussion

Destructor for the TestLog class.