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

**

** 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 test suite of the Qt Toolkit.

**

** $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 <qtest.h>

#include <QSignalSpy>

#include <QTimer>

#include <QHostAddress>

#include <QDebug>

#include <QThread>

#include <QtDeclarative/qdeclarativeengine.h>

#include <QtDeclarative/qdeclarativecontext.h>

#include <QtDeclarative/qdeclarativecomponent.h>

#include <QtDeclarative/qdeclarativeexpression.h>

#include <QtDeclarative/qdeclarativeproperty.h>

#include <private/qdeclarativebinding_p.h>

#include <private/qdeclarativedebug_p.h>

#include <private/qdeclarativeenginedebug_p.h>

#include <private/qdeclarativedebugclient_p.h>

#include <private/qdeclarativedebugservice_p.h>

#include <private/qdeclarativerectangle_p.h>

#include <private/qdeclarativemetatype_p.h>

#include <private/qdeclarativeproperty_p.h>

#include "../../../shared/util.h"

#include "../shared/debugutil_p.h"

Q_DECLARE_METATYPE(QDeclarativeDebugWatch::State)

class tst_QDeclarativeDebug : public QObject

{

    Q_OBJECT

private:

    QDeclarativeDebugObjectReference findRootObject();

    QDeclarativeDebugPropertyReference findProperty(const QList<QDeclarativeDebugPropertyReference> &props, const QString &name) const;

    void waitForQuery(QDeclarativeDebugQuery *query);

    void recursiveObjectTest(QObject *o, const QDeclarativeDebugObjectReference &oref, bool recursive) const;

    void recursiveCompareObjects(const QDeclarativeDebugObjectReference &a, const QDeclarativeDebugObjectReference &b) const;

    void recursiveCompareContexts(const QDeclarativeDebugContextReference &a, const QDeclarativeDebugContextReference &b) const;

    void compareProperties(const QDeclarativeDebugPropertyReference &a, const QDeclarativeDebugPropertyReference &b) const;

    QDeclarativeDebugConnection *m_conn;

    QDeclarativeEngineDebug *m_dbg;

    QDeclarativeEngine *m_engine;

    QDeclarativeItem *m_rootItem;

    QObjectList m_components;

private slots:

    void initTestCase();

    void cleanupTestCase();

    void watch_property();

    void watch_object();

    void watch_expression();

    void watch_expression_data();

    void watch_context();

    void watch_file();

    void queryAvailableEngines();

    void queryRootContexts();

    void queryObject();

    void queryObject_data();

    void queryExpressionResult();

    void queryExpressionResult_data();

    void tst_QDeclarativeDebugFileReference();

    void tst_QDeclarativeDebugEngineReference();

    void tst_QDeclarativeDebugObjectReference();

    void tst_QDeclarativeDebugContextReference();

    void tst_QDeclarativeDebugPropertyReference();

};

QDeclarativeDebugObjectReference tst_QDeclarativeDebug::findRootObject()

{

    QDeclarativeDebugEnginesQuery *q_engines = m_dbg->queryAvailableEngines(this);

    waitForQuery(q_engines);

    if (q_engines->engines().count() == 0)

        return QDeclarativeDebugObjectReference();

    QDeclarativeDebugRootContextQuery *q_context = m_dbg->queryRootContexts(q_engines->engines()[0].debugId(), this);

    waitForQuery(q_context);

    if (q_context->rootContext().objects().count() == 0)

        return QDeclarativeDebugObjectReference();

    QDeclarativeDebugObjectQuery *q_obj = m_dbg->queryObject(q_context->rootContext().objects()[0], this);

    waitForQuery(q_obj);

    QDeclarativeDebugObjectReference result = q_obj->object();

    delete q_engines;

    delete q_context;

    delete q_obj;

    return result;

}

QDeclarativeDebugPropertyReference tst_QDeclarativeDebug::findProperty(const QList<QDeclarativeDebugPropertyReference> &props, const QString &name) const

{

    foreach(const QDeclarativeDebugPropertyReference &p, props) {

        if (p.name() == name)

            return p;

    }

    return QDeclarativeDebugPropertyReference();

}

void tst_QDeclarativeDebug::waitForQuery(QDeclarativeDebugQuery *query)

{

    QVERIFY(query);

    QCOMPARE(query->parent(), qobject_cast<QObject*>(this));

    QVERIFY(query->state() == QDeclarativeDebugQuery::Waiting);

    if (!QDeclarativeDebugTest::waitForSignal(query, SIGNAL(stateChanged(QDeclarativeDebugQuery::State))))

        QFAIL("query timed out");

}

void tst_QDeclarativeDebug::recursiveObjectTest(QObject *o, const QDeclarativeDebugObjectReference &oref, bool recursive) const

{

    const QMetaObject *meta = o->metaObject();

    QDeclarativeType *type = QDeclarativeMetaType::qmlType(o->metaObject());

    QString className = type ? type->qmlTypeName() : QString();

    className = className.mid(className.lastIndexOf(QLatin1Char('/'))+1);

    QCOMPARE(oref.debugId(), QDeclarativeDebugService::idForObject(o));

    QCOMPARE(oref.name(), o->objectName());

    QCOMPARE(oref.className(), className);

    QCOMPARE(oref.contextDebugId(), QDeclarativeDebugService::idForObject(qmlContext(o)));

    const QObjectList &children = o->children();

    for (int i=0; i<children.count(); i++) {

        QObject *child = children[i];

        if (!qmlContext(child))

            continue;

        int debugId = QDeclarativeDebugService::idForObject(child);

        QVERIFY(debugId >= 0);

        QDeclarativeDebugObjectReference cref;

        foreach (const QDeclarativeDebugObjectReference &ref, oref.children()) {

            if (ref.debugId() == debugId) {

                cref = ref;

                break;

            }

        }

        QVERIFY(cref.debugId() >= 0);

        if (recursive)

            recursiveObjectTest(child, cref, true);

    }

    foreach (const QDeclarativeDebugPropertyReference &p, oref.properties()) {

        QCOMPARE(p.objectDebugId(), QDeclarativeDebugService::idForObject(o));

        // signal properties are fake - they are generated from QDeclarativeBoundSignal children

        if (p.name().startsWith("on") && p.name().length() > 2 && p.name()[2].isUpper()) {

            QVERIFY(p.value().toString().startsWith('{') && p.value().toString().endsWith('}'));

            QVERIFY(p.valueTypeName().isEmpty());

            QVERIFY(p.binding().isEmpty());

            QVERIFY(!p.hasNotifySignal());

            continue;

        }

        QMetaProperty pmeta = meta->property(meta->indexOfProperty(p.name().toUtf8().constData()));

        QCOMPARE(p.name(), QString::fromUtf8(pmeta.name()));

        if (pmeta.type() < QVariant::UserType) // TODO test complex types

            QCOMPARE(p.value(), pmeta.read(o));

        if (p.name() == "parent")

            QVERIFY(p.valueTypeName() == "QGraphicsObject*" || p.valueTypeName() == "QDeclarativeItem*");

        else

            QCOMPARE(p.valueTypeName(), QString::fromUtf8(pmeta.typeName()));

        QDeclarativeAbstractBinding *binding = 

            QDeclarativePropertyPrivate::binding(QDeclarativeProperty(o, p.name()));

        if (binding)

            QCOMPARE(binding->expression(), p.binding());

        QCOMPARE(p.hasNotifySignal(), pmeta.hasNotifySignal());

        QVERIFY(pmeta.isValid());

    }

}

void tst_QDeclarativeDebug::recursiveCompareObjects(const QDeclarativeDebugObjectReference &a, const QDeclarativeDebugObjectReference &b) const

{

    QCOMPARE(a.debugId(), b.debugId());

    QCOMPARE(a.className(), b.className());

    QCOMPARE(a.name(), b.name());

    QCOMPARE(a.contextDebugId(), b.contextDebugId());

    QCOMPARE(a.source().url(), b.source().url());

    QCOMPARE(a.source().lineNumber(), b.source().lineNumber());

    QCOMPARE(a.source().columnNumber(), b.source().columnNumber());

    QCOMPARE(a.properties().count(), b.properties().count());

    QCOMPARE(a.children().count(), b.children().count());

    QList<QDeclarativeDebugPropertyReference> aprops = a.properties();

    QList<QDeclarativeDebugPropertyReference> bprops = b.properties();

    for (int i=0; i<aprops.count(); i++)

        compareProperties(aprops[i], bprops[i]);

    for (int i=0; i<a.children().count(); i++)

        recursiveCompareObjects(a.children()[i], b.children()[i]);

}

void tst_QDeclarativeDebug::recursiveCompareContexts(const QDeclarativeDebugContextReference &a, const QDeclarativeDebugContextReference &b) const

{

    QCOMPARE(a.debugId(), b.debugId());

    QCOMPARE(a.name(), b.name());

    QCOMPARE(a.objects().count(), b.objects().count());

    QCOMPARE(a.contexts().count(), b.contexts().count());

    for (int i=0; i<a.objects().count(); i++)

        recursiveCompareObjects(a.objects()[i], b.objects()[i]);

    for (int i=0; i<a.contexts().count(); i++)

        recursiveCompareContexts(a.contexts()[i], b.contexts()[i]);

}

void tst_QDeclarativeDebug::compareProperties(const QDeclarativeDebugPropertyReference &a, const QDeclarativeDebugPropertyReference &b) const

{

    QCOMPARE(a.objectDebugId(), b.objectDebugId());

    QCOMPARE(a.name(), b.name());

    QCOMPARE(a.value(), b.value());

    QCOMPARE(a.valueTypeName(), b.valueTypeName());

    QCOMPARE(a.binding(), b.binding());

    QCOMPARE(a.hasNotifySignal(), b.hasNotifySignal());

}

void tst_QDeclarativeDebug::initTestCase()

{

    qRegisterMetaType<QDeclarativeDebugWatch::State>();

    QTest::ignoreMessage(QtWarningMsg, "QDeclarativeDebugServer: Waiting for connection on port 3768...");

    qputenv("QML_DEBUG_SERVER_PORT", "3768");

    m_engine = new QDeclarativeEngine(this);

    QList<QByteArray> qml;

    qml << "import Qt 4.7\n"

            "Item {"

                "width: 10; height: 20; scale: blueRect.scale;"

                "Rectangle { id: blueRect; width: 500; height: 600; color: \"blue\"; }"

                "Text { color: blueRect.color; }"

                "MouseArea {"

                    "onEntered: { console.log('hello') }"

                "}"

            "}";

    // add second component to test multiple root contexts

    qml << "import Qt 4.7\n"

            "Item {}";

    for (int i=0; i<qml.count(); i++) {

        QDeclarativeComponent component(m_engine);

        component.setData(qml[i], QUrl::fromLocalFile(""));

        Q_ASSERT(component.isReady());  // fails if bad syntax

        m_components << qobject_cast<QDeclarativeItem*>(component.create());

    }

    m_rootItem = qobject_cast<QDeclarativeItem*>(m_components.first());

    // add an extra context to test for multiple contexts

    QDeclarativeContext *context = new QDeclarativeContext(m_engine->rootContext(), this);

    context->setObjectName("tst_QDeclarativeDebug_childContext");

    m_conn = new QDeclarativeDebugConnection(this);

    m_conn->connectToHost("127.0.0.1", 3768);

    QTest::ignoreMessage(QtWarningMsg, "QDeclarativeDebugServer: Connection established");

    bool ok = m_conn->waitForConnected();

    Q_ASSERT(ok);

    QTRY_VERIFY(QDeclarativeDebugService::hasDebuggingClient());

    m_dbg = new QDeclarativeEngineDebug(m_conn, this);

}

void tst_QDeclarativeDebug::cleanupTestCase()

{

    qDeleteAll(m_components);

}

void tst_QDeclarativeDebug::watch_property()

{

    QDeclarativeDebugObjectReference obj = findRootObject();

    QDeclarativeDebugPropertyReference prop = findProperty(obj.properties(), "width");

    QDeclarativeDebugPropertyWatch *watch;

    QDeclarativeEngineDebug *unconnected = new QDeclarativeEngineDebug(0);

    watch = unconnected->addWatch(prop, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Dead);

    delete watch;

    delete unconnected;

    watch = m_dbg->addWatch(QDeclarativeDebugPropertyReference(), this);

    QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Inactive);

    delete watch;

    watch = m_dbg->addWatch(prop, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Waiting);

    QCOMPARE(watch->objectDebugId(), obj.debugId());

    QCOMPARE(watch->name(), prop.name());

    QSignalSpy spy(watch, SIGNAL(valueChanged(QByteArray,QVariant)));

    int origWidth = m_rootItem->property("width").toInt();

    m_rootItem->setProperty("width", origWidth*2);

    // stateChanged() is received before valueChanged()

    QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Active);

    QCOMPARE(spy.count(), 1);

    m_dbg->removeWatch(watch);

    delete watch;

    // restore original value and verify spy doesn't get additional signal since watch has been removed

    m_rootItem->setProperty("width", origWidth);

    QTest::qWait(100);

    QCOMPARE(spy.count(), 1);

    QCOMPARE(spy.at(0).at(0).value<QByteArray>(), prop.name().toUtf8());

    QCOMPARE(spy.at(0).at(1).value<QVariant>(), qVariantFromValue(origWidth*2));

}

void tst_QDeclarativeDebug::watch_object()

{

    QDeclarativeDebugEnginesQuery *q_engines = m_dbg->queryAvailableEngines(this);

    waitForQuery(q_engines);

    Q_ASSERT(q_engines->engines().count() > 0);

    QDeclarativeDebugRootContextQuery *q_context = m_dbg->queryRootContexts(q_engines->engines()[0].debugId(), this);

    waitForQuery(q_context);

    Q_ASSERT(q_context->rootContext().objects().count() > 0);

    QDeclarativeDebugObjectQuery *q_obj = m_dbg->queryObject(q_context->rootContext().objects()[0], this);

    waitForQuery(q_obj);

    QDeclarativeDebugObjectReference obj = q_obj->object();

    delete q_engines;

    delete q_context;

    delete q_obj;

    QDeclarativeDebugWatch *watch;

    QDeclarativeEngineDebug *unconnected = new QDeclarativeEngineDebug(0);

    watch = unconnected->addWatch(obj, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Dead);

    delete watch;

    delete unconnected;

    watch = m_dbg->addWatch(QDeclarativeDebugObjectReference(), this);

    QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Inactive);

    delete watch;

    watch = m_dbg->addWatch(obj, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Waiting);

    QCOMPARE(watch->objectDebugId(), obj.debugId());

    QSignalSpy spy(watch, SIGNAL(valueChanged(QByteArray,QVariant)));

    int origWidth = m_rootItem->property("width").toInt();

    int origHeight = m_rootItem->property("height").toInt();

    m_rootItem->setProperty("width", origWidth*2);

    m_rootItem->setProperty("height", origHeight*2);

    // stateChanged() is received before any valueChanged() signals

    QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Active);

    QVERIFY(spy.count() > 0);

    int newWidth = -1;

    int newHeight = -1;

    for (int i=0; i<spy.count(); i++) {

        const QVariantList &values = spy[i];

        if (values[0].value<QByteArray>() == "width")

            newWidth = values[1].value<QVariant>().toInt();

        else if (values[0].value<QByteArray>() == "height")

            newHeight = values[1].value<QVariant>().toInt();

    }

    m_dbg->removeWatch(watch);

    delete watch;

    // since watch has been removed, restoring the original values should not trigger a valueChanged()

    spy.clear();

    m_rootItem->setProperty("width", origWidth);

    m_rootItem->setProperty("height", origHeight);

    QTest::qWait(100);

    QCOMPARE(spy.count(), 0);

    QCOMPARE(newWidth, origWidth * 2);

    QCOMPARE(newHeight, origHeight * 2);

}

void tst_QDeclarativeDebug::watch_expression()

{

    QFETCH(QString, expr);

    QFETCH(int, increment);

    QFETCH(int, incrementCount);

    int origWidth = m_rootItem->property("width").toInt();

    QDeclarativeDebugObjectReference obj = findRootObject();

    QDeclarativeDebugObjectExpressionWatch *watch;

    QDeclarativeEngineDebug *unconnected = new QDeclarativeEngineDebug(0);

    watch = unconnected->addWatch(obj, expr, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Dead);

    delete watch;

    delete unconnected;

    watch = m_dbg->addWatch(QDeclarativeDebugObjectReference(), expr, this);

    QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Inactive);

    delete watch;

    watch = m_dbg->addWatch(obj, expr, this);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Waiting);

    QCOMPARE(watch->objectDebugId(), obj.debugId());

    QCOMPARE(watch->expression(), expr);

    QSignalSpy spyState(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State)));

    QSignalSpy spy(watch, SIGNAL(valueChanged(QByteArray,QVariant)));

    int expectedSpyCount = incrementCount + 1;  // should also get signal with expression's initial value

    int width = origWidth;

    for (int i=0; i<incrementCount+1; i++) {

        if (i > 0) {

            width += increment;

            m_rootItem->setProperty("width", width);

        }

        if (!QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(valueChanged(QByteArray,QVariant))))

            QFAIL("Did not receive valueChanged() for expression");

    }

    if (spyState.count() == 0)

        QVERIFY(QDeclarativeDebugTest::waitForSignal(watch, SIGNAL(stateChanged(QDeclarativeDebugWatch::State))));

    QCOMPARE(spyState.count(), 1);

    QCOMPARE(watch->state(), QDeclarativeDebugWatch::Active);

    m_dbg->removeWatch(watch);

    delete watch;

    // restore original value and verify spy doesn't get a signal since watch has been removed

    m_rootItem->setProperty("width", origWidth); 

    QTest::qWait(100);

    QCOMPARE(spy.count(), expectedSpyCount);

    width = origWidth + increment;

    for (int i=0; i<spy.count(); i++) {

        QCOMPARE(spy.at(i).at(1).value<QVariant>().toInt(), width);

        width += increment;

    }

}

void tst_QDeclarativeDebug::watch_expression_data()

{

    QTest::addColumn<QString>("expr");

    QTest::addColumn<int>("increment");

    QTest::addColumn<int>("incrementCount");

    QTest::newRow("width") << "width" << 0 << 0;

    QTest::newRow("width+10") << "width + 10" << 10 << 5;

}

void tst_QDeclarativeDebug::watch_context()

{

    QDeclarativeDebugContextReference c;

    QTest::ignoreMessage(QtWarningMsg, "QDeclarativeEngineDebug::addWatch(): Not implemented");

    QVERIFY(!m_dbg->addWatch(c, QString(), this));

}

void tst_QDeclarativeDebug::watch_file()

{

    QDeclarativeDebugFileReference f;

    QTest::ignoreMessage(QtWarningMsg, "QDeclarativeEngineDebug::addWatch(): Not implemented");

    QVERIFY(!m_dbg->addWatch(f, this));

}