KUnitTest::Tester Class Reference
#include <tester.h>
Inheritance diagram for KUnitTest::Tester:

Detailed Description
The abstract Tester class forms the base class for all test cases. Users must implement the void Tester::allTests() method. This method contains the actual test.Use the CHECK(x,y), XFAIL(x,y) and SKIP(x) macros in the allTests() method to perform the tests.
Definition at line 522 of file tester.h.
Public Member Functions | |
Tester (const char *name=0L) | |
virtual | ~Tester () |
virtual void | allTests ()=0 |
virtual TestResults * | results () |
Protected Member Functions | |
void | skip (const char *file, int line, QString msg) |
template<typename T> | |
void | check (const char *file, int line, const char *str, const T &result, const T &expectedResult, bool expectedFail) |
void | success (const QString &message) |
void | failure (const QString &message) |
void | expectedFailure (const QString &message) |
void | unexpectedSuccess (const QString &message) |
void | skipTest (const QString &message) |
void | setExceptionRaised (bool state) |
bool | exceptionRaised () const |
Protected Attributes | |
TestResults * | m_results |
Member Function Documentation
virtual void KUnitTest::Tester::allTests | ( | ) | [pure virtual] |
Implement this method with the tests and checks you want to perform.
Implemented in SampleTester, and KUnitTest::SlotTester.
virtual TestResults* KUnitTest::Tester::results | ( | ) | [inline, virtual] |
void KUnitTest::Tester::skip | ( | const char * | file, | |
int | line, | |||
QString | msg | |||
) | [inline, protected] |
This is called when the SKIP(x) macro is used.
- Parameters:
-
file A C-string containing the name of the file where the skipped tests resides. Typically the __FILE__ macro is used to retrieve the filename. line The linenumber in the file file
. Use the __LINE__ macro for this.msg The message that identifies the skipped test.
void KUnitTest::Tester::check | ( | const char * | file, | |
int | line, | |||
const char * | str, | |||
const T & | result, | |||
const T & | expectedResult, | |||
bool | expectedFail | |||
) | [inline, protected] |
This is called when the CHECK or XFAIL macro is used.
- Parameters:
-
file A C-string containing the name of the file where the skipped tests resides. Typically the __FILE__ macro is used to retrieve the filename. line The linenumber in the file file
. Use the __LINE__ macro for this.str The message that identifies the skipped test. result The result of the test. expectedResult The expected result. expectedFail Indicates whether or not a failure is expected.
void KUnitTest::Tester::success | ( | const QString & | message | ) | [inline, protected] |
This function can be used to flag succeeding tests, when doing customized tests while not using the check function.
- Parameters:
-
message the message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file and file number.
void KUnitTest::Tester::failure | ( | const QString & | message | ) | [inline, protected] |
This function can be used to flag failing tests, when doing customized tests while not using the check function.
- Parameters:
-
message the message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file name and file number.
void KUnitTest::Tester::expectedFailure | ( | const QString & | message | ) | [inline, protected] |
This function can be used to flag expected failures, when doing customized tests while not using the check function.
- Parameters:
-
message the message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file name and file number.
void KUnitTest::Tester::unexpectedSuccess | ( | const QString & | message | ) | [inline, protected] |
This function can be used to flag unexpected successes, when doing customized tests while not using the check function.
- Parameters:
-
message the message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file name and file number.
void KUnitTest::Tester::skipTest | ( | const QString & | message | ) | [inline, protected] |
This function can be used to flag a test as skipped, when doing customized tests while not using the check function.
- Parameters:
-
message the message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file name and file number.
void KUnitTest::Tester::setExceptionRaised | ( | bool | state | ) | [inline, protected] |
exceptionRaised and exceptionState are book-keeping functions for testing for exceptions. setExceptionRaised sets an internal boolean to true.
- See also:
- exceptionRaised
- Parameters:
-
state the new
bool KUnitTest::Tester::exceptionRaised | ( | ) | const [inline, protected] |
The documentation for this class was generated from the following file: