Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QTestResult Class Reference

\inmodule QtTest More...

#include <qtestresult_p.h>

Collaboration diagram for QTestResult:

Classes

class  IdentifierLocker

Static Public Member Functions

static const char * currentTestObjectName ()
static bool currentTestFailed ()
static QTestData * currentTestData ()
static QTestData * currentGlobalTestData ()
static const char * currentTestFunction ()
static const char * currentDataTag ()
static const char * currentGlobalDataTag ()
static void finishedCurrentTestData ()
 This function is called after completing each test function, including test functions that are not data-driven.
static void finishedCurrentTestDataCleanup ()
 This function is called after completing each test function, including test functions that are not data-driven.
static void finishedCurrentTestFunction ()
 This function is called after completing each test function, including test functions that are data-driven.
static void reset ()
static void setBlacklistCurrentTest (bool b)
static void addFailure (const char *message, const char *file=nullptr, int line=0)
static bool compare (bool success, const char *failureMsg, char *val1, char *val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, double val1, double val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, float val1, float val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, int val1, int val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, unsigned val1, unsigned val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, QStringView val1, QStringView val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, const QLatin1StringView &val1, QStringView val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, QStringView val1, const QLatin1StringView &val2, const char *actual, const char *expected, const char *file, int line)
static bool compare (bool success, const char *failureMsg, const char *actual, const char *expeceted, const char *file, int line)
static void setCurrentGlobalTestData (QTestData *data)
static void setCurrentTestData (QTestData *data)
static void setCurrentTestFunction (const char *func)
static void setCurrentTestObject (const char *name)
static void addSkip (const char *message, const char *file, int line)
static bool expectFail (const char *dataIndex, const char *comment, QTest::TestFailMode mode, const char *file, int line)
static void fail (const char *message, const char *file, int line)
static bool verify (bool statement, const char *statementStr, const char *extraInfo, const char *file, int line)
static void setSkipCurrentTest (bool value)
static bool skipCurrentTest ()
static void setCurrentAppName (const char *appName)
static const char * currentAppName ()
static bool reportResult (bool success, const void *lhs, const void *rhs, const char *(*lhsFormatter)(const void *), const char *(*rhsFormatter)(const void *), const char *lhsExpr, const char *rhsExpr, QTest::ComparisonOperation op, const char *file, int line, const char *failureMessage=nullptr)
static bool report3WayResult (bool success, const char *failureMessage, const void *lhs, const void *rhs, const char *(*lhsFormatter)(const void *), const char *(*rhsFormatter)(const void *), const char *lhsExpression, const char *rhsExpression, const char *(*actualOrderFormatter)(const void *), const char *(*expectedOrderFormatter)(const void *), const void *actualOrder, const void *expectedOrder, const char *expectedExpression, const char *file, int line)

Detailed Description

\inmodule QtTest

Definition at line 26 of file qtestresult_p.h.

Member Function Documentation

◆ addFailure()

void QTestResult::addFailure ( const char * message,
const char * file = nullptr,
int line = 0 )
static

Definition at line 669 of file qtestresult.cpp.

◆ addSkip()

void QTestResult::addSkip ( const char * message,
const char * file,
int line )
static

Definition at line 682 of file qtestresult.cpp.

◆ compare() [1/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
char * val1,
char * val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 576 of file qtestresult.cpp.

◆ compare() [2/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
const char * actual,
const char * expeceted,
const char * file,
int line )
static

Definition at line 662 of file qtestresult.cpp.

◆ compare() [3/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
const QLatin1StringView & val1,
QStringView val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 652 of file qtestresult.cpp.

◆ compare() [4/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
double val1,
double val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 594 of file qtestresult.cpp.

◆ compare() [5/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
float val1,
float val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 602 of file qtestresult.cpp.

◆ compare() [6/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
int val1,
int val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 610 of file qtestresult.cpp.

◆ compare() [7/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
QStringView val1,
const QLatin1StringView & val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 644 of file qtestresult.cpp.

◆ compare() [8/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
QStringView val1,
QStringView val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 636 of file qtestresult.cpp.

◆ compare() [9/9]

bool QTestResult::compare ( bool success,
const char * failureMsg,
unsigned val1,
unsigned val2,
const char * actual,
const char * expected,
const char * file,
int line )
static

Definition at line 628 of file qtestresult.cpp.

◆ currentAppName()

const char * QTestResult::currentAppName ( )
static

Definition at line 715 of file qtestresult.cpp.

◆ currentDataTag()

const char * QTestResult::currentDataTag ( )
static

Definition at line 290 of file qtestresult.cpp.

◆ currentGlobalDataTag()

const char * QTestResult::currentGlobalDataTag ( )
static

Definition at line 295 of file qtestresult.cpp.

◆ currentGlobalTestData()

QTestData * QTestResult::currentGlobalTestData ( )
static

Definition at line 169 of file qtestresult.cpp.

◆ currentTestData()

QTestData * QTestResult::currentTestData ( )
static

Definition at line 174 of file qtestresult.cpp.

◆ currentTestFailed()

bool QTestResult::currentTestFailed ( )
static

Definition at line 164 of file qtestresult.cpp.

◆ currentTestFunction()

const char * QTestResult::currentTestFunction ( )
static

Definition at line 285 of file qtestresult.cpp.

◆ currentTestObjectName()

const char * QTestResult::currentTestObjectName ( )
static

Definition at line 695 of file qtestresult.cpp.

◆ expectFail()

bool QTestResult::expectFail ( const char * dataIndex,
const char * comment,
QTest::TestFailMode mode,
const char * file,
int line )
static

Definition at line 311 of file qtestresult.cpp.

◆ fail()

void QTestResult::fail ( const char * message,
const char * file,
int line )
static

Definition at line 365 of file qtestresult.cpp.

◆ finishedCurrentTestData()

void QTestResult::finishedCurrentTestData ( )
static

This function is called after completing each test function, including test functions that are not data-driven.

For data-driven functions, this is called after each call to the test function, with distinct data. Otherwise, this function is called once, with currentTestData() and currentGlobalTestData() set to \nullptr.

The function is called before the test's cleanup(), if it has one.

For benchmarks, this will be called after each repeat of a function (with the same data row), when the benchmarking code decides to re-run one to get sufficient data.

See also
finishedCurrentTestDataCleanup()

Definition at line 226 of file qtestresult.cpp.

◆ finishedCurrentTestDataCleanup()

void QTestResult::finishedCurrentTestDataCleanup ( )
static

This function is called after completing each test function, including test functions that are not data-driven.

For data-driven functions, this is called after each call to the test function, with distinct data. Otherwise, this function is called once, with currentTestData() and currentGlobalTestData() set to \nullptr.

The function is called after the test's cleanup(), if it has one.

For benchmarks, this is called after all repeat calls to the function (with a given data row).

See also
finishedCurrentTestData()

Definition at line 249 of file qtestresult.cpp.

◆ finishedCurrentTestFunction()

void QTestResult::finishedCurrentTestFunction ( )
static

This function is called after completing each test function, including test functions that are data-driven.

For data-driven functions, this is called after all data rows have been tested, and the data table has been cleared, so both currentTestData() and currentGlobalTestData() will be \nullptr.

Definition at line 276 of file qtestresult.cpp.

◆ report3WayResult()

bool QTestResult::report3WayResult ( bool success,
const char * failureMessage,
const void * lhs,
const void * rhs,
const char *(* lhsFormatter )(const void *),
const char *(* rhsFormatter )(const void *),
const char * lhsExpression,
const char * rhsExpression,
const char *(* actualOrderFormatter )(const void *),
const char *(* expectedOrderFormatter )(const void *),
const void * actualOrder,
const void * expectedOrder,
const char * expectedExpression,
const char * file,
int line )
static

Definition at line 806 of file qtestresult.cpp.

◆ reportResult()

bool QTestResult::reportResult ( bool success,
const void * lhs,
const void * rhs,
const char *(* lhsFormatter )(const void *),
const char *(* rhsFormatter )(const void *),
const char * lhsExpr,
const char * rhsExpr,
QTest::ComparisonOperation op,
const char * file,
int line,
const char * failureMessage = nullptr )
static

Definition at line 768 of file qtestresult.cpp.

◆ reset()

void QTestResult::reset ( )
static

Definition at line 143 of file qtestresult.cpp.

◆ setBlacklistCurrentTest()

void QTestResult::setBlacklistCurrentTest ( bool b)
static

Definition at line 159 of file qtestresult.cpp.

◆ setCurrentAppName()

void QTestResult::setCurrentAppName ( const char * appName)
static

Definition at line 710 of file qtestresult.cpp.

◆ setCurrentGlobalTestData()

void QTestResult::setCurrentGlobalTestData ( QTestData * data)
static

Definition at line 179 of file qtestresult.cpp.

◆ setCurrentTestData()

void QTestResult::setCurrentTestData ( QTestData * data)
static

Definition at line 185 of file qtestresult.cpp.

◆ setCurrentTestFunction()

void QTestResult::setCurrentTestFunction ( const char * func)
static

Definition at line 194 of file qtestresult.cpp.

◆ setCurrentTestObject()

void QTestResult::setCurrentTestObject ( const char * name)
static

Definition at line 689 of file qtestresult.cpp.

◆ setSkipCurrentTest()

void QTestResult::setSkipCurrentTest ( bool value)
static

Definition at line 700 of file qtestresult.cpp.

◆ skipCurrentTest()

bool QTestResult::skipCurrentTest ( )
static

Definition at line 705 of file qtestresult.cpp.

◆ verify()

bool QTestResult::verify ( bool statement,
const char * statementStr,
const char * extraInfo,
const char * file,
int line )
static

Definition at line 376 of file qtestresult.cpp.

The documentation for this class was generated from the following files: