Improve stability of unit tests when running them with Valgrind

I noticed unexpected unit test failures when running the tests with
Valgrind. The reason was that test execution was slowed down a lot,
such that that TestBase::waitForFinishedPathLoading() did not receive
the view's signal within the default timeout of 2 seconds, and that
this failure was not detected in every test -> the tests failed later
on because not all expected items had been loaded yet.

To fix this, I changed two things:
1. Added an assert in TestBase::waitForFinishedPathLoading() that checks
if the signal has been received. Continuing does not make much sense if
that is not the case.
2. Increased the default timeout to 20 seconds. The reason why there is
a finite timeout at all is that I didn't want to waste too much time on
machines where the file kioslave seems to have problems loading a
directory (I've seen corresponding test logs at cdash.org). However, with
the first change I mentioned above, the waiting time is lost only once
(due to the assert) rather than every time a directory is loaded
-> I think that the timeout increase does not lead to an increased waste
of time on such machines.

diff --git a/src/tests/dolphindetailsviewtest.cpp b/src/tests/dolphindetailsviewtest.cpp
index 2aaf95e01a6fe481b9ef17bd6ca9089904883ae7..31b4a57cdde64e630b0decad2e1de0b1b6f5cf3e 100644 (file)
--- a/src/tests/dolphindetailsviewtest.cpp
+++ b/src/tests/dolphindetailsviewtest.cpp
@@ -68,7 +68,7 @@ private:
         // while we were waiting in QTest::qWaitForWindowShown(view)
         // -> waitForFinishedPathLoading(view) would fail in that case.
         if (spyFinishedPathLoading.isEmpty()) {
-            Q_ASSERT(waitForFinishedPathLoading(view));
+            waitForFinishedPathLoading(view);
         }
 
         return detailsView;
@@ -121,7 +121,7 @@ void DolphinDetailsViewTest::testExpandedUrls()
 
         // Before we proceed, we have to make sure that the view has finished
         // loading the contents of the expanded folder.
-        QVERIFY(waitForFinishedPathLoading(&view));
+        waitForFinishedPathLoading(&view);
     }
 
     // Collapse URLs one by one and verify the result of DolphinDetailsView::expandedUrls()

diff --git a/src/tests/dolphinviewtest_allviewmodes.cpp b/src/tests/dolphinviewtest_allviewmodes.cpp
index 409b1b0ac898e43826e885f180892316b580d192..79c3ed47800d43069047f318156e29f5e2238c3e 100644 (file)
--- a/src/tests/dolphinviewtest_allviewmodes.cpp
+++ b/src/tests/dolphinviewtest_allviewmodes.cpp
@@ -198,7 +198,7 @@ void DolphinViewTest_AllViewModes::testViewPropertySettings()
     // Show hidden files. This triggers the dir lister
     // -> we have to wait until loading the hidden files is finished
     view.setShowHiddenFiles(true);
-    QVERIFY(waitForFinishedPathLoading(&view));
+    waitForFinishedPathLoading(&view);
     QVERIFY(view.showHiddenFiles());
     QCOMPARE(viewItems(&view), QStringList() << ".f" << "a" << "b" << "c" << "d" << "e");
 
@@ -332,12 +332,12 @@ void DolphinViewTest_AllViewModes::testSaveAndRestoreState()
 
     // Change the URL
     view.setUrl(dir.name() + "51");
-    QVERIFY(waitForFinishedPathLoading(&view));
+    waitForFinishedPathLoading(&view);
     qApp->sendPostedEvents();
 
     // Go back, but do not call DolphinView::restoreState()
     view.setUrl(dir.url());
-    QVERIFY(waitForFinishedPathLoading(&view));
+    waitForFinishedPathLoading(&view);
     qApp->sendPostedEvents();
 
     // Verify that the view is scrolled to top-left corner and that item 45 is not the current item.
@@ -351,7 +351,7 @@ void DolphinViewTest_AllViewModes::testSaveAndRestoreState()
 
     // Change the URL again
     view.setUrl(dir.name() + "51");
-    QVERIFY(waitForFinishedPathLoading(&view));
+    waitForFinishedPathLoading(&view);
     qApp->sendPostedEvents();
 
     // Check that the current item and scroll position are correct if DolphinView::restoreState()
@@ -359,7 +359,7 @@ void DolphinViewTest_AllViewModes::testSaveAndRestoreState()
     view.setUrl(dir.url());
     QDataStream restoreStream(viewState);
     view.restoreState(restoreStream);
-    QVERIFY(waitForFinishedPathLoading(&view));
+    waitForFinishedPathLoading(&view);
     qApp->sendPostedEvents();
 
     QCOMPARE(itemView(&view)->currentIndex(), index45);
@@ -391,7 +391,7 @@ void DolphinViewTest_AllViewModes::testSaveAndRestoreState()
     qApp->sendPostedEvents();
     if (!spy.isEmpty()) {
         // The dir lister reloads the directory. We wait until the loading is finished.
-        QVERIFY(waitForFinishedPathLoading(&view));
+        waitForFinishedPathLoading(&view);
     }
 
     // Current item and scroll position should not change.
@@ -555,7 +555,7 @@ QAbstractItemView* DolphinViewTest_AllViewModes::initView(DolphinView* view) con
     // while we were waiting in QTest::qWaitForWindowShown(view)
     // -> waitForFinishedPathLoading(view) would fail in that case.
     if (spyFinishedPathLoading.isEmpty()) {
-        Q_ASSERT(waitForFinishedPathLoading(view));
+        waitForFinishedPathLoading(view);
     }
 
     return itemView(view);

diff --git a/src/tests/testbase.cpp b/src/tests/testbase.cpp
index 52dc59a63f7dc03a942af7a4f5f3e942ebd1c58b..de323aac24f28af4b07ec5426e02cbee711e1308 100644 (file)
--- a/src/tests/testbase.cpp
+++ b/src/tests/testbase.cpp
@@ -33,15 +33,19 @@ QAbstractItemView* TestBase::itemView(const DolphinView* view)
     return view->m_viewAccessor.itemView();
 }
 
-bool TestBase::waitForFinishedPathLoading(DolphinView* view, int milliseconds)
+void TestBase::waitForFinishedPathLoading(DolphinView* view, int milliseconds)
 {
-    return QTest::kWaitForSignal(view, SIGNAL(finishedPathLoading(const KUrl&)), milliseconds);
+    // If the signal is not received, somthing is going seriously wrong.
+    // -> assert here rather than continuing, which might result in test failures which are hard to unterstand.
+    bool viewHasFinishedLoading = QTest::kWaitForSignal(view, SIGNAL(finishedPathLoading(const KUrl&)), milliseconds);
+    Q_ASSERT(viewHasFinishedLoading);
+    Q_UNUSED(viewHasFinishedLoading) // suppress compiler warining is asserts are disabled
 }
 
 void TestBase::reloadViewAndWait(DolphinView* view)
 {
     view->reload();
-    QVERIFY(waitForFinishedPathLoading(view));
+    waitForFinishedPathLoading(view);
 }
 
 QStringList TestBase::viewItems(const DolphinView* view)

diff --git a/src/tests/testbase.h b/src/tests/testbase.h
index 433319db38e3c702a65e758e0125b4d40dfe188c..957d822c3bff83c1198db93016b28a66b750a512 100644 (file)
--- a/src/tests/testbase.h
+++ b/src/tests/testbase.h
@@ -49,9 +49,9 @@ public:
 
     /**
      * Waits until the view emits its finishedPathLoading(const KUrl&) signal.
-     * Returns false if it is not received within the given number of milliseconds.
+     * Asserts if the signal is not received within the given number of milliseconds.
      */
-    static bool waitForFinishedPathLoading(DolphinView* view, int milliseconds=2000);
+    static void waitForFinishedPathLoading(DolphinView* view, int milliseconds=20000);
 
     /** Reloads the view and waits for the finishedPathLoading(const KUrl&) signal. */
     static void reloadViewAndWait(DolphinView* view);