[libcommhistory] Use standalone test database when running tests. JB#…

…52802 Use a separate test database instead of polluting the general database when running the tests. This also means the test database can be freely deleted before running each tests, to ensure stray database entries from one tests (e.g. left behind if a test crashes) do not cause failures in following tests when the tests are run in a batch.
sailfishos · Mar 17, 2021 · 2b5ade9 · 2b5ade9
1 parent fcd71fc
commit 2b5ade9
Show file tree

Hide file tree

Showing 20 changed files with 62 additions and 46 deletions.
diff --git a/src/commhistorydatabase.cpp b/src/commhistorydatabase.cpp
@@ -28,12 +28,15 @@
 #include <QSqlQuery>
 #include <QDebug>
 #include <QStandardPaths>
+#include <QCoreApplication>
 
 // Appended to GenericDataLocation (or a hardcoded equivalent on Qt4)
 #define COMMHISTORY_DATABASE_DIR "/commhistory/"
 #define COMMHISTORY_DATABASE_NAME "commhistory.db"
 #define COMMHISTORY_DATA_DIR COMMHISTORY_DATABASE_DIR "data/"
 
+static QString db_root_dir = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation);
+
 static const char *db_setup[] = {
     "PRAGMA temp_store = MEMORY",
     "PRAGMA journal_mode = WAL",
@@ -345,9 +348,14 @@ QSqlQuery CommHistoryDatabase::prepare(const char *statement, const QSqlDatabase
     return query;
 }
 
+void CommHistoryDatabasePath::setRootDir(const QString &rootDir)
+{
+    db_root_dir = rootDir;
+}
+
 QString CommHistoryDatabasePath::databaseDir()
 {
-    return QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QLatin1String(COMMHISTORY_DATABASE_DIR);
+    return db_root_dir + QLatin1String(COMMHISTORY_DATABASE_DIR);
 }
 
 QString CommHistoryDatabasePath::databaseFile()
@@ -357,7 +365,7 @@ QString CommHistoryDatabasePath::databaseFile()
 
 QString CommHistoryDatabasePath::dataDir()
 {
-    return QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + QStringLiteral(COMMHISTORY_DATA_DIR);
+    return db_root_dir + QStringLiteral(COMMHISTORY_DATA_DIR);
 }
 
 QString CommHistoryDatabasePath::dataDir(int id)

diff --git a/src/commhistorydatabasepath.h b/src/commhistorydatabasepath.h
@@ -32,6 +32,8 @@ class LIBCOMMHISTORY_EXPORT CommHistoryDatabasePath
     static QString databaseFile();
     static QString dataDir();
     static QString dataDir(int id);
+
+    static void setRootDir(const QString &rootDir);
 };
 
 #endif
diff --git a/tests/common.cpp b/tests/common.cpp
@@ -56,6 +56,7 @@
 #include "common.h"
 #include "commonutils.h"
 #include "contactlistener.h"
+#include "commhistorydatabasepath.h"
 
 QTCONTACTS_USE_NAMESPACE
 
@@ -142,6 +143,13 @@ quint64 idleTicks = 0;
 QSet<QContactId> addedContactIds;
 QSet<int> addedEventIds;
 
+void initTestDatabase()
+{
+    deleteAll();
+
+    CommHistoryDatabasePath::setRootDir(TEST_DATABASE_DIR);
+}
+
 int addTestEvent(EventModel &model,
                  Event::EventType type,
                  Event::EventDirection direction,
@@ -369,29 +377,6 @@ void deleteTestContact(int id)
     addedContactIds.remove(contactId);
 }
 
-void cleanUpTestContacts()
-{
-    if (!addedContactIds.isEmpty()) {
-        QString aggregatesType = QContactRelationship::Aggregates();
-
-        const QList<QContactId> contactIdsToRemove = addedContactIds.toList();
-        QList<QContact> contactsToRemove;
-        for (const QContactId &contactId : addedContactIds) {
-            const QContactId localId = localContactForAggregate(contactId);
-            QContact localContact = manager()->contact(localId);
-            if (!localContact.isEmpty()) {
-                contactsToRemove.append(localContact);
-            }
-        }
-
-        if (!SeasideCache::removeContacts(contactsToRemove)) {
-            qWarning() << "Unable to remove test contacts:" << addedContactIds;
-        }
-
-        addedContactIds.clear();
-    }
-}
-
 void cleanupTestGroups()
 {
     GroupModel groupModel;
@@ -503,9 +488,20 @@ void deleteAll()
 {
     qDebug() << Q_FUNC_INFO << "- Deleting all";
 
-    cleanUpTestContacts();
     cleanupTestGroups();
     cleanupTestEvents();
+
+    if (!QDir(TEST_DATABASE_DIR).removeRecursively()) {
+        qWarning() << "Unable to remove test database directory:" << TEST_DATABASE_DIR;
+    }
+
+    if (!qgetenv("LIBCONTACTS_TEST_MODE").isEmpty()) {
+        QString contactsDbDir = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation)
+                + QStringLiteral("/system/privileged/Contacts/qtcontacts-sqlite-test");
+        if (!QDir(contactsDbDir).removeRecursively()) {
+            qWarning() << "Unable to remove test contacts database directory:" << contactsDbDir;
+        }
+    }
 }
 
 QString randomMessage(int words)

diff --git a/tests/common.h b/tests/common.h
@@ -30,6 +30,7 @@
 
 #include <QFile>
 #include <QSignalSpy>
+#include <QStandardPaths>
 
 #include <iterator>
 
@@ -51,6 +52,9 @@ void waitForSignal(QObject *object, const char *signal);
 
 using namespace CommHistory;
 
+const QString TEST_DATABASE_DIR = QStandardPaths::writableLocation(QStandardPaths::TempLocation)
+        + "/tests";
+
 const QString ACCOUNT1 = "/org/freedesktop/Telepathy/Account/gabble/jabber/dut_40localhost0";
 const QString ACCOUNT2 = "/org/freedesktop/Telepathy/Account/gabble/jabber/dut2_40localhost0";
 
@@ -65,6 +69,8 @@ const int WAIT_SIGNAL_TIMEOUT = 5000;
 /* Duration of phone calls added with addTestEvent */
 const int TESTCALL_SECS = 100;
 
+void initTestDatabase();
+
 int addTestEvent(EventModel &model,
                  Event::EventType type,
                  Event::EventDirection direction,
@@ -87,7 +93,6 @@ bool addTestContactAddress(int contactId, const QString &remoteUid, const QStrin
 void modifyTestContact(int id, const QString &name, bool favorite = false);
 void deleteTestContact(int id);
 QContactId localContactForAggregate(const QContactId &contactId);
-void cleanUpTestContacts();
 void cleanupTestGroups();
 void cleanupTestEvents();
 bool compareEvents(Event &e1, Event &e2);

diff --git a/tests/mem_eventmodel/mem_eventmodel.cpp b/tests/mem_eventmodel/mem_eventmodel.cpp
@@ -40,7 +40,7 @@ Group group;
 
 void MemEventModelTest::initTestCase()
 {
-    deleteAll();
+    initTestDatabase();
 
     MALLINFO_DUMP("INIT");
 

diff --git a/tests/perf_callmodel/callmodelperftest.cpp b/tests/perf_callmodel/callmodelperftest.cpp
@@ -32,15 +32,15 @@ using namespace CommHistory;
 
 void CallModelPerfTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = new QFile("libcommhistory-performance-test.log");
     if(!logFile->open(QIODevice::Append)) {
         qDebug() << "!!!! Failed to open log file !!!!";
         logFile = 0;
     }
 
     qsrand( QDateTime::currentDateTime().toTime_t() );
-
-    deleteAll();
 }
 
 void CallModelPerfTest::init()

diff --git a/tests/perf_conversationmodel/conversationmodelperftest.cpp b/tests/perf_conversationmodel/conversationmodelperftest.cpp
@@ -33,15 +33,15 @@ using namespace CommHistory;
 
 void ConversationModelPerfTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = new QFile("libcommhistory-performance-test.log");
     if(!logFile->open(QIODevice::Append)) {
         qDebug() << "!!!! Failed to open log file !!!!";
         logFile = 0;
     }
 
     qsrand( QDateTime::currentDateTime().toTime_t() );
-
-    deleteAll();
 }
 
 void ConversationModelPerfTest::init()

diff --git a/tests/perf_groupmodel/groupmodelperftest.cpp b/tests/perf_groupmodel/groupmodelperftest.cpp
@@ -33,15 +33,15 @@ using namespace CommHistory;
 
 void GroupModelPerfTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = new QFile("libcommhistory-performance-test.log");
     if(!logFile->open(QIODevice::Append)) {
         qDebug() << "!!!! Failed to open log file !!!!";
         logFile = 0;
     }
 
     qsrand( QDateTime::currentDateTime().toTime_t() );
-
-    deleteAll();
 }
 
 void GroupModelPerfTest::init()

diff --git a/tests/perf_recentcontactsmodel/recentcontactsmodelperftest.cpp b/tests/perf_recentcontactsmodel/recentcontactsmodelperftest.cpp
@@ -33,15 +33,15 @@ using namespace CommHistory;
 
 void RecentContactsModelPerfTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = new QFile("libcommhistory-performance-test.log");
     if(!logFile->open(QIODevice::Append)) {
         qDebug() << "!!!! Failed to open log file !!!!";
         logFile = 0;
     }
 
     qsrand( QDateTime::currentDateTime().toTime_t() );
-
-    deleteAll();
 }
 
 void RecentContactsModelPerfTest::init()

diff --git a/tests/profile_callmodel/callmodelprofiletest.cpp b/tests/profile_callmodel/callmodelprofiletest.cpp
@@ -34,6 +34,8 @@ using namespace CommHistory;
 
 void CallModelProfileTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = 0;
 
     qsrand( QDateTime::currentDateTime().toTime_t() );

diff --git a/tests/profile_conversationmodel/conversationmodelprofiletest.cpp b/tests/profile_conversationmodel/conversationmodelprofiletest.cpp
@@ -35,6 +35,8 @@ using namespace CommHistory;
 
 void ConversationModelProfileTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = 0;
 
     qsrand( QDateTime::currentDateTime().toTime_t() );

diff --git a/tests/profile_groupmodel/groupmodelprofiletest.cpp b/tests/profile_groupmodel/groupmodelprofiletest.cpp
@@ -33,6 +33,8 @@ using namespace CommHistory;
 
 void GroupModelProfileTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = 0;
 
     qsrand( QDateTime::currentDateTime().toTime_t() );

diff --git a/tests/profile_recentcontactsmodel/recentcontactsmodelprofiletest.cpp b/tests/profile_recentcontactsmodel/recentcontactsmodelprofiletest.cpp
@@ -33,6 +33,8 @@ using namespace CommHistory;
 
 void RecentContactsModelProfileTest::initTestCase()
 {
+    initTestDatabase();
+
     logFile = 0;
 
     qsrand( QDateTime::currentDateTime().toTime_t() );

diff --git a/tests/ut_callmodel/callmodeltest.cpp b/tests/ut_callmodel/callmodeltest.cpp
@@ -60,9 +60,9 @@ QList<TestCallItem> testCalls;
 
 void CallModelTest::initTestCase()
 {
+    initTestDatabase();
     QVERIFY( QDBusConnection::sessionBus().isConnected() );
 
-    deleteAll();
     QTest::qWait(100);
 
     qsrand( QDateTime::currentDateTime().toTime_t() );

diff --git a/tests/ut_conversationmodel/conversationmodeltest.cpp b/tests/ut_conversationmodel/conversationmodeltest.cpp
@@ -40,10 +40,9 @@ ModelWatcher watcher, watcher2;
 
 void ConversationModelTest::initTestCase()
 {
+    initTestDatabase();
     QVERIFY(QDBusConnection::sessionBus().isConnected());
 
-    deleteAll();
-
     loop = new QEventLoop(this);
 
     qsrand(QDateTime::currentDateTime().toTime_t());

diff --git a/tests/ut_eventmodel/eventmodeltest.cpp b/tests/ut_eventmodel/eventmodeltest.cpp
@@ -60,7 +60,7 @@ void EventModelTest::groupsDeletedSlot(const QList<int> &groupIds)
 
 void EventModelTest::initTestCase()
 {
-    deleteAll();
+    initTestDatabase();
 
     qsrand(QDateTime::currentDateTime().toTime_t());
 

diff --git a/tests/ut_groupmodel/groupmodeltest.cpp b/tests/ut_groupmodel/groupmodeltest.cpp
@@ -99,8 +99,7 @@ void GroupModelTest::dataChangedSlot(const QModelIndex &start, const QModelIndex
 
 void GroupModelTest::initTestCase()
 {
-    deleteAll();
-    QTest::qWait(100);
+    initTestDatabase();
 
     QVERIFY(QDBusConnection::sessionBus().isConnected());
 

diff --git a/tests/ut_recentcontactsmodel/recentcontactsmodeltest.cpp b/tests/ut_recentcontactsmodel/recentcontactsmodeltest.cpp
@@ -126,10 +126,9 @@ private Q_SLOTS:
 
 void RecentContactsModelTest::initTestCase()
 {
+    initTestDatabase();
     QVERIFY(QDBusConnection::sessionBus().isConnected());
 
-    deleteAll();
-
     qsrand(QDateTime::currentDateTime().toTime_t());
 
     addTestGroups( group1, group2 );

diff --git a/tests/ut_recipienteventmodel/recipienteventmodeltest.cpp b/tests/ut_recipienteventmodel/recipienteventmodeltest.cpp
@@ -34,7 +34,7 @@ Group group1, group2;
 
 void RecipientEventModelTest::initTestCase()
 {
-    deleteAll();
+    initTestDatabase();
 
     qsrand(QDateTime::currentDateTime().toTime_t());
 }

diff --git a/tests/ut_singleeventmodel/singleeventmodeltest.cpp b/tests/ut_singleeventmodel/singleeventmodeltest.cpp
@@ -18,7 +18,7 @@ ModelWatcher watcher;
 
 void SingleEventModelTest::initTestCase()
 {
-    deleteAll();
+    initTestDatabase();
 
     qsrand(QDateTime::currentDateTime().toTime_t());