From 04b180f7f25d73d002df31085cf1c352e075d4e5 Mon Sep 17 00:00:00 2001 From: Samuel Gaist Date: Thu, 7 Dec 2017 09:46:30 +0100 Subject: Improve std::tuple handling in tests Currently when doing comparison with std::tuple the fallback toString method is called which returns a Q_NULLPTR thus not allowing proper diagnostic of the values that triggered an error. This patch adds support for std::tuple to improve the tests output readability. [ChangeLog][QtTest][QCOMPARE] Now outputs contents of std::tuple on failure. Change-Id: I046a55e2ce44c3f7728d51e4745120d38aa5e007 Reviewed-by: Thiago Macieira --- src/testlib/qtest.h | 21 +++++++ src/testlib/qtestcase.cpp | 25 +++++++++ src/testlib/qtestcase.h | 5 ++ .../selftests/expected_tuplediagnostics.lightxml | 34 +++++++++++ .../selftests/expected_tuplediagnostics.tap | 33 +++++++++++ .../selftests/expected_tuplediagnostics.teamcity | 14 +++++ .../selftests/expected_tuplediagnostics.txt | 15 +++++ .../selftests/expected_tuplediagnostics.xml | 37 ++++++++++++ .../selftests/expected_tuplediagnostics.xunitxml | 22 ++++++++ tests/auto/testlib/selftests/selftests.pri | 1 + tests/auto/testlib/selftests/tst_selftests.cpp | 1 + .../tuplediagnostics/tst_tuplediagnostics.cpp | 65 ++++++++++++++++++++++ .../tuplediagnostics/tuplediagnostics.pro | 6 ++ 13 files changed, 279 insertions(+) create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.lightxml create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.tap create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.teamcity create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.txt create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.xml create mode 100644 tests/auto/testlib/selftests/expected_tuplediagnostics.xunitxml create mode 100644 tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp create mode 100644 tests/auto/testlib/selftests/tuplediagnostics/tuplediagnostics.pro diff --git a/src/testlib/qtest.h b/src/testlib/qtest.h index 1cb6a91d33..927b68bd27 100644 --- a/src/testlib/qtest.h +++ b/src/testlib/qtest.h @@ -59,6 +59,8 @@ #include #include +#include + QT_BEGIN_NAMESPACE @@ -215,6 +217,25 @@ inline char *toString(const std::pair &pair) return toString(QString::asprintf("std::pair(%s,%s)", first.data(), second.data())); } +template +inline char *toString(const Tuple & tuple, QtPrivate::IndexesList) { + using UP = std::unique_ptr; + // Generate a table of N + 1 elements where N is the number of + // elements in the tuple. + // The last element is needed to support the empty tuple use case. + const UP data[] = { + UP(toString(std::get(tuple)))..., UP{} + }; + return formatString("std::tuple(", ")", sizeof...(I), data[I].get()...); +} + +template +inline char *toString(const std::tuple &tuple) +{ + static const std::size_t params_count = sizeof...(Types); + return toString(tuple, typename QtPrivate::Indexes::Value()); +} + inline char *toString(std::nullptr_t) { return toString(QLatin1String("nullptr")); diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp index 0866176b6b..469c423109 100644 --- a/src/testlib/qtestcase.cpp +++ b/src/testlib/qtestcase.cpp @@ -1146,6 +1146,31 @@ void *fetchData(QTestData *data, const char *tagName, int typeId) return data->data(idx); } +/*! + * \internal + */ +char *formatString(const char *prefix, const char *suffix, size_t numArguments, ...) +{ + va_list ap; + va_start(ap, numArguments); + + QByteArray arguments; + arguments += prefix; + + if (numArguments > 0) { + arguments += va_arg(ap, const char *); + + for (size_t i = 1; i < numArguments; ++i) { + arguments += ", "; + arguments += va_arg(ap, const char *); + } + } + + va_end(ap); + arguments += suffix; + return qstrdup(arguments.constData()); +} + /*! \fn char* QTest::toHexRepresentation(const char *ba, int length) diff --git a/src/testlib/qtestcase.h b/src/testlib/qtestcase.h index 4bf816a850..f6891dc941 100644 --- a/src/testlib/qtestcase.h +++ b/src/testlib/qtestcase.h @@ -283,6 +283,9 @@ namespace QTest template inline char *toString(const std::pair &pair); + template + inline char *toString(const std::tuple &tuple); + 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(QStringView string); @@ -388,6 +391,8 @@ namespace QTest Q_TESTLIB_EXPORT bool compare_string_helper(const char *t1, const char *t2, const char *actual, const char *expected, const char *file, int line); + Q_TESTLIB_EXPORT char *formatString(const char *prefix, const char *suffix, size_t numArguments, ...); + #ifndef Q_QDOC QTEST_COMPARE_DECL(short) QTEST_COMPARE_DECL(ushort) diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.lightxml b/tests/auto/testlib/selftests/expected_tuplediagnostics.lightxml new file mode 100644 index 0000000000..810941d894 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.lightxml @@ -0,0 +1,34 @@ + + @INSERT_QT_VERSION_HERE@ + + @INSERT_QT_VERSION_HERE@ + + + + + + + + + + + + {1}): std::tuple(1) + Expected (std::tuple{2}): std::tuple(2)]]> + + + + + + + + + + + + + + diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.tap b/tests/auto/testlib/selftests/expected_tuplediagnostics.tap new file mode 100644 index 0000000000..9e007c14e1 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.tap @@ -0,0 +1,33 @@ +TAP version 13 +# tst_TupleDiagnostics +ok 1 - initTestCase() +ok 2 - testEmptyTuple() +not ok 3 - testSimpleTuple() + --- + type: QCOMPARE + message: Compared values are not the same + wanted: std::tuple(2) (std::tuple{2}) + found: std::tuple(1) (std::tuple{1}) + expected: std::tuple(2) (std::tuple{2}) + actual: std::tuple(1) (std::tuple{1}) + at: tst_TupleDiagnostics::testSimpleTuple() (/localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp:53) + file: /localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp + line: 53 + ... +not ok 4 - testTuple() + --- + type: QCOMPARE + message: Compared values are not the same + wanted: std::tuple(42, 'Y', "tuple2") (tuple2) + found: std::tuple(42, 'Y', "tuple1") (tuple1) + expected: std::tuple(42, 'Y', "tuple2") (tuple2) + actual: std::tuple(42, 'Y', "tuple1") (tuple1) + at: tst_TupleDiagnostics::testTuple() (/localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp:60) + file: /localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp + line: 60 + ... +ok 5 - cleanupTestCase() +1..5 +# tests 5 +# pass 3 +# fail 2 diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.teamcity b/tests/auto/testlib/selftests/expected_tuplediagnostics.teamcity new file mode 100644 index 0000000000..a395857c60 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.teamcity @@ -0,0 +1,14 @@ +##teamcity[testSuiteStarted name='tst_TupleDiagnostics' flowId='tst_TupleDiagnostics'] +##teamcity[testStarted name='initTestCase()' flowId='tst_TupleDiagnostics'] +##teamcity[testFinished name='initTestCase()' flowId='tst_TupleDiagnostics'] +##teamcity[testStarted name='testEmptyTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testFinished name='testEmptyTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testStarted name='testSimpleTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testFailed name='testSimpleTuple()' message='Failure! |[Loc: /localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp(0)|]' details='Compared values are not the same|n Actual (std::tuple{1}): std::tuple(1)|n Expected (std::tuple{2}): std::tuple(2)' flowId='tst_TupleDiagnostics'] +##teamcity[testFinished name='testSimpleTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testStarted name='testTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testFailed name='testTuple()' message='Failure! |[Loc: /localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp(0)|]' details='Compared values are not the same|n Actual (tuple1): std::tuple(42, |'Y|', "tuple1")|n Expected (tuple2): std::tuple(42, |'Y|', "tuple2")' flowId='tst_TupleDiagnostics'] +##teamcity[testFinished name='testTuple()' flowId='tst_TupleDiagnostics'] +##teamcity[testStarted name='cleanupTestCase()' flowId='tst_TupleDiagnostics'] +##teamcity[testFinished name='cleanupTestCase()' flowId='tst_TupleDiagnostics'] +##teamcity[testSuiteFinished name='tst_TupleDiagnostics' flowId='tst_TupleDiagnostics'] diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.txt b/tests/auto/testlib/selftests/expected_tuplediagnostics.txt new file mode 100644 index 0000000000..ce568bf6c0 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.txt @@ -0,0 +1,15 @@ +********* Start testing of tst_TupleDiagnostics ********* +Config: Using QtTest library +PASS : tst_TupleDiagnostics::initTestCase() +PASS : tst_TupleDiagnostics::testEmptyTuple() +FAIL! : tst_TupleDiagnostics::testSimpleTuple() Compared values are not the same + Actual (std::tuple{1}): std::tuple(1) + Expected (std::tuple{2}): std::tuple(2) + Loc: [/localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp(0)] +FAIL! : tst_TupleDiagnostics::testTuple() Compared values are not the same + Actual (tuple1): std::tuple(42, 'Y', "tuple1") + Expected (tuple2): std::tuple(42, 'Y', "tuple2") + Loc: [/localqtbase/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp(0)] +PASS : tst_TupleDiagnostics::cleanupTestCase() +Totals: 3 passed, 2 failed, 0 skipped, 0 blacklisted, 0ms +********* Finished testing of tst_TupleDiagnostics ********* diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.xml b/tests/auto/testlib/selftests/expected_tuplediagnostics.xml new file mode 100644 index 0000000000..4c55a6d393 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.xml @@ -0,0 +1,37 @@ + + + + @INSERT_QT_VERSION_HERE@ + + @INSERT_QT_VERSION_HERE@ + + + + + + + + + + + + {1}): std::tuple(1) + Expected (std::tuple{2}): std::tuple(2)]]> + + + + + + + + + + + + + + + diff --git a/tests/auto/testlib/selftests/expected_tuplediagnostics.xunitxml b/tests/auto/testlib/selftests/expected_tuplediagnostics.xunitxml new file mode 100644 index 0000000000..0a276a17f5 --- /dev/null +++ b/tests/auto/testlib/selftests/expected_tuplediagnostics.xunitxml @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + diff --git a/tests/auto/testlib/selftests/selftests.pri b/tests/auto/testlib/selftests/selftests.pri index 2a31630737..498d1653c0 100644 --- a/tests/auto/testlib/selftests/selftests.pri +++ b/tests/auto/testlib/selftests/selftests.pri @@ -45,6 +45,7 @@ SUBPROGRAMS = \ sleep \ strcmp \ subtest \ + tuplediagnostics \ verbose1 \ verbose2 \ verifyexceptionthrown \ diff --git a/tests/auto/testlib/selftests/tst_selftests.cpp b/tests/auto/testlib/selftests/tst_selftests.cpp index ac20b12433..c5f847562e 100644 --- a/tests/auto/testlib/selftests/tst_selftests.cpp +++ b/tests/auto/testlib/selftests/tst_selftests.cpp @@ -494,6 +494,7 @@ void tst_Selftests::runSubTest_data() << "sleep" << "strcmp" << "subtest" + << "tuplediagnostics" << "verbose1" << "verbose2" #ifndef QT_NO_EXCEPTIONS diff --git a/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp b/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp new file mode 100644 index 0000000000..17da52eaba --- /dev/null +++ b/tests/auto/testlib/selftests/tuplediagnostics/tst_tuplediagnostics.cpp @@ -0,0 +1,65 @@ +/**************************************************************************** +** +** Copyright (C) 2017 Samuel Gaist +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the test suite of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** 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 General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** 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-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +// Make sure we get a real Q_ASSERT even in release builds +#ifdef QT_NO_DEBUG +# undef QT_NO_DEBUG +#endif + +#include + +class tst_TupleDiagnostics: public QObject +{ + Q_OBJECT + +private slots: + void testEmptyTuple() const; + void testSimpleTuple() const; + void testTuple() const; +}; + +void tst_TupleDiagnostics::testEmptyTuple() const +{ + QCOMPARE(std::tuple<>{}, std::tuple<>{}); +} + +void tst_TupleDiagnostics::testSimpleTuple() const +{ + QCOMPARE(std::tuple{1}, std::tuple{2}); +} + +void tst_TupleDiagnostics::testTuple() const +{ + std::tuple tuple1{42, 'Y', QStringLiteral("tuple1")}; + std::tuple tuple2{42, 'Y', QStringLiteral("tuple2")}; + QCOMPARE(tuple1, tuple2); +} + +QTEST_MAIN(tst_TupleDiagnostics) + +#include "tst_tuplediagnostics.moc" diff --git a/tests/auto/testlib/selftests/tuplediagnostics/tuplediagnostics.pro b/tests/auto/testlib/selftests/tuplediagnostics/tuplediagnostics.pro new file mode 100644 index 0000000000..7a29e0e5e1 --- /dev/null +++ b/tests/auto/testlib/selftests/tuplediagnostics/tuplediagnostics.pro @@ -0,0 +1,6 @@ +SOURCES += tst_tuplediagnostics.cpp +QT = core testlib + +CONFIG -= app_bundle debug_and_release_target + +TARGET = tuplediagnostics -- cgit v1.2.3