Unit Tests for QRenderPassFilter

Change-Id: I304a5b7a0501ccb94e0c100ae5445e6a5ddbd594
Reviewed-by: Andy Nichols <andy.nichols@theqtcompany.com>

3 files changed, 262 insertions, 1 deletions

diff --git a/tests/auto/render/qrenderpassfilter/qrenderpassfilter.pro b/tests/auto/render/qrenderpassfilter/qrenderpassfilter.pro
new file mode 100644
index 000000000..f69ed7202
--- /dev/null
+++ b/tests/auto/render/qrenderpassfilter/qrenderpassfilter.pro
@@ -0,0 +1,10 @@
+TEMPLATE = app
+
+TARGET = tst_qrenderpassfilter
+QT += core-private 3dcore 3dcore-private 3drenderer 3drenderer-private testlib
+
+CONFIG += testcase
+
+SOURCES += tst_qrenderpassfilter.cpp
+
+include(../commons/commons.pri)
diff --git a/tests/auto/render/qrenderpassfilter/tst_qrenderpassfilter.cpp b/tests/auto/render/qrenderpassfilter/tst_qrenderpassfilter.cpp
new file mode 100644
index 000000000..a8e3f943f
--- /dev/null
+++ b/tests/auto/render/qrenderpassfilter/tst_qrenderpassfilter.cpp
@@ -0,0 +1,250 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QTest>
+#include <Qt3DCore/private/qnode_p.h>
+#include <Qt3DCore/private/qscene_p.h>
+#include <Qt3DCore/qentity.h>
+
+#include <Qt3DRenderer/qrenderpassfilter.h>
+#include <Qt3DRenderer/qparameter.h>
+#include <Qt3DRenderer/qannotation.h>
+
+#include "testpostmanarbiter.h"
+
+// We need to call QNode::clone which is protected
+// So we sublcass QNode instead of QObject
+class tst_QRenderPassFilter: public Qt3DCore::QNode
+{
+    Q_OBJECT
+public:
+    ~tst_QRenderPassFilter()
+    {
+        QNode::cleanup();
+    }
+
+private Q_SLOTS:
+
+    void checkSaneDefaults()
+    {
+        QScopedPointer<Qt3DRender::QRenderPassFilter> defaultRenderPassFilter(new Qt3DRender::QRenderPassFilter);
+
+        QCOMPARE(defaultRenderPassFilter->includes().count(), 0);
+        QCOMPARE(defaultRenderPassFilter->parameters().count(), 0);
+    }
+
+    void checkCloning_data()
+    {
+        QTest::addColumn<Qt3DRender::QRenderPassFilter *>("renderPassFilter");
+        QTest::addColumn<QList<Qt3DRender::QParameter *> >("parameters");
+        QTest::addColumn<QList<Qt3DRender::QAnnotation *> >("annotations");
+
+        Qt3DRender::QRenderPassFilter *defaultConstructed = new Qt3DRender::QRenderPassFilter();
+        QTest::newRow("defaultConstructed") << defaultConstructed << QList<Qt3DRender::QParameter *>() << QList<Qt3DRender::QAnnotation *>();
+
+        Qt3DRender::QRenderPassFilter *renderPassFilterWithParams = new Qt3DRender::QRenderPassFilter();
+        Qt3DRender::QParameter *parameter1 = new Qt3DRender::QParameter(QStringLiteral("displacement"), 454.0f);
+        Qt3DRender::QParameter *parameter2 = new Qt3DRender::QParameter(QStringLiteral("torque"), 650);
+        QList<Qt3DRender::QParameter *> params1 = QList<Qt3DRender::QParameter *>() << parameter1 << parameter2;
+        renderPassFilterWithParams->addParameter(parameter1);
+        renderPassFilterWithParams->addParameter(parameter2);
+        QTest::newRow("renderPassFilterWithParams") << renderPassFilterWithParams << params1 << QList<Qt3DRender::QAnnotation *>();
+
+        Qt3DRender::QRenderPassFilter *renderPassFilterWithAnnotations = new Qt3DRender::QRenderPassFilter();
+        Qt3DRender::QAnnotation *annotation1 = new Qt3DRender::QAnnotation();
+        Qt3DRender::QAnnotation *annotation2 = new Qt3DRender::QAnnotation();
+        annotation1->setName(QStringLiteral("hasSuperCharger"));
+        annotation1->setValue(true);
+        annotation1->setName(QStringLiteral("hasNitroKit"));
+        annotation1->setValue(false);
+        QList<Qt3DRender::QAnnotation *> annotations1 = QList<Qt3DRender::QAnnotation *>() << annotation1 << annotation2;
+        renderPassFilterWithAnnotations->addInclude(annotation1);
+        renderPassFilterWithAnnotations->addInclude(annotation2);
+        QTest::newRow("renderPassFilterWithAnnotations") << renderPassFilterWithAnnotations << QList<Qt3DRender::QParameter *>() << annotations1;
+
+        Qt3DRender::QRenderPassFilter *renderPassFilterWithParamsAndAnnotations = new Qt3DRender::QRenderPassFilter();
+        Qt3DRender::QParameter *parameter3 = new Qt3DRender::QParameter(QStringLiteral("displacement"), 383.0f);
+        Qt3DRender::QParameter *parameter4 = new Qt3DRender::QParameter(QStringLiteral("torque"), 555);
+        Qt3DRender::QAnnotation *annotation3 = new Qt3DRender::QAnnotation();
+        Qt3DRender::QAnnotation *annotation4 = new Qt3DRender::QAnnotation();
+        annotation3->setName(QStringLiteral("hasSuperCharger"));
+        annotation3->setValue(false);
+        annotation4->setName(QStringLiteral("hasNitroKit"));
+        annotation4->setValue(true);
+        QList<Qt3DRender::QParameter *> params2 = QList<Qt3DRender::QParameter *>() << parameter3 << parameter4;
+        QList<Qt3DRender::QAnnotation *> annotations2 = QList<Qt3DRender::QAnnotation *>() << annotation3 << annotation4;
+        renderPassFilterWithParamsAndAnnotations->addParameter(parameter3);
+        renderPassFilterWithParamsAndAnnotations->addParameter(parameter4);
+        renderPassFilterWithParamsAndAnnotations->addInclude(annotation3);
+        renderPassFilterWithParamsAndAnnotations->addInclude(annotation4);
+        QTest::newRow("renderPassFilterWithParamsAndAnnotations") << renderPassFilterWithParamsAndAnnotations << params2 << annotations2;
+    }
+
+    void checkCloning()
+    {
+        // GIVEN
+        QFETCH(Qt3DRender::QRenderPassFilter*, renderPassFilter);
+        QFETCH(QList<Qt3DRender::QParameter *>, parameters);
+        QFETCH(QList<Qt3DRender::QAnnotation *>, annotations);
+
+        // THEN
+        QCOMPARE(renderPassFilter->parameters(), parameters);
+        QCOMPARE(renderPassFilter->includes(), annotations);
+
+        // WHEN
+        Qt3DRender::QRenderPassFilter *clone = static_cast<Qt3DRender::QRenderPassFilter *>(QNode::clone(renderPassFilter));
+
+        // THEN
+        QVERIFY(clone != Q_NULLPTR);
+        QCOMPARE(renderPassFilter->id(), clone->id());
+
+        QCOMPARE(renderPassFilter->includes().count(), clone->includes().count());
+        QCOMPARE(renderPassFilter->parameters().count(), clone->parameters().count());
+
+        for (int i = 0, m = parameters.count(); i < m; ++i) {
+            Qt3DRender::QParameter *pClone = clone->parameters().at(i);
+            Qt3DRender::QParameter *pOrig = parameters.at(i);
+            QCOMPARE(pOrig->id(),pClone->id());
+            QCOMPARE(pOrig->name(), pClone->name());
+            QCOMPARE(pOrig->value(), pClone->value());
+            QVERIFY(pClone->parent() == clone);
+            QVERIFY(pOrig->parent() == renderPassFilter);
+        }
+
+        for (int i = 0, m = annotations.count(); i < m; ++i) {
+            Qt3DRender::QAnnotation *aClone = clone->includes().at(i);
+            Qt3DRender::QAnnotation *aOrig = annotations.at(i);
+            QCOMPARE(aOrig->id(),aClone->id());
+            QCOMPARE(aOrig->name(), aClone->name());
+            QCOMPARE(aOrig->value(), aClone->value());
+            QVERIFY(aClone->parent() == clone);
+            QVERIFY(aOrig->parent() == renderPassFilter);
+        }
+
+        delete renderPassFilter;
+        delete clone;
+    }
+
+    void checkPropertyUpdates()
+    {
+        // GIVEN
+        QScopedPointer<Qt3DRender::QRenderPassFilter> renderPassFilter(new Qt3DRender::QRenderPassFilter());
+        TestArbiter arbiter(renderPassFilter.data());
+
+        // WHEN
+        Qt3DRender::QParameter *param1 = new Qt3DRender::QParameter();
+        renderPassFilter->addParameter(param1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 1);
+        Qt3DCore::QScenePropertyChangePtr change = arbiter.events.first().staticCast<Qt3DCore::QScenePropertyChange>();
+        QCOMPARE(change->propertyName(), "parameter");
+        QCOMPARE(change->subjectId(),renderPassFilter->id());
+        QCOMPARE(change->value().value<Qt3DCore::QNodeId>(), param1->id());
+        QCOMPARE(change->type(), Qt3DCore::NodeAdded);
+
+        arbiter.events.clear();
+
+        // WHEN
+        renderPassFilter->addParameter(param1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 0);
+
+        // WHEN
+        renderPassFilter->removeParameter(param1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 1);
+        change = arbiter.events.first().staticCast<Qt3DCore::QScenePropertyChange>();
+        QCOMPARE(change->propertyName(), "parameter");
+        QCOMPARE(change->subjectId(), renderPassFilter->id());
+        QCOMPARE(change->value().value<Qt3DCore::QNodeId>(), param1->id());
+        QCOMPARE(change->type(), Qt3DCore::NodeRemoved);
+
+        arbiter.events.clear();
+
+        // WHEN
+        Qt3DRender::QAnnotation *annotation1 = new Qt3DRender::QAnnotation();
+        renderPassFilter->addInclude(annotation1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 1);
+        change = arbiter.events.first().staticCast<Qt3DCore::QScenePropertyChange>();
+        QCOMPARE(change->propertyName(), "include");
+        QCOMPARE(change->subjectId(),renderPassFilter->id());
+        QCOMPARE(change->value().value<Qt3DCore::QNodeId>(), annotation1->id());
+        QCOMPARE(change->type(), Qt3DCore::NodeAdded);
+
+        arbiter.events.clear();
+
+        // WHEN
+        renderPassFilter->addInclude(annotation1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 0);
+
+        // WHEN
+        renderPassFilter->removeInclude(annotation1);
+        QCoreApplication::processEvents();
+
+        // THEN
+        QCOMPARE(arbiter.events.size(), 1);
+        change = arbiter.events.first().staticCast<Qt3DCore::QScenePropertyChange>();
+        QCOMPARE(change->propertyName(), "include");
+        QCOMPARE(change->subjectId(), renderPassFilter->id());
+        QCOMPARE(change->value().value<Qt3DCore::QNodeId>(), annotation1->id());
+        QCOMPARE(change->type(), Qt3DCore::NodeRemoved);
+
+        arbiter.events.clear();
+    }
+
+protected:
+    Qt3DCore::QNode *doClone() const Q_DECL_OVERRIDE
+    {
+        return Q_NULLPTR;
+    }
+
+};
+
+QTEST_MAIN(tst_QRenderPassFilter)
+
+#include "tst_qrenderpassfilter.moc"
diff --git a/tests/auto/render/render.pro b/tests/auto/render/render.pro
index 7dcc25d1d..1cff56a9b 100644
--- a/tests/auto/render/render.pro
+++ b/tests/auto/render/render.pro
@@ -26,5 +26,6 @@ contains(QT_CONFIG, private_tests) {
         qclearbuffer \
         qframegraphnode \
         qframegraph \
-        qlayerfilter
+        qlayerfilter \
+        qrenderpassfilter
 }