Changes: add registerForCleanup(QContact)
[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 typedef QList<QContactLocalId> QContactLocalIdList;
68 typedef QList<QContact> QContactList;
69
70 // create metadata so that those types can be used with QTest library
71 Q_DECLARE_METATYPE(QContact);
72 Q_DECLARE_METATYPE(QContactFilter);
73 Q_DECLARE_METATYPE(QContactLocalIdList);
74 Q_DECLARE_METATYPE(QContactList);
75
76 Q_DECLARE_METATYPE(QList<int>);
77
78 namespace QTest
79 {
80     template<> inline char *toString<QVariant::Type>(const QVariant::Type &type)
81     {
82         return qstrdup(QVariant::typeToName(type));
83     }
84
85     template<> inline char *toString<QContactManager::Error>(const QContactManager::Error &error)
86     {
87 #define DO_CASE(v) case (v): return qstrdup(#v)
88         switch(error) {
89             DO_CASE(QContactManager::NoError);
90             DO_CASE(QContactManager::DoesNotExistError);
91             DO_CASE(QContactManager::AlreadyExistsError);
92             DO_CASE(QContactManager::InvalidDetailError);
93             DO_CASE(QContactManager::InvalidRelationshipError);
94             DO_CASE(QContactManager::LockedError);
95             DO_CASE(QContactManager::DetailAccessError);
96             DO_CASE(QContactManager::PermissionsError);
97             DO_CASE(QContactManager::OutOfMemoryError);
98             DO_CASE(QContactManager::NotSupportedError);
99             DO_CASE(QContactManager::BadArgumentError);
100             DO_CASE(QContactManager::UnspecifiedError);
101             DO_CASE(QContactManager::VersionMismatchError);
102             DO_CASE(QContactManager::LimitReachedError);
103             DO_CASE(QContactManager::InvalidContactTypeError);
104 #undef DO_CASE
105         }
106
107         return qstrdup(qPrintable(QString("QContactManager::Error(%1)").arg(error)));
108     }
109
110     template<> inline char *toString< QVariantMap >(const QVariantMap &map)
111     {
112         QString result;
113
114         for(QVariantMap::ConstIterator i = map.begin(); i != map.end(); ++i) {
115             if (result.length() > 0) {
116                 result +=", ";
117             }
118
119             char *str(toString(i.value()));
120             result += "(" + i.key() + ": " + str + ")";
121             qFree(str);
122         }
123
124         return qstrdup(qPrintable("(" + result + ")"));
125     }
126
127     template<> inline char *toString< QVariantHash >(const QVariantHash &hash)
128     {
129         QString result;
130
131         for(QVariantHash::ConstIterator i = hash.begin(); i != hash.end(); ++i) {
132             if (result.length() > 0) {
133                 result +=", ";
134             }
135
136             char *str(toString(i.value()));
137             result += "(" + i.key() + ": " + str + ")";
138             qFree(str);
139         }
140
141         return qstrdup(qPrintable("(" + result + ")"));
142     }
143
144     template<> inline char *toString< QList<QString> >(const QList<QString> &list)
145     {
146         return qstrdup(qPrintable("(\"" + QStringList(list).join("\", \"") + "\")"));
147     }
148
149     template<> inline char *toString< QSet<QString> >(const QSet<QString> &set)
150     {
151         return toString(set.toList());
152     }
153
154     template<> inline char *toString< QList<QUrl> >(const QList<QUrl> &list)
155     {
156         QStringList strList;
157
158         foreach(const QUrl &url, list) {
159             strList += url.toString();
160         }
161
162         return toString< QList<QString> >(strList);
163     }
164
165     template<> inline char *toString< QSet<QUrl> >(const QSet<QUrl> &set)
166     {
167         return toString(set.toList());
168     }
169 }
170
171 class ut_qtcontacts_trackerplugin_common : public QObject
172 {
173     Q_OBJECT;
174
175 public:
176     static const int DefaultTimeout = 5000;
177
178     explicit ut_qtcontacts_trackerplugin_common(const QDir &dataDir, const QDir &srcDir,
179                                                 QObject *parent = 0);
180     virtual ~ut_qtcontacts_trackerplugin_common();
181
182 private slots:
183     // function setup
184     void cleanup();
185
186 protected:
187     QSet<QString> findTestSlotNames();
188
189     void saveContact(QContact &contact, int timeout = DefaultTimeout);
190     void saveContacts(QList<QContact> &contacts, int timeout = DefaultTimeout);
191     void fetchContact(const QContactLocalId &id, QContact &result, int timeout = DefaultTimeout);
192     void fetchContact(const QContactFilter &filter, QContact &result, int timeout = DefaultTimeout);
193     void fetchContactLocalId(const QContactFilter &filter, QContactLocalId &result, int timeout = DefaultTimeout);
194     void fetchContacts(const QList<QContactLocalId> &ids, QList<QContact> &result, int timeout = DefaultTimeout);
195     void fetchContacts(const QContactFilter &filter, QList<QContact> &result, int timeout = DefaultTimeout);
196     void fetchContactLocalIds(const QContactFilter &filter, QList<QContactLocalId> &result, int timeout = DefaultTimeout);
197     void saveRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
198     void saveRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
199     void fetchRelationship(const QContactId &firstId, const QString &relationshipType, const QContactId &secondId, QContactRelationship &result, int timeout = DefaultTimeout);
200     void fetchRelationships(const QString &relationshipType, const QContactId &participantId, QContactRelationship::Role role, QList<QContactRelationship> &result, int timeout = DefaultTimeout);
201     void removeRelationship(const QContactRelationship &relationship, int timeout = DefaultTimeout);
202     void removeRelationships(const QList<QContactRelationship> &relationships, int timeout = DefaultTimeout);
203
204     QList<QContact> parseVCards(const QString &fileName, int limit = INT_MAX);
205     QList<QContact> parseVCards(const QByteArray &vcardData, int limit = INT_MAX);
206
207     virtual QMap<QString, QString> makeEngineParams();
208     QContactLocalIdList & localIds() { return mLocalIds; }
209     void registerForCleanup(const QContact &contact) { mLocalIds.append(contact.localId()); }
210     QContactTrackerEngine *engine();
211     void resetEngine();
212
213     QString referenceFileName(const QString &fileName);
214     QUrl referenceFileUrl(const QString &fileName);
215     QString loadReferenceFile(const QString &fileName);
216     QList<QUrl> fillAddressbook(const QString &fileName = "000-contacts.ttl");
217     QDomDocument loadReferenceContacts(const QString &fileName = "000-contacts.xml");
218
219     void verifyContacts(const QList<QContact> &candiates, const QDomDocument &reference,
220                         const QStringList &missingIds = QStringList());
221     void verifyContacts(const QList<QContact> &candiates,
222                         const QString &referenceFileName = "000-contacts.xml",
223                         const QStringList &missingIds = QStringList());
224
225 private:
226     QContactTrackerEngine *mEngine;
227     QContactLocalIdList mLocalIds;
228     QDir mDataDir, mSrcDir;
229 };
230
231 #endif /* UT_QTCONTACTS_TRACKERPLUGIN_COMMON_H */