• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KUnitTest

KUnitTest::Tester

KUnitTest::Tester Class Reference

#include <tester.h>

Inheritance diagram for KUnitTest::Tester:
QObject KUnitTest::SlotTester SampleTester

List of all members.

Public Member Functions

virtual void allTests ()=0
virtual TestResults * results () const
 Tester (const char *name=0L)
virtual ~Tester ()

Protected Member Functions

template<typename T >
void check (const char *file, int line, const char *str, const T &result, const T &expectedResult, bool expectedFail)
bool exceptionRaised () const
void expectedFailure (const QString &message)
void failure (const QString &message)
void setExceptionRaised (bool state)
void skip (const char *file, int line, QString msg)
void skipTest (const QString &message)
void success (const QString &message)
void unexpectedSuccess (const QString &message)

Protected Attributes

TestResults * m_results

Detailed Description

A type that can be used to iterate through the registry.

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.

See also:
CHECK, XFAIL, SKIP

Definition at line 516 of file tester.h.


Constructor & Destructor Documentation

KUnitTest::Tester::Tester ( const char *  name = 0L  )  [inline]

Definition at line 519 of file tester.h.

virtual KUnitTest::Tester::~Tester (  )  [inline, virtual]

Definition at line 525 of file tester.h.


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.

template<typename T >
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.

Definition at line 560 of file tester.h.

bool KUnitTest::Tester::exceptionRaised (  )  const [inline, protected]

Returns what the currently tested exception state.

See also:
setExceptionRaised

Definition at line 665 of file tester.h.

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.

Definition at line 631 of file tester.h.

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.

Definition at line 622 of file tester.h.

virtual TestResults* KUnitTest::Tester::results (  )  const [inline, virtual]
Returns:
The TestResults instance.

Reimplemented in KUnitTest::SlotTester.

Definition at line 535 of file tester.h.

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

Definition at line 658 of file tester.h.

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.

Definition at line 543 of file tester.h.

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.

Definition at line 649 of file tester.h.

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.

Definition at line 613 of file tester.h.

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.

Definition at line 640 of file tester.h.


Member Data Documentation

TestResults* KUnitTest::Tester::m_results [protected]

Definition at line 671 of file tester.h.


The documentation for this class was generated from the following file:
  • tester.h

KUnitTest

Skip menu "KUnitTest"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal