Abstracted the storage so the facade can be tested.

6 files changed, 244 insertions, 106 deletions

diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt
index a69c62c..b242256 100644
--- a/common/CMakeLists.txt
+++ b/common/CMakeLists.txt
@@ -13,6 +13,7 @@ endif (STORAGE_unqlite)
 set(command_SRCS
     log.cpp
     entitybuffer.cpp
+    entitystorage.cpp
     clientapi.cpp
     facadefactory.cpp
     commands.cpp
diff --git a/common/entitystorage.cpp b/common/entitystorage.cpp
new file mode 100644
index 0000000..f84e9f5
--- /dev/null
+++ b/common/entitystorage.cpp
@@ -0,0 +1,122 @@
+/*
+ * Copyright (C) 2014 Christian Mollekopf <chrigi_1@fastmail.fm>
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 2 of the License, or
+ *   (at your option) any later version.
+ *
+ *   This program 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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program; if not, write to the
+ *   Free Software Foundation, Inc.,
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
+ */
+
+#include "entitystorage.h"
+
+static void scan(const QSharedPointer<Akonadi2::Storage> &storage, const QByteArray &key, std::function<bool(const QByteArray &key, const Akonadi2::Entity &entity)> callback)
+{
+    storage->scan(key, [=](void *keyValue, int keySize, void *dataValue, int dataSize) -> bool {
+        //Skip internals
+        if (Akonadi2::Storage::isInternalKey(keyValue, keySize)) {
+            return true;
+        }
+
+        //Extract buffers
+        Akonadi2::EntityBuffer buffer(dataValue, dataSize);
+
+        //FIXME implement buffer.isValid()
+        // const auto resourceBuffer = Akonadi2::EntityBuffer::readBuffer<DummyEvent>(buffer.entity().resource());
+        // const auto localBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::ApplicationDomain::Buffer::Event>(buffer.entity().local());
+        // const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::Metadata>(buffer.entity().metadata());
+
+        // if ((!resourceBuffer && !localBuffer) || !metadataBuffer) {
+        //     qWarning() << "invalid buffer " << QByteArray::fromRawData(static_cast<char*>(keyValue), keySize);
+        //     return true;
+        // }
+        return callback(QByteArray::fromRawData(static_cast<char*>(keyValue), keySize), buffer.entity());
+    },
+    [](const Akonadi2::Storage::Error &error) {
+        qWarning() << "Error during query: " << error.message;
+    });
+}
+
+void EntityStorageBase::readValue(const QSharedPointer<Akonadi2::Storage> &storage, const QByteArray &key, const std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)> &resultCallback)
+{
+    scan(storage, key, [=](const QByteArray &key, const Akonadi2::Entity &entity) {
+        const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::Metadata>(entity.metadata());
+        qint64 revision = metadataBuffer ? metadataBuffer->revision() : -1;
+        //This only works for a 1:1 mapping of resource to domain types.
+        //Not i.e. for tags that are stored as flags in each entity of an imap store.
+        //additional properties that don't have a 1:1 mapping (such as separately stored tags),
+        //could be added to the adaptor
+        auto domainObject = create(key, revision, mDomainTypeAdaptorFactory->createAdaptor(entity));
+        resultCallback(domainObject);
+        return true;
+    });
+}
+
+static ResultSet fullScan(const QSharedPointer<Akonadi2::Storage> &storage)
+{
+    //TODO use a result set with an iterator, to read values on demand
+    QVector<QByteArray> keys;
+    scan(storage, QByteArray(), [=, &keys](const QByteArray &key, const Akonadi2::Entity &) {
+        keys << key;
+        return true;
+    });
+    Trace() << "Full scan found " << keys.size() << " results";
+    return ResultSet(keys);
+}
+
+ResultSet EntityStorageBase::filteredSet(const ResultSet &resultSet, const std::function<bool(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject)> &filter, const QSharedPointer<Akonadi2::Storage> &storage, qint64 baseRevision, qint64 topRevision)
+{
+    auto resultSetPtr = QSharedPointer<ResultSet>::create(resultSet);
+
+    //Read through the source values and return whatever matches the filter
+    std::function<bool(std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)>)> generator = [this, resultSetPtr, storage, filter](std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)> callback) -> bool {
+        while (resultSetPtr->next()) {
+            readValue(storage, resultSetPtr->id(), [this, filter, callback](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject) {
+                if (filter(domainObject)) {
+                    callback(domainObject);
+                }
+            });
+        }
+        return false;
+    };
+    return ResultSet(generator);
+}
+
+ResultSet EntityStorageBase::getResultSet(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::Storage> &storage, qint64 baseRevision, qint64 topRevision)
+{
+    QSet<QByteArray> appliedFilters;
+    ResultSet resultSet = queryIndexes(query, mResourceInstanceIdentifier, appliedFilters);
+    const auto remainingFilters = query.propertyFilter.keys().toSet() - appliedFilters;
+
+    //We do a full scan if there were no indexes available to create the initial set.
+    if (appliedFilters.isEmpty()) {
+        resultSet = fullScan(storage);
+    }
+
+    auto filter = [remainingFilters, query, baseRevision, topRevision](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject) -> bool {
+        if (topRevision > 0) {
+            Trace() << "filtering by revision " << domainObject->revision();
+            if (domainObject->revision() < baseRevision || domainObject->revision() > topRevision) {
+                return false;
+            }
+        }
+        for (const auto &filterProperty : remainingFilters) {
+            //TODO implement other comparison operators than equality
+            if (domainObject->getProperty(filterProperty) != query.propertyFilter.value(filterProperty)) {
+                return false;
+            }
+        }
+        return true;
+    };
+
+    return filteredSet(resultSet, filter, storage, baseRevision, topRevision);
+}
diff --git a/common/entitystorage.h b/common/entitystorage.h
index 6a41e0e..a62d474 100644
--- a/common/entitystorage.h
+++ b/common/entitystorage.h
@@ -31,124 +31,59 @@
 /**
  * Wraps storage, entity adaptor factory and indexes into one.
  */
-template <typename DomainType>
-class EntityStorage
+class EntityStorageBase
 {
-
-public:
-    EntityStorage(const QByteArray &instanceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory)
+protected:
+    EntityStorageBase(const QByteArray &instanceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory)
         : mResourceInstanceIdentifier(instanceIdentifier),
         mDomainTypeAdaptorFactory(adaptorFactory)
     {
 
     }
 
-private:
-    static void scan(const QSharedPointer<Akonadi2::Storage> &storage, const QByteArray &key, std::function<bool(const QByteArray &key, const Akonadi2::Entity &entity)> callback)
-    {
-        storage->scan(key, [=](void *keyValue, int keySize, void *dataValue, int dataSize) -> bool {
-            //Skip internals
-            if (Akonadi2::Storage::isInternalKey(keyValue, keySize)) {
-                return true;
-            }
-
-            //Extract buffers
-            Akonadi2::EntityBuffer buffer(dataValue, dataSize);
-
-            //FIXME implement buffer.isValid()
-            // const auto resourceBuffer = Akonadi2::EntityBuffer::readBuffer<DummyEvent>(buffer.entity().resource());
-            // const auto localBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::ApplicationDomain::Buffer::Event>(buffer.entity().local());
-            // const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::Metadata>(buffer.entity().metadata());
-
-            // if ((!resourceBuffer && !localBuffer) || !metadataBuffer) {
-            //     qWarning() << "invalid buffer " << QByteArray::fromRawData(static_cast<char*>(keyValue), keySize);
-            //     return true;
-            // }
-            return callback(QByteArray::fromRawData(static_cast<char*>(keyValue), keySize), buffer.entity());
-        },
-        [](const Akonadi2::Storage::Error &error) {
-            qWarning() << "Error during query: " << error.message;
-        });
-    }
+    virtual Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr create(const QByteArray &key, qint64 revision, const QSharedPointer<Akonadi2::ApplicationDomain::BufferAdaptor> &adaptor) = 0;
+    virtual Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr copy(const Akonadi2::ApplicationDomain::ApplicationDomainType &) = 0;
+    virtual ResultSet queryIndexes(const Akonadi2::Query &query, const QByteArray &resourceInstanceIdentifier, QSet<QByteArray> &appliedFilters) = 0;
+
+    void readValue(const QSharedPointer<Akonadi2::Storage> &storage, const QByteArray &key, const std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)> &resultCallback);
+    ResultSet filteredSet(const ResultSet &resultSet, const std::function<bool(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject)> &filter, const QSharedPointer<Akonadi2::Storage> &storage, qint64 baseRevision, qint64 topRevision);
+    ResultSet getResultSet(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::Storage> &storage, qint64 baseRevision, qint64 topRevision);
+
+protected:
+    QByteArray mResourceInstanceIdentifier;
+    DomainTypeAdaptorFactoryInterface::Ptr mDomainTypeAdaptorFactory;
+};
+
+template<typename DomainType>
+class EntityStorage : public EntityStorageBase
+{
 
-    static void readValue(const QSharedPointer<Akonadi2::Storage> &storage, const QByteArray &key, const std::function<void(const typename DomainType::Ptr &)> &resultCallback, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory, const QByteArray &instanceIdentifier)
+public:
+    EntityStorage(const QByteArray &instanceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory)
+        : EntityStorageBase(instanceIdentifier, adaptorFactory)
     {
-        scan(storage, key, [=](const QByteArray &key, const Akonadi2::Entity &entity) {
-            const auto metadataBuffer = Akonadi2::EntityBuffer::readBuffer<Akonadi2::Metadata>(entity.metadata());
-            qint64 revision = metadataBuffer ? metadataBuffer->revision() : -1;
-            //This only works for a 1:1 mapping of resource to domain types.
-            //Not i.e. for tags that are stored as flags in each entity of an imap store.
-            //additional properties that don't have a 1:1 mapping (such as separately stored tags),
-            //could be added to the adaptor
-            auto domainObject = QSharedPointer<DomainType>::create(instanceIdentifier, key, revision, adaptorFactory->createAdaptor(entity));
-            resultCallback(domainObject);
-            return true;
-        });
+
     }
 
-    static ResultSet fullScan(const QSharedPointer<Akonadi2::Storage> &storage)
+protected:
+    Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr create(const QByteArray &key, qint64 revision, const QSharedPointer<Akonadi2::ApplicationDomain::BufferAdaptor> &adaptor) Q_DECL_OVERRIDE
     {
-        //TODO use a result set with an iterator, to read values on demand
-        QVector<QByteArray> keys;
-        scan(storage, QByteArray(), [=, &keys](const QByteArray &key, const Akonadi2::Entity &) {
-            keys << key;
-            return true;
-        });
-        Trace() << "Full scan found " << keys.size() << " results";
-        return ResultSet(keys);
+        return DomainType::Ptr::create(mResourceInstanceIdentifier, key, revision, adaptor);
     }
 
-    static ResultSet filteredSet(const ResultSet &resultSet, const std::function<bool(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject)> &filter, const QSharedPointer<Akonadi2::Storage> &storage, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory, qint64 baseRevision, qint64 topRevision, const QByteArray &instanceIdentifier)
+    Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr copy(const Akonadi2::ApplicationDomain::ApplicationDomainType &object) Q_DECL_OVERRIDE
     {
-        auto resultSetPtr = QSharedPointer<ResultSet>::create(resultSet);
-
-        //Read through the source values and return whatever matches the filter
-        std::function<bool(std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)>)> generator = [resultSetPtr, storage, adaptorFactory, filter, instanceIdentifier](std::function<void(const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &)> callback) -> bool {
-            while (resultSetPtr->next()) {
-                readValue(storage, resultSetPtr->id(), [filter, callback](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject) {
-                    if (filter(domainObject)) {
-                        callback(domainObject);
-                    }
-                }, adaptorFactory, instanceIdentifier);
-            }
-            return false;
-        };
-        return ResultSet(generator);
+        return Akonadi2::ApplicationDomain::ApplicationDomainType::getInMemoryRepresentation<DomainType>(object);
     }
 
-    static ResultSet getResultSet(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::Storage> &storage, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory, const QByteArray &resourceInstanceIdentifier, qint64 baseRevision, qint64 topRevision)
+    ResultSet queryIndexes(const Akonadi2::Query &query, const QByteArray &resourceInstanceIdentifier, QSet<QByteArray> &appliedFilters) Q_DECL_OVERRIDE
     {
-        QSet<QByteArray> appliedFilters;
-        ResultSet resultSet = Akonadi2::ApplicationDomain::TypeImplementation<DomainType>::queryIndexes(query, resourceInstanceIdentifier, appliedFilters, qMakePair(baseRevision, topRevision));
-        const auto remainingFilters = query.propertyFilter.keys().toSet() - appliedFilters;
-
-        //We do a full scan if there were no indexes available to create the initial set.
-        if (appliedFilters.isEmpty()) {
-            resultSet = fullScan(storage);
-        }
-
-        auto filter = [remainingFilters, query, baseRevision, topRevision](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &domainObject) -> bool {
-            if (topRevision > 0) {
-                Trace() << "filtering by revision " << domainObject->revision();
-                if (domainObject->revision() < baseRevision || domainObject->revision() > topRevision) {
-                    return false;
-                }
-            }
-            for (const auto &filterProperty : remainingFilters) {
-                //TODO implement other comparison operators than equality
-                if (domainObject->getProperty(filterProperty) != query.propertyFilter.value(filterProperty)) {
-                    return false;
-                }
-            }
-            return true;
-        };
-
-        return filteredSet(resultSet, filter, storage, adaptorFactory, baseRevision, topRevision, resourceInstanceIdentifier);
+        return Akonadi2::ApplicationDomain::TypeImplementation<DomainType>::queryIndexes(query, resourceInstanceIdentifier, appliedFilters);
     }
 
 public:
 
-    void read(const Akonadi2::Query &query, const QPair<qint64, qint64> &revisionRange, const QSharedPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > &resultProvider)
+    virtual void read(const Akonadi2::Query &query, const QPair<qint64, qint64> &revisionRange, const QSharedPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > &resultProvider) 
     {
         auto storage = QSharedPointer<Akonadi2::Storage>::create(Akonadi2::Store::storageLocation(), mResourceInstanceIdentifier);
         storage->setDefaultErrorHandler([](const Akonadi2::Storage::Error &error) {
@@ -159,17 +94,14 @@ public:
         //TODO start transaction on indexes as well
 
         Log() << "Querying" << revisionRange.first << revisionRange.second;
-        auto resultSet = getResultSet(query, storage, mDomainTypeAdaptorFactory, mResourceInstanceIdentifier, revisionRange.first, revisionRange.second);
-        auto resultCallback = std::bind(&Akonadi2::ResultProvider<typename DomainType::Ptr>::add, resultProvider, std::placeholders::_1);
-        while(resultSet.next([resultCallback](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &value) -> bool {
-            resultCallback(Akonadi2::ApplicationDomain::ApplicationDomainType::getInMemoryRepresentation<DomainType>(*value));
+        auto resultSet = getResultSet(query, storage, revisionRange.first, revisionRange.second);
+        while(resultSet.next([this, resultProvider](const Akonadi2::ApplicationDomain::ApplicationDomainType::Ptr &value) -> bool {
+            auto cloned = copy(*value);
+            resultProvider->add(cloned.template staticCast<DomainType>());
             return true;
         })){};
         //TODO replay removals and modifications
         storage->abortTransaction();
     }
 
-private:
-    DomainTypeAdaptorFactoryInterface::Ptr mDomainTypeAdaptorFactory;
-    QByteArray mResourceInstanceIdentifier;
 };
diff --git a/common/facade.h b/common/facade.h
index ef3bbbc..254f671 100644
--- a/common/facade.h
+++ b/common/facade.h
@@ -112,9 +112,10 @@ public:
      * @param resourceIdentifier is the identifier of the resource instance
      * @param adaptorFactory is the adaptor factory used to generate the mappings from domain to resource types and vice versa
      */
-    GenericFacade(const QByteArray &resourceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory = DomainTypeAdaptorFactoryInterface::Ptr())
+    GenericFacade(const QByteArray &resourceIdentifier, const DomainTypeAdaptorFactoryInterface::Ptr &adaptorFactory = DomainTypeAdaptorFactoryInterface::Ptr(), const QSharedPointer<EntityStorage<DomainType> > storage = QSharedPointer<EntityStorage<DomainType> >())
         : Akonadi2::StoreFacade<DomainType>(),
         mResourceAccess(new ResourceAccess(resourceIdentifier)),
+        mStorage(storage ? storage : QSharedPointer<EntityStorage<DomainType> >::create(resourceIdentifier, adaptorFactory)),
         mDomainTypeAdaptorFactory(adaptorFactory),
         mResourceInstanceIdentifier(resourceIdentifier)
     {
@@ -257,11 +258,11 @@ protected:
     }
 
 
+private:
     virtual KAsync::Job<qint64> load(const Akonadi2::Query &query, const QSharedPointer<Akonadi2::ResultProvider<typename DomainType::Ptr> > &resultProvider, qint64 oldRevision, qint64 newRevision)
     {
         return KAsync::start<qint64>([=]() -> qint64 {
-            EntityStorage<DomainType> storage(mResourceInstanceIdentifier, mDomainTypeAdaptorFactory);
-            storage.read(query, qMakePair(oldRevision, newRevision), resultProvider);
+            mStorage->read(query, qMakePair(oldRevision, newRevision), resultProvider);
             return newRevision;
         });
     }
@@ -269,6 +270,7 @@ protected:
 protected:
     //TODO use one resource access instance per application & per resource
     QSharedPointer<Akonadi2::ResourceAccess> mResourceAccess;
+    QSharedPointer<EntityStorage<DomainType> > mStorage;
     DomainTypeAdaptorFactoryInterface::Ptr mDomainTypeAdaptorFactory;
     QByteArray mResourceInstanceIdentifier;
 };
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index eb4d606..6a52101 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -40,6 +40,7 @@ auto_tests (
     messagequeuetest
     indextest
     genericresourcetest
+    genericfacadetest
 )
 
 target_link_libraries(dummyresourcetest akonadi2_resource_dummy)
diff --git a/tests/genericfacadetest.cpp b/tests/genericfacadetest.cpp
new file mode 100644
index 0000000..fa086d1
--- /dev/null
+++ b/tests/genericfacadetest.cpp
@@ -0,0 +1,80 @@
+#include <QtTest>
+
+#include <QString>
+
+#include <common/facade.h>
+#include <common/domainadaptor.h>
+#include <common/resultprovider.h>
+#include <common/synclistresult.h>
+
+//Replace with something different
+#include "event_generated.h"
+
+class TestEventAdaptorFactory : public DomainTypeAdaptorFactory<Akonadi2::ApplicationDomain::Event, Akonadi2::ApplicationDomain::Buffer::Event, Akonadi2::ApplicationDomain::Buffer::EventBuilder>
+{
+public:
+    TestEventAdaptorFactory()
+        : DomainTypeAdaptorFactory()
+    {
+    }
+
+    virtual ~TestEventAdaptorFactory() {};
+};
+
+class TestEntityStorage : public EntityStorage<Akonadi2::ApplicationDomain::Event>
+{
+public:
+    using EntityStorage::EntityStorage;
+    virtual void read(const Akonadi2::Query &query, const QPair<qint64, qint64> &revisionRange, const QSharedPointer<Akonadi2::ResultProvider<Akonadi2::ApplicationDomain::Event::Ptr> > &resultProvider)  Q_DECL_OVERRIDE
+    {
+        for (const auto &res : mResults) {
+            resultProvider->add(res);
+        }
+    }
+
+    QList<Akonadi2::ApplicationDomain::Event::Ptr> mResults;
+};
+
+class TestResourceFacade : public Akonadi2::GenericFacade<Akonadi2::ApplicationDomain::Event>
+{
+public:
+    TestResourceFacade(const QByteArray &instanceIdentifier, const QSharedPointer<EntityStorage<Akonadi2::ApplicationDomain::Event> > storage)
+        : Akonadi2::GenericFacade<Akonadi2::ApplicationDomain::Event>(instanceIdentifier, QSharedPointer<TestEventAdaptorFactory>::create(), storage)
+    {
+
+    }
+    virtual ~TestResourceFacade()
+    {
+
+    }
+};
+
+class GenericFacadeTest : public QObject
+{
+    Q_OBJECT
+private Q_SLOTS:
+
+    void testLoad()
+    {
+        Akonadi2::Query query;
+        query.liveQuery = false;
+        auto resultSet = QSharedPointer<Akonadi2::ResultProvider<Akonadi2::ApplicationDomain::Event::Ptr> >::create();
+
+        auto storage = QSharedPointer<TestEntityStorage>::create("identifier", QSharedPointer<TestEventAdaptorFactory>::create());
+        storage->mResults << Akonadi2::ApplicationDomain::Event::Ptr::create();
+        TestResourceFacade facade("identifier", storage);
+
+        async::SyncListResult<Akonadi2::ApplicationDomain::Event::Ptr> result(resultSet->emitter());
+
+        facade.load(query, resultSet).exec().waitForFinished();
+        resultSet->initialResultSetComplete();
+
+        //We have to wait for the events that deliver the results to be processed by the eventloop
+        result.exec();
+
+        QCOMPARE(result.size(), 1);
+    }
+};
+
+QTEST_MAIN(GenericFacadeTest)
+#include "genericfacadetest.moc"