diff options
Diffstat (limited to 'src/testlib')
-rw-r--r-- | src/testlib/doc/src/qttestlib-manual.qdoc | 6 | ||||
-rw-r--r-- | src/testlib/qteamcitylogger.cpp | 292 | ||||
-rw-r--r-- | src/testlib/qteamcitylogger_p.h | 90 | ||||
-rw-r--r-- | src/testlib/qtestcase.cpp | 8 | ||||
-rw-r--r-- | src/testlib/qtestlog.cpp | 4 | ||||
-rw-r--r-- | src/testlib/qtestlog_p.h | 2 | ||||
-rw-r--r-- | src/testlib/testlib.pro | 1 |
7 files changed, 399 insertions, 4 deletions
diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc index 00ad84b78b..3b9d0f3d80 100644 --- a/src/testlib/doc/src/qttestlib-manual.qdoc +++ b/src/testlib/doc/src/qttestlib-manual.qdoc @@ -190,6 +190,8 @@ \li \c -csv \br Outputs results as comma-separated values (CSV). This mode is only suitable for benchmarks, since it suppresses normal pass/fail messages. + \li \c -teamcity \br + Outputs results in TeamCity format. \endlist The first version of the \c -o option may be repeated in order to log @@ -197,8 +199,8 @@ option can log test results to standard output. If the first version of the \c -o option is used, neither the second version - of the \c -o option nor the \c -txt, \c -xml, \c -lightxml or \c -xunitxml - options should be used. + of the \c -o option nor the \c -txt, \c -xml, \c -lightxml, \c -teamcity + or \c -xunitxml options should be used. If neither version of the \c -o option is used, test results will be logged to standard output. If no format option is used, test results will be logged in diff --git a/src/testlib/qteamcitylogger.cpp b/src/testlib/qteamcitylogger.cpp new file mode 100644 index 0000000000..4773ea937f --- /dev/null +++ b/src/testlib/qteamcitylogger.cpp @@ -0,0 +1,292 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Borgar Ovsthus +** 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$ +** +****************************************************************************/ + +#include <QtTest/private/qtestresult_p.h> +#include <QtTest/qtestassert.h> +#include <QtTest/private/qtestlog_p.h> +#include <QtTest/private/qteamcitylogger_p.h> +#include <QtCore/qbytearray.h> +#include <stdarg.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +QT_BEGIN_NAMESPACE + +namespace QTest { + + static const char *incidentType2String(QAbstractTestLogger::IncidentTypes type) + { + switch (type) { + case QAbstractTestLogger::Pass: + return "PASS"; + case QAbstractTestLogger::XFail: + return "XFAIL"; + case QAbstractTestLogger::Fail: + return "FAIL!"; + case QAbstractTestLogger::XPass: + return "XPASS"; + case QAbstractTestLogger::BlacklistedPass: + return "BPASS"; + case QAbstractTestLogger::BlacklistedFail: + return "BFAIL"; + } + return "??????"; + } + + static const char *messageType2String(QAbstractTestLogger::MessageTypes type) + { + switch (type) { + case QAbstractTestLogger::Skip: + return "SKIP"; + case QAbstractTestLogger::Warn: + return "WARNING"; + case QAbstractTestLogger::QWarning: + return "QWARN"; + case QAbstractTestLogger::QDebug: + return "QDEBUG"; + case QAbstractTestLogger::QInfo: + return "QINFO"; + case QAbstractTestLogger::QSystem: + return "QSYSTEM"; + case QAbstractTestLogger::QFatal: + return "QFATAL"; + case QAbstractTestLogger::Info: + return "INFO"; + } + return "??????"; + } +} + +QTeamCityLogger::QTeamCityLogger(const char *filename) + : QAbstractTestLogger(filename) +{ +} + +QTeamCityLogger::~QTeamCityLogger() +{ +} + +void QTeamCityLogger::startLogging() +{ + QAbstractTestLogger::startLogging(); + + QString testSuiteName = tcEscapedString(QString::fromUtf8(QTestResult::currentTestObjectName())); + + QString str = QString(QLatin1String("##teamcity[testSuiteStarted name='%1']\n")).arg(testSuiteName); + outputString(qPrintable(str)); +} + +void QTeamCityLogger::stopLogging() +{ + QString testSuiteName = tcEscapedString(QString::fromUtf8(QTestResult::currentTestObjectName())); + + QString str = QString(QLatin1String("##teamcity[testSuiteFinished name='%1']\n")).arg(testSuiteName); + outputString(qPrintable(str)); + + QAbstractTestLogger::stopLogging(); +} + +void QTeamCityLogger::enterTestFunction(const char * /*function*/) +{ + // don't print anything +} + +void QTeamCityLogger::leaveTestFunction() +{ + // don't print anything +} + +void QTeamCityLogger::addIncident(IncidentTypes type, const char *description, + const char *file, int line) +{ + // suppress PASS and XFAIL in silent mode + if ((type == QAbstractTestLogger::Pass || type == QAbstractTestLogger::XFail) && QTestLog::verboseLevel() < 0) + return; + + QString buf; + + QString tmpFuncName = escapedTestFuncName(); + + if (tmpFuncName != currTestFuncName) { + buf = QString(QLatin1String("##teamcity[testStarted name='%1']\n")).arg(tmpFuncName); + outputString(qPrintable(buf)); + } + + currTestFuncName = tmpFuncName; + + if (type == QAbstractTestLogger::XFail) { + addPendingMessage(QTest::incidentType2String(type), QString::fromUtf8(description), file, line); + return; + } + + QString detailedText = QString::fromUtf8(description); + detailedText = tcEscapedString(detailedText); + + // Test failed + if ((type == QAbstractTestLogger::Fail) || (type == QAbstractTestLogger::XPass)) { + QString messageText(QLatin1String("Failure!")); + + if (file) + messageText += QString(QLatin1String(" |[Loc: %1(%2)|]")).arg(QString::fromUtf8(file)).arg(line); + + buf = QString(QLatin1String("##teamcity[testFailed name='%1' message='%2' details='%3']\n")) + .arg(tmpFuncName) + .arg(messageText) + .arg(detailedText); + + outputString(qPrintable(buf)); + } + + if (!pendingMessages.isEmpty()) { + buf = QString(QLatin1String("##teamcity[testStdOut name='%1' out='%2']\n")) + .arg(tmpFuncName) + .arg(pendingMessages); + + outputString(qPrintable(buf)); + + pendingMessages.clear(); + } + + buf = QString(QLatin1String("##teamcity[testFinished name='%1']\n")).arg(tmpFuncName); + outputString(qPrintable(buf)); +} + +void QTeamCityLogger::addBenchmarkResult(const QBenchmarkResult &) +{ + // don't print anything +} + +void QTeamCityLogger::addMessage(MessageTypes type, const QString &message, + const char *file, int line) +{ + // suppress non-fatal messages in silent mode + if (type != QAbstractTestLogger::QFatal && QTestLog::verboseLevel() < 0) + return; + + QString escapedMessage = tcEscapedString(message); + + QString buf; + + if (type == QAbstractTestLogger::Skip) { + if (file) + escapedMessage.append(QString(QLatin1String(" |[Loc: %1(%2)|]")).arg(QString::fromUtf8(file)).arg(line)); + + buf = QString(QLatin1String("##teamcity[testIgnored name='%1' message='%2']\n")) + .arg(escapedTestFuncName()) + .arg(escapedMessage); + + outputString(qPrintable(buf)); + } + else { + addPendingMessage(QTest::messageType2String(type), escapedMessage, file, line); + } +} + +QString QTeamCityLogger::tcEscapedString(const QString &str) const +{ + QString formattedString; + + for (int i = 0; i < str.length(); i++) { + QChar ch = str.at(i); + + switch (ch.toLatin1()) { + case '\n': + formattedString.append(QLatin1Literal("|n")); + break; + case '\r': + formattedString.append(QLatin1Literal("|r")); + break; + case '|': + formattedString.append(QLatin1Literal("||")); + break; + case '[': + formattedString.append(QLatin1Literal("|[")); + break; + case ']': + formattedString.append(QLatin1Literal("|]")); + break; + case '\'': + formattedString.append(QLatin1Literal("|'")); + break; + default: + formattedString.append(ch); + } + } + + return qMove(formattedString).simplified(); +} + +QString QTeamCityLogger::escapedTestFuncName() const +{ + const char *fn = QTestResult::currentTestFunction() ? QTestResult::currentTestFunction() + : "UnknownTestFunc"; + const char *tag = QTestResult::currentDataTag() ? QTestResult::currentDataTag() : ""; + + QString str = QString(QLatin1String("%1(%2)")).arg(QString::fromUtf8(fn)).arg(QString::fromUtf8(tag)); + str = tcEscapedString(str); + + return str; +} + +void QTeamCityLogger::addPendingMessage(const char *type, const QString &msg, const char *file, int line) +{ + QString pendMessage; + + if (!pendingMessages.isEmpty()) + pendMessage += QLatin1String("|n"); + + if (file) { + pendMessage += QString(QLatin1String("%1 |[Loc: %2(%3)|]: %4")) + .arg(QString::fromUtf8(type)) + .arg(QString::fromUtf8(file)) + .arg(line) + .arg(msg); + + } + else { + pendMessage += QString(QLatin1String("%1: %2")) + .arg(QString::fromUtf8(type)) + .arg(msg); + } + + pendingMessages.append(pendMessage); +} + +QT_END_NAMESPACE diff --git a/src/testlib/qteamcitylogger_p.h b/src/testlib/qteamcitylogger_p.h new file mode 100644 index 0000000000..b8fad3ae34 --- /dev/null +++ b/src/testlib/qteamcitylogger_p.h @@ -0,0 +1,90 @@ +/**************************************************************************** +** +** Copyright (C) 2016 Borgar Ovsthus +** 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$ +** +****************************************************************************/ + +#ifndef QTEAMCITYLOGGER_P_H +#define QTEAMCITYLOGGER_P_H + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. +// + +#include <QtTest/private/qabstracttestlogger_p.h> + +#include <QtCore/qstring.h> + +QT_BEGIN_NAMESPACE + +class QTeamCityLogger : public QAbstractTestLogger +{ +public: + QTeamCityLogger(const char *filename); + ~QTeamCityLogger(); + + void startLogging(); + void stopLogging(); + + void enterTestFunction(const char *function); + void leaveTestFunction(); + + void addIncident(IncidentTypes type, const char *description, + const char *file = 0, int line = 0); + void addBenchmarkResult(const QBenchmarkResult &result); + + void addMessage(MessageTypes type, const QString &message, + const char *file = 0, int line = 0); + +private: + QString currTestFuncName; + QString pendingMessages; + + QString tcEscapedString(const QString &str) const; + QString escapedTestFuncName() const; + void addPendingMessage(const char *type, const QString &msg, const char *file, int line); +}; + +QT_END_NAMESPACE + +#endif diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp index 0aec8a44b8..d71b64428d 100644 --- a/src/testlib/qtestcase.cpp +++ b/src/testlib/qtestcase.cpp @@ -404,6 +404,7 @@ Q_TESTLIB_EXPORT void qtest_qParseArgs(int argc, char *argv[], bool qml) " xunitxml : XML XUnit document\n" " xml : XML document\n" " lightxml : A stream of XML tags\n" + " teamcity : TeamCity format\n" "\n" " *** Multiple loggers can be specified, but at most one can log to stdout.\n" "\n" @@ -414,6 +415,7 @@ Q_TESTLIB_EXPORT void qtest_qParseArgs(int argc, char *argv[], bool qml) " -xunitxml : Output results as XML XUnit document\n" " -xml : Output results as XML document\n" " -lightxml : Output results as stream of XML tags\n" + " -teamcity : Output results in TeamCity format\n" "\n" " *** If no output file is specified, stdout is assumed.\n" " *** If no output format is specified, -txt is assumed.\n" @@ -499,6 +501,8 @@ Q_TESTLIB_EXPORT void qtest_qParseArgs(int argc, char *argv[], bool qml) logFormat = QTestLog::XML; } else if (strcmp(argv[i], "-lightxml") == 0) { logFormat = QTestLog::LightXML; + } else if (strcmp(argv[i], "-teamcity") == 0) { + logFormat = QTestLog::TeamCity; } else if (strcmp(argv[i], "-silent") == 0) { QTestLog::setVerboseLevel(-1); } else if (strcmp(argv[i], "-v1") == 0) { @@ -531,8 +535,10 @@ Q_TESTLIB_EXPORT void qtest_qParseArgs(int argc, char *argv[], bool qml) logFormat = QTestLog::XML; else if (strcmp(format, "xunitxml") == 0) logFormat = QTestLog::XunitXML; + else if (strcmp(format, "teamcity") == 0) + logFormat = QTestLog::TeamCity; else { - fprintf(stderr, "output format must be one of txt, csv, lightxml, xml or xunitxml\n"); + fprintf(stderr, "output format must be one of txt, csv, lightxml, xml, teamcity or xunitxml\n"); exit(1); } if (strcmp(filename, "-") == 0 && QTestLog::loggerUsingStdout()) { diff --git a/src/testlib/qtestlog.cpp b/src/testlib/qtestlog.cpp index ab370786bd..5bbf2c6458 100644 --- a/src/testlib/qtestlog.cpp +++ b/src/testlib/qtestlog.cpp @@ -46,6 +46,7 @@ #include <QtTest/private/qcsvbenchmarklogger_p.h> #include <QtTest/private/qxunittestlogger_p.h> #include <QtTest/private/qxmltestlogger_p.h> +#include <QtTest/private/qteamcitylogger_p.h> #if defined(HAVE_XCTEST) #include <QtTest/private/qxctestlogger_p.h> #endif @@ -500,6 +501,9 @@ void QTestLog::addLogger(LogMode mode, const char *filename) case QTestLog::XunitXML: logger = new QXunitTestLogger(filename); break; + case QTestLog::TeamCity: + logger = new QTeamCityLogger(filename); + break; #if defined(HAVE_XCTEST) case QTestLog::XCTest: logger = new QXcodeTestLogger; diff --git a/src/testlib/qtestlog_p.h b/src/testlib/qtestlog_p.h index 9bdbd736a9..f72c047c35 100644 --- a/src/testlib/qtestlog_p.h +++ b/src/testlib/qtestlog_p.h @@ -62,7 +62,7 @@ class Q_TESTLIB_EXPORT QTestLog { public: enum LogMode { - Plain = 0, XML, LightXML, XunitXML, CSV, + Plain = 0, XML, LightXML, XunitXML, CSV, TeamCity, #if defined(HAVE_XCTEST) XCTest #endif diff --git a/src/testlib/testlib.pro b/src/testlib/testlib.pro index ff4379f85d..0faa1c7d30 100644 --- a/src/testlib/testlib.pro +++ b/src/testlib/testlib.pro @@ -54,6 +54,7 @@ SOURCES = qtestcase.cpp \ qbenchmarkperfevents.cpp \ qbenchmarkmetric.cpp \ qcsvbenchmarklogger.cpp \ + qteamcitylogger.cpp \ qtestelement.cpp \ qtestelementattribute.cpp \ qtestmouse.cpp \ |