[Qt] Public API watch dog auto test.
authorjocelyn.turcotte@nokia.com <jocelyn.turcotte@nokia.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 20 Jan 2012 10:04:30 +0000 (10:04 +0000)
committerjocelyn.turcotte@nokia.com <jocelyn.turcotte@nokia.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 20 Jan 2012 10:04:30 +0000 (10:04 +0000)
https://bugs.webkit.org/show_bug.cgi?id=73922

Reviewed by Simon Hausmann.

This test aims to prevent unintended/unapproved
modifications to the public QML API.

.:

* Source/tests.pri:

Source/WebKit2:

* UIProcess/API/qt/tests/publicapi/publicapi.pro: Added.
* UIProcess/API/qt/tests/publicapi/tst_publicapi.cpp: Added.
(isCheckedEnum):
(isCheckedClass):
(checkKnownType):
(gatherAPI):
(tst_publicapi::publicAPI):

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@105498 268f45cc-cd09-0410-ab3c-d52691b4dbfc

ChangeLog
Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/qt/tests/publicapi/publicapi.pro [new file with mode: 0644]
Source/WebKit2/UIProcess/API/qt/tests/publicapi/tst_publicapi.cpp [new file with mode: 0644]
Source/tests.pri

index ed0dd7da57323bead0db6ae740d914604f60bd13..baba21830b5849092139797be55d362cb581bb22 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,15 @@
+2012-01-19  Jocelyn Turcotte  <jocelyn.turcotte@nokia.com>
+
+        [Qt] Public API watch dog auto test.
+        https://bugs.webkit.org/show_bug.cgi?id=73922
+
+        Reviewed by Simon Hausmann.
+
+        This test aims to prevent unintended/unapproved
+        modifications to the public QML API.
+
+        * Source/tests.pri:
+
 2012-01-19  Gustavo Noronha Silva  <gns@gnome.org>
 
         Rubber-stamped by Martin Robinson.
index c866fd706316cb4fc534c798eeb1233f9db8796f..20a04f7069326c9a9bcb4c692906d065cdb52eb4 100644 (file)
@@ -1,3 +1,21 @@
+2012-01-19  Jocelyn Turcotte  <jocelyn.turcotte@nokia.com>
+
+        [Qt] Public API watch dog auto test.
+        https://bugs.webkit.org/show_bug.cgi?id=73922
+
+        Reviewed by Simon Hausmann.
+
+        This test aims to prevent unintended/unapproved
+        modifications to the public QML API.
+
+        * UIProcess/API/qt/tests/publicapi/publicapi.pro: Added.
+        * UIProcess/API/qt/tests/publicapi/tst_publicapi.cpp: Added.
+        (isCheckedEnum):
+        (isCheckedClass):
+        (checkKnownType):
+        (gatherAPI):
+        (tst_publicapi::publicAPI):
+
 2012-01-13  Jocelyn Turcotte  <jocelyn.turcotte@nokia.com>
 
         [Qt] Trigger forcing accelerated compositing from the UI process side.
diff --git a/Source/WebKit2/UIProcess/API/qt/tests/publicapi/publicapi.pro b/Source/WebKit2/UIProcess/API/qt/tests/publicapi/publicapi.pro
new file mode 100644 (file)
index 0000000..728521f
--- /dev/null
@@ -0,0 +1,2 @@
+include(../tests.pri)
+CONFIG += qtwebkit-private
diff --git a/Source/WebKit2/UIProcess/API/qt/tests/publicapi/tst_publicapi.cpp b/Source/WebKit2/UIProcess/API/qt/tests/publicapi/tst_publicapi.cpp
new file mode 100644 (file)
index 0000000..f1a81bc
--- /dev/null
@@ -0,0 +1,170 @@
+/*
+    Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies)
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library 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
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#include <QMetaEnum>
+#include <QMetaMethod>
+#include <QMetaObject>
+#include <QMetaProperty>
+#include <QMetaType>
+#include <QtTest/QtTest>
+#include <qquickwebview_p.h>
+#include <qwebnavigationrequest_p.h>
+
+class tst_publicapi : public QObject {
+    Q_OBJECT
+private slots:
+    void publicAPI();
+};
+
+static QList<const QMetaObject*> typesToCheck = QList<const QMetaObject*>()
+    << &QQuickWebView::staticMetaObject
+    << &QWebNavigationRequest::staticMetaObject;
+
+static QStringList expectedAPI = QStringList()
+    << "QQuickWebView.AcceptRequest --> NavigationRequestAction"
+    << "QQuickWebView.IgnoreRequest --> NavigationRequestAction"
+    << "QQuickWebView.InternalErrorDomain --> ErrorDomain"
+    << "QQuickWebView.NetworkErrorDomain --> ErrorDomain"
+    << "QQuickWebView.HttpErrorDomain --> ErrorDomain"
+    << "QQuickWebView.DownloadErrorDomain --> ErrorDomain"
+    << "QQuickWebView.title --> QString"
+    << "QQuickWebView.url --> QUrl"
+    << "QQuickWebView.icon --> QUrl"
+    << "QQuickWebView.loadProgress --> int"
+    << "QQuickWebView.canGoBack --> bool"
+    << "QQuickWebView.canGoForward --> bool"
+    << "QQuickWebView.loading --> bool"
+    << "QQuickWebView.canReload --> bool"
+    << "QQuickWebView.titleChanged(QString) --> void"
+    << "QQuickWebView.loadStarted() --> void"
+    << "QQuickWebView.loadSucceeded() --> void"
+    << "QQuickWebView.loadFailed(QQuickWebView::ErrorDomain,int,QUrl,QString) --> void"
+    << "QQuickWebView.loadProgressChanged(int) --> void"
+    << "QQuickWebView.urlChanged(QUrl) --> void"
+    << "QQuickWebView.iconChanged(QUrl) --> void"
+    << "QQuickWebView.linkHovered(QUrl,QString) --> void"
+    << "QQuickWebView.navigationStateChanged() --> void"
+    << "QQuickWebView.navigationRequested(QWebNavigationRequest*) --> void"
+    << "QQuickWebView.load(QUrl) --> void"
+    << "QQuickWebView.loadHtml(QString,QUrl) --> void"
+    << "QQuickWebView.loadHtml(QString) --> void"
+    << "QQuickWebView.goBack() --> void"
+    << "QQuickWebView.goForward() --> void"
+    << "QQuickWebView.stop() --> void"
+    << "QQuickWebView.reload() --> void"
+    << "QWebNavigationRequest.url --> QUrl"
+    << "QWebNavigationRequest.originatingUrl --> QUrl"
+    << "QWebNavigationRequest.button --> int"
+    << "QWebNavigationRequest.modifiers --> int"
+    << "QWebNavigationRequest.action --> int"
+    << "QWebNavigationRequest.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(method.signature()).arg(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)
+        QVERIFY2(expectedAPI.contains(actual), qPrintable(actual));
+    // Make sure that the expected list is up-to-date with intentionally added APIs.
+    foreach (QString expected, expectedAPI)
+        QVERIFY2(actualAPI.contains(expected), qPrintable(expected));
+}
+
+QTEST_MAIN(tst_publicapi)
+
+#include "tst_publicapi.moc"
index 1b415fdf1df8d23adae8691a128f60f1bdbd7530..c9a6b7af15229192160c6e0a13bac789100bcc2d 100644 (file)
@@ -43,6 +43,7 @@ contains(DEFINES, ENABLE_WEBGL=1) {
     WEBKIT2_TESTS_DIR = $$PWD/WebKit2/UIProcess/API/qt/tests
 
     SUBDIRS += \
+        $$WEBKIT2_TESTS_DIR/publicapi \
         $$WEBKIT2_TESTS_DIR/qquickwebview \
         $$WEBKIT2_TESTS_DIR/qmltests
 }