diff options
Diffstat (limited to 'src/testlib/qabstracttestlogger.cpp')
| -rw-r--r-- | src/testlib/qabstracttestlogger.cpp | 131 |
1 files changed, 72 insertions, 59 deletions
diff --git a/src/testlib/qabstracttestlogger.cpp b/src/testlib/qabstracttestlogger.cpp index ce9e0c593a..de6fb63560 100644 --- a/src/testlib/qabstracttestlogger.cpp +++ b/src/testlib/qabstracttestlogger.cpp @@ -1,44 +1,9 @@ -/**************************************************************************** -** -** Copyright (C) 2021 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtTest module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:LGPL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Lesser General Public License Usage -** Alternatively, this file may be used under the terms of the GNU Lesser -** General Public License version 3 as published by the Free Software -** Foundation and appearing in the file LICENSE.LGPL3 included in the -** packaging of this file. Please review the following information to -** ensure the GNU Lesser General Public License version 3 requirements -** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 2.0 or (at your option) the GNU General -** Public license version 3 or any later version approved by the KDE Free -** Qt Foundation. The licenses are as published by the Free Software -** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-2.0.html and -** https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include <QtTest/private/qabstracttestlogger_p.h> #include <QtTest/qtestassert.h> +#include <qbenchmark_p.h> #include <qtestresult_p.h> #include <QtCore/qbytearray.h> @@ -83,6 +48,7 @@ QT_BEGIN_NAMESPACE \value XPass A check which was expected to fail actually passed. This is counted as a failure, as it means whatever caused the known failure no longer does, so the test needs an update. + \value Skip The current test ended prematurely, skipping some checks. \value BlacklistedPass As Pass but the test was blacklisted. \value BlacklistedXFail As XFail but the test was blacklisted. \value BlacklistedFail As Fail but the test was blacklisted. @@ -122,7 +88,6 @@ QT_BEGIN_NAMESPACE \value QCritical A critical error from qCritical(). \value QFatal A fatal error from qFatal(), or an unrecognised message from the Qt logging functions. - \value Skip The current test ended prematurely, skipping some checks. \value Info Messages QtTest generates as requested by the \c{-v1} or \c{-v2} command-line option being specified when running the test. \value Warn A warning generated internally by QtTest @@ -131,7 +96,9 @@ QT_BEGIN_NAMESPACE functions to facilitate testing - such as \l QSignalSpy, \l QTestAccessibility, \l QTest::qExtractTestData(), and the facilities to deliver artificial mouse and keyboard events - are treated as test code, - rather than internal to QtTest. + rather than internal to QtTest; they call \l qWarning() and friends rather + than using the internal logging infrastructure, so that \l + QTest::ignoreMessage() can be used to anticipate the messages. \sa QAbstractTestLogger::addMessage() */ @@ -181,6 +148,19 @@ QAbstractTestLogger::~QAbstractTestLogger() } /*! + Returns true if the logger supports repeated test runs. + + Repetition of test runs is disabled by default, and can be enabled only for + test loggers that support it. Even if the logger may create syntactically + correct test reports, log-file analyzers may assume that test names are + unique within one report file. +*/ +bool QAbstractTestLogger::isRepeatSupported() const +{ + return false; +} + +/*! Returns true if the \c output stream is standard output. */ bool QAbstractTestLogger::isLoggingToStdout() const @@ -256,6 +236,12 @@ void QAbstractTestLogger::stopLogging() { } +void QAbstractTestLogger::addBenchmarkResults(const QList<QBenchmarkResult> &result) +{ + for (const auto &m : result) + addBenchmarkResult(m); +} + /*! \fn void QAbstractTestLogger::enterTestFunction(const char *function) @@ -308,19 +294,21 @@ void QAbstractTestLogger::stopLogging() /*! \fn void QAbstractTestLogger::addIncident(IncidentTypes type, const char *description, const char *file, int line) - This virtual method is called when an event occurs that relates to whether - the test passes or fails. The \a type indicates whether this was a pass or a - fail, whether a failure was expected, and whether the test being run is - blacklisted. The \a description may be empty (for a pass), a message - describing the failure or, for an expected failure, the explanation of why a - failure was expected. Where the location in code of the incident is known, - it is indicated by \a file and \a line; otherwise, these are \a nullptr and - 0, respectively. + This virtual method is called when an event occurs that relates to the + resolution of the test. The \a 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 \a 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 \a file and \a line; otherwise, + these are \a 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. + 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. \sa addMessage(), addBenchmarkResult() */ @@ -340,17 +328,17 @@ void QAbstractTestLogger::stopLogging() \fn void QAbstractTestLogger::addMessage(MessageTypes type, const QString &message, const char *file, int line) This virtual method is called, via its \c QtMsgType overload, from the - custom message handler QtTest installs. It is also used by the - implementations of QSKIP(), to warn about various situations detected by - QtTest itself, such as \e 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. + custom message handler QtTest installs. It is also used to + warn about various situations detected by QtTest itself, such + as \e 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 \a type indicates the category of message and the \a message is the content to be reported. When the message is associated with specific code, the name of the - \a file and \a line number within it are also supplied (otherwise, these are - \nullptr and 0, respectively). + \a file and \a line number within it are also supplied; otherwise, these are + \nullptr and 0, respectively. \sa QTest::ignoreMessage(), addIncident() */ @@ -383,8 +371,7 @@ void QAbstractTestLogger::addMessage(QtMsgType type, const QMessageLogContext &c case QtWarningMsg: return QAbstractTestLogger::QWarning; case QtFatalMsg: return QAbstractTestLogger::QFatal; } - Q_UNREACHABLE(); - return QAbstractTestLogger::QFatal; + Q_UNREACHABLE_RETURN(QAbstractTestLogger::QFatal); }(); QString formattedMessage = qFormatLogMessage(type, context, message); @@ -395,6 +382,11 @@ void QAbstractTestLogger::addMessage(QtMsgType type, const QMessageLogContext &c addMessage(messageType, formattedMessage); } +namespace +{ + constexpr int MAXSIZE = 1024 * 1024 * 2; +} + namespace QTest { @@ -404,7 +396,6 @@ namespace QTest */ int qt_asprintf(QTestCharBuffer *str, const char *format, ...) { - constexpr int MAXSIZE = 1024 * 1024 * 2; Q_ASSERT(str); int size = str->size(); Q_ASSERT(size > 0); @@ -452,6 +443,28 @@ void generateTestIdentifier(QTestCharBuffer *identifier, int parts) globalDataTag, tagFiller, dataTag, testFuctionEnd); } +// strcat() for QTestCharBuffer objects: +bool appendCharBuffer(QTestCharBuffer *accumulator, const QTestCharBuffer &more) +{ + const auto bufsize = [](const QTestCharBuffer &buf) -> int { + const int max = buf.size(); + return max > 0 ? int(qstrnlen(buf.constData(), max)) : 0; + }; + const int extra = bufsize(more); + if (extra <= 0) + return true; // Nothing to do, fatuous success + + const int oldsize = bufsize(*accumulator); + const int newsize = oldsize + extra + 1; // 1 for final '\0' + if (newsize > MAXSIZE || !accumulator->resize(newsize)) + return false; // too big or unable to grow + + char *tail = accumulator->data() + oldsize; + memcpy(tail, more.constData(), extra); + tail[extra] = '\0'; + return true; +} + } QT_END_NAMESPACE |