 |
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
|
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
#include <qjunittestlogger_p.h>
Inheritance diagram for QJUnitTestLogger: Collaboration diagram for QJUnitTestLogger:Public Member Functions | |
| QJUnitTestLogger (const char *filename) | |
| ~QJUnitTestLogger () | |
| void | startLogging () override |
| Called before the start of a test run. | |
| void | stopLogging () override |
| Called after the end of a test run. | |
| void | enterTestFunction (const char *function) override |
| This virtual method is called before each test function is invoked. | |
| void | leaveTestFunction () override |
| This virtual method is called after a test function has completed, to match \l enterTestFunction(). | |
| void | enterTestData (QTestData *) override |
| This virtual method is called before and after each call to a test function. | |
| void | addIncident (IncidentTypes type, const char *description, const char *file=nullptr, int line=0) override |
| This virtual method is called when an event occurs that relates to the resolution of the test. | |
| void | addMessage (MessageTypes type, const QString &message, const char *file=nullptr, int line=0) override |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| void | addBenchmarkResult (const QBenchmarkResult &) override |
| This virtual method is called after a benchmark has been run enough times to produce usable data. | |
| Public Member Functions inherited from QAbstractTestLogger | |
| QAbstractTestLogger (const char *filename) | |
| Constructs the base-class parts of the logger. | |
| virtual | ~QAbstractTestLogger () |
| Destroys the logger object. | |
| virtual void | addBenchmarkResults (const QList< QBenchmarkResult > &result) |
| virtual void | addMessage (QtMsgType, const QMessageLogContext &, const QString &) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This virtual method is called from the custom message handler QtTest installs in place of Qt's default message handler for the duration of testing, unless QTest::ignoreMessage() was used to ignore it, or too many messages have previously been processed. | |
| virtual bool | isRepeatSupported () const |
| Returns true if the logger supports repeated test runs. | |
| bool | isLoggingToStdout () const |
Returns true if the output stream is standard output. | |
| void | outputString (const char *msg) |
| Convenience method to write msg to the output stream. | |
Additional Inherited Members | |
| Public Types inherited from QAbstractTestLogger | |
| enum | IncidentTypes { Skip , Pass , XFail , Fail , XPass , BlacklistedPass , BlacklistedFail , BlacklistedXPass , BlacklistedXFail } |
| \value Pass The test ran to completion successfully. More... | |
| enum | MessageTypes { QDebug , QInfo , QWarning , QCritical , QFatal , Info , Warn } |
The members whose names begin with Q describe messages that originate in calls, by the test or code under test, to Qt logging functions (implemented as macros) whose names are similar, with a q in place of the leading Q. More... | |
| Protected Member Functions inherited from QAbstractTestLogger | |
| void | filterUnprintable (char *str) const |
| Helper utility to blot out unprintable characters in str. | |
| Protected Attributes inherited from QAbstractTestLogger | |
| FILE * | stream |
\inmodule QtTest
QJUnitTestLogger implements logging in a JUnit-compatible XML format.
The \l{JUnit XML} format was originally developed for Java testing. It is supported by \l{Test Center}.
Definition at line 30 of file qjunittestlogger_p.h.
| QJUnitTestLogger::QJUnitTestLogger | ( | const char * | filename | ) |
Definition at line 28 of file qjunittestlogger.cpp.
| QJUnitTestLogger::~QJUnitTestLogger | ( | ) |
Definition at line 33 of file qjunittestlogger.cpp.
References Q_ASSERT.
|
inlineoverridevirtual |
This virtual method is called after a benchmark has been run enough times to produce usable data.
It is passed the median result from all cycles of the code controlled by the test's QBENCHMARK loop.
Every logging implementation must implement this method.
Implements QAbstractTestLogger.
Definition at line 49 of file qjunittestlogger_p.h.
|
overridevirtual |
This virtual method is called when an event occurs that relates to the resolution of the test.
The type indicates whether this was a pass, a fail or a skip, whether a failure was expected, and whether the test being run is blacklisted. The description may be empty (for a pass) or a message describing the nature of the incident. Where the location in code of the incident is known, it is indicated by file and line; otherwise, these are nullptr and 0, respectively.
Every logging implementation must implement this method. Note that there are circumstances where more than one incident may be reported, in this way, for a single run of a test on a single dataset. It is the implementation's responsibility to recognize such cases and decide what to do about them. For purposes of counting resolutions of tests in the "Totals" report at the end of a test run, QtTest considers the first incident (excluding XFail and its blacklisted variant) decisive.
Implements QAbstractTestLogger.
Definition at line 191 of file qjunittestlogger.cpp.
References QTestElement::addChild(), addMessage(), QTest::AI_Message, QAbstractTestLogger::Fail, file, QString::fromUtf8(), QAbstractTestLogger::Info, QTest::LET_Failure, QTest::LET_Skipped, line, QAbstractTestLogger::Skip, QAbstractTestLogger::XFail, and QAbstractTestLogger::XPass.
Here is the call graph for this function:
|
overridevirtual |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
This virtual method is called, via its QtMsgType overload, from the custom message handler QtTest installs. It is also used to warn about various situations detected by QtTest itself, such as failure to see a message anticipated by QTest::ignoreMessage() and, particularly when verbosity options have been enabled via the command-line, to log some extra information.
Every logging implementation must implement this method. The type indicates the category of message and the message is the content to be reported. When the message is associated with specific code, the name of the file and line number within it are also supplied; otherwise, these are \nullptr and 0, respectively.
Implements QAbstractTestLogger.
Definition at line 252 of file qjunittestlogger.cpp.
References QTest::AI_Value, file, QAbstractTestLogger::Info, QTest::LET_Error, QTest::LET_Text, line, Q_UNUSED, QAbstractTestLogger::QCritical, QAbstractTestLogger::QDebug, QAbstractTestLogger::QFatal, QAbstractTestLogger::QInfo, QAbstractTestLogger::QWarning, and QAbstractTestLogger::Warn.
Referenced by addIncident().
Here is the caller graph for this function:This virtual method is called before and after each call to a test function.
For a data-driven test, the call before is passed the name of the test data row. This may combine a global data row name with a local data row name. For non-data-driven tests and for the call after a test function, \nullptr is passed
A logging implementation might chose to record the data row name for reporting of results from the test for that data row. It should, in such a case, clear its record of the name when called with \nullptr.
Reimplemented from QAbstractTestLogger.
Definition at line 146 of file qjunittestlogger.cpp.
References QTest::AI_Name, QTestCoreElement< ElementType >::attribute(), QTestResult::currentTestFunction(), elapsedTestcaseTime, QTestPrivate::generateTestIdentifier(), QTestElementAttribute::setPair(), QTestPrivate::TestDataTag, and QTestPrivate::TestFunction.
Here is the call graph for this function:
|
overridevirtual |
This virtual method is called before each test function is invoked.
It is passed the name of the test function (without its class prefix) as function. It is likewise called for {initTestCase()} at the start of testing, after \l startLogging(), and for {cleanupTestCase()} at the end of testing, in each case passing the name of the function. It is also called with \nullptr as function after the last of these functions, or in the event of an early end to testing, before \l stopLogging().
For data-driven test functions, this is called only once, before the data function is called to set up the table of datasets and the test is run with its first dataset.
Every logging implementation must implement this method. It shall typically need to record the name of the function for later use in log messages.
Implements QAbstractTestLogger.
Definition at line 123 of file qjunittestlogger.cpp.
|
overridevirtual |
This virtual method is called after a test function has completed, to match \l enterTestFunction().
For data-driven test functions, this is called only once, after the test is run with its last dataset.
Every logging implementation must implement this method. In some cases it may be called more than once without an intervening call to \l enterTestFunction(). In such cases, the implementation should ignore these later calls, until the next call to enterTestFunction().
Implements QAbstractTestLogger.
Definition at line 167 of file qjunittestlogger.cpp.
|
overridevirtual |
Called before the start of a test run.
This virtual method is called before the first tests are run. A logging implementation might open a file, write some preamble, or prepare in other ways, such as setting up initial values of variables. It can use the usual Qt logging infrastucture, since it is also called before QtTest installs its own custom message handler.
Reimplemented from QAbstractTestLogger.
Definition at line 52 of file qjunittestlogger.cpp.
References QTestCoreElement< ElementType >::addAttribute(), QTestElement::addChild(), QTest::AI_Hostname, QTest::AI_Name, QTest::AI_PropertyValue, QTest::AI_Timestamp, QLibraryInfo::build(), QDateTime::currentDateTime(), QTestResult::currentTestObjectName(), elapsedTestcaseTime, Qt::ISODate, QTest::LET_Properties, QTest::LET_Property, QTest::LET_TestSuite, QSysInfo::machineHostName(), properties, property, Q_ASSERT, QTEST_VERSION_STR, qVersion(), and QAbstractTestLogger::startLogging().
Here is the call graph for this function:
|
overridevirtual |
Called after the end of a test run.
This virtual method is called after all tests have run. A logging implementation might collate information gathered from the run, write a summary, or close a file. It can use the usual Qt logging infrastucture, since it is also called after QtTest has restored the default message handler it replaced with its own custom message handler.
Reimplemented from QAbstractTestLogger.
Definition at line 92 of file qjunittestlogger.cpp.
References QTestCoreElement< ElementType >::addAttribute(), QTestElement::addChild(), QTest::AI_Errors, QTest::AI_Failures, QTest::AI_Skipped, QTest::AI_Tests, QTest::AI_Time, QTestLog::msecsTotalTime(), QTestJUnitStreamer::output(), qsnprintf(), QTestLog::skipCount(), QAbstractTestLogger::stopLogging(), and toSecondsFormat().
Here is the call graph for this function:
1.10.0