QTest: DRY test function invocation

Wrap the QMetaMethod::invoke() calls in a helper function in
preparation of filtering execeptions as part of QTBUG-66320. Rename
the existing helper function to make the old documentation comment
redundant.

Pick this back to LTS branch in order to avoid needless code
divergence going forward.

Pick-to: 6.7 6.6 6.5
Change-Id: I34ae24bf23ea21d7063016257908f925fc087298
Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>

1 files changed, 17 insertions, 22 deletions

diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp
index 9a5c088a6e..5db6cbd47b 100644
--- a/src/testlib/qtestcase.cpp
+++ b/src/testlib/qtestcase.cpp
@@ -543,17 +543,17 @@ static int repetitions = 1;
 static bool repeatForever = false;
 static bool skipBlacklisted = false;
 
-/*! \internal
-    Invoke a method of the object without generating warning if the method does not exist
-*/
-static void invokeMethod(QObject *obj, const char *methodName)
+static bool invokeTestMethodIfValid(QMetaMethod m, QObject *obj = QTest::currentTestObject)
+{
+    return m.isValid() && m.invoke(obj, Qt::DirectConnection);
+}
+
+static void invokeTestMethodIfExists(const char *methodName, QObject *obj = QTest::currentTestObject)
 {
     const QMetaObject *metaObject = obj->metaObject();
     int funcIndex = metaObject->indexOfMethod(methodName);
-    if (funcIndex >= 0) {
-        QMetaMethod method = metaObject->method(funcIndex);
-        method.invoke(obj, Qt::DirectConnection);
-    }
+    // doesn't generate a warning if it doesn't exist:
+    invokeTestMethodIfValid(metaObject->method(funcIndex), obj);
 }
 
 int defaultEventDelay()
@@ -637,7 +637,7 @@ static void qPrintDataTags(FILE *stream)
 
     // Get global data tags:
     QTestTable::globalTestTable();
-    invokeMethod(QTest::currentTestObject, "initTestCase_data()");
+    invokeTestMethodIfExists("initTestCase_data()");
     const QTestTable *gTable = QTestTable::globalTestTable();
 
     const QMetaObject *currTestMetaObj = QTest::currentTestObject->metaObject();
@@ -656,7 +656,7 @@ static void qPrintDataTags(FILE *stream)
             QByteArray member;
             member.resize(qstrlen(slot) + qstrlen("_data()") + 1);
             qsnprintf(member.data(), member.size(), "%s_data()", slot);
-            invokeMethod(QTest::currentTestObject, member.constData());
+            invokeTestMethodIfExists(member.constData());
             const int dataCount = table.dataCount();
             localTags.reserve(dataCount);
             for (int j = 0; j < dataCount; ++j)
@@ -1150,8 +1150,7 @@ void TestMethods::invokeTestOnData(int index) const
         bool invokeOk;
         do {
             QTest::inTestFunction = true;
-            if (m_initMethod.isValid())
-                m_initMethod.invoke(QTest::currentTestObject, Qt::DirectConnection);
+            invokeTestMethodIfValid(m_initMethod);
 
             const bool initQuit =
                 QTestResult::skipCurrentTest() || QTestResult::currentTestFailed();
@@ -1163,7 +1162,7 @@ void TestMethods::invokeTestOnData(int index) const
                 QBenchmarkGlobalData::current->context.tag = QLatin1StringView(
                     QTestResult::currentDataTag() ? QTestResult::currentDataTag() : "");
 
-                invokeOk = m_methods[index].invoke(QTest::currentTestObject, Qt::DirectConnection);
+                invokeOk = invokeTestMethodIfValid(m_methods[index]);
                 if (!invokeOk)
                     QTestResult::addFailure("Unable to execute slot", __FILE__, __LINE__);
 
@@ -1176,8 +1175,7 @@ void TestMethods::invokeTestOnData(int index) const
             QTestResult::finishedCurrentTestData();
 
             if (!initQuit) {
-                if (m_cleanupMethod.isValid())
-                    m_cleanupMethod.invoke(QTest::currentTestObject, Qt::DirectConnection);
+                invokeTestMethodIfValid(m_cleanupMethod);
 
                 // Process any deleteLater(), used by event-loop-based apps.
                 // Fixes memleak reports.
@@ -1430,7 +1428,7 @@ bool TestMethods::invokeTest(int index, QLatin1StringView tag, WatchDog *watchDo
 
         if (curGlobalDataIndex == 0) {
             qsnprintf(member, 512, "%s_data()", name.constData());
-            invokeMethod(QTest::currentTestObject, member);
+            invokeTestMethodIfExists(member);
             if (QTestResult::skipCurrentTest())
                 break;
         }
@@ -1776,8 +1774,7 @@ void TestMethods::invokeTests(QObject *testObject) const
     const QMetaObject *metaObject = testObject->metaObject();
     QTEST_ASSERT(metaObject);
     QTestResult::setCurrentTestFunction("initTestCase");
-    if (m_initTestCaseDataMethod.isValid())
-        m_initTestCaseDataMethod.invoke(testObject, Qt::DirectConnection);
+    invokeTestMethodIfValid(m_initTestCaseDataMethod, testObject);
 
     QScopedPointer<WatchDog> watchDog;
     if (!alreadyDebugging()
@@ -1791,8 +1788,7 @@ void TestMethods::invokeTests(QObject *testObject) const
     QSignalDumper::startDump();
 
     if (!QTestResult::skipCurrentTest() && !QTestResult::currentTestFailed()) {
-        if (m_initTestCaseMethod.isValid())
-            m_initTestCaseMethod.invoke(testObject, Qt::DirectConnection);
+        invokeTestMethodIfValid(m_initTestCaseMethod, testObject);
 
         // finishedCurrentTestDataCleanup() resets QTestResult::currentTestFailed(), so use a local copy.
         const bool previousFailed = QTestResult::currentTestFailed();
@@ -1816,8 +1812,7 @@ void TestMethods::invokeTests(QObject *testObject) const
         QTestResult::setSkipCurrentTest(false);
         QTestResult::setBlacklistCurrentTest(false);
         QTestResult::setCurrentTestFunction("cleanupTestCase");
-        if (m_cleanupTestCaseMethod.isValid())
-            m_cleanupTestCaseMethod.invoke(testObject, Qt::DirectConnection);
+        invokeTestMethodIfValid(m_cleanupTestCaseMethod, testObject);
         QTestResult::finishedCurrentTestData();
         // Restore skip state as it affects decision on whether we passed:
         QTestResult::setSkipCurrentTest(wasSkipped || QTestResult::skipCurrentTest());