[autotests/integration] Add test case for rule matching on window role

New test infrastructure which supports testing window rules at runtime.
Test exposes problem of window rules not able to match window roles in
a case insensitive manner.

CCBUG: 367554

autotests/integration/CMakeLists.txt

@@ -49,6 +49,7 @@ if (XCB_ICCCM_FOUND)
     integrationTest(NAME testScreenEdgeClientShow SRCS screenedge_client_show_test.cpp LIBS XCB::ICCCM)
     integrationTest(NAME testX11DesktopWindow SRCS desktop_window_x11_test.cpp LIBS XCB::ICCCM)
     integrationTest(NAME testXwaylandInput SRCS xwayland_input_test.cpp LIBS XCB::ICCCM)
+    integrationTest(NAME testWindowRules SRCS window_rules_test.cpp LIBS XCB::ICCCM)
 
     if (KWIN_BUILD_ACTIVITIES)
         integrationTest(NAME testActivities SRCS activities_test.cpp LIBS XCB::ICCCM)

autotests/integration/data/rules/maximize-vert-apply-initial

@@ -0,0 +1,13 @@
+Description=Window settings for kpat
+clientmachine=localhost
+clientmachinematch=0
+maximizevert=true
+maximizevertrule=3
+title=KPatience
+titlematch=0
+types=1
+windowrole=mainwindow
+windowrolematch=1
+wmclass=kpat
+wmclasscomplete=false
+wmclassmatch=1

autotests/integration/window_rules_test.cpp

@@ -0,0 +1,172 @@
+/********************************************************************
+KWin - the KDE window manager
+This file is part of the KDE project.
+
+Copyright (C) 2016 Martin Gräßlin <mgraesslin@kde.org>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*********************************************************************/
+#include "kwin_wayland_test.h"
+#include "platform.h"
+#include "atoms.h"
+#include "client.h"
+#include "cursor.h"
+#include "deleted.h"
+#include "screenedge.h"
+#include "screens.h"
+#include "rules.h"
+#include "wayland_server.h"
+#include "workspace.h"
+#include "shell_client.h"
+
+#include <netwm.h>
+#include <xcb/xcb_icccm.h>
+
+namespace KWin
+{
+
+static const QString s_socketName = QStringLiteral("wayland_test_kwin_window_rules-0");
+
+class WindowRuleTest : public QObject
+{
+    Q_OBJECT
+private Q_SLOTS:
+    void initTestCase();
+    void init();
+    void cleanup();
+    void testApplyInitialMaximizeVert_data();
+    void testApplyInitialMaximizeVert();
+};
+
+void WindowRuleTest::initTestCase()
+{
+    qRegisterMetaType<KWin::ShellClient*>();
+    qRegisterMetaType<KWin::AbstractClient*>();
+    qRegisterMetaType<KWin::Deleted*>();
+    QSignalSpy workspaceCreatedSpy(kwinApp(), &Application::workspaceCreated);
+    QVERIFY(workspaceCreatedSpy.isValid());
+    kwinApp()->platform()->setInitialWindowSize(QSize(1280, 1024));
+    QMetaObject::invokeMethod(kwinApp()->platform(), "setOutputCount", Qt::DirectConnection, Q_ARG(int, 2));
+    QVERIFY(waylandServer()->init(s_socketName.toLocal8Bit()));
+
+    kwinApp()->start();
+    QVERIFY(workspaceCreatedSpy.wait());
+    QCOMPARE(screens()->count(), 2);
+    QCOMPARE(screens()->geometry(0), QRect(0, 0, 1280, 1024));
+    QCOMPARE(screens()->geometry(1), QRect(1280, 0, 1280, 1024));
+    setenv("QT_QPA_PLATFORM", "wayland", true);
+    waylandServer()->initWorkspace();
+}
+
+void WindowRuleTest::init()
+{
+    screens()->setCurrent(0);
+    Cursor::setPos(QPoint(640, 512));
+    QVERIFY(waylandServer()->clients().isEmpty());
+}
+
+void WindowRuleTest::cleanup()
+{
+    // discards old rules
+    RuleBook::self()->load();
+}
+
+struct XcbConnectionDeleter
+{
+    static inline void cleanup(xcb_connection_t *pointer)
+    {
+        xcb_disconnect(pointer);
+    }
+};
+
+void WindowRuleTest::testApplyInitialMaximizeVert_data()
+{
+    QTest::addColumn<QByteArray>("role");
+
+    QTest::newRow("lowercase") << QByteArrayLiteral("mainwindow");
+    QTest::newRow("CamelCase") << QByteArrayLiteral("MainWindow");
+}
+
+void WindowRuleTest::testApplyInitialMaximizeVert()
+{
+    // this test creates the situation of BUG 367554: creates a window and initial apply maximize vertical
+    // the window is matched by class and role
+    // load the rule
+    QFile ruleFile(QFINDTESTDATA("./data/rules/maximize-vert-apply-initial"));
+    QVERIFY(ruleFile.open(QIODevice::ReadOnly | QIODevice::Text));
+    QMetaObject::invokeMethod(RuleBook::self(), "temporaryRulesMessage", Q_ARG(QString, QString::fromUtf8(ruleFile.readAll())));
+
+    // create the test window
+    QScopedPointer<xcb_connection_t, XcbConnectionDeleter> c(xcb_connect(nullptr, nullptr));
+    QVERIFY(!xcb_connection_has_error(c.data()));
+
+    xcb_window_t w = xcb_generate_id(c.data());
+    const QRect windowGeometry = QRect(0, 0, 10, 20);
+    const uint32_t values[] = {
+        XCB_EVENT_MASK_ENTER_WINDOW |
+        XCB_EVENT_MASK_LEAVE_WINDOW
+    };
+    xcb_create_window(c.data(), XCB_COPY_FROM_PARENT, w, rootWindow(),
+                      windowGeometry.x(),
+                      windowGeometry.y(),
+                      windowGeometry.width(),
+                      windowGeometry.height(),
+                      0, XCB_WINDOW_CLASS_INPUT_OUTPUT, XCB_COPY_FROM_PARENT, XCB_CW_EVENT_MASK, values);
+    xcb_size_hints_t hints;
+    memset(&hints, 0, sizeof(hints));
+    xcb_icccm_size_hints_set_position(&hints, 1, windowGeometry.x(), windowGeometry.y());
+    xcb_icccm_size_hints_set_size(&hints, 1, windowGeometry.width(), windowGeometry.height());
+    xcb_icccm_set_wm_normal_hints(c.data(), w, &hints);
+    xcb_icccm_set_wm_class(c.data(), w, 9, "kpat\0kpat");
+
+    QFETCH(QByteArray, role);
+    xcb_change_property(c.data(), XCB_PROP_MODE_REPLACE, w, atoms->wm_window_role, XCB_ATOM_STRING, 8, role.length(), role.constData());
+
+    NETWinInfo info(c.data(), w, rootWindow(), NET::WMAllProperties, NET::WM2AllProperties);
+    info.setWindowType(NET::Normal);
+    xcb_map_window(c.data(), w);
+    xcb_flush(c.data());
+
+    QSignalSpy windowCreatedSpy(workspace(), &Workspace::clientAdded);
+    QVERIFY(windowCreatedSpy.isValid());
+    QVERIFY(windowCreatedSpy.wait());
+    Client *client = windowCreatedSpy.last().first().value<Client*>();
+    QVERIFY(client);
+    QVERIFY(client->isDecorated());
+    QVERIFY(!client->hasStrut());
+    QVERIFY(!client->isHiddenInternal());
+    QVERIFY(!client->readyForPainting());
+    QMetaObject::invokeMethod(client, "setReadyForPainting");
+    QVERIFY(client->readyForPainting());
+    QVERIFY(!client->surface());
+    QSignalSpy surfaceChangedSpy(client, &Toplevel::surfaceChanged);
+    QVERIFY(surfaceChangedSpy.isValid());
+    QVERIFY(surfaceChangedSpy.wait());
+    QVERIFY(client->surface());
+    QEXPECT_FAIL("CamelCase", "BUG 367554", Continue);
+    QCOMPARE(client->maximizeMode(), MaximizeVertical);
+
+    // destroy window again
+    QSignalSpy windowClosedSpy(client, &Client::windowClosed);
+    QVERIFY(windowClosedSpy.isValid());
+    xcb_unmap_window(c.data(), w);
+    xcb_destroy_window(c.data(), w);
+    xcb_flush(c.data());
+    QVERIFY(windowClosedSpy.wait());
+}
+
+}
+
+WAYLANDTEST_MAIN(KWin::WindowRuleTest)
+#include "window_rules_test.moc"

rules.h

@@ -287,7 +287,7 @@ private:
 };
 
 #ifndef KCMRULES
-class RuleBook : public QObject
+class KWIN_EXPORT RuleBook : public QObject
 {
     Q_OBJECT
 public: