Create a new type of mock compositor for client tests

There are a number of issues with the current client testing:

- Adding new compositor functionality is cumbersome (need to add compositor
  send method, command, implementation, not to mention creating new wrapper
  objects.
- Customizing available globals and their versions is not possible and would be
  hard to implement. I.e. how to test that functionality works with old and new
  versions of an interface? Handle globals being destroyed. We did this with
  wl_output, but it was painfully cumbersome.
- Hard to verify that the compositor state is clean between tests. It is
  currently done in some tests, but requires boiler plate code which needs to
  be added and maintained for each test.
- In general lots of boiler-plate for new tests. (We have to have separate
  tests as long as Qt has global/static state. I.e. if one shell extension has
  been initialized, we can't deinitialize and initialize another one, so tests
  have to be separate.)
- Dispatching server events tied to the client event loop sometimes makes it
  hard to write tests without deadlocks.
- Abstraction, encapsulation and automatic behavior that can't be disabled
  makes it hard to test low-level functionality like surface exposure.

So, in an attempt to mitigate these issues, I wrote a new testing framework.

- Compositor dispatch is running continuously in it's own thread, access to
  compositor state is guarded by a mutex on the compositor, locking this will
  make dispatching stop, so the test can safely access internals. Although a
  bit cumbersome at first this makes it much easier to directly use server
  protocol commands from the test itself, i.e. no need to create commands for
  every single thing we want to test.
- The CoreCompositor::exec template method can accept a lambda that will be run
  with dispatching stopped. It can also return a value, conveniently letting us
  safely extract or modify compositor state from tests.
- This framework also takes full advantage of the qtwaylandscanner, using
  wrapper classes for everything, reducing boiler plate considerably.
- The compositor parts are designed to do as little as possible automatically,
  but still provide easy ways to enable common functionality, like releasing
  buffers automatically, configuring shell surfaces etc.
- Compositor globals are pluggable, use add<GlobalClass>() and
  remove<GlobalClass>() to add new global interfaces. I.e. easy to create a
  compositor with or without data_device_manager for instance.
- DefaultCompositor provides a sensible default set of functionality and
  convenience methods for most test-cases. Custom ones can still be made by
  inheriting from CoreCompositor directly instead or by removing or adding
  globals to DefaultCompositor.
- Globals have an isClean() method. Implement it to verify that the client
  didn't leave any objects lying around from the previous test.
  CoreCompositor::isClean calls isClean on the globals so a single call is all
  that's needed.

In short, we've traded mock compositor encapsulation and thread safety
guarantees for less boiler-plate, easier and more convenient access to
internals.

Anything accessing compositor state should go into a exec() call, or through
the wrapper macros QCOMPOSITOR_VERIFY and QCOMPOSITOR_COMPARE (or the TRY
versions). I've also tried to make the compositor print warnings if compositor
state is accessed in an unsafe way.

The mock compositor is currently built once per test due to CI limitations
(same thing as with the old tests).

Change-Id: Ia3feb80ce175d3814292b7f4768a0cc719f8b0e8
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>

2 files changed, 270 insertions, 0 deletions

diff --git a/tests/auto/client/seatv4/seatv4.pro b/tests/auto/client/seatv4/seatv4.pro
new file mode 100644
index 000000000..c02db5855
--- /dev/null
+++ b/tests/auto/client/seatv4/seatv4.pro
@@ -0,0 +1,4 @@
+include (../shared/shared.pri)
+
+TARGET = tst_seatv4
+SOURCES += tst_seatv4.cpp
diff --git a/tests/auto/client/seatv4/tst_seatv4.cpp b/tests/auto/client/seatv4/tst_seatv4.cpp
new file mode 100644
index 000000000..a95dbfcc2
--- /dev/null
+++ b/tests/auto/client/seatv4/tst_seatv4.cpp
@@ -0,0 +1,266 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "mockcompositor.h"
+
+#include <QtGui/QRasterWindow>
+#include <QtGui/QOpenGLWindow>
+
+using namespace MockCompositor;
+
+// wl_seat version 5 was introduced in wayland 1.10, and although that's pretty old,
+// there are still compositors that have yet to update their implementation to support
+// the new version (most importantly our own QtWaylandCompositor).
+// As long as that's the case, this test makes sure input events still works on version 4.
+class SeatV4Compositor : public DefaultCompositor {
+public:
+    explicit SeatV4Compositor()
+    {
+        exec([this] {
+            m_config.autoConfigure = true;
+
+            removeAll<Seat>();
+
+            uint capabilities = MockCompositor::Seat::capability_pointer;
+            int version = 4;
+            add<Seat>(capabilities, version);
+        });
+    }
+};
+
+class tst_seatv4 : public QObject, private SeatV4Compositor
+{
+    Q_OBJECT
+private slots:
+    void cleanup();
+    void bindsToSeat();
+    void createsPointer();
+    void setsCursorOnEnter();
+    void usesEnterSerial();
+    void simpleAxis_data();
+    void simpleAxis();
+    void invalidPointerEvents();
+    void scaledCursor();
+};
+
+void tst_seatv4::cleanup()
+{
+    QTRY_VERIFY2(isClean(), qPrintable(dirtyMessage()));
+    QCOMPOSITOR_COMPARE(getAll<Output>().size(), 1); // No extra outputs left
+}
+
+void tst_seatv4::bindsToSeat()
+{
+    QCOMPOSITOR_COMPARE(get<Seat>()->resourceMap().size(), 1);
+    QCOMPOSITOR_COMPARE(get<Seat>()->resourceMap().first()->version(), 4);
+}
+
+void tst_seatv4::createsPointer()
+{
+    QCOMPOSITOR_TRY_COMPARE(pointer()->resourceMap().size(), 1);
+    QCOMPOSITOR_TRY_COMPARE(pointer()->resourceMap().first()->version(), 4);
+}
+
+void tst_seatv4::setsCursorOnEnter()
+{
+    QRasterWindow window;
+    window.resize(64, 64);
+    window.show();
+    QCOMPOSITOR_TRY_VERIFY(xdgSurface() && xdgSurface()->m_committedConfigureSerial);
+
+    exec([=] { pointer()->sendEnter(xdgSurface()->m_surface, {32, 32}); });
+    QCOMPOSITOR_TRY_VERIFY(pointer()->cursorSurface());
+}
+
+void tst_seatv4::usesEnterSerial()
+{
+    QSignalSpy setCursorSpy(exec([=] { return pointer(); }), &Pointer::setCursor);
+    QRasterWindow window;
+    window.resize(64, 64);
+    window.show();
+    QCOMPOSITOR_TRY_VERIFY(xdgSurface() && xdgSurface()->m_committedConfigureSerial);
+
+    uint enterSerial = exec([=] {
+        return pointer()->sendEnter(xdgSurface()->m_surface, {32, 32});
+    });
+    QCOMPOSITOR_TRY_VERIFY(pointer()->cursorSurface());
+
+    QTRY_COMPARE(setCursorSpy.count(), 1);
+    QCOMPARE(setCursorSpy.takeFirst().at(0).toUInt(), enterSerial);
+}
+
+void tst_seatv4::simpleAxis_data()
+{
+    QTest::addColumn<uint>("axis");
+    QTest::addColumn<qreal>("value");
+    QTest::addColumn<Qt::Orientation>("orientation");
+    QTest::addColumn<QPoint>("angleDelta");
+
+    // Directions in regular windows/linux terms (no "natural" scrolling)
+    QTest::newRow("down") << uint(Pointer::axis_vertical_scroll) << 1.0 << Qt::Vertical << QPoint{0, -12};
+    QTest::newRow("up") << uint(Pointer::axis_vertical_scroll) << -1.0 << Qt::Vertical << QPoint{0, 12};
+    QTest::newRow("left") << uint(Pointer::axis_horizontal_scroll) << 1.0 << Qt::Horizontal << QPoint{-12, 0};
+    QTest::newRow("right") << uint(Pointer::axis_horizontal_scroll) << -1.0 << Qt::Horizontal << QPoint{12, 0};
+    QTest::newRow("up big") << uint(Pointer::axis_vertical_scroll) << -10.0 << Qt::Vertical << QPoint{0, 120};
+}
+
+void tst_seatv4::simpleAxis()
+{
+    QFETCH(uint, axis);
+    QFETCH(qreal, value);
+    QFETCH(Qt::Orientation, orientation);
+    QFETCH(QPoint, angleDelta);
+
+    class WheelWindow : QRasterWindow {
+    public:
+        explicit WheelWindow()
+        {
+            resize(64, 64);
+            show();
+        }
+        void wheelEvent(QWheelEvent *event) override
+        {
+            QRasterWindow::wheelEvent(event);
+            // Angle delta should always be provided (says docs)
+            QVERIFY(!event->angleDelta().isNull());
+
+            // There are now scroll phases on Wayland prior to v5
+            QCOMPARE(event->phase(), Qt::NoScrollPhase);
+
+            // Pixel delta should only be set if we know it's a high-res input device (which we don't)
+            QCOMPARE(event->pixelDelta(), QPoint(0, 0));
+
+            // The axis vector of the event is already in surface space, so there is now way to tell
+            // whether it is inverted or not.
+            QCOMPARE(event->inverted(), false);
+
+            // We didn't press any buttons
+            QCOMPARE(event->buttons(), Qt::NoButton);
+
+            if (event->orientation() == Qt::Horizontal)
+                QCOMPARE(event->delta(), event->angleDelta().x());
+            else
+                QCOMPARE(event->delta(), event->angleDelta().y());
+
+            // There has been no information about what created the event.
+            // Documentation says not synthesized is appropriate in such cases
+            QCOMPARE(event->source(), Qt::MouseEventNotSynthesized);
+
+            m_events.append(Event(event->pixelDelta(), event->angleDelta(), event->orientation()));
+        }
+        struct Event // Because I didn't find a convenient way to copy it entirely
+        {
+            // TODO: Constructors can be removed when we start supporting brace-initializers
+            Event() = default;
+            Event(const QPoint &pixelDelta, const QPoint &angleDelta, Qt::Orientation orientation)
+                : pixelDelta(pixelDelta), angleDelta(angleDelta), orientation(orientation)
+            {}
+            const QPoint pixelDelta;
+            const QPoint angleDelta; // eights of a degree, positive is upwards, left
+            const Qt::Orientation orientation{};
+        };
+        QVector<Event> m_events;
+    };
+
+    WheelWindow window;
+    QCOMPOSITOR_TRY_VERIFY(xdgSurface() && xdgSurface()->m_committedConfigureSerial);
+
+    exec([=] {
+        Surface *surface = xdgSurface()->m_surface;
+        pointer()->sendEnter(surface, {32, 32});
+        wl_client *client = surface->resource()->client();
+        // Length of vector in surface-local space. i.e. positive is downwards
+        pointer()->sendAxis(
+            client,
+            Pointer::axis(axis),
+            value // Length of vector in surface-local space. i.e. positive is downwards
+        );
+    });
+
+    QTRY_COMPARE(window.m_events.size(), 1);
+    auto event = window.m_events.takeFirst();
+    QCOMPARE(event.angleDelta, angleDelta);
+    QCOMPARE(event.orientation, orientation);
+}
+
+void tst_seatv4::invalidPointerEvents()
+{
+    QRasterWindow window;
+    window.resize(64, 64);
+    window.show();
+    QCOMPOSITOR_TRY_VERIFY(xdgSurface() && xdgSurface()->m_committedConfigureSerial);
+
+    exec([=] {
+        auto *p = pointer();
+        auto *c = client();
+        // Purposefully send events without a wl_pointer.enter
+        p->sendMotion(c, {32, 32});
+        p->sendButton(c, BTN_LEFT, Pointer::button_state_pressed);
+        p->sendAxis(c, Pointer::axis_vertical_scroll, 1.0);
+    });
+
+    // Make sure we get here without crashing
+    xdgPingAndWaitForPong();
+}
+
+void tst_seatv4::scaledCursor()
+{
+    QSKIP("Currently broken and should be fixed");
+    // Add a highdpi output
+    exec([&] {
+        int scale = 2;
+        add<Output>(scale);
+    });
+
+    QRasterWindow window;
+    window.resize(64, 64);
+    window.show();
+    QCOMPOSITOR_TRY_VERIFY(xdgSurface() && xdgSurface()->m_committedConfigureSerial);
+
+    exec([=] { pointer()->sendEnter(xdgSurface()->m_surface, {32, 32}); });
+    QCOMPOSITOR_TRY_VERIFY(pointer()->cursorSurface());
+    QCOMPOSITOR_TRY_VERIFY(pointer()->cursorSurface()->m_committed.buffer);
+    QCOMPOSITOR_TRY_COMPARE(pointer()->cursorSurface()->m_committed.bufferScale, 1);
+    QSize unscaledPixelSize = exec([=] {
+        return pointer()->cursorSurface()->m_committed.buffer->size();
+    });
+
+    exec([=] {
+        auto *surface = pointer()->cursorSurface();
+        surface->sendEnter(getAll<Output>()[1]);
+        surface->sendLeave(getAll<Output>()[0]);
+    });
+
+    QCOMPOSITOR_TRY_COMPARE(pointer()->cursorSurface()->m_committed.buffer->size(), unscaledPixelSize * 2);
+
+    // Remove the extra output to clean up for the next test
+    exec([&] { remove(getAll<Output>()[1]); });
+}
+
+QCOMPOSITOR_TEST_MAIN(tst_seatv4)
+#include "tst_seatv4.moc"