kwin/autotests/test_virtualkeyboard_dbus.cpp
Martin Flöser 8c2b2faf9d Add DBus protocol to virtual keyboard
Summary:
This change adds a DBus API to query whether the virtual keyboard is
currently enabled and provides DBus methods to request that the virtual
keyboard gets enabled/disabled. This is useful for e.g. providing a
Plasmoid or for convertables where the tablet mode needs to be enabled.

Reviewers: #kwin, #plasma

Subscribers: plasma-devel, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D8166
2017-10-19 17:59:19 +02:00

142 lines
5 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2017 Martin Flöser <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 <QtTest/QTest>
#include <QDBusConnection>
#include <QDBusMessage>
#include <QDBusPendingReply>
#include <QSignalSpy>
#include "../virtualkeyboard_dbus.h"
using KWin::VirtualKeyboardDBus;
class VirtualKeyboardDBusTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void testEnabled();
void testRequestEnabled_data();
void testRequestEnabled();
};
class DbusPropertyHelper : public QObject
{
Q_OBJECT
public:
DbusPropertyHelper()
: QObject(nullptr)
{
QDBusConnection::sessionBus().connect(
QStringLiteral("org.kde.kwin.testvirtualkeyboard"),
QStringLiteral("/VirtualKeyboard"),
QStringLiteral("org.kde.kwin.VirtualKeyboard"),
QStringLiteral("enabledChanged"),
this,
SLOT(slotEnabledChanged()));
}
~DbusPropertyHelper() = default;
Q_SIGNALS:
void enabledChanged();
private Q_SLOTS:
void slotEnabledChanged() {
emit enabledChanged();
}
};
void VirtualKeyboardDBusTest::initTestCase()
{
QDBusConnection::sessionBus().registerService(QStringLiteral("org.kde.kwin.testvirtualkeyboard"));
}
void VirtualKeyboardDBusTest::testEnabled()
{
VirtualKeyboardDBus dbus;
DbusPropertyHelper helper;
QSignalSpy helperChangedSpy(&helper, &DbusPropertyHelper::enabledChanged);
QVERIFY(helperChangedSpy.isValid());
QCOMPARE(dbus.isEnabled(), false);
QCOMPARE(dbus.property("enabled").toBool(), false);
QSignalSpy enabledChangedSpy(&dbus, &VirtualKeyboardDBus::enabledChanged);
QVERIFY(enabledChangedSpy.isValid());
auto readProperty = [] (bool enabled) {
const QDBusMessage message = QDBusMessage::createMethodCall(QStringLiteral("org.kde.kwin.testvirtualkeyboard"),
QStringLiteral("/VirtualKeyboard"),
QStringLiteral("org.kde.kwin.VirtualKeyboard"),
QStringLiteral("isEnabled"));
const auto reply = QDBusConnection::sessionBus().call(message);
QCOMPARE(reply.type(), QDBusMessage::ReplyMessage);
QCOMPARE(reply.arguments().count(), 1);
QCOMPARE(reply.arguments().first().toBool(), enabled);
};
readProperty(false);
dbus.setEnabled(true);
QCOMPARE(enabledChangedSpy.count(), 1);
QVERIFY(helperChangedSpy.wait());
QCOMPARE(helperChangedSpy.count(), 1);
QCOMPARE(dbus.isEnabled(), true);
QCOMPARE(dbus.property("enabled").toBool(), true);
readProperty(true);
// setting again to enabled should not change anything
dbus.setEnabled(true);
QCOMPARE(enabledChangedSpy.count(), 1);
// back to false
dbus.setEnabled(false);
QCOMPARE(enabledChangedSpy.count(), 2);
QVERIFY(helperChangedSpy.wait());
QCOMPARE(helperChangedSpy.count(), 2);
QCOMPARE(dbus.isEnabled(), false);
QCOMPARE(dbus.property("enabled").toBool(), false);
readProperty(false);
}
void VirtualKeyboardDBusTest::testRequestEnabled_data()
{
QTest::addColumn<QString>("method");
QTest::addColumn<bool>("expectedResult");
QTest::newRow("enable") << QStringLiteral("enable") << true;
QTest::newRow("disable") << QStringLiteral("disable") << false;
}
void VirtualKeyboardDBusTest::testRequestEnabled()
{
VirtualKeyboardDBus dbus;
QSignalSpy activateRequestedSpy(&dbus, &VirtualKeyboardDBus::activateRequested);
QVERIFY(activateRequestedSpy.isValid());
QFETCH(QString, method);
const QDBusMessage message = QDBusMessage::createMethodCall(QStringLiteral("org.kde.kwin.testvirtualkeyboard"),
QStringLiteral("/VirtualKeyboard"),
QStringLiteral("org.kde.kwin.VirtualKeyboard"),
method);
QDBusConnection::sessionBus().asyncCall(message);
QTRY_COMPARE(activateRequestedSpy.count(), 1);
QTEST(activateRequestedSpy.first().first().toBool(), "expectedResult");
}
QTEST_GUILESS_MAIN(VirtualKeyboardDBusTest)
#include "test_virtualkeyboard_dbus.moc"