kde-playground/kdepimlibs/akonadi/tests/changerecordertest.cpp

/*
    Copyright (c) 2007 Volker Krause <vkrause@kde.org>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#include "testattribute.h"

#include <akonadi/changerecorder.h>
#include <akonadi/itemfetchscope.h>
#include <akonadi/itemmodifyjob.h>
#include <akonadi/itemdeletejob.h>
#include <akonadi/agentmanager.h>

#include <QtCore/QObject>
#include <QtCore/QSettings>

#include <qtest_akonadi.h>

using namespace Akonadi;

Q_DECLARE_METATYPE(QSet<QByteArray>)

class ChangeRecorderTest : public QObject
{
  Q_OBJECT

  private Q_SLOTS:
    void initTestCase()
    {
      qRegisterMetaType<Akonadi::Item>();
      qRegisterMetaType<QSet<QByteArray> >();
      AkonadiTest::checkTestIsIsolated();
      AkonadiTest::setAllResourcesOffline();

      settings = new QSettings( "kde.org", "akonadi-changerecordertest", this );
    }

    // After each test
    void cleanup()
    {
      // See ChangeRecorderPrivate::notificationsFileName()
      QFile::remove(settings->fileName() + QLatin1String( "_changes.dat") );
    }

    void testChangeRecorder_data()
    {
      QTest::addColumn<QStringList>( "actions" );

      QTest::newRow("nothingToReplay") << (QStringList() << "rn");
      QTest::newRow("nothingOneNothing") << (QStringList() << "rn" << "c2" << "r2" << "rn");
      QTest::newRow("multipleItems") << (QStringList() << "c1" << "c2" << "c3" << "r1" << "c4" << "r2" << "r3" << "r4" << "rn");
      QTest::newRow("reload") << (QStringList() << "c1" << "c1" << "c3" << "reload" << "r1" << "r3" << "rn");
      QTest::newRow("more") << (QStringList() << "c1" << "c2" << "c3" << "reload" << "r1" << "reload" << "c4" << "reload" << "r2" << "reload" << "r3" << "r4" << "rn");
      QTest::newRow("modifyThenDelete") << (QStringList() << "c1" << "d1" << "r1" << "rn");
    }

    void testChangeRecorder()
    {
      QFETCH(QStringList, actions);
      QString lastAction;

      ChangeRecorder *rec = createChangeRecorder();
      QVERIFY( rec->isEmpty() );
      Q_FOREACH( const QString& action, actions ) {
        kDebug() << action;
        if ( action == "rn" ) {
          replayNextAndExpectNothing( rec );
        } else if ( action == "reload" ) {
          // Check saving and loading from disk
          delete rec;
          rec = createChangeRecorder();
        } else if ( action.at(0) == 'c' ) {
          // c1 = "trigger change on item 1"
          const int id = action.mid(1).toInt();
          Q_ASSERT(id);
          triggerChange( id );
          if (action != lastAction) {
            // enter event loop and wait for change notifications from the server
            QVERIFY( QTest::kWaitForSignal( rec, SIGNAL(changesAdded()), 1000 ) );
          }
        } else if ( action.at(0) == 'd' ) {
          // d1 = "delete item 1"
          const int id = action.mid(1).toInt();
          Q_ASSERT(id);
          triggerDelete( id );
          QTest::qWait(500);
        } else if ( action.at(0) == 'r' ) {
          // r1 = "replayNext and expect to get itemChanged(1)"
          const int id = action.mid(1).toInt();
          Q_ASSERT(id);
          replayNextAndProcess( rec, id );
        } else {
          QVERIFY2( false, qPrintable("Unsupported: " + action) );
        }
        lastAction = action;
      }
      QVERIFY( rec->isEmpty() );
      delete rec;
    }

  private:
    void triggerChange( Akonadi::Item::Id uid )
    {
      static int s_num = 0;
      Item item( uid );
      TestAttribute *attr = item.attribute<TestAttribute>(Item::AddIfMissing);
      attr->data = QByteArray::number(++s_num);
      ItemModifyJob *job = new ItemModifyJob( item );
      job->disableRevisionCheck();
      AKVERIFYEXEC( job );
    }

    void triggerDelete( Akonadi::Item::Id uid )
    {
      Item item( uid );
      ItemDeleteJob* job = new ItemDeleteJob( item );
      AKVERIFYEXEC( job );
    }

    void replayNextAndProcess( ChangeRecorder* rec, Akonadi::Item::Id expectedUid )
    {
      kDebug();

      QSignalSpy nothingSpy( rec, SIGNAL(nothingToReplay()) );
      QVERIFY( nothingSpy.isValid() );
      QSignalSpy itemChangedSpy( rec, SIGNAL(itemChanged(Akonadi::Item,QSet<QByteArray>)) );
      QVERIFY( itemChangedSpy.isValid() );

      rec->replayNext();
      if ( itemChangedSpy.isEmpty() )
        QVERIFY( QTest::kWaitForSignal( rec, SIGNAL(itemChanged(Akonadi::Item,QSet<QByteArray>)), 1000 ) );
      QCOMPARE( itemChangedSpy.count(), 1 );
      QCOMPARE( itemChangedSpy.at(0).at(0).value<Akonadi::Item>().id(), expectedUid );

      rec->changeProcessed();

      QCOMPARE( nothingSpy.count(), 0 );
    }

    void replayNextAndExpectNothing( ChangeRecorder* rec )
    {
      kDebug();

      QSignalSpy nothingSpy( rec, SIGNAL(nothingToReplay()) );
      QVERIFY( nothingSpy.isValid() );
      QSignalSpy itemChangedSpy( rec, SIGNAL(itemChanged(Akonadi::Item,QSet<QByteArray>)) );
      QVERIFY( itemChangedSpy.isValid() );

      rec->replayNext(); // emits nothingToReplay immediately

      QCOMPARE( itemChangedSpy.count(), 0 );
      QCOMPARE( nothingSpy.count(), 1 );
    }

    ChangeRecorder* createChangeRecorder() const
    {
      ChangeRecorder* rec = new ChangeRecorder();
      rec->setConfig( settings );
      rec->setAllMonitored();
      rec->itemFetchScope().fetchFullPayload();
      rec->itemFetchScope().fetchAllAttributes();
      rec->itemFetchScope().setCacheOnly( true );

      // Ensure we listen to a signal, otherwise MonitorPrivate::isLazilyIgnored will ignore notifications
      QSignalSpy* spy = new QSignalSpy( rec, SIGNAL(itemChanged(Akonadi::Item,QSet<QByteArray>)) );
      spy->setParent( rec );

      return rec;
    }

    QSettings* settings;

};

QTEST_AKONADIMAIN( ChangeRecorderTest, NoGUI )

#include "changerecordertest.moc"