Add public API test to Quick API.

This test checks the compatibility of WebEngineView and QtWebKit's
WebView. (The differences are marked as expected failure.)

The QQuickWebEngineNavigationRequest class has not been
implemented yet.

Change-Id: Ie03d605b06d141c6ca352ae1cd5c6a38f4c80039
Reviewed-by: Andras Becsi <andras.becsi@digia.com>
Reviewed-by: Jocelyn Turcotte <jocelyn.turcotte@digia.com>

3 files changed, 223 insertions, 0 deletions

diff --git a/tests/auto/quick/publicapi/publicapi.pro b/tests/auto/quick/publicapi/publicapi.pro
new file mode 100644
index 000000000..1e0a82e68
--- /dev/null
+++ b/tests/auto/quick/publicapi/publicapi.pro
@@ -0,0 +1,2 @@
+include(../tests.pri)
+QT += webengine
diff --git a/tests/auto/quick/publicapi/tst_publicapi.cpp b/tests/auto/quick/publicapi/tst_publicapi.cpp
new file mode 100644
index 000000000..a5fd120ac
--- /dev/null
+++ b/tests/auto/quick/publicapi/tst_publicapi.cpp
@@ -0,0 +1,220 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Quick Controls module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 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 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QMetaEnum>
+#include <QMetaMethod>
+#include <QMetaObject>
+#include <QMetaProperty>
+#include <QMetaType>
+#include <QtTest/QtTest>
+#include <qquickwebengineview_p.h>
+#include <qquickwebengineloadrequest_p.h>
+// FIXME: Implement!
+// #include <qquickwebenginenavigationrequest_p.h>
+
+class tst_publicapi : public QObject {
+    Q_OBJECT
+private Q_SLOTS:
+    void publicAPI();
+};
+
+static QList<const QMetaObject *> typesToCheck = QList<const QMetaObject *>()
+    << &QQuickWebEngineView::staticMetaObject
+    << &QQuickWebEngineLoadRequest::staticMetaObject
+    // << &QQuickWebEngineNavigationRequest::staticMetaObject
+    ;
+
+static QStringList expectedAPI = QStringList()
+    << "QQuickWebEngineView.AcceptRequest --> NavigationRequestAction"
+    << "QQuickWebEngineView.IgnoreRequest --> NavigationRequestAction"
+    << "QQuickWebEngineView.LoadStartedStatus --> LoadStatus"
+    << "QQuickWebEngineView.LoadStoppedStatus --> LoadStatus"
+    << "QQuickWebEngineView.LoadSucceededStatus --> LoadStatus"
+    << "QQuickWebEngineView.LoadFailedStatus --> LoadStatus"
+    << "QQuickWebEngineView.NoErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.InternalErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.ConnectionErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.CertificateErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.HttpErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.FtpErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.DnsErrorDomain --> ErrorDomain"
+    << "QQuickWebEngineView.LinkClickedNavigation --> NavigationType"
+    << "QQuickWebEngineView.FormSubmittedNavigation --> NavigationType"
+    << "QQuickWebEngineView.BackForwardNavigation --> NavigationType"
+    << "QQuickWebEngineView.ReloadNavigation --> NavigationType"
+    << "QQuickWebEngineView.FormResubmittedNavigation --> NavigationType"
+    << "QQuickWebEngineView.OtherNavigation --> NavigationType"
+    << "QQuickWebEngineView.title --> QString"
+    << "QQuickWebEngineView.url --> QUrl"
+    << "QQuickWebEngineView.icon --> QUrl"
+    << "QQuickWebEngineView.canGoBack --> bool"
+    << "QQuickWebEngineView.canGoForward --> bool"
+    << "QQuickWebEngineView.inspectable --> bool"
+    << "QQuickWebEngineView.loading --> bool"
+    << "QQuickWebEngineView.loadProgress --> int"
+    << "QQuickWebEngineView.titleChanged() --> void"
+    << "QQuickWebEngineView.navigationHistoryChanged() --> void"
+    << "QQuickWebEngineView.loadingChanged(QQuickWebEngineLoadRequest*) --> void"
+    << "QQuickWebEngineView.loadProgressChanged() --> void"
+    << "QQuickWebEngineView.javaScriptConsoleMessage(int,QString,int,QString) --> void"
+    << "QQuickWebEngineView.urlChanged() --> void"
+    << "QQuickWebEngineView.iconChanged() --> void"
+    << "QQuickWebEngineView.linkHovered(QUrl,QString) --> void"
+    << "QQuickWebEngineView.navigationRequested(QQuickWebEngineNavigationRequest*) --> void"
+    << "QQuickWebEngineView.loadHtml(QString,QUrl,QUrl) --> void"
+    << "QQuickWebEngineView.loadHtml(QString,QUrl) --> void"
+    << "QQuickWebEngineView.loadHtml(QString) --> void"
+    << "QQuickWebEngineView.goBack() --> void"
+    << "QQuickWebEngineView.goForward() --> void"
+    << "QQuickWebEngineView.stop() --> void"
+    << "QQuickWebEngineView.reload() --> void"
+    << "QQuickWebEngineLoadRequest.url --> QUrl"
+    << "QQuickWebEngineLoadRequest.status --> QQuickWebEngineView::LoadStatus"
+    << "QQuickWebEngineLoadRequest.errorString --> QString"
+    << "QQuickWebEngineLoadRequest.errorDomain --> QQuickWebEngineView::ErrorDomain"
+    << "QQuickWebEngineLoadRequest.errorCode --> int"
+    << "QQuickWebEngineNavigationRequest.url --> QUrl"
+    << "QQuickWebEngineNavigationRequest.mouseButton --> int"
+    << "QQuickWebEngineNavigationRequest.keyboardModifiers --> int"
+    << "QQuickWebEngineNavigationRequest.action --> QQuickWebEngineView::NavigationRequestAction"
+    << "QQuickWebEngineNavigationRequest.navigationType --> QQuickWebEngineView::NavigationType"
+    << "QQuickWebEngineNavigationRequest.actionChanged() --> void"
+    ;
+
+static bool isCheckedEnum(const QByteArray &typeName)
+{
+    QList<QByteArray> tokens = typeName.split(':');
+    if (tokens.size() == 3) {
+        QByteArray &enumClass = tokens[0];
+        QByteArray &enumName = tokens[2];
+        foreach (const QMetaObject *mo, typesToCheck) {
+            if (mo->className() != enumClass)
+                continue;
+            for (int i = mo->enumeratorOffset(); i < mo->enumeratorCount(); ++i)
+                if (mo->enumerator(i).name() == enumName)
+                    return true;
+        }
+    }
+    return false;
+}
+
+static bool isCheckedClass(const QByteArray &typeName)
+{
+    foreach (const QMetaObject *mo, typesToCheck) {
+        QByteArray moTypeName(mo->className());
+        if (moTypeName == typeName || moTypeName + "*" == typeName)
+            return true;
+    }
+    return false;
+}
+
+static void checkKnownType(const QByteArray &typeName)
+{
+    if ((typeName != "void" && !QMetaType::type(typeName)) || QMetaType::type(typeName) >= QMetaType::User) {
+        bool knownEnum = isCheckedEnum(typeName);
+        bool knownClass = isCheckedClass(typeName);
+        QVERIFY2(knownEnum || knownClass, qPrintable(QString("The API uses an unknown type [%1], you might have to add it to the typesToCheck list.").arg(typeName.constData())));
+    }
+}
+
+static void gatherAPI(const QString &prefix, const QMetaEnum &metaEnum, QStringList *output)
+{
+    for (int i = 0; i < metaEnum.keyCount(); ++i)
+        *output << QString::fromLatin1("%1%2 --> %3").arg(prefix).arg(metaEnum.key(i)).arg(metaEnum.name());
+}
+
+static void gatherAPI(const QString &prefix, const QMetaProperty &property, QStringList *output)
+{
+    *output << QString::fromLatin1("%1%2 --> %3").arg(prefix).arg(property.name()).arg(property.typeName());
+    checkKnownType(property.typeName());
+}
+
+static void gatherAPI(const QString &prefix, const QMetaMethod &method, QStringList *output)
+{
+    if (method.access() != QMetaMethod::Private) {
+        const char *methodTypeName = !!strlen(method.typeName()) ? method.typeName() : "void";
+        *output << QString::fromLatin1("%1%2 --> %3").arg(prefix).arg(QString::fromLatin1(method.methodSignature())).arg(QString::fromLatin1(methodTypeName));
+
+        checkKnownType(methodTypeName);
+        foreach (QByteArray paramType, method.parameterTypes())
+            checkKnownType(paramType);
+    }
+}
+
+static void gatherAPI(const QString &prefix, const QMetaObject *meta, QStringList *output)
+{
+    // *Offset points us only at the leaf class members, we don't have inheritance in our API yet anyway.
+    for (int i = meta->enumeratorOffset(); i < meta->enumeratorCount(); ++i)
+        gatherAPI(prefix, meta->enumerator(i), output);
+    for (int i = meta->propertyOffset(); i < meta->propertyCount(); ++i)
+        gatherAPI(prefix, meta->property(i), output);
+    for (int i = meta->methodOffset(); i < meta->methodCount(); ++i)
+        gatherAPI(prefix, meta->method(i), output);
+}
+
+void tst_publicapi::publicAPI()
+{
+    QStringList actualAPI;
+    foreach (const QMetaObject *meta, typesToCheck)
+        gatherAPI(QString::fromLatin1(meta->className()) + ".", meta, &actualAPI);
+
+    // Uncomment to print the actual API.
+    // foreach (QString actual, actualAPI)
+    //     printf("    << \"%s\"\n", qPrintable(actual));
+
+    // Make sure that nothing slips in the public API unintentionally.
+    foreach (QString actual, actualAPI) {
+        if (!expectedAPI.contains(actual))
+            QEXPECT_FAIL("", qPrintable("Expected list is not up-to-date: " + actual), Continue);
+        QVERIFY2(expectedAPI.contains(actual), qPrintable(actual));
+    }
+    // Make sure that the expected list is up-to-date with intentionally added APIs.
+    foreach (QString expected, expectedAPI) {
+        if (!actualAPI.contains(expected))
+            QEXPECT_FAIL("", qPrintable("Not implemented: " + expected), Continue);
+        QVERIFY2(actualAPI.contains(expected), qPrintable(expected));
+    }
+}
+
+QTEST_MAIN(tst_publicapi)
+
+#include "tst_publicapi.moc"
+
diff --git a/tests/auto/quick/quick.pro b/tests/auto/quick/quick.pro
index de26bb2e9..e679184b6 100644
--- a/tests/auto/quick/quick.pro
+++ b/tests/auto/quick/quick.pro
@@ -2,6 +2,7 @@ TEMPLATE = subdirs
 
 SUBDIRS += \
     qquickwebviewgraphics/qquickwebviewgraphics_software.pro \
+    publicapi/publicapi.pro \
     qmltests/qmltests.pro \
 
 equals(QT_MAJOR_VERSION, 5):greaterThan(QT_MINOR_VERSION, 1): SUBDIRS += qquickwebviewgraphics/qquickwebviewgraphics.pro