/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include <QtTest/QtTest>

#include <QObject>

#include <qtcontacts.h>

#ifdef SYMBIANSIM_BACKEND_USE_ETEL_TESTSERVER

#include <etelmm_etel_test_server.h>

#else

#include <etelmm.h>

#endif

#include <mmtsy_names.h>

QTM_USE_NAMESPACE

#ifndef QTRY_COMPARE

#define QTRY_COMPARE(__expr, __expected) \

    do { \

        const int __step = 50; \

        const int __timeout = 5000; \

        if ((__expr) != (__expected)) { \

            QTest::qWait(0); \

        } \

        for (int __i = 0; __i < __timeout && ((__expr) != (__expected)); __i+=__step) { \

            QTest::qWait(__step); \

        } \

        QCOMPARE(__expr, __expected); \

    } while(0)

#endif

//TESTED_CLASS=

//TESTED_FILES=

/*!

*/

class tst_SimCM : public QObject

{

Q_OBJECT

public:

    tst_SimCM();

    virtual ~tst_SimCM();

public slots:

    void init();

    void cleanup();

    void initTestCase();

    void cleanupTestCase();

private slots:

    /* Test cases that need data */

    void initManager_data();

    void initManager();

    void hasFeature_data();

    void hasFeature();

    void supportedContactTypes_data();

    void supportedContactTypes();

    void detailDefinitions_data();

    void detailDefinitions();

    void addContact_data();

    void addContact();

    void fetchContacts_data();

    void fetchContacts();

    void updateContactDetail_data();

    void updateContactDetail();

    void batchOperations_data();

    void batchOperations();

    /* Test cases that take no data */

    void signalEmission();

private:

    void initManager(QString simStore);

    void getEtelStoreInfoL(const TDesC &phonebook, TDes8 &infoPckg) const;

    bool isContactSupported(QContact contact);

    void parseDetails(QContact &contact, QStringList details, QList<QContactDetail> &parsedDetails);

    void compareDetails(QContact contact, QList<QContactDetail> expectedDetails);

    QContact createContact(QString name, QString number);

private:

    QContactManager* m_cm;

    RMobilePhoneBookStore::TMobilePhoneBookInfoV5 m_etelStoreInfo;

    RMobilePhoneBookStore::TMobilePhoneBookInfoV5Pckg m_etelStoreInfoPckg;

};

tst_SimCM::tst_SimCM() :

    m_cm(0),

    m_etelStoreInfoPckg(m_etelStoreInfo)

{

}

tst_SimCM::~tst_SimCM()

{

}

void tst_SimCM::init()

{

    // remove all contacts

    QList<QContactLocalId> ids = m_cm->contactIds();

    m_cm->removeContacts(&ids, 0);   

}

void tst_SimCM::cleanup()

{

    // remove all contacts

    QList<QContactLocalId> ids = m_cm->contactIds();

    m_cm->removeContacts(&ids, 0);   

}

void tst_SimCM::initTestCase()

{

    initManager(QString());

    // TODO: how about other stores?

    TRAPD(err, getEtelStoreInfoL(KETelIccAdnPhoneBook, m_etelStoreInfoPckg));

    QCOMPARE(err, KErrNone);

}

void tst_SimCM::cleanupTestCase()

{

    delete m_cm;

    m_cm = 0;

}

void tst_SimCM::initManager_data()

{

    QTest::addColumn<QString>("simStore"); // empty (defaults to ADN), "ADN", "SDN" or "FDN"

    QString es = QString();

    QTest::newRow("Empty store string (defaults to ADN store)") << es;

    QTest::newRow("Initialize SDN store") << "SDN";

    QTest::newRow("Initialize FDN store") << "FDN";

    QTest::newRow("Initialize ADN store") << "ADN";

}

void tst_SimCM::initManager()

{

    delete m_cm;

    m_cm = 0;

    QString uri("qtcontacts:symbiansim");

    // Set the sim store if available (simbackend defaults to ADN if not available)

    QFETCH(QString, simStore);

    if(!simStore.isEmpty()) {

        uri.append(":store=");

        uri.append(simStore);

    }

    m_cm = QContactManager::fromUri(uri);

    QVERIFY(m_cm);

    // NotSupportedError is allowed (the sim card may not support FDN and SDN stores)

    if(m_cm->error() == QContactManager::NotSupportedError) {

        QSKIP("The store not supported by the SIM card", SkipSingle);

    } else {

        QCOMPARE(m_cm->error(), QContactManager::NoError);

    }

}

void tst_SimCM::initManager(QString simStore)

{

    delete m_cm;

    m_cm = 0;

    QString uri("qtcontacts:symbiansim");

    // Set the sim store if available (simbackend defaults to ADN if not available)

    if(!simStore.isEmpty()) {

        uri.append(":store=");

        uri.append(simStore);

    }

    m_cm = QContactManager::fromUri(uri);

}

void tst_SimCM::hasFeature_data()

{

    QTest::addColumn<QString>("simStore");      // empty (defaults to ADN), "ADN", "SDN" or "FDN"

    QTest::addColumn<int>("managerFeature");              // one of QContactManager::ManagerFeature

    QTest::addColumn<bool>("expectedResult");   // true = has feature, false = does not have feature

    QString es = QString();

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::Groups << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::ActionPreferences << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::MutableDefinitions << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::Relationships << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::ArbitraryRelationshipTypes << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::RelationshipOrdering << false;

    // TODO: self contact may be supported on ADN? (so called "own number store")

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::SelfContact << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::Anonymous << false;

    QTest::newRow("ADN store (default)") << es << (int) QContactManager::ChangeLogs << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::Groups << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::ActionPreferences << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::MutableDefinitions << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::Relationships << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::ArbitraryRelationshipTypes << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::RelationshipOrdering << false;

    // TODO: self contact may be supported on ADN? (so called "own number store")

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::SelfContact << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::Anonymous << false;

    QTest::newRow("ADN store") << "ADN" << (int) QContactManager::ChangeLogs << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::Groups << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::ActionPreferences << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::MutableDefinitions << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::Relationships << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::ArbitraryRelationshipTypes << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::RelationshipOrdering << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::SelfContact << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::Anonymous << false;

    QTest::newRow("SDN store") << "SDN" << (int) QContactManager::ChangeLogs << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::Groups << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::ActionPreferences << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::MutableDefinitions << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::Relationships << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::ArbitraryRelationshipTypes << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::RelationshipOrdering << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::SelfContact << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::Anonymous << false;

    QTest::newRow("FDN store") << "FDN" << (int) QContactManager::ChangeLogs << false;

}

void tst_SimCM::hasFeature()

{

    // initialize

    QFETCH(QString, simStore);

    initManager(simStore);

    QVERIFY(m_cm);

    if(m_cm->error() == QContactManager::NotSupportedError) {

        QSKIP("The store not supported by the SIM card", SkipSingle);

    }

    QFETCH(bool, expectedResult);

    QFETCH(int, managerFeature);

    // verify

    QCOMPARE(m_cm->hasFeature((QContactManager::ManagerFeature) managerFeature), expectedResult);

    QCOMPARE(m_cm->hasFeature((QContactManager::ManagerFeature) managerFeature, QContactType::TypeContact), expectedResult);

    QCOMPARE(m_cm->hasFeature((QContactManager::ManagerFeature) managerFeature, QContactType::TypeGroup), expectedResult);

}

void tst_SimCM::supportedContactTypes_data()

{

    QTest::addColumn<QString>("simStore");

    QTest::newRow("custom label") << "ADN";

    QTest::newRow("custom label") << "SDN";

    QTest::newRow("custom label") << "FDN";

}

void tst_SimCM::supportedContactTypes()

{

    QFETCH(QString, simStore);

    initManager(simStore);

    QVERIFY(m_cm);

    if(m_cm->error() == QContactManager::NotSupportedError) {

        QSKIP("The store not supported by the SIM card", SkipSingle);

    }

    QStringList types = m_cm->supportedContactTypes();

    QCOMPARE(m_cm->error(), QContactManager::NoError);

    QVERIFY(types.count() > 0);

    // Contacts should always be supported

    QVERIFY(types.contains(QContactType::TypeContact));

    // Groups should not be supported

    QVERIFY(!types.contains(QContactType::TypeGroup));

}

void tst_SimCM::detailDefinitions_data()

{

    QTest::addColumn<QString>("simStore");

    QTest::newRow("custom label") << "ADN";

    QTest::newRow("custom label") << "SDN";

    QTest::newRow("custom label") << "FDN";

}

void tst_SimCM::detailDefinitions()

{

    QFETCH(QString, simStore);

    initManager(simStore);

    QVERIFY(m_cm);

    if(m_cm->error() == QContactManager::NotSupportedError) {

        QSKIP("The store not supported by the SIM card", SkipSingle);

    }

    QMap<QString, QContactDetailDefinition> detailDefinitions = m_cm->detailDefinitions();

    QCOMPARE(m_cm->error(), QContactManager::NoError);

    QVERIFY(detailDefinitions.count() >= 2);

    QVERIFY(detailDefinitions.count() <= 7);

    // check that at least definitions for name and phone number exist

    QVERIFY(detailDefinitions.contains(QContactName::DefinitionName));

    QVERIFY(detailDefinitions.contains(QContactPhoneNumber::DefinitionName));

    QVERIFY(detailDefinitions.contains(QContactDisplayLabel::DefinitionName));

    QVERIFY(detailDefinitions.contains(QContactType::DefinitionName));

    QVERIFY(detailDefinitions.contains(QContactSyncTarget::DefinitionName));

    // Dynamic definitions (that depend on SIM card type)

    if(detailDefinitions.count() == 7) {

        QVERIFY(detailDefinitions.contains(QContactNickname::DefinitionName));

        QVERIFY(detailDefinitions.contains(QContactEmailAddress::DefinitionName));

    }

}

void tst_SimCM::addContact_data()

{

    QTest::addColumn<QString>("simStore"); // empty (defaults to ADN), "ADN", "SDN" or "FDN"

    QTest::addColumn<int>("expectedResult"); // 1 = pass, 0 = fail, -1 = depends on the SIM card

    QTest::addColumn<QString>("expectedDisplayLabel");

    QTest::addColumn<QStringList>("details"); // format is <detail definition name>:<field name>:<value>

    QString unnamedLabel("Unnamed");

    QString es = QString();

    QString tooLongText("James Hunt the 12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890th");

    // TODO: what name field to use for a sim contact name?

    // Note: With the current implementation the value must not contain a ':' character

    QTest::newRow("ADN custom label")

        << QString("ADN")

        << 1 // expected to pass

        << "James"

        << (QStringList()

            << "Name:CustomLabel:James");

    QTest::newRow("ADN (explicitly defined store) custom label")

        << QString("ADN")

        << 1 // expected to pass

        << "James"

        << (QStringList()

            << "Name:CustomLabel:James");

    QTest::newRow("ADN custom label 2")

        << QString("ADN")

        << 1 // expected to pass

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt");

    QTest::newRow("ADN 2 custom labels")

        << QString("ADN")

        << 0 // expected to fail. Custom label is unique.

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James"

            << "Name:CustomLabel:James Hunt");

    QTest::newRow("ADN too long custom label")

        << QString("ADN")

        << 1 // expected to pass. Note: too long display label is truncated

        << tooLongText

        << (QStringList()

            << (QString("Name:CustomLabel:").append(tooLongText)));

    QTest::newRow("ADN custom label and nick name")

        << QString("ADN")

        << -1 // Depends on SIM card support (some cards support second name)

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "Nickname:Nickname:Hunt the Shunt");

    QTest::newRow("ADN custom label and too long nick name")

        << QString("ADN")

        << -1 // Depends on SIM card support (some cards support second name)

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << (QString("Nickname:Nickname:").append(tooLongText)));

    QTest::newRow("ADN phone number")

        << QString("ADN")

        << 1

        << unnamedLabel

        << (QStringList()

            << "PhoneNumber:PhoneNumber:+44752222222");

    QTest::newRow("ADN custom label and phone number")

        << QString("ADN")

        << 1

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:+44752222222");

    QTest::newRow("ADN custom label and funny (but legal) phone number")

        << QString("ADN")

        << 1

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:+0123456789*#p");

    QTest::newRow("ADN custom label and illegal phone number 1")

        << QString("ADN")

        << 0 // illegal characters in the phone number, should fail

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:+44(75)2222222");

    QTest::newRow("ADN custom label and illegal phone number 2")

        << QString("ADN")

        << 0 // illegal characters in the phone number, should fail

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:asdfqwer");

    QTest::newRow("ADN custom label and illegal phone number 3")

        << QString("ADN")

        << 0 // illegal characters in the phone number, should fail

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:1234567a");

    QTest::newRow("ADN custom label and illegal phone number 4")

        << QString("ADN")

        << 0 // illegal characters in the phone number, should fail

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:&1234567");

    QTest::newRow("ADN custom label and too long phone number")

        << QString("ADN")

        << 0 // long enough phone number to fail on any SIM card

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890");

    QTest::newRow("ADN custom label and multiple phone numbers")

        << QString("ADN")

        << -1 // some SIM cards support multiple phone numbers

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:+44752222222"

            << "PhoneNumber:PhoneNumber:+44751111111");

    QTest::newRow("ADN custom label and multiple phone numbers, one phone number too long")

        << QString("ADN")

        << 0 // Long enough additional phone number to fail on any SIM card

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "PhoneNumber:PhoneNumber:+44752222222"

            << "PhoneNumber:PhoneNumber:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890");

    QTest::newRow("ADN custom label and email")

        << QString("ADN")

        << -1 // some SIM cards support e-mail address

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "EmailAddress:EmailAddress:james@mclaren.com");

    QTest::newRow("ADN custom label and multiple emails")

        << QString("ADN")

        << 0 // some SIM cards support multiple e-mail addresses, but not this many

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "EmailAddress:EmailAddress:james@march.com"

            << "EmailAddress:EmailAddress:james@hesketh.com"

            << "EmailAddress:EmailAddress:james@mclaren.com"

            << "EmailAddress:EmailAddress:james.hunt@bbc.co.uk");

    QTest::newRow("ADN custom label and too long email")

        << QString("ADN")

        << 0 // long enough e-mail to fail on any SIM card

        << "James Hunt"

        << (QStringList()

            << "Name:CustomLabel:James Hunt"

            << "EmailAddress:EmailAddress:james.hunt.the12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890th@mclaren.com");

    QTest::newRow("ADN non-supported field")

        << QString("ADN")

        << 0 // expected to fail

        << es

        << (QStringList()

            << "Name:IllegalNameDetailFieldName:James");

    QTest::newRow("ADN non-supported detail")