Improve pair-like class handling in tests

Currently when doing comparison with pair-like classes 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 QPair and std::pair to improve the tests output readability. [ChangeLog][QtTest][QCOMPARE] Now outputs contents of QPair and std::pair on failure. Change-Id: Ib0b4aad7640590d56275b6f1306fb9fb39fa81bc Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2017-03-28 08:56:24 +02:00 · 2017-03-28 08:56:24 +02:00 · c608ffc56a
commit c608ffc56a
parent 6f41600422
11 changed files with 202 additions and 0 deletions
--- a/src/testlib/qtestcase.h
+++ b/src/testlib/qtestcase.h
@ -259,6 +259,22 @@ namespace QTest
        return Internal::toString(t);
    }

+    template <typename T1, typename T2>
+    inline char *toString(const QPair<T1, T2> &pair)
+    {
+        const QScopedArrayPointer<char> first(toString(pair.first));
+        const QScopedArrayPointer<char> second(toString(pair.second));
+        return toString(QString::asprintf("QPair(%s,%s)", first.data(), second.data()));
+    }
+
+    template <typename T1, typename T2>
+    inline char *toString(const std::pair<T1, T2> &pair)
+    {
+        const QScopedArrayPointer<char> first(toString(pair.first));
+        const QScopedArrayPointer<char> second(toString(pair.second));
+        return toString(QString::asprintf("std::pair(%s,%s)", first.data(), second.data()));
+    }
+
    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);
--- a/tests/auto/testlib/selftests/expected_pairdiagnostics.lightxml
+++ b/tests/auto/testlib/selftests/expected_pairdiagnostics.lightxml
@ -0,0 +1,30 @@
+<Environment>
+    <QtVersion>@INSERT_QT_VERSION_HERE@</QtVersion>
+    <QtBuild/>
+    <QTestVersion>@INSERT_QT_VERSION_HERE@</QTestVersion>
+</Environment>
+<TestFunction name="initTestCase">
+<Incident type="pass" file="" line="0" />
+    <Duration msecs="0"/>
+</TestFunction>
+<TestFunction name="testQPair">
+<Incident type="fail" file="../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp" line="51">
+    <Description><![CDATA[Compared values are not the same
+   Actual   (pair1): "QPair(1,1)"
+   Expected (pair2): "QPair(1,2)"]]></Description>
+</Incident>
+    <Duration msecs="0"/>
+</TestFunction>
+<TestFunction name="testStdPair">
+<Incident type="fail" file="../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp" line="58">
+    <Description><![CDATA[Compared values are not the same
+   Actual   (pair1): "std::pair(1,1)"
+   Expected (pair2): "std::pair(1,2)"]]></Description>
+</Incident>
+    <Duration msecs="0"/>
+</TestFunction>
+<TestFunction name="cleanupTestCase">
+<Incident type="pass" file="" line="0" />
+    <Duration msecs="0"/>
+</TestFunction>
+<Duration msecs="0"/>
--- a/tests/auto/testlib/selftests/expected_pairdiagnostics.teamcity
+++ b/tests/auto/testlib/selftests/expected_pairdiagnostics.teamcity
@ -0,0 +1,12 @@
+##teamcity[testSuiteStarted name='tst_PairDiagnostics']
+##teamcity[testStarted name='initTestCase()']
+##teamcity[testFinished name='initTestCase()']
+##teamcity[testStarted name='testQPair()']
+##teamcity[testFailed name='testQPair()' message='Failure! |[Loc: ../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp(51)|]' details='Compared values are not the same|n Actual (pair1): "QPair(1,1)"|n Expected (pair2): "QPair(1,2)"']
+##teamcity[testFinished name='testQPair()']
+##teamcity[testStarted name='testStdPair()']
+##teamcity[testFailed name='testStdPair()' message='Failure! |[Loc: ../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp(58)|]' details='Compared values are not the same|n Actual (pair1): "std::pair(1,1)"|n Expected (pair2): "std::pair(1,2)"']
+##teamcity[testFinished name='testStdPair()']
+##teamcity[testStarted name='cleanupTestCase()']
+##teamcity[testFinished name='cleanupTestCase()']
+##teamcity[testSuiteFinished name='tst_PairDiagnostics']
--- a/tests/auto/testlib/selftests/expected_pairdiagnostics.txt
+++ b/tests/auto/testlib/selftests/expected_pairdiagnostics.txt
@ -0,0 +1,14 @@
+********* Start testing of tst_PairDiagnostics *********
+Config: Using QtTest library @INSERT_QT_VERSION_HERE@, Qt @INSERT_QT_VERSION_HERE@
+PASS   : tst_PairDiagnostics::initTestCase()
+FAIL!  : tst_PairDiagnostics::testQPair() Compared values are not the same
+   Actual   (pair1): "QPair(1,1)"
+   Expected (pair2): "QPair(1,2)"
+   Loc: [../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp(51)]
+FAIL!  : tst_PairDiagnostics::testStdPair() Compared values are not the same
+   Actual   (pair1): "std::pair(1,1)"
+   Expected (pair2): "std::pair(1,2)"
+   Loc: [../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp(58)]
+PASS   : tst_PairDiagnostics::cleanupTestCase()
+Totals: 2 passed, 2 failed, 0 skipped, 0 blacklisted, 1ms
+********* Finished testing of tst_PairDiagnostics *********
--- a/tests/auto/testlib/selftests/expected_pairdiagnostics.xml
+++ b/tests/auto/testlib/selftests/expected_pairdiagnostics.xml
@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<TestCase name="tst_PairDiagnostics">
+<Environment>
+    <QtVersion>@INSERT_QT_VERSION_HERE@</QtVersion>
+    <QtBuild/>
+    <QTestVersion>@INSERT_QT_VERSION_HERE@</QTestVersion>
+</Environment>
+<TestFunction name="initTestCase">
+<Incident type="pass" file="" line="0" />
+    <Duration msecs="0.680795"/>
+</TestFunction>
+<TestFunction name="testQPair">
+<Incident type="fail" file="../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp" line="51">
+    <Description><![CDATA[Compared values are not the same
+   Actual   (pair1): "QPair(1,1)"
+   Expected (pair2): "QPair(1,2)"]]></Description>
+</Incident>
+    <Duration msecs="0.085705"/>
+</TestFunction>
+<TestFunction name="testStdPair">
+<Incident type="fail" file="../../../qt5/qtbase_fixItemData/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp" line="58">
+    <Description><![CDATA[Compared values are not the same
+   Actual   (pair1): "std::pair(1,1)"
+   Expected (pair2): "std::pair(1,2)"]]></Description>
+</Incident>
+    <Duration msecs="0.030780"/>
+</TestFunction>
+<TestFunction name="cleanupTestCase">
+<Incident type="pass" file="" line="0" />
+    <Duration msecs="0.039052"/>
+</TestFunction>
+<Duration msecs="0.995227"/>
+</TestCase>
--- a/tests/auto/testlib/selftests/expected_pairdiagnostics.xunitxml
+++ b/tests/auto/testlib/selftests/expected_pairdiagnostics.xunitxml
@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<testsuite errors="0" failures="2" tests="4" name="tst_PairDiagnostics">
+  <properties>
+    <property value="@INSERT_QT_VERSION_HERE@" name="QTestVersion"/>
+    <property value="@INSERT_QT_VERSION_HERE@" name="QtVersion"/>
+    <property value="" name="QtBuild"/>
+  </properties>
+  <testcase result="pass" name="initTestCase"/>
+  <testcase result="fail" name="testQPair">
+    <failure message="Compared values are not the same
+   Actual   (pair1): &quot;QPair(1,1)&quot;
+   Expected (pair2): &quot;QPair(1,2)&quot;" result="fail"/>
+  </testcase>
+  <testcase result="fail" name="testStdPair">
+    <failure message="Compared values are not the same
+   Actual   (pair1): &quot;std::pair(1,1)&quot;
+   Expected (pair2): &quot;std::pair(1,2)&quot;" result="fail"/>
+  </testcase>
+  <testcase result="pass" name="cleanupTestCase"/>
+  <system-err/>
+</testsuite>
--- a/tests/auto/testlib/selftests/pairdiagnostics/pairdiagnostics.pro
+++ b/tests/auto/testlib/selftests/pairdiagnostics/pairdiagnostics.pro
@ -0,0 +1,6 @@
+SOURCES += tst_pairdiagnostics.cpp
+QT = core testlib
+
+CONFIG -= app_bundle debug_and_release_target
+
+TARGET = pairdiagnostics
--- a/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp
+++ b/tests/auto/testlib/selftests/pairdiagnostics/tst_pairdiagnostics.cpp
@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** 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 <QtCore/QCoreApplication>
+#include <QtCore/QPair>
+#include <QtTest/QtTest>
+
+class tst_PairDiagnostics: public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void testQPair() const;
+    void testStdPair() const;
+};
+
+void tst_PairDiagnostics::testQPair() const
+{
+    QPair<int, int> pair1 = qMakePair(1, 1);
+    QPair<int, int> pair2 = qMakePair(1, 2);
+    QCOMPARE(pair1, pair2);
+}
+
+void tst_PairDiagnostics::testStdPair() const
+{
+    std::pair<int, int> pair1 = std::make_pair(1, 1);
+    std::pair<int, int> pair2 = std::make_pair(1, 2);
+    QCOMPARE(pair1, pair2);
+}
+
+QTEST_MAIN(tst_PairDiagnostics)
+
+#include "tst_pairdiagnostics.moc"
--- a/tests/auto/testlib/selftests/selftests.pri
+++ b/tests/auto/testlib/selftests/selftests.pri
@ -28,6 +28,7 @@ SUBPROGRAMS = \
     longstring \
     maxwarnings \
     multiexec \
+     pairdiagnostics \
     printdatatags \
     printdatatagswithglobaltags \
     qexecstringlist \
--- a/tests/auto/testlib/selftests/selftests.qrc
+++ b/tests/auto/testlib/selftests/selftests.qrc
@ -115,6 +115,11 @@
        <file>expected_maxwarnings.xml</file>
        <file>expected_maxwarnings.xunitxml</file>
        <file>expected_multiexec.txt</file>
+        <file>expected_pairdiagnostics.lightxml</file>
+        <file>expected_pairdiagnostics.teamcity</file>
+        <file>expected_pairdiagnostics.txt</file>
+        <file>expected_pairdiagnostics.xml</file>
+        <file>expected_pairdiagnostics.xunitxml</file>
        <file>expected_printdatatags.txt</file>
        <file>expected_printdatatagswithglobaltags.txt</file>
        <file>expected_qexecstringlist.txt</file>
--- a/tests/auto/testlib/selftests/tst_selftests.cpp
+++ b/tests/auto/testlib/selftests/tst_selftests.cpp
@ -395,6 +395,7 @@ void tst_Selftests::runSubTest_data()
        << "longstring"
        << "maxwarnings"
        << "multiexec"
+        << "pairdiagnostics"
        << "printdatatags"
        << "printdatatagswithglobaltags"
        << "qexecstringlist"