summaryrefslogtreecommitdiffstats
path: root/tests/auto/util/util.h
diff options
context:
space:
mode:
Diffstat (limited to 'tests/auto/util/util.h')
-rw-r--r--tests/auto/util/util.h178
1 files changed, 178 insertions, 0 deletions
diff --git a/tests/auto/util/util.h b/tests/auto/util/util.h
new file mode 100644
index 000000000..5533eed80
--- /dev/null
+++ b/tests/auto/util/util.h
@@ -0,0 +1,178 @@
+// Copyright (C) 2016 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
+
+// Functions and macros that really need to be in QTestLib
+
+#if 0
+#pragma qt_no_master_include
+#endif
+
+#include <QEventLoop>
+#include <QPoint>
+#include <QRect>
+#include <QSignalSpy>
+#include <QTimer>
+#include <qwebenginefindtextresult.h>
+#include <qwebenginepage.h>
+
+// Disconnect signal on destruction.
+class ScopedConnection
+{
+public:
+ ScopedConnection(QMetaObject::Connection connection) : m_connection(std::move(connection)) { }
+ ~ScopedConnection() { QObject::disconnect(m_connection); }
+
+private:
+ QMetaObject::Connection m_connection;
+};
+
+/**
+ * Just like QSignalSpy but facilitates sync and async
+ * signal emission. For example if you want to verify that
+ * page->foo() emitted a signal, it could be that the
+ * implementation decides to emit the signal asynchronously
+ * - in which case we want to spin a local event loop until
+ * emission - or that the call to foo() emits it right away.
+ */
+class SignalBarrier : private QSignalSpy
+{
+public:
+ SignalBarrier(const QObject* obj, const char* aSignal)
+ : QSignalSpy(obj, aSignal)
+ { }
+
+ bool ensureSignalEmitted()
+ {
+ bool result = size() > 0;
+ if (!result)
+ result = wait();
+ clear();
+ return result;
+ }
+};
+
+template<typename T, typename R>
+struct CallbackWrapper {
+ QPointer<R> p;
+ void operator()(const T& result) {
+ if (p)
+ (*p)(result);
+ }
+};
+
+template<typename T>
+class CallbackSpy: public QObject {
+public:
+ CallbackSpy() : called(false) {
+ timeoutTimer.setSingleShot(true);
+ QObject::connect(&timeoutTimer, SIGNAL(timeout()), &eventLoop, SLOT(quit()));
+ }
+
+ T waitForResult(int timeout = 20000) {
+ const int step = 1000;
+ int elapsed = 0;
+ while (elapsed < timeout && !called) {
+ timeoutTimer.start(step);
+ eventLoop.exec();
+ elapsed += step;
+ }
+ return result;
+ }
+
+ bool wasCalled() const {
+ return called;
+ }
+
+ void operator()(const T &result) {
+ this->result = result;
+ called = true;
+ eventLoop.quit();
+ }
+
+ CallbackWrapper<T, CallbackSpy<T> > ref()
+ {
+ CallbackWrapper<T, CallbackSpy<T> > wrapper = {this};
+ return wrapper;
+ }
+
+private:
+ Q_DISABLE_COPY(CallbackSpy)
+ bool called;
+ QTimer timeoutTimer;
+ QEventLoop eventLoop;
+ T result;
+};
+
+static inline QString toPlainTextSync(QWebEnginePage *page)
+{
+ CallbackSpy<QString> spy;
+ page->toPlainText(spy.ref());
+ return spy.waitForResult();
+}
+
+static inline QString toHtmlSync(QWebEnginePage *page)
+{
+ CallbackSpy<QString> spy;
+ page->toHtml(spy.ref());
+ return spy.waitForResult();
+}
+
+static inline bool findTextSync(QWebEnginePage *page, const QString &subString)
+{
+ CallbackSpy<QWebEngineFindTextResult> spy;
+ page->findText(subString, {}, spy.ref());
+ return spy.waitForResult().numberOfMatches() > 0;
+}
+
+static inline QVariant evaluateJavaScriptSync(QWebEnginePage *page, const QString &script)
+{
+ CallbackSpy<QVariant> spy;
+ page->runJavaScript(script, spy.ref());
+ return spy.waitForResult();
+}
+
+static inline QVariant evaluateJavaScriptSyncInWorld(QWebEnginePage *page, const QString &script, int worldId)
+{
+ CallbackSpy<QVariant> spy;
+ page->runJavaScript(script, worldId, spy.ref());
+ return spy.waitForResult();
+}
+
+static inline QUrl baseUrlSync(QWebEnginePage *page)
+{
+ CallbackSpy<QVariant> spy;
+ page->runJavaScript("document.baseURI", spy.ref());
+ return spy.waitForResult().toUrl();
+}
+
+static inline bool loadSync(QWebEnginePage *page, const QUrl &url, bool ok = true)
+{
+ QSignalSpy spy(page, &QWebEnginePage::loadFinished);
+ page->load(url);
+ return (!spy.empty() || spy.wait(20000)) && (spy.front().value(0).toBool() == ok);
+}
+
+static inline QRect elementGeometry(QWebEnginePage *page, const QString &id)
+{
+ const QString jsCode(
+ "(function() {"
+ " var elem = document.getElementById('" + id + "');"
+ " var rect = elem.getBoundingClientRect();"
+ " return [rect.left, rect.top, rect.width, rect.height];"
+ "})()");
+ QVariantList coords = evaluateJavaScriptSync(page, jsCode).toList();
+
+ if (coords.size() != 4) {
+ qWarning("elementGeometry failed.");
+ return QRect();
+ }
+
+ return QRect(coords[0].toInt(), coords[1].toInt(), coords[2].toInt(), coords[3].toInt());
+}
+
+static inline QPoint elementCenter(QWebEnginePage *page, const QString &id)
+{
+ return elementGeometry(page, id).center();
+}
+
+#define W_QSKIP(a, b) QSKIP(a)