Changes: Use QLatin1String for default arguments
[qtcontacts-tracker:qtcontacts-tracker.git] / tests / ut_qtcontacts_trackerplugin_common / ut_qtcontacts_trackerplugin_common.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the Qt Mobility Components.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** No Commercial Usage
11 ** This file contains pre-release code and may not be distributed.
12 ** You may use this file in accordance with the terms and conditions
13 ** contained in the Technology Preview License Agreement accompanying
14 ** this package.
15 **
16 ** GNU Lesser General Public License Usage
17 ** Alternatively, this file may be used under the terms of the GNU Lesser
18 ** General Public License version 2.1 as published by the Free Software
19 ** Foundation and appearing in the file LICENSE.LGPL included in the
20 ** packaging of this file.  Please review the following information to
21 ** ensure the GNU Lesser General Public License version 2.1 requirements
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23 **
24 ** In addition, as a special exception, Nokia gives you certain additional
25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27 **
28 ** If you have questions regarding the use of this file, please contact
29 ** Nokia at qt-info@nokia.com.
30 **
31 **
32 **
33 **
34 **
35 **
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #ifndef UT_QTCONTACTS_TRACKERPLUGIN_COMMON_H
43 #define UT_QTCONTACTS_TRACKERPLUGIN_COMMON_H
44
45 #include <QContactAbstractRequest>
46 #include <QContactDetailFilter>
47
48 #include <QtSparql>
49 #include <QtTest/QtTest>
50 #include <QtXml/QDomDocument>
51
52 #include <engine/engine.h>
53
54 QTM_USE_NAMESPACE;
55
56 // macro to be used if calling another test function from a test function
57 // there could have been a failing test in that function, so the current function
58 // also needs to return at once
59 // giving the file and line number is useful to get to know the call stack
60 #define CHECK_CURRENT_TEST_FAILED                                               \
61                                                                                 \
62 do {                                                                            \
63     if (QTest::currentTestFailed()) {                                           \
64         qWarning("failing test called from %s(%d)", __FILE__, __LINE__);        \
65         return;                                                                 \
66     }                                                                           \
67 } while (0)
68
69 // macros to deal with multiple contacts:
70 // * nickname works for both normal and group contacts
71 // * using the test run's uuid to namespace contacts from different tests in the same database,
72 // * using __func__ to identify contacts from a test
73 // * using an int index to identify the contacts by order of creation
74 // In the tests use SET_TESTNICKNAME_TO_CONTACT to mark created contacts
75 // and TESTNICKNAME_FILTER for fetch requests to limit to contacts from current test,
76 // add it with a QContactIntersectionFilter to the real filter, if used.
77 #define SET_TESTNICKNAME_TO_CONTACT(c)   setTestNicknameToContact(c, QLatin1String(__func__))
78 #define TESTNICKNAME_FILTER              testNicknameFilter(QLatin1String(__func__))
79
80 typedef QList<QContactLocalId> QContactLocalIdList;
81 typedef QList<QContact> QContactList;
82
83 // create metadata so that those types can be used with QTest library
84 Q_DECLARE_METATYPE(QContact);
85 Q_DECLARE_METATYPE(QContactFilter);
86 Q_DECLARE_METATYPE(QContactLocalIdList);
87 Q_DECLARE_METATYPE(QContactList);
88
89 Q_DECLARE_METATYPE(QList<int>);
90
91 namespace QTest
92 {
93     template<> inline char *toString<QVariant::Type>(const QVariant::Type &type)
94     {
95         return qstrdup(QVariant::typeToName(type));
96     }
97
98     template<> inline char *toString<QContactManager::Error>(const QContactManager::Error &error)
99     {
100 #define DO_CASE(v) case (v): return qstrdup(#v)
101         switch(error) {
102             DO_CASE(QContactManager::NoError);
103             DO_CASE(QContactManager::DoesNotExistError);
104             DO_CASE(QContactManager::AlreadyExistsError);
105             DO_CASE(QContactManager::InvalidDetailError);
106             DO_CASE(QContactManager::InvalidRelationshipError);
107             DO_CASE(QContactManager::LockedError);
108             DO_CASE(QContactManager::DetailAccessError);
109             DO_CASE(QContactManager::PermissionsError);
110             DO_CASE(QContactManager::OutOfMemoryError);
111             DO_CASE(QContactManager::NotSupportedError);
112             DO_CASE(QContactManager::BadArgumentError);
113             DO_CASE(QContactManager::UnspecifiedError);
114             DO_CASE(QContactManager::VersionMismatchError);
115             DO_CASE(QContactManager::LimitReachedError);
116             DO_CASE(QContactManager::InvalidContactTypeError);
117 #undef DO_CASE
118         }
119
120         return qstrdup(qPrintable(QString::fromLatin1("QContactManager::Error(%1)").arg(error)));
121     }
122
123     template<> inline char *toString< QVariantMap >(const QVariantMap &map)
124     {
125         QString result;
126
127         for(QVariantMap::ConstIterator i = map.begin(); i != map.end(); ++i) {
128             if (result.length() > 0) {
129                 result += QLatin1String(", ");
130             }
131
132             char *str(toString(i.value()));
133
134             result +=
135                     QLatin1Char('(') % i.key() % QLatin1String(": ") %
136                     QString::fromLocal8Bit(str) % QLatin1Char(')');
137
138             qFree(str);
139         }
140
141         return qstrdup(qPrintable(QLatin1Char('(') + result + QLatin1Char(')')));
142     }
143
144     template<> inline char *toString< QVariantHash >(const QVariantHash &hash)
145     {
146         QString result;
147
148         for(QVariantHash::ConstIterator i = hash.begin(); i != hash.end(); ++i) {
149             if (result.length() > 0) {
150                 result += QLatin1String(", ");
151             }
152
153             char *str(toString(i.value()));
154
155             result +=
156                     QLatin1Char('(') % i.key() % QLatin1String(": ") %
157                     QString::fromLocal8Bit(str) % QLatin1Char(')');
158
159             qFree(str);
160         }
161
162         return qstrdup(qPrintable(QLatin1Char('(') + result + QLatin1Char(')')));
163     }
164
165     template<> inline char *toString< QList<QString> >(const QList<QString> &list)
166     {
167         return qstrdup(qPrintable(QLatin1String("(\"") +
168                                   QStringList(list).join(QLatin1String("\", \"")) +
169                                   QLatin1String("\")")));
170     }
171
172     template<> inline char *toString< QSet<QString> >(const QSet<QString> &set)
173     {
174         return toString(set.toList());
175     }
176
177     template<> inline char *toString< QList<QUrl> >(const QList<QUrl> &list)
178     {
179         QStringList strList;
180
181         foreach(const QUrl &url, list) {
182             strList += url.toString();
183         }
184
185         return toString< QList<QString> >(strList);
186     }
187
188     template<> inline char *toString< QSet<QUrl> >(const QSet<QUrl> &set)
189     {
190         return toString(set.toList());
191     }
192 }
193
194 class ut_qtcontacts_trackerplugin_common : public QObject
195 {
196     Q_OBJECT;
197
198 public:
199     static const int DefaultTimeout = 5000;
200     static const QList<QContactSortOrder> NoOrder;
201
202     explicit ut_qtcontacts_trackerplugin_common(const QDir &dataDir, const QDir &srcDir,
203                                                 QObject *parent = 0);
204     virtual ~ut_qtcontacts_trackerplugin_common();
205
206 protected slots:
207     // function setup
208     void cleanup();
209
210 protected:
211     QSet<QString> findTestSlotNames();
212
213     void saveContact(QContact &contact, int timeout = DefaultTimeout);
214     void saveContacts(QList<QContact> &contacts, int timeout = DefaultTimeout);
215     void fetchContact(const QContactLocalId &id, QContact &result, int timeout = DefaultTimeout);
216     void fetchContact(const QContactFilter &filter, QContact &result, int timeout = DefaultTimeout);
217     void fetchContactLocalId(const QContactFilter &filter, QContactLocalId &result, int timeout = DefaultTimeout);
218     void fetchContacts(const QList<QContactLocalId> &ids, QList<QContact> &result, int timeout = DefaultTimeout);
219     void fetchContacts(const QContactFilter &filter, QList<QContact> &result, int timeout = DefaultTimeout);
220     void fetchContacts(const QContactFilter &filter, const QList<QContactSortOrder> &sorting, QList<QContact> &result, int timeout = DefaultTimeout);
221     void fetchContactLocalIds(const QContactFilter &filter, QList<QContactLocalId> &result, int timeout = DefaultTimeout);
222     void fetchContactLocalIds(const QContactFilter &filter, const QList<QContactSortOrder> &sorting, QList<QContactLocalId> &result, int timeout = DefaultTimeout);
223     void saveRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
224     void saveRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
225     void fetchRelationship(const QContactId &firstId, const QString &relationshipType, const QContactId &secondId, QContactRelationship &result, int timeout = DefaultTimeout);
226     void fetchRelationships(const QString &relationshipType, const QContactId &participantId, QContactRelationship::Role role, QList<QContactRelationship> &result, int timeout = DefaultTimeout);
227     void removeRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
228     void removeRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
229
230     QList<QContact> parseVCards(const QString &fileName, int limit = INT_MAX);
231     QList<QContact> parseVCards(const QByteArray &vcardData, int limit = INT_MAX);
232
233     virtual QMap<QString, QString> makeEngineParams() const;
234     QContactLocalIdList & localIds() { return mLocalIds; }
235     void registerForCleanup(const QContact &contact) { mLocalIds.append(contact.localId()); }
236     QContactTrackerEngine *engine() const;
237     void resetEngine();
238
239     QString referenceFileName(const QString &fileName);
240     QString loadReferenceFile(const QString &fileName);
241
242     QSparqlResult * executeQuery(const QString &queryString,
243                                        QSparqlQuery::StatementType type);
244
245     QList<QUrl> loadRawTuples(const QString &fileName);
246     QDomDocument loadReferenceContacts(const QString &fileName = QLatin1String("000-contacts.xml"));
247
248     void verifyContacts(const QList<QContact> &candiates, const QDomDocument &reference,
249                         const QStringList &missingIds = QStringList());
250     void verifyContacts(const QList<QContact> &candiates,
251                         const QString &referenceFileName = QLatin1String("000-contacts.xml"),
252                         const QStringList &missingIds = QStringList());
253
254     /// returns the unique identifier of the testrun, extended by the given @p id, if not empty.
255     QString uniqueTestId(const QString& id = QString()) const;
256     /// returns a name which is unique and contains a custom identifier, the given @p id.
257     /// Uniqueness is created by the unique id of the testrun (mNamePrefix) and an increasing number,
258     /// starting from 0000 and ending with 99999 (i.e. ending being useful).
259     /// The number has fixed set of digits, with leading 0, to enable sorting by name in order of creation.
260     /// The created name has this pattern: testClassName:Uuid:idPassedByParameter_12345
261     QString makeUniqueName(const QString &id) const;
262     /// sets a nickname to the contact using the test uuid and the given @p id.
263     /// Use the macro SET_TESTNICKNAME_TO_CONTACT(c) to get the function name as id.
264     void setTestNicknameToContact(QContact &contact, const QString &id) const;
265     /// returns a filter on nicknames using the test uuid and the given @p id.
266     /// Use the macro TESTNICKNAME_FILTER to get a filter with the function name as id.
267     QContactDetailFilter testNicknameFilter(const QString &id) const;
268
269 private:
270     mutable QContactTrackerEngine *mEngine;
271     QContactLocalIdList mLocalIds;
272     QDir mDataDir, mSrcDir;
273     /// unique identifier for a testrun, used e.g. to mark contacts stored in tracker
274     QString mUuid;
275 };
276
277 #endif /* UT_QTCONTACTS_TRACKERPLUGIN_COMMON_H */