kwin/autotests/integration/scripting/screenedge_test.cpp
Vlad Zahorodnii 141947d2e8 effects: Link builtin effects with executables
The main motivation behind this change is to prepare kwin for importing
kwayland-server code in libkwin.

As is, builtin effects are linked with libkwin. Some builtin effects
have wayland specific code. If we move wayland stuff in libkwin, there's
going to be a circular dependency between kwin4_effect_builtins and
libkwin targets.

This change intends to break that dependency by linking builtin effects
to kwin executable.

The main issue with that is that EffectLoader would need to discover the
effects indirectly. QStaticPlugin is used for that purpose.

Besides breaking the cyclic dependency, it makes builtin effects use the
same plugin infrastructure in libkwineffects that external effects use.

Metadata in src/effects/effect_builtins.cpp was converted in a list of
python dictionaries, which was fed to a python script that generated
main.cpp and metadata.json files.
2021-10-19 09:12:15 +00:00

285 lines
9.8 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2016 Martin Gräßlin <mgraesslin@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "kwin_wayland_test.h"
#include "cursor.h"
#include "effectloader.h"
#include "platform.h"
#include "wayland_server.h"
#include "workspace.h"
#include "scripting/scripting.h"
#define private public
#include "screenedge.h"
#undef private
#include <KConfigGroup>
Q_DECLARE_METATYPE(KWin::ElectricBorder)
using namespace KWin;
static const QString s_socketName = QStringLiteral("wayland_test_kwin_scripting_screenedge-0");
class ScreenEdgeTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void cleanup();
void testEdge_data();
void testEdge();
void testTouchEdge_data();
void testTouchEdge();
void testEdgeUnregister();
void testDeclarativeTouchEdge();
private:
void triggerConfigReload();
};
void ScreenEdgeTest::initTestCase()
{
QSignalSpy applicationStartedSpy(kwinApp(), &Application::started);
QVERIFY(applicationStartedSpy.isValid());
kwinApp()->platform()->setInitialWindowSize(QSize(1280, 1024));
QVERIFY(waylandServer()->init(s_socketName));
// empty config to have defaults
auto config = KSharedConfig::openConfig(QString(), KConfig::SimpleConfig);
// disable all effects to prevent them grabbing edges
KConfigGroup plugins(config, QStringLiteral("Plugins"));
const auto builtinNames = EffectLoader().listOfKnownEffects();
for (QString name : builtinNames) {
plugins.writeEntry(name + QStringLiteral("Enabled"), false);
}
// disable electric border pushback
config->group("Windows").writeEntry("ElectricBorderPushbackPixels", 0);
config->group("TabBox").writeEntry("TouchBorderActivate", int(ElectricNone));
config->sync();
kwinApp()->setConfig(config);
kwinApp()->start();
QVERIFY(applicationStartedSpy.wait());
QVERIFY(Scripting::self());
ScreenEdges::self()->setTimeThreshold(0);
ScreenEdges::self()->setReActivationThreshold(0);
}
void ScreenEdgeTest::init()
{
KWin::Cursors::self()->mouse()->setPos(640, 512);
if (workspace()->showingDesktop()) {
workspace()->slotToggleShowDesktop();
}
QVERIFY(!workspace()->showingDesktop());
}
void ScreenEdgeTest::cleanup()
{
// try to unload the script
const QStringList scripts = {QFINDTESTDATA("./scripts/screenedge.js"), QFINDTESTDATA("./scripts/screenedgeunregister.js"), QFINDTESTDATA("./scripts/touchScreenedge.js")};
for (const QString &script: scripts) {
if (!script.isEmpty()) {
if (Scripting::self()->isScriptLoaded(script)) {
QVERIFY(Scripting::self()->unloadScript(script));
QTRY_VERIFY(!Scripting::self()->isScriptLoaded(script));
}
}
}
}
void ScreenEdgeTest::testEdge_data()
{
QTest::addColumn<KWin::ElectricBorder>("edge");
QTest::addColumn<QPoint>("triggerPos");
QTest::newRow("Top") << KWin::ElectricTop << QPoint(512, 0);
QTest::newRow("TopRight") << KWin::ElectricTopRight << QPoint(1279, 0);
QTest::newRow("Right") << KWin::ElectricRight << QPoint(1279, 512);
QTest::newRow("BottomRight") << KWin::ElectricBottomRight << QPoint(1279, 1023);
QTest::newRow("Bottom") << KWin::ElectricBottom << QPoint(512, 1023);
QTest::newRow("BottomLeft") << KWin::ElectricBottomLeft << QPoint(0, 1023);
QTest::newRow("Left") << KWin::ElectricLeft << QPoint(0, 512);
QTest::newRow("TopLeft") << KWin::ElectricTopLeft << QPoint(0, 0);
//repeat a row to show previously unloading and re-registering works
QTest::newRow("Top") << KWin::ElectricTop << QPoint(512, 0);
}
void ScreenEdgeTest::testEdge()
{
const QString scriptToLoad = QFINDTESTDATA("./scripts/screenedge.js");
QVERIFY(!scriptToLoad.isEmpty());
// mock the config
auto config = kwinApp()->config();
QFETCH(KWin::ElectricBorder, edge);
config->group(QLatin1String("Script-") + scriptToLoad).writeEntry("Edge", int(edge));
config->sync();
QVERIFY(!Scripting::self()->isScriptLoaded(scriptToLoad));
const int id = Scripting::self()->loadScript(scriptToLoad);
QVERIFY(id != -1);
QVERIFY(Scripting::self()->isScriptLoaded(scriptToLoad));
auto s = Scripting::self()->findScript(scriptToLoad);
QVERIFY(s);
QSignalSpy runningChangedSpy(s, &AbstractScript::runningChanged);
QVERIFY(runningChangedSpy.isValid());
s->run();
QVERIFY(runningChangedSpy.wait());
QCOMPARE(runningChangedSpy.count(), 1);
QCOMPARE(runningChangedSpy.first().first().toBool(), true);
// triggering the edge will result in show desktop being triggered
QSignalSpy showDesktopSpy(workspace(), &Workspace::showingDesktopChanged);
QVERIFY(showDesktopSpy.isValid());
// trigger the edge
QFETCH(QPoint, triggerPos);
KWin::Cursors::self()->mouse()->setPos(triggerPos);
QCOMPARE(showDesktopSpy.count(), 1);
QVERIFY(workspace()->showingDesktop());
}
void ScreenEdgeTest::testTouchEdge_data()
{
QTest::addColumn<KWin::ElectricBorder>("edge");
QTest::addColumn<QPoint>("triggerPos");
QTest::addColumn<QPoint>("motionPos");
QTest::newRow("Top") << KWin::ElectricTop << QPoint(50, 0) << QPoint(50, 500);
QTest::newRow("Right") << KWin::ElectricRight << QPoint(1279, 50) << QPoint(500, 50);
QTest::newRow("Bottom") << KWin::ElectricBottom << QPoint(512, 1023) << QPoint(512, 500);
QTest::newRow("Left") << KWin::ElectricLeft << QPoint(0, 50) << QPoint(500, 50);
//repeat a row to show previously unloading and re-registering works
QTest::newRow("Top") << KWin::ElectricTop << QPoint(512, 0) << QPoint(512, 500);
}
void ScreenEdgeTest::testTouchEdge()
{
const QString scriptToLoad = QFINDTESTDATA("./scripts/touchScreenedge.js");
QVERIFY(!scriptToLoad.isEmpty());
// mock the config
auto config = kwinApp()->config();
QFETCH(KWin::ElectricBorder, edge);
config->group(QLatin1String("Script-") + scriptToLoad).writeEntry("Edge", int(edge));
config->sync();
QVERIFY(!Scripting::self()->isScriptLoaded(scriptToLoad));
const int id = Scripting::self()->loadScript(scriptToLoad);
QVERIFY(id != -1);
QVERIFY(Scripting::self()->isScriptLoaded(scriptToLoad));
auto s = Scripting::self()->findScript(scriptToLoad);
QVERIFY(s);
QSignalSpy runningChangedSpy(s, &AbstractScript::runningChanged);
QVERIFY(runningChangedSpy.isValid());
s->run();
QVERIFY(runningChangedSpy.wait());
QCOMPARE(runningChangedSpy.count(), 1);
QCOMPARE(runningChangedSpy.first().first().toBool(), true);
// triggering the edge will result in show desktop being triggered
QSignalSpy showDesktopSpy(workspace(), &Workspace::showingDesktopChanged);
QVERIFY(showDesktopSpy.isValid());
// trigger the edge
QFETCH(QPoint, triggerPos);
quint32 timestamp = 0;
kwinApp()->platform()->touchDown(0, triggerPos, timestamp++);
QFETCH(QPoint, motionPos);
kwinApp()->platform()->touchMotion(0, motionPos, timestamp++);
kwinApp()->platform()->touchUp(0, timestamp++);
QVERIFY(showDesktopSpy.wait());
QCOMPARE(showDesktopSpy.count(), 1);
QVERIFY(workspace()->showingDesktop());
}
void ScreenEdgeTest::triggerConfigReload() {
workspace()->slotReconfigure();
}
void ScreenEdgeTest::testEdgeUnregister()
{
const QString scriptToLoad = QFINDTESTDATA("./scripts/screenedgeunregister.js");
QVERIFY(!scriptToLoad.isEmpty());
Scripting::self()->loadScript(scriptToLoad);
auto s = Scripting::self()->findScript(scriptToLoad);
auto configGroup = s->config();
configGroup.writeEntry("Edge", int(KWin::ElectricLeft));
configGroup.sync();
const QPoint triggerPos = QPoint(0, 512);
QSignalSpy runningChangedSpy(s, &AbstractScript::runningChanged);
s->run();
QVERIFY(runningChangedSpy.wait());
QSignalSpy showDesktopSpy(workspace(), &Workspace::showingDesktopChanged);
QVERIFY(showDesktopSpy.isValid());
//trigger the edge
KWin::Cursors::self()->mouse()->setPos(triggerPos);
QCOMPARE(showDesktopSpy.count(), 1);
//reset
KWin::Cursors::self()->mouse()->setPos(500,500);
workspace()->slotToggleShowDesktop();
showDesktopSpy.clear();
//trigger again, to show that retriggering works
KWin::Cursors::self()->mouse()->setPos(triggerPos);
QCOMPARE(showDesktopSpy.count(), 1);
//reset
KWin::Cursors::self()->mouse()->setPos(500,500);
workspace()->slotToggleShowDesktop();
showDesktopSpy.clear();
//make the script unregister the edge
configGroup.writeEntry("mode", "unregister");
triggerConfigReload();
KWin::Cursors::self()->mouse()->setPos(triggerPos);
QCOMPARE(showDesktopSpy.count(), 0); //not triggered
//force the script to unregister a non-registered edge to prove it doesn't explode
triggerConfigReload();
}
void ScreenEdgeTest::testDeclarativeTouchEdge()
{
const QString scriptToLoad = QFINDTESTDATA("./scripts/screenedgetouch.qml");
QVERIFY(!scriptToLoad.isEmpty());
QVERIFY(Scripting::self()->loadDeclarativeScript(scriptToLoad) != -1);
QVERIFY(Scripting::self()->isScriptLoaded(scriptToLoad));
auto s = Scripting::self()->findScript(scriptToLoad);
QSignalSpy runningChangedSpy(s, &AbstractScript::runningChanged);
s->run();
QTRY_COMPARE(runningChangedSpy.count(), 1);
QSignalSpy showDesktopSpy(workspace(), &Workspace::showingDesktopChanged);
QVERIFY(showDesktopSpy.isValid());
// Trigger the edge through touch
quint32 timestamp = 0;
kwinApp()->platform()->touchDown(0, QPointF(0, 50), timestamp++);
kwinApp()->platform()->touchMotion(0, QPointF(500, 50), timestamp++);
kwinApp()->platform()->touchUp(0, timestamp++);
QVERIFY(showDesktopSpy.wait());
}
WAYLANDTEST_MAIN(ScreenEdgeTest)
#include "screenedge_test.moc"