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

**

** Copyright (C) 2010 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 <QObject>

#include <QTest>

#include <QDebug>

#include "qtmessaging.h"

#include "../support/support.h"

# if defined(TESTDATA_DIR)

#  undef TESTDATA_DIR

# endif

# define TESTDATA_DIR "."

#endif

//TESTED_CLASS=

//TESTED_FILES=

QTM_USE_NAMESPACE

/*

    Unit test for classes implementing query keys for the QMessageStore class.

*/

class tst_QMessageStoreKeys : public QObject

{

    Q_OBJECT

public:

    tst_QMessageStoreKeys();

    virtual ~tst_QMessageStoreKeys();

private slots:

    void init();

    void initTestCase();

    void cleanup();

    void cleanupTestCase();

    void testAccountFilter_data();

    void testAccountFilter();

    void testAccountOrdering_data();

    void testAccountOrdering();

    void testFolderFilter_data();

    void testFolderFilter();

    void testFolderOrdering_data();

    void testFolderOrdering();

    void testMessageFilter_data();

    void testMessageFilter();

    void testMessageOrdering_data();

    void testMessageOrdering();

private:

    QSet<QMessageAccountId> existingAccountIds;

    QMessageAccountIdList accountIds;

    QSet<QMessageFolderId> existingFolderIds;

    QMessageFolderIdList folderIds;

    QSet<QMessageId> existingMessageIds;

    QMessageFilter existingAccountsFilter;

    QMessageIdList messageIds;

    QList<int> messageSizes;

    QMessageManager *manager;

};

Q_DECLARE_METATYPE(QMessageAccountIdList)

Q_DECLARE_METATYPE(QMessageAccountFilter)

Q_DECLARE_METATYPE(QMessageAccountSortOrder)

Q_DECLARE_METATYPE(QMessageFolderIdList)

Q_DECLARE_METATYPE(QMessageFolderFilter)

Q_DECLARE_METATYPE(QMessageFolderSortOrder)

typedef QList<QMessageFolderSortOrder> FolderSortList;

Q_DECLARE_METATYPE(FolderSortList)

Q_DECLARE_METATYPE(QMessageIdList)

Q_DECLARE_METATYPE(QMessageFilter)

Q_DECLARE_METATYPE(QMessageSortOrder)

typedef QList<QMessageSortOrder> MessageSortList;

Q_DECLARE_METATYPE(MessageSortList)

typedef QList<QMessageIdList> MessageListList;

Q_DECLARE_METATYPE(MessageListList)

QDebug &operator<<(QDebug &dbg, const QMessageAccountId &id)

{

    return dbg << id.toString();

}

QDebug &operator<<(QDebug &dbg, const QMessageFolderId &id)

{

    return dbg << id.toString();

}

QDebug &operator<<(QDebug &dbg, const QMessageId &id)

{

    return dbg << id.toString();

}

QTEST_MAIN(tst_QMessageStoreKeys)

#include "tst_qmessagestorekeys.moc"

tst_QMessageStoreKeys::tst_QMessageStoreKeys()

    : manager(0)

{

}

tst_QMessageStoreKeys::~tst_QMessageStoreKeys()

{

    delete manager;

}

class Params

{

    QMap<const char*, const char*> _map;

public:

    Params() {}

    Params& operator()(const char* name, const char* value)

    {

        _map.insert(name, value); return *this; 

    }

    operator Support::Parameters() const

    {

        Support::Parameters result;

        QMap<const char*, const char*>::const_iterator it = _map.begin(), end = _map.end();

        for ( ; it != end; ++it) {

            result.insert(it.key(), it.value());

        }

        return result;

    }

};

void tst_QMessageStoreKeys::init()

{

}

void tst_QMessageStoreKeys::initTestCase()

{

#if defined(Q_OS_WIN) && !defined(Q_OS_WINCE)

    if (!Support::mapiAvailable())

        QSKIP("Skipping tests because a MAPI subsystem does not appear to be available", SkipAll);

#endif

    // Clear any existing data before we instantiate the message manager

    Support::clearMessageStore();

    manager = new QMessageManager;

    existingAccountIds = manager->queryAccounts().toSet();

    existingAccountsFilter = ~QMessageFilter();

    foreach(QMessageAccountId id, existingAccountIds) {

        existingAccountsFilter |= QMessageFilter::byParentAccountId(id);

    }

    QList<Support::Parameters> accountParams;

    accountParams << Params()("name", "Work")

                             ("fromAddress", "Important.Person@example.com")

                  << Params()("name", "Personal")

                             ("fromAddress", "superstar2000@example.net")

                  << Params()("name", "Alter Ego")

                             ("fromAddress", "UltraMegaLightningBabe@superhero.test");

    foreach (const Support::Parameters &params, accountParams) {

        accountIds.append(Support::addAccount(params));

        QVERIFY(accountIds.last().isValid());

    }

    existingFolderIds = manager->queryFolders().toSet();

    QList<Support::Parameters> folderParams;

    folderParams << Params()("parentAccountName", "Alter Ego")

                            ("path", "My messages")

                            ("name", "My messages")

                            ("parentFolderPath", "")

                 << Params()("parentAccountName", "Work")

                            ("path", "Innbox")

                            ("name", "Innbox")

                            ("parentFolderPath", "")

#if !defined(Q_OS_SYMBIAN) && !defined(Q_WS_MAEMO_5) && !defined(Q_WS_MAEMO_6)

                 << Params()("parentAccountName", "Work")

                            ("path", "Innbox/X-Announce")

                            ("name", "X-Announce")

                            ("parentFolderPath", "Innbox")

                 << Params()("parentAccountName", "Work")

                            ("path", "Innbox/X-Announce/X-Archived")

                            ("name", "X-Archived")

                            ("parentFolderPath", "Innbox/X-Announce");

#else    

                 << Params()("parentAccountName", "Work")

                            ("path", "X-Announce")

                            ("name", "X-Announce")

                            ("parentFolderPath", "")

                 << Params()("parentAccountName", "Work")

                            ("path", "X-Archived")

                            ("name", "X-Archived")

                            ("parentFolderPath", "");

#endif    

    foreach (const Support::Parameters &params, folderParams) {

        folderIds.append(Support::addFolder(params));

        QVERIFY(folderIds.last().isValid());

    }

#if defined(Q_WS_MAEMO_5) || defined(Q_WS_MAEMO_6)

    // Local folders can be seen through every account

    // => Make sure that existingFolderIds contains all folderIds

    //    but not ids which were returned from addFolder calls

    QMessageFolderFilter folderFilter;

    foreach(QMessageAccountId id, accountIds) {

        folderFilter |= QMessageFolderFilter::byParentAccountId(id);

    }

    QSet<QMessageFolderId> newFolderIds = manager->queryFolders(folderFilter).toSet().subtract(existingFolderIds);

    newFolderIds = newFolderIds.subtract(folderIds.toSet());

    existingFolderIds.unite(newFolderIds);

#endif

    existingMessageIds = manager->queryMessages(~existingAccountsFilter).toSet();

    // For windows at least, we can't have HasAttachments set without a real attachment

#ifndef Q_OS_SYMBIAN

    const char *attachmentPaths = TESTDATA_DIR "/testdata/1.txt";

#else

    const char *attachmentPaths = TESTDATA_DIR "\\testdata\\1.txt";

#endif

    QList<Support::Parameters> messageParams;

    messageParams << Params()("parentAccountName", "Alter Ego")

                             ("parentFolderPath", "My messages")

#if (defined(Q_OS_SYMBIAN) || defined(Q_OS_WIN)) || defined(Q_WS_MAEMO_5) || defined(Q_WS_MAEMO_6) // SMS messages must be in SMS store on Windows and on Symbian

                             ("type", "email")

#else

                             ("type", "sms")

#endif

                             ("to", "SuperMegaLightningBabe")

                             ("from", "Frozone")

                             ("subject", "Ice to meet you")

                             ("text", "Shall I compare thee to a summers day")

                             ("date", "2000-01-01T12:00:00Z")

                             ("receivedDate", "2000-01-01T12:01:00Z")

                             ("priority", "")

                             ("size", "160")

                             ("status-read", "true")

                             ("custom-flagged", "true")

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "Innbox")

                             ("type", "email")

                             ("to", "Important.Person@example.com")

                             ("from", "Esteemed.Colleague@example.com")

                             ("subject", "Meeting agenda")

                             ("date", "2000-01-01T12:00:00Z")

                             ("receivedDate", "2000-01-01T20:00:00Z")

                             ("priority", "High")

                             ("size", "10240")

                             ("status-hasAttachments", "true")

                             ("attachments", attachmentPaths)

                             ("custom-spam", "filter:no")

                             ("custom-flagged", "true")

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "Innbox")

                             ("type", "email")

                             ("to", "Important.Person@example.com,Minion@example.com")

                             ("from", "Big.Boss@example.com")

                             ("subject", "Motivational message")

                             ("text", "School's out for summer")

                             ("date", "2000-01-01T13:00:00Z")

                             ("receivedDate", "2000-01-01T13:05:00Z")

                             ("priority", "High")

                             ("size", "20480")

                             ("status-hasAttachments", "true")

                             ("attachments", attachmentPaths)

                             ("custom-spam", "filter:no")

#if !defined(Q_OS_SYMBIAN) && !defined(Q_WS_MAEMO_5) && !defined(Q_WS_MAEMO_6)

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "Innbox/X-Announce")

                             ("type", "email")

                             ("to", "announce@example.com,maintenance-log@example.com")

                             ("from", "sysadmin@example.com")

                             ("subject", "Scheduled maintenance")

                             ("date", "2000-01-01T13:00:00Z")

                             ("receivedDate", "2000-01-01T13:00:01Z")

                             ("priority", "")

                             ("size", "1056")

                             ("status-read", "true")

                             ("custom-spam", "filter:maybe")

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "Innbox/X-Announce/X-Archived")

                             ("type", "email")

                             ("to", "announce@example.com")

                             ("from", "Big.Boss@example.com")

                             ("subject", "Free beer")

                             ("date", "1999-04-01T10:30:00Z")

                             ("receivedDate", "1999-04-01T10:31:00Z")

                             ("priority", "Low")

                             ("size", "4096")

                             ("status-read", "true")

                             ("status-hasAttachments", "true")

                             ("attachments", attachmentPaths)

                             ("custom-spam", "filter:yes");

#else

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "X-Announce")

                             ("type", "email")

                             ("to", "announce@example.com,maintenance-log@example.com")

                             ("from", "sysadmin@example.com")

                             ("subject", "Scheduled maintenance")

                             ("date", "2000-01-01T13:00:00Z")

                             ("receivedDate", "2000-01-01T13:00:01Z")

                             ("priority", "")

                             ("size", "1056")

                             ("status-read", "true")

                             ("custom-spam", "filter:maybe")

                  << Params()("parentAccountName", "Work")

                             ("parentFolderPath", "X-Archived")

                             ("type", "email")

                             ("to", "announce@example.com")

                             ("from", "Big.Boss@example.com")

                             ("subject", "Free beer")

                             ("date", "1999-04-01T10:30:00Z")

                             ("receivedDate", "1999-04-01T10:31:00Z")

                             ("priority", "Low")

                             ("size", "4096")

                             ("status-read", "true")

                             ("status-hasAttachments", "true")

                             ("attachments", attachmentPaths)

                             ("custom-spam", "filter:yes");

#endif

    foreach (const Support::Parameters &params, messageParams) {

        messageIds.append(Support::addMessage(params));

        QVERIFY(messageIds.last().isValid());

        // Use the resultant message sizes in testing - the configured sizes aren't honoured by MAPI

        QMessage m(messageIds.last());

        messageSizes.append(m.size());

    }

}

void tst_QMessageStoreKeys::cleanup()

{

}

void tst_QMessageStoreKeys::cleanupTestCase()

{

}

void tst_QMessageStoreKeys::testAccountFilter_data()

{

    QTest::addColumn<QMessageAccountFilter>("filter");

    QTest::addColumn<QMessageAccountIdList>("ids");

    QTest::addColumn<QMessageAccountIdList>("negatedIds");

    QTest::newRow("empty filter")

        << QMessageAccountFilter() 

        << accountIds

        << QMessageAccountIdList();

    QTest::newRow("id equality 1")

        << QMessageAccountFilter::byId(accountIds[0], QMessageDataComparator::Equal) 

        << ( QMessageAccountIdList() << accountIds[0] )

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] );

    QTest::newRow("id equality 2")

        << QMessageAccountFilter::byId(accountIds[1], QMessageDataComparator::Equal) 

        << ( QMessageAccountIdList() << accountIds[1] )

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] );

    QTest::newRow("id equality invalid")

        << QMessageAccountFilter::byId(QMessageAccountId(), QMessageDataComparator::Equal) 

        << QMessageAccountIdList()

        << accountIds;

    QTest::newRow("id inequality 1")

        << QMessageAccountFilter::byId(accountIds[0], QMessageDataComparator::NotEqual) 

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[0] );

    QTest::newRow("id inequality 2")

        << QMessageAccountFilter::byId(accountIds[1], QMessageDataComparator::NotEqual) 

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[1] );

    QTest::newRow("id inequality invalid")

        << QMessageAccountFilter::byId(QMessageAccountId(), QMessageDataComparator::NotEqual) 

        << accountIds

        << QMessageAccountIdList();

    QTest::newRow("id list inclusion 1")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[0], QMessageDataComparator::Includes) 

        << ( QMessageAccountIdList() << accountIds[0] )

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] );

    QTest::newRow("id list inclusion 2")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[1], QMessageDataComparator::Includes) 

        << ( QMessageAccountIdList() << accountIds[1] )

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] );

    QTest::newRow("id list inclusion 3")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[0] << accountIds[1], QMessageDataComparator::Includes) 

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[1] )

        << ( QMessageAccountIdList() << accountIds[2] );

    QTest::newRow("id list inclusion empty")

        << QMessageAccountFilter::byId(QMessageAccountIdList(), QMessageDataComparator::Includes) 

        << QMessageAccountIdList()

        << accountIds;

    QTest::newRow("id list exclusion 1")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[0], QMessageDataComparator::Excludes) 

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[0] );

    QTest::newRow("id list exclusion 2")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[1], QMessageDataComparator::Excludes) 

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[1] );

    QTest::newRow("id list exclusion 3")

        << QMessageAccountFilter::byId(QMessageAccountIdList() << accountIds[0] << accountIds[1], QMessageDataComparator::Excludes) 

        << ( QMessageAccountIdList() << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[1] );

    QTest::newRow("id list exclusion empty")

        << QMessageAccountFilter::byId(QMessageAccountIdList(), QMessageDataComparator::Excludes) 

        << accountIds

        << QMessageAccountIdList();

    QTest::newRow("id filter inclusion 1")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("Work", QMessageDataComparator::Equal), QMessageDataComparator::Includes) 

        << ( QMessageAccountIdList() << accountIds[0] )

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] );

    QTest::newRow("id filter inclusion 2")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("Personal", QMessageDataComparator::Equal), QMessageDataComparator::Includes) 

        << ( QMessageAccountIdList() << accountIds[1] )

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] );

    QTest::newRow("id filter inclusion 3")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("o", QMessageDataComparator::Includes), QMessageDataComparator::Includes) 

        << accountIds

        << QMessageAccountIdList();

    QTest::newRow("id filter inclusion empty")

        << QMessageAccountFilter::byId(QMessageAccountFilter(), QMessageDataComparator::Includes) 

        << accountIds

        << QMessageAccountIdList();

    QTest::newRow("id filter inclusion non-matching")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("NoneSuch"), QMessageDataComparator::Includes) 

        << QMessageAccountIdList()

        << accountIds;

    QTest::newRow("id filter exclusion 1")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("Work", QMessageDataComparator::Equal), QMessageDataComparator::Excludes) 

        << ( QMessageAccountIdList() << accountIds[1] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[0] );

    QTest::newRow("id filter exclusion 2")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("Personal", QMessageDataComparator::Equal), QMessageDataComparator::Excludes) 

        << ( QMessageAccountIdList() << accountIds[0] << accountIds[2] )

        << ( QMessageAccountIdList() << accountIds[1] );

    QTest::newRow("id filter exclusion 3")

        << QMessageAccountFilter::byId(QMessageAccountFilter::byName("o", QMessageDataComparator::Includes), QMessageDataComparator::Excludes) 

        << QMessageAccountIdList()

        << accountIds;

    QTest::newRow("id filter exclusion empty")

        << QMessageAccountFilter::byId(QMessageAccountFilter(), QMessageDataComparator::Excludes) 

        << QMessageAccountIdList()