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

KUnitTest

  • 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:
Inheritance graph
[legend]

Public Member Functions

 Tester (const char *name=0L)
 
virtual ~Tester ()
 
virtual void allTests ()=0
 
virtual TestResults * results () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

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 Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

TestResults * m_results
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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 ( )
inlinevirtual

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 KUnitTest::SlotTester, and SampleTester.

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 560 of file tester.h.

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

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)
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 631 of file tester.h.

void KUnitTest::Tester::failure ( const QString &  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 622 of file tester.h.

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

Reimplemented in KUnitTest::SlotTester.

Definition at line 535 of file tester.h.

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 658 of file tester.h.

void KUnitTest::Tester::skip ( const char *  file,
int  line,
QString  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 543 of file tester.h.

void KUnitTest::Tester::skipTest ( const QString &  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 649 of file tester.h.

void KUnitTest::Tester::success ( const QString &  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 613 of file tester.h.

void KUnitTest::Tester::unexpectedSuccess ( const QString &  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 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:26:58 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KUnitTest

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal