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