qtestcase.h 16.06 KiB
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtTest module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
** $QT_END_LICENSE$
****************************************************************************/
#ifndef QTESTCASE_H
#define QTESTCASE_H
#include <QtTest/qtest_global.h>
#include <QtCore/qstring.h>
#include <QtCore/qnamespace.h>
#include <QtCore/qmetatype.h>
#include <QtCore/qmetaobject.h>
#include <QtCore/qtypetraits.h>
#include <QtCore/qsharedpointer.h>
#include <QtCore/qtemporarydir.h>
#include <string.h>
#ifndef QT_NO_EXCEPTIONS
#  include <exception>
#endif // QT_NO_EXCEPTIONS
QT_BEGIN_NAMESPACE
class QRegularExpression;
#define QVERIFY(statement) \
do {\
    if (!QTest::qVerify((statement), #statement, "", __FILE__, __LINE__))\
        return;\
} while (0)
#define QFAIL(message) \
do {\
    QTest::qFail(message, __FILE__, __LINE__);\
    return;\
} while (0)
#define QVERIFY2(statement, description) \
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
do {\ if (statement) {\ if (!QTest::qVerify(true, #statement, (description), __FILE__, __LINE__))\ return;\ } else {\ if (!QTest::qVerify(false, #statement, (description), __FILE__, __LINE__))\ return;\ }\ } while (0) #define QCOMPARE(actual, expected) \ do {\ if (!QTest::qCompare(actual, expected, #actual, #expected, __FILE__, __LINE__))\ return;\ } while (0) #ifndef QT_NO_EXCEPTIONS # define QVERIFY_EXCEPTION_THROWN(expression, exceptiontype) \ do {\ QT_TRY {\ QT_TRY {\ expression;\ QTest::qFail("Expected exception of type " #exceptiontype " to be thrown" \ " but no exception caught", __FILE__, __LINE__);\ return;\ } QT_CATCH (const exceptiontype &) {\ }\ } QT_CATCH (const std::exception &e) {\ QByteArray msg = QByteArray() + "Expected exception of type " #exceptiontype \ " to be thrown but std::exception caught with message: " + e.what(); \ QTest::qFail(msg.constData(), __FILE__, __LINE__);\ return;\ } QT_CATCH (...) {\ QTest::qFail("Expected exception of type " #exceptiontype " to be thrown" \ " but unknown exception caught", __FILE__, __LINE__);\ return;\ }\ } while (0) #else // QT_NO_EXCEPTIONS /* * The expression passed to the macro should throw an exception and we can't * catch it because Qt has been compiled without exception support. We can't * skip the expression because it may have side effects and must be executed. * So, users must use Qt with exception support enabled if they use exceptions * in their code. */ # define QVERIFY_EXCEPTION_THROWN(expression, exceptiontype) \ Q_STATIC_ASSERT_X(false, "Support of exceptions is disabled") #endif // !QT_NO_EXCEPTIONS #define QTRY_LOOP_IMPL(__expr, __timeoutValue, __step) \ if (!(__expr)) { \ QTest::qWait(0); \ } \ int __i = 0; \ for (; __i < __timeoutValue && !(__expr); __i += __step) { \ QTest::qWait(__step); \ } #define QTRY_TIMEOUT_DEBUG_IMPL(__expr, __timeoutValue, __step)\ if (!(__expr)) { \ QTRY_LOOP_IMPL((__expr), (2 * __timeoutValue), __step);\ if (__expr) { \ QString msg = QString::fromUtf8("QTestLib: This test case check (\"%1\") failed because the requested timeout (%2 ms) was too short, %3 ms would have been sufficient this time."); \
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
msg = msg.arg(QString::fromUtf8(#__expr)).arg(__timeoutValue).arg(__timeoutValue + __i); \ QFAIL(qPrintable(msg)); \ } \ } #define QTRY_IMPL(__expr, __timeout)\ const int __step = 50; \ const int __timeoutValue = __timeout; \ QTRY_LOOP_IMPL((__expr), __timeoutValue, __step); \ QTRY_TIMEOUT_DEBUG_IMPL((__expr), __timeoutValue, __step)\ // Will try to wait for the expression to become true while allowing event processing #define QTRY_VERIFY_WITH_TIMEOUT(__expr, __timeout) \ do { \ QTRY_IMPL((__expr), __timeout);\ QVERIFY(__expr); \ } while (0) #define QTRY_VERIFY(__expr) QTRY_VERIFY_WITH_TIMEOUT((__expr), 5000) // Will try to wait for the expression to become true while allowing event processing #define QTRY_VERIFY2_WITH_TIMEOUT(__expr, __messageExpression, __timeout) \ do { \ QTRY_IMPL((__expr), __timeout);\ QVERIFY2(__expr, __messageExpression); \ } while (0) #define QTRY_VERIFY2(__expr, __messageExpression) QTRY_VERIFY2_WITH_TIMEOUT((__expr), (__messageExpression), 5000) // Will try to wait for the comparison to become successful while allowing event processing #define QTRY_COMPARE_WITH_TIMEOUT(__expr, __expected, __timeout) \ do { \ QTRY_IMPL(((__expr) == (__expected)), __timeout);\ QCOMPARE((__expr), __expected); \ } while (0) #define QTRY_COMPARE(__expr, __expected) QTRY_COMPARE_WITH_TIMEOUT((__expr), __expected, 5000) #define QSKIP_INTERNAL(statement) \ do {\ QTest::qSkip(statement, __FILE__, __LINE__);\ return;\ } while (0) #ifdef Q_COMPILER_VARIADIC_MACROS #define QSKIP(statement, ...) QSKIP_INTERNAL(statement) #else #define QSKIP(statement) QSKIP_INTERNAL(statement) #endif #define QEXPECT_FAIL(dataIndex, comment, mode)\ do {\ if (!QTest::qExpectFail(dataIndex, comment, QTest::mode, __FILE__, __LINE__))\ return;\ } while (0) #define QFETCH(type, name)\ type name = *static_cast<type *>(QTest::qData(#name, ::qMetaTypeId<type >())) #define QFETCH_GLOBAL(type, name)\ type name = *static_cast<type *>(QTest::qGlobalData(#name, ::qMetaTypeId<type >())) #define QTEST(actual, testElement)\ do {\ if (!QTest::qTest(actual, testElement, #actual, #testElement, __FILE__, __LINE__))\ return;\
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
} while (0) #define QWARN(msg)\ QTest::qWarn(msg, __FILE__, __LINE__) #ifdef QT_TESTCASE_BUILDDIR # define QFINDTESTDATA(basepath)\ QTest::qFindTestData(basepath, __FILE__, __LINE__, QT_TESTCASE_BUILDDIR) #else # define QFINDTESTDATA(basepath)\ QTest::qFindTestData(basepath, __FILE__, __LINE__) #endif # define QEXTRACTTESTDATA(resourcePath) \ QTest::qExtractTestData(resourcePath) class QObject; class QTestData; #define QTEST_COMPARE_DECL(KLASS)\ template<> Q_TESTLIB_EXPORT char *toString<KLASS >(const KLASS &); namespace QTest { namespace Internal { template<typename T> // Output registered enums inline typename QtPrivate::QEnableIf<QtPrivate::IsQEnumHelper<T>::Value, char*>::Type toString(T e) { QMetaEnum me = QMetaEnum::fromType<T>(); return qstrdup(me.key(int(e))); // int cast is necessary to support enum classes } template <typename T> // Fallback inline typename QtPrivate::QEnableIf<!QtPrivate::IsQEnumHelper<T>::Value, char*>::Type toString(const T &) { return Q_NULLPTR; } } // namespace Internal template<typename T> inline char *toString(const T &t) { return Internal::toString(t); } Q_TESTLIB_EXPORT char *toHexRepresentation(const char *ba, int length); Q_TESTLIB_EXPORT char *toPrettyCString(const char *unicode, int length); Q_TESTLIB_EXPORT char *toPrettyUnicode(const ushort *unicode, int length); Q_TESTLIB_EXPORT char *toString(const char *); Q_TESTLIB_EXPORT char *toString(const void *); Q_TESTLIB_EXPORT int qExec(QObject *testObject, int argc = 0, char **argv = Q_NULLPTR); Q_TESTLIB_EXPORT int qExec(QObject *testObject, const QStringList &arguments); Q_TESTLIB_EXPORT void setMainSourcePath(const char *file, const char *builddir = Q_NULLPTR); Q_TESTLIB_EXPORT bool qVerify(bool statement, const char *statementStr, const char *description, const char *file, int line); Q_TESTLIB_EXPORT void qFail(const char *statementStr, const char *file, int line); Q_TESTLIB_EXPORT void qSkip(const char *message, const char *file, int line); Q_TESTLIB_EXPORT bool qExpectFail(const char *dataIndex, const char *comment, TestFailMode mode, const char *file, int line); Q_TESTLIB_EXPORT void qWarn(const char *message, const char *file = Q_NULLPTR, int line = 0); Q_TESTLIB_EXPORT void ignoreMessage(QtMsgType type, const char *message); #ifndef QT_NO_REGULAREXPRESSION Q_TESTLIB_EXPORT void ignoreMessage(QtMsgType type, const QRegularExpression &messagePattern); #endif
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
Q_TESTLIB_EXPORT QSharedPointer<QTemporaryDir> qExtractTestData(const QString &dirName); Q_TESTLIB_EXPORT QString qFindTestData(const char* basepath, const char* file = Q_NULLPTR, int line = 0, const char* builddir = Q_NULLPTR); Q_TESTLIB_EXPORT QString qFindTestData(const QString& basepath, const char* file = Q_NULLPTR, int line = 0, const char* builddir = Q_NULLPTR); Q_TESTLIB_EXPORT void *qData(const char *tagName, int typeId); Q_TESTLIB_EXPORT void *qGlobalData(const char *tagName, int typeId); Q_TESTLIB_EXPORT void *qElementData(const char *elementName, int metaTypeId); Q_TESTLIB_EXPORT QObject *testObject(); Q_TESTLIB_EXPORT const char *currentAppName(); Q_TESTLIB_EXPORT const char *currentTestFunction(); Q_TESTLIB_EXPORT const char *currentDataTag(); Q_TESTLIB_EXPORT bool currentTestFailed(); Q_TESTLIB_EXPORT Qt::Key asciiToKey(char ascii); Q_TESTLIB_EXPORT char keyToAscii(Qt::Key key); Q_TESTLIB_EXPORT bool compare_helper(bool success, const char *failureMsg, char *val1, char *val2, const char *actual, const char *expected, const char *file, int line); Q_TESTLIB_EXPORT void qSleep(int ms); Q_TESTLIB_EXPORT void addColumnInternal(int id, const char *name); template <typename T> inline void addColumn(const char *name, T * = 0) { typedef QtPrivate::is_same<T, const char*> QIsSameTConstChar; Q_STATIC_ASSERT_X(!QIsSameTConstChar::value, "const char* is not allowed as a test data format."); addColumnInternal(qMetaTypeId<T>(), name); } Q_TESTLIB_EXPORT QTestData &newRow(const char *dataTag); template <typename T> inline bool qCompare(T const &t1, T const &t2, const char *actual, const char *expected, const char *file, int line) { return compare_helper(t1 == t2, "Compared values are not the same", toString(t1), toString(t2), actual, expected, file, line); } Q_TESTLIB_EXPORT bool qCompare(float const &t1, float const &t2, const char *actual, const char *expected, const char *file, int line); Q_TESTLIB_EXPORT bool qCompare(double const &t1, double const &t2, const char *actual, const char *expected, const char *file, int line); inline bool compare_ptr_helper(const void *t1, const void *t2, const char *actual, const char *expected, const char *file, int line) { return compare_helper(t1 == t2, "Compared pointers are not the same", toString(t1), toString(t2), actual, expected, file, line); } Q_TESTLIB_EXPORT bool compare_string_helper(const char *t1, const char *t2, const char *actual, const char *expected, const char *file, int line); #ifndef Q_QDOC QTEST_COMPARE_DECL(short) QTEST_COMPARE_DECL(ushort) QTEST_COMPARE_DECL(int) QTEST_COMPARE_DECL(uint) QTEST_COMPARE_DECL(long) QTEST_COMPARE_DECL(ulong) QTEST_COMPARE_DECL(qint64) QTEST_COMPARE_DECL(quint64) QTEST_COMPARE_DECL(float) QTEST_COMPARE_DECL(double)
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
QTEST_COMPARE_DECL(char) QTEST_COMPARE_DECL(signed char) QTEST_COMPARE_DECL(unsigned char) QTEST_COMPARE_DECL(bool) #endif template <typename T1, typename T2> bool qCompare(T1 const &, T2 const &, const char *, const char *, const char *, int); inline bool qCompare(double const &t1, float const &t2, const char *actual, const char *expected, const char *file, int line) { return qCompare(qreal(t1), qreal(t2), actual, expected, file, line); } inline bool qCompare(float const &t1, double const &t2, const char *actual, const char *expected, const char *file, int line) { return qCompare(qreal(t1), qreal(t2), actual, expected, file, line); } template <typename T> inline bool qCompare(const T *t1, const T *t2, const char *actual, const char *expected, const char *file, int line) { return compare_ptr_helper(t1, t2, actual, expected, file, line); } template <typename T> inline bool qCompare(T *t1, T *t2, const char *actual, const char *expected, const char *file, int line) { return compare_ptr_helper(t1, t2, actual, expected, file, line); } template <typename T1, typename T2> inline bool qCompare(const T1 *t1, const T2 *t2, const char *actual, const char *expected, const char *file, int line) { return compare_ptr_helper(t1, static_cast<const T1 *>(t2), actual, expected, file, line); } template <typename T1, typename T2> inline bool qCompare(T1 *t1, T2 *t2, const char *actual, const char *expected, const char *file, int line) { return compare_ptr_helper(const_cast<const T1 *>(t1), static_cast<const T1 *>(const_cast<const T2 *>(t2)), actual, expected, file, line); } inline bool qCompare(const char *t1, const char *t2, const char *actual, const char *expected, const char *file, int line) { return compare_string_helper(t1, t2, actual, expected, file, line); } inline bool qCompare(char *t1, char *t2, const char *actual, const char *expected, const char *file, int line) { return compare_string_helper(t1, t2, actual, expected, file, line); } /* The next two overloads are for MSVC that shows problems with implicit conversions */ inline bool qCompare(char *t1, const char *t2, const char *actual, const char *expected, const char *file, int line) { return compare_string_helper(t1, t2, actual, expected, file, line); } inline bool qCompare(const char *t1, char *t2, const char *actual, const char *expected, const char *file, int line) { return compare_string_helper(t1, t2, actual, expected, file, line);
421422423424425426427428429430431432433434435436437
} template <class T> inline bool qTest(const T& actual, const char *elementName, const char *actualStr, const char *expected, const char *file, int line) { return qCompare(actual, *static_cast<const T *>(QTest::qElementData(elementName, qMetaTypeId<T>())), actualStr, expected, file, line); } } #undef QTEST_COMPARE_DECL QT_END_NAMESPACE #endif