Add unit test for FindRunningClipAnimatorsJob

Should pass before and after the refactoring.

Change-Id: I9ef8f948f03a131546fc6485e9c66494ff383714
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

5 files changed, 340 insertions, 1 deletions

diff --git a/tests/auto/animation/animation.pro b/tests/auto/animation/animation.pro
index b48fd347b..421ecfdd5 100644
--- a/tests/auto/animation/animation.pro
+++ b/tests/auto/animation/animation.pro
@@ -34,5 +34,6 @@ qtConfig(private_tests) {
         additiveclipblend \
         clipblendvalue \
         animationutils \
-        qabstractanimation
+        qabstractanimation \
+        findrunningclipanimatorsjob
 }
diff --git a/tests/auto/animation/findrunningclipanimatorsjob/clip1.json b/tests/auto/animation/findrunningclipanimatorsjob/clip1.json
new file mode 100644
index 000000000..a2ad365a8
--- /dev/null
+++ b/tests/auto/animation/findrunningclipanimatorsjob/clip1.json
@@ -0,0 +1,114 @@
+{
+  "animations": [
+    {
+      "animationName": "CubeAction",
+      "channels": [
+        {
+          "channelComponents": [
+            {
+              "channelComponentName": "Location X",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    5.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    5.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    5.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Location Y",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            },
+            {
+              "channelComponentName": "Location Z",
+              "keyFrames": [
+                {
+                  "coords": [
+                    0.0,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    -0.9597616195678711,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    0.9597616195678711,
+                    0.0
+                  ]
+                },
+                {
+                  "coords": [
+                    2.4583333333333335,
+                    0.0
+                  ],
+                  "leftHandle": [
+                    1.4985717137654622,
+                    0.0
+                  ],
+                  "rightHandle": [
+                    3.4180949529012046,
+                    0.0
+                  ]
+                }
+              ]
+            }
+          ],
+          "channelName": "Location"
+        }
+      ]
+    }
+  ]
+}
+
diff --git a/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.pro b/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.pro
new file mode 100644
index 000000000..f81b95dcd
--- /dev/null
+++ b/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.pro
@@ -0,0 +1,15 @@
+TEMPLATE = app
+
+TARGET = tst_findrunningclipanimatorsjob
+
+QT += core-private 3dcore 3dcore-private 3danimation 3danimation-private testlib
+
+CONFIG += testcase
+
+SOURCES += \
+    tst_findrunningclipanimatorsjob.cpp
+
+include(../../core/common/common.pri)
+
+RESOURCES += \
+    findrunningclipanimatorsjob.qrc
diff --git a/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.qrc b/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.qrc
new file mode 100644
index 000000000..72234ec64
--- /dev/null
+++ b/tests/auto/animation/findrunningclipanimatorsjob/findrunningclipanimatorsjob.qrc
@@ -0,0 +1,5 @@
+<RCC>
+    <qresource prefix="/">
+        <file>clip1.json</file>
+    </qresource>
+</RCC>
diff --git a/tests/auto/animation/findrunningclipanimatorsjob/tst_findrunningclipanimatorsjob.cpp b/tests/auto/animation/findrunningclipanimatorsjob/tst_findrunningclipanimatorsjob.cpp
new file mode 100644
index 000000000..79d18b7cf
--- /dev/null
+++ b/tests/auto/animation/findrunningclipanimatorsjob/tst_findrunningclipanimatorsjob.cpp
@@ -0,0 +1,204 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QTest>
+#include <Qt3DAnimation/qanimationcliploader.h>
+#include <Qt3DAnimation/qclipanimator.h>
+#include <Qt3DAnimation/qchannelmapper.h>
+#include <Qt3DAnimation/qchannelmapping.h>
+#include <Qt3DAnimation/private/clipanimator_p.h>
+#include <Qt3DAnimation/private/channelmapper_p.h>
+#include <Qt3DAnimation/private/channelmapping_p.h>
+#include <Qt3DAnimation/private/findrunningclipanimatorsjob_p.h>
+#include <Qt3DAnimation/private/handler_p.h>
+#include <Qt3DAnimation/private/managers_p.h>
+#include <Qt3DCore/private/qnode_p.h>
+#include <Qt3DCore/private/qscene_p.h>
+#include <Qt3DCore/qpropertyupdatedchange.h>
+#include <Qt3DCore/private/qbackendnode_p.h>
+#include <qbackendnodetester.h>
+#include <testpostmanarbiter.h>
+
+using namespace Qt3DAnimation::Animation;
+
+Q_DECLARE_METATYPE(Qt3DAnimation::Animation::Handler*)
+Q_DECLARE_METATYPE(QVector<Qt3DAnimation::Animation::HClipAnimator>)
+
+typedef QHash<ClipAnimator*, QVector<Qt3DAnimation::Animation::MappingData>> MappingDataResults;
+Q_DECLARE_METATYPE(MappingDataResults)
+
+class tst_FindRunningClipAnimatorsJob: public Qt3DCore::QBackendNodeTester
+{
+    Q_OBJECT
+public:
+    ChannelMapping *createChannelMapping(Handler *handler,
+                                         const QString &channelName,
+                                         const Qt3DCore::QNodeId targetId,
+                                         const QString &property,
+                                         const char *propertyName,
+                                         int type)
+    {
+        auto channelMappingId = Qt3DCore::QNodeId::createId();
+        ChannelMapping *channelMapping = handler->channelMappingManager()->getOrCreateResource(channelMappingId);
+        setPeerId(channelMapping, channelMappingId);
+        channelMapping->setHandler(handler);
+        channelMapping->setTargetId(targetId);
+        channelMapping->setProperty(property);
+        channelMapping->setPropertyName(propertyName);
+        channelMapping->setChannelName(channelName);
+        channelMapping->setType(type);
+        return channelMapping;
+    }
+
+    ChannelMapper *createChannelMapper(Handler *handler,
+                                       const QVector<Qt3DCore::QNodeId> &mappingIds)
+    {
+        auto channelMapperId = Qt3DCore::QNodeId::createId();
+        ChannelMapper *channelMapper = handler->channelMapperManager()->getOrCreateResource(channelMapperId);
+        setPeerId(channelMapper, channelMapperId);
+        channelMapper->setHandler(handler);
+        channelMapper->setMappingIds(mappingIds);
+        return channelMapper;
+    }
+
+    AnimationClip *createAnimationClipLoader(Handler *handler,
+                                             const QUrl &source)
+    {
+        auto clipId = Qt3DCore::QNodeId::createId();
+        AnimationClip *clip = handler->animationClipLoaderManager()->getOrCreateResource(clipId);
+        setPeerId(clip, clipId);
+        clip->setHandler(handler);
+        clip->setDataType(AnimationClip::File);
+        clip->setSource(source);
+        clip->loadAnimation();
+        return clip;
+    }
+
+    ClipAnimator *createClipAnimator(Handler *handler,
+                                     qint64 globalStartTimeNS,
+                                     int loops)
+    {
+        auto animatorId = Qt3DCore::QNodeId::createId();
+        ClipAnimator *animator = handler->clipAnimatorManager()->getOrCreateResource(animatorId);
+        setPeerId(animator, animatorId);
+        animator->setHandler(handler);
+        animator->setStartTime(globalStartTimeNS);
+        animator->setLoops(loops);
+        return animator;
+    }
+
+private Q_SLOTS:
+    void checkJob_data()
+    {
+        QTest::addColumn<Handler *>("handler");
+        QTest::addColumn<QVector<HClipAnimator>>("dirtyClipAnimators");
+        QTest::addColumn<MappingDataResults>("expectedResults");
+
+        Handler *handler;
+        AnimationClip *clip;
+        ClipAnimator *animator;
+        QVector<HClipAnimator> dirtyClipAnimators;
+        ChannelMapper *channelMapper;
+        MappingDataResults expectedResults;
+
+        {
+            handler = new Handler();
+            clip = createAnimationClipLoader(handler, QUrl("qrc:/clip1.json"));
+
+            const qint64 globalStartTimeNS = 0;
+            const int loops = 1;
+            animator = createClipAnimator(handler, globalStartTimeNS, loops);
+            animator->setClipId(clip->peerId());
+            dirtyClipAnimators = (QVector<HClipAnimator>()
+                                 << handler->clipAnimatorManager()->getOrAcquireHandle(animator->peerId()));
+
+            auto channelMapping = createChannelMapping(handler,
+                                                       QLatin1String("Location"),
+                                                       Qt3DCore::QNodeId::createId(),
+                                                       QLatin1String("translation"),
+                                                       "translation",
+                                                       static_cast<int>(QVariant::Vector3D));
+            QVector<ChannelMapping *> channelMappings;
+            channelMappings.push_back(channelMapping);
+
+            channelMapper = createChannelMapper(handler, QVector<Qt3DCore::QNodeId>() << channelMapping->peerId());
+            animator->setMapperId(channelMapper->peerId());
+            animator->setRunning(true); // Has to be marked as running for the job to process it
+
+            const ComponentIndices locationIndices = { 0, 1, 2 };
+            MappingData expectedMapping;
+            expectedMapping.targetId = channelMapping->targetId();
+            expectedMapping.propertyName = channelMapping->propertyName();
+            expectedMapping.type = channelMapping->type();
+            expectedMapping.channelIndices = locationIndices;
+            expectedResults.insert(animator, QVector<MappingData>() << expectedMapping);
+
+            QTest::newRow("single mapping")
+                    << handler
+                    << dirtyClipAnimators
+                    << expectedResults;
+        }
+    }
+
+    void checkJob()
+    {
+        // GIVEN
+        QFETCH(Handler *, handler);
+        QFETCH(QVector<HClipAnimator>, dirtyClipAnimators);
+        QFETCH(MappingDataResults, expectedResults);
+        FindRunningClipAnimatorsJob job;
+
+        // WHEN
+        job.setHandler(handler);
+        job.setDirtyClipAnimators(dirtyClipAnimators);
+        job.run();
+
+        // THEN - check the resulting MappingData on the animator matches the expected results
+        for (const auto &dirtyClipAnimator : dirtyClipAnimators) {
+            const auto animator = handler->clipAnimatorManager()->data(dirtyClipAnimator);
+            const QVector<MappingData> actualMappingData = animator->mappingData();
+            const QVector<MappingData> expectedMappingData = expectedResults[animator];
+
+            QCOMPARE(expectedMappingData.size(), actualMappingData.size());
+            for (int i = 0; i < actualMappingData.size(); ++i) {
+                QCOMPARE(expectedMappingData[i].targetId, actualMappingData[i].targetId);
+                QCOMPARE(expectedMappingData[i].type, actualMappingData[i].type);
+                QVERIFY(qstrcmp(expectedMappingData[i].propertyName, actualMappingData[i].propertyName) == 0);
+                QCOMPARE(expectedMappingData[i].channelIndices.size(), actualMappingData[i].channelIndices.size());
+
+                for (int j = 0; j < actualMappingData[i].channelIndices.size(); ++j) {
+                    QCOMPARE(expectedMappingData[i].channelIndices[j], actualMappingData[i].channelIndices[j]);
+                }
+            }
+        }
+    }
+};
+
+QTEST_APPLESS_MAIN(tst_FindRunningClipAnimatorsJob)
+
+#include "tst_findrunningclipanimatorsjob.moc"