• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeunittest
 

tdeunittest

  • KUnitTest
  • Tester
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KUnitTest::Tester Class Referenceabstract

#include <tester.h>

Inheritance diagram for KUnitTest::Tester:
KUnitTest::SlotTester

Public Member Functions

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

Protected Member Functions

void skip (const char *file, int line, TQString 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 TQString &message)
 
void failure (const TQString &message)
 
void expectedFailure (const TQString &message)
 
void unexpectedSuccess (const TQString &message)
 
void skipTest (const TQString &message)
 
void setExceptionRaised (bool state)
 
bool exceptionRaised () const
 

Protected Attributes

TestResults * m_results
 

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.

See also
CHECK, XFAIL, SKIP

Definition at line 522 of file tester.h.

Constructor & Destructor Documentation

◆ Tester()

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

Definition at line 525 of file tester.h.

◆ ~Tester()

virtual KUnitTest::Tester::~Tester ( )
inlinevirtual

Definition at line 529 of file tester.h.

Member Function Documentation

◆ allTests()

virtual void KUnitTest::Tester::allTests ( )
pure virtual

Implement this method with the tests and checks you want to perform.

Implemented in KUnitTest::SlotTester.

◆ check()

template<typename T >
void KUnitTest::Tester::check ( const char *  file,
int  line,
const char *  str,
const T &  result,
const T &  expectedResult,
bool  expectedFail 
)
inlineprotected

This is called when the CHECK or XFAIL macro is used.

Parameters
fileA C-string containing the name of the file where the skipped tests resides. Typically the FILE macro is used to retrieve the filename.
lineThe linenumber in the file file. Use the LINE macro for this.
strThe message that identifies the skipped test.
resultThe result of the test.
expectedResultThe expected result.
expectedFailIndicates whether or not a failure is expected.

Definition at line 564 of file tester.h.

◆ exceptionRaised()

bool KUnitTest::Tester::exceptionRaised ( ) const
inlineprotected

Returns what the currently tested exception state.

See also
setExceptionRaised

Definition at line 669 of file tester.h.

◆ expectedFailure()

void KUnitTest::Tester::expectedFailure ( const TQString &  message)
inlineprotected

This function can be used to flag expected failures, when doing customized tests while not using the check function.

Parameters
messagethe 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 635 of file tester.h.

◆ failure()

void KUnitTest::Tester::failure ( const TQString &  message)
inlineprotected

This function can be used to flag failing tests, when doing customized tests while not using the check function.

Parameters
messagethe 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 626 of file tester.h.

◆ results()

virtual TestResults * KUnitTest::Tester::results ( )
inlinevirtual
Returns
The TestResults instance.

Definition at line 539 of file tester.h.

◆ setExceptionRaised()

void KUnitTest::Tester::setExceptionRaised ( bool  state)
inlineprotected

exceptionRaised and exceptionState are book-keeping functions for testing for exceptions. setExceptionRaised sets an internal boolean to true.

See also
exceptionRaised
Parameters
statethe new

Definition at line 662 of file tester.h.

◆ skip()

void KUnitTest::Tester::skip ( const char *  file,
int  line,
TQString  msg 
)
inlineprotected

This is called when the SKIP(x) macro is used.

Parameters
fileA C-string containing the name of the file where the skipped tests resides. Typically the FILE macro is used to retrieve the filename.
lineThe linenumber in the file file. Use the LINE macro for this.
msgThe message that identifies the skipped test.

Definition at line 547 of file tester.h.

◆ skipTest()

void KUnitTest::Tester::skipTest ( const TQString &  message)
inlineprotected

This function can be used to flag a test as skipped, when doing customized tests while not using the check function.

Parameters
messagethe 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 653 of file tester.h.

◆ success()

void KUnitTest::Tester::success ( const TQString &  message)
inlineprotected

This function can be used to flag succeeding tests, when doing customized tests while not using the check function.

Parameters
messagethe message describing what failed. Should be informative, such as mentioning the expression that failed and where, the file and file number.

Definition at line 617 of file tester.h.

◆ unexpectedSuccess()

void KUnitTest::Tester::unexpectedSuccess ( const TQString &  message)
inlineprotected

This function can be used to flag unexpected successes, when doing customized tests while not using the check function.

Parameters
messagethe 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 644 of file tester.h.

Member Data Documentation

◆ m_results

TestResults* KUnitTest::Tester::m_results
protected

Definition at line 675 of file tester.h.


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

tdeunittest

Skip menu "tdeunittest"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

tdeunittest

Skip menu "tdeunittest"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeunittest by doxygen 1.9.4
This website is maintained by Timothy Pearson.