Changes: merge utils to identify contacts from the tests into ut_qtcontacts_trackerpl...
[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 #include <QtTest/QtTest>
48 #include <QtXml/QDomDocument>
49
50 #include <engine/engine.h>
51
52 QTM_USE_NAMESPACE;
53
54 // macro to be used if calling another test function from a test function
55 // there could have been a failing test in that function, so the current function
56 // also needs to return at once
57 // giving the file and line number is useful to get to know the call stack
58 #define CHECK_CURRENT_TEST_FAILED                                               \
59                                                                                 \
60 do {                                                                            \
61     if (QTest::currentTestFailed()) {                                           \
62         qWarning("failing test called from %s(%d)", __FILE__, __LINE__);        \
63         return;                                                                 \
64     }                                                                           \
65 } while (0)
66
67 // macros to deal with multiple contacts:
68 // * nickname works for both normal and group contacts
69 // * using the test run's uuid to namespace contacts from different tests in the same database,
70 // * using __func__ to identify contacts from a test
71 // * using an int index to identify the contacts by order of creation
72 // In the tests use SET_TESTNICKNAME_TO_CONTACT to mark created contacts
73 // and TESTNICKNAME_FILTER for fetch requests to limit to contacts from current test,
74 // add it with a QContactIntersectionFilter to the real filter, if used.
75 #define SET_TESTNICKNAME_TO_CONTACT(c)   setTestNicknameToContact(c, __func__)
76 #define TESTNICKNAME_FILTER              testNicknameFilter(__func__)
77
78 typedef QList<QContactLocalId> QContactLocalIdList;
79 typedef QList<QContact> QContactList;
80
81 // create metadata so that those types can be used with QTest library
82 Q_DECLARE_METATYPE(QContact);
83 Q_DECLARE_METATYPE(QContactFilter);
84 Q_DECLARE_METATYPE(QContactLocalIdList);
85 Q_DECLARE_METATYPE(QContactList);
86
87 Q_DECLARE_METATYPE(QList<int>);
88
89 namespace QTest
90 {
91     template<> inline char *toString<QVariant::Type>(const QVariant::Type &type)
92     {
93         return qstrdup(QVariant::typeToName(type));
94     }
95
96     template<> inline char *toString<QContactManager::Error>(const QContactManager::Error &error)
97     {
98 #define DO_CASE(v) case (v): return qstrdup(#v)
99         switch(error) {
100             DO_CASE(QContactManager::NoError);
101             DO_CASE(QContactManager::DoesNotExistError);
102             DO_CASE(QContactManager::AlreadyExistsError);
103             DO_CASE(QContactManager::InvalidDetailError);
104             DO_CASE(QContactManager::InvalidRelationshipError);
105             DO_CASE(QContactManager::LockedError);
106             DO_CASE(QContactManager::DetailAccessError);
107             DO_CASE(QContactManager::PermissionsError);
108             DO_CASE(QContactManager::OutOfMemoryError);
109             DO_CASE(QContactManager::NotSupportedError);
110             DO_CASE(QContactManager::BadArgumentError);
111             DO_CASE(QContactManager::UnspecifiedError);
112             DO_CASE(QContactManager::VersionMismatchError);
113             DO_CASE(QContactManager::LimitReachedError);
114             DO_CASE(QContactManager::InvalidContactTypeError);
115 #undef DO_CASE
116         }
117
118         return qstrdup(qPrintable(QString("QContactManager::Error(%1)").arg(error)));
119     }
120
121     template<> inline char *toString< QVariantMap >(const QVariantMap &map)
122     {
123         QString result;
124
125         for(QVariantMap::ConstIterator i = map.begin(); i != map.end(); ++i) {
126             if (result.length() > 0) {
127                 result +=", ";
128             }
129
130             char *str(toString(i.value()));
131             result += "(" + i.key() + ": " + str + ")";
132             qFree(str);
133         }
134
135         return qstrdup(qPrintable("(" + result + ")"));
136     }
137
138     template<> inline char *toString< QVariantHash >(const QVariantHash &hash)
139     {
140         QString result;
141
142         for(QVariantHash::ConstIterator i = hash.begin(); i != hash.end(); ++i) {
143             if (result.length() > 0) {
144                 result +=", ";
145             }
146
147             char *str(toString(i.value()));
148             result += "(" + i.key() + ": " + str + ")";
149             qFree(str);
150         }
151
152         return qstrdup(qPrintable("(" + result + ")"));
153     }
154
155     template<> inline char *toString< QList<QString> >(const QList<QString> &list)
156     {
157         return qstrdup(qPrintable("(\"" + QStringList(list).join("\", \"") + "\")"));
158     }
159
160     template<> inline char *toString< QSet<QString> >(const QSet<QString> &set)
161     {
162         return toString(set.toList());
163     }
164
165     template<> inline char *toString< QList<QUrl> >(const QList<QUrl> &list)
166     {
167         QStringList strList;
168
169         foreach(const QUrl &url, list) {
170             strList += url.toString();
171         }
172
173         return toString< QList<QString> >(strList);
174     }
175
176     template<> inline char *toString< QSet<QUrl> >(const QSet<QUrl> &set)
177     {
178         return toString(set.toList());
179     }
180 }
181
182 class ut_qtcontacts_trackerplugin_common : public QObject
183 {
184     Q_OBJECT;
185
186 public:
187     static const int DefaultTimeout = 5000;
188     static const QList<QContactSortOrder> NoOrder;
189
190     explicit ut_qtcontacts_trackerplugin_common(const QDir &dataDir, const QDir &srcDir,
191                                                 QObject *parent = 0);
192     virtual ~ut_qtcontacts_trackerplugin_common();
193
194 protected slots:
195     // function setup
196     void cleanup();
197
198 protected:
199     QSet<QString> findTestSlotNames();
200
201     void saveContact(QContact &contact, int timeout = DefaultTimeout);
202     void saveContacts(QList<QContact> &contacts, int timeout = DefaultTimeout);
203     void fetchContact(const QContactLocalId &id, QContact &result, int timeout = DefaultTimeout);
204     void fetchContact(const QContactFilter &filter, QContact &result, int timeout = DefaultTimeout);
205     void fetchContactLocalId(const QContactFilter &filter, QContactLocalId &result, int timeout = DefaultTimeout);
206     void fetchContacts(const QList<QContactLocalId> &ids, QList<QContact> &result, int timeout = DefaultTimeout);
207     void fetchContacts(const QContactFilter &filter, QList<QContact> &result, int timeout = DefaultTimeout);
208     void fetchContacts(const QContactFilter &filter, const QList<QContactSortOrder> &sorting, QList<QContact> &result, int timeout = DefaultTimeout);
209     void fetchContactLocalIds(const QContactFilter &filter, QList<QContactLocalId> &result, int timeout = DefaultTimeout);
210     void fetchContactLocalIds(const QContactFilter &filter, const QList<QContactSortOrder> &sorting, QList<QContactLocalId> &result, int timeout = DefaultTimeout);
211     void saveRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
212     void saveRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
213     void fetchRelationship(const QContactId &firstId, const QString &relationshipType, const QContactId &secondId, QContactRelationship &result, int timeout = DefaultTimeout);
214     void fetchRelationships(const QString &relationshipType, const QContactId &participantId, QContactRelationship::Role role, QList<QContactRelationship> &result, int timeout = DefaultTimeout);
215     void removeRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
216     void removeRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
217
218     QList<QContact> parseVCards(const QString &fileName, int limit = INT_MAX);
219     QList<QContact> parseVCards(const QByteArray &vcardData, int limit = INT_MAX);
220
221     virtual QMap<QString, QString> makeEngineParams();
222     QContactLocalIdList & localIds() { return mLocalIds; }
223     void registerForCleanup(const QContact &contact) { mLocalIds.append(contact.localId()); }
224     QContactTrackerEngine *engine();
225     void resetEngine();
226
227     QString referenceFileName(const QString &fileName);
228     QString loadReferenceFile(const QString &fileName);
229     QList<QUrl> loadRawTuples(const QString &fileName);
230     QDomDocument loadReferenceContacts(const QString &fileName = "000-contacts.xml");
231
232     void verifyContacts(const QList<QContact> &candiates, const QDomDocument &reference,
233                         const QStringList &missingIds = QStringList());
234     void verifyContacts(const QList<QContact> &candiates,
235                         const QString &referenceFileName = "000-contacts.xml",
236                         const QStringList &missingIds = QStringList());
237
238     /// returns the unique identifier of the testrun, extended by the given @p id, if not empty.
239     QString uniqueTestId(const QString& id = QString()) const;
240     /// returns a name which is unique and contains a custom identifier, the given @p id.
241     /// Uniqueness is created by the unique id of the testrun (mNamePrefix) and an increasing number,
242     /// starting from 0000 and ending with 99999 (i.e. ending being useful).
243     /// The number has fixed set of digits, with leading 0, to enable sorting by name in order of creation.
244     /// The created name has this pattern: testClassName:Uuid:idPassedByParameter_12345
245     QString makeUniqueName(const QString &id) const;
246     /// sets a nickname to the contact using the test uuid and the given @p id.
247     /// Use the macro SET_TESTNICKNAME_TO_CONTACT(c) to get the function name as id.
248     void setTestNicknameToContact(QContact &contact, const QString &id) const;
249     /// returns a filter on nicknames using the test uuid and the given @p id.
250     /// Use the macro TESTNICKNAME_FILTER to get a filter with the function name as id.
251     QContactDetailFilter testNicknameFilter(const QString &id) const;
252
253 private:
254     QContactTrackerEngine *mEngine;
255     QContactLocalIdList mLocalIds;
256     QDir mDataDir, mSrcDir;
257     /// unique identifier for a testrun, used e.g. to mark contacts stored in tracker
258     QString mUuid;
259 };
260
261 #endif /* UT_QTCONTACTS_TRACKERPLUGIN_COMMON_H */