From 30b257be08fe10cd27afc4f226acb154118fbacd Mon Sep 17 00:00:00 2001 From: Vlad Zagorodniy Date: Sat, 5 Jan 2019 14:42:30 +0200 Subject: [PATCH] [autotests] Test popup open/close animations Summary: The new test is similar to testToplevelOpenCloseAnimation. The main purpose of this test is to verify that the Fading Popups effect animates all sorts of popups, e.g. popup menus, tooltips, etc. testAnimateUserActionsPopup is skipped for now because stuff that animates unmapped clients is broken. Reviewers: #kwin, davidedmundson Reviewed By: #kwin, davidedmundson Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D17992 --- autotests/integration/effects/CMakeLists.txt | 1 + .../popup_open_close_animation_test.cpp | 280 ++++++++++++++++++ shell_client.cpp | 4 +- 3 files changed, 283 insertions(+), 2 deletions(-) create mode 100644 autotests/integration/effects/popup_open_close_animation_test.cpp diff --git a/autotests/integration/effects/CMakeLists.txt b/autotests/integration/effects/CMakeLists.txt index eae5445f10..1c1f9d76df 100644 --- a/autotests/integration/effects/CMakeLists.txt +++ b/autotests/integration/effects/CMakeLists.txt @@ -7,3 +7,4 @@ integrationTest(NAME testFade SRCS fade_test.cpp) integrationTest(WAYLAND_ONLY NAME testEffectWindowGeometry SRCS windowgeometry_test.cpp) integrationTest(NAME testScriptedEffects SRCS scripted_effects_test.cpp) integrationTest(WAYLAND_ONLY NAME testToplevelOpenCloseAnimation SRCS toplevel_open_close_animation_test.cpp) +integrationTest(WAYLAND_ONLY NAME testPopupOpenCloseAnimation SRCS popup_open_close_animation_test.cpp) diff --git a/autotests/integration/effects/popup_open_close_animation_test.cpp b/autotests/integration/effects/popup_open_close_animation_test.cpp new file mode 100644 index 0000000000..447e1d1561 --- /dev/null +++ b/autotests/integration/effects/popup_open_close_animation_test.cpp @@ -0,0 +1,280 @@ +/******************************************************************** +KWin - the KDE window manager +This file is part of the KDE project. + +Copyright (C) 2019 Vlad Zagorodniy + +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 . +*********************************************************************/ + +#include "kwin_wayland_test.h" + +#include "abstract_client.h" +#include "deleted.h" +#include "effectloader.h" +#include "effects.h" +#include "platform.h" +#include "shell_client.h" +#include "useractions.h" +#include "wayland_server.h" +#include "workspace.h" + +#include "decorations/decoratedclient.h" + +#include "effect_builtins.h" + +#include +#include +#include + +#include + +using namespace KWin; + +static const QString s_socketName = QStringLiteral("wayland_test_effects_popup_open_close_animation-0"); + +class PopupOpenCloseAnimationTest : public QObject +{ + Q_OBJECT + +private Q_SLOTS: + void initTestCase(); + void init(); + void cleanup(); + + void testAnimatePopups(); + void testAnimateUserActionsPopup(); + void testAnimateDecorationTooltips(); +}; + +void PopupOpenCloseAnimationTest::initTestCase() +{ + qputenv("XDG_DATA_DIRS", QCoreApplication::applicationDirPath().toUtf8()); + + qRegisterMetaType(); + qRegisterMetaType(); + qRegisterMetaType(); + QSignalSpy workspaceCreatedSpy(kwinApp(), &Application::workspaceCreated); + QVERIFY(workspaceCreatedSpy.isValid()); + kwinApp()->platform()->setInitialWindowSize(QSize(1280, 1024)); + QVERIFY(waylandServer()->init(s_socketName.toLocal8Bit())); + + auto config = KSharedConfig::openConfig(QString(), KConfig::SimpleConfig); + KConfigGroup plugins(config, QStringLiteral("Plugins")); + ScriptedEffectLoader loader; + const auto builtinNames = BuiltInEffects::availableEffectNames() << loader.listOfKnownEffects(); + for (const QString &name : builtinNames) { + plugins.writeEntry(name + QStringLiteral("Enabled"), false); + } + config->sync(); + kwinApp()->setConfig(config); + + qputenv("KWIN_EFFECTS_FORCE_ANIMATIONS", QByteArrayLiteral("1")); + + kwinApp()->start(); + QVERIFY(workspaceCreatedSpy.wait()); + waylandServer()->initWorkspace(); +} + +void PopupOpenCloseAnimationTest::init() +{ + QVERIFY(Test::setupWaylandConnection(Test::AdditionalWaylandInterface::XdgDecoration)); +} + +void PopupOpenCloseAnimationTest::cleanup() +{ + auto effectsImpl = qobject_cast(effects); + QVERIFY(effectsImpl); + effectsImpl->unloadAllEffects(); + QVERIFY(effectsImpl->loadedEffects().isEmpty()); + + Test::destroyWaylandConnection(); +} + +void PopupOpenCloseAnimationTest::testAnimatePopups() +{ + // This test verifies that popup open/close animation effects try + // to animate popups(e.g. popup menus, tooltips, etc). + + // Make sure that we have the right effects ptr. + auto effectsImpl = qobject_cast(effects); + QVERIFY(effectsImpl); + + // Create the main window. + using namespace KWayland::Client; + QScopedPointer mainWindowSurface(Test::createSurface()); + QVERIFY(!mainWindowSurface.isNull()); + QScopedPointer mainWindowShellSurface(Test::createXdgShellStableSurface(mainWindowSurface.data())); + QVERIFY(!mainWindowShellSurface.isNull()); + ShellClient *mainWindow = Test::renderAndWaitForShown(mainWindowSurface.data(), QSize(100, 50), Qt::blue); + QVERIFY(mainWindow); + + // Load effect that will be tested. + const QString effectName = QStringLiteral("kwin4_effect_fadingpopups"); + QVERIFY(effectsImpl->loadEffect(effectName)); + QCOMPARE(effectsImpl->loadedEffects().count(), 1); + QCOMPARE(effectsImpl->loadedEffects().first(), effectName); + Effect *effect = effectsImpl->findEffect(effectName); + QVERIFY(effect); + QVERIFY(!effect->isActive()); + + // Create a popup, it should be animated. + QScopedPointer popupSurface(Test::createSurface()); + QVERIFY(!popupSurface.isNull()); + XdgPositioner positioner(QSize(20, 20), QRect(0, 0, 10, 10)); + positioner.setGravity(Qt::BottomEdge | Qt::RightEdge); + positioner.setAnchorEdge(Qt::BottomEdge | Qt::LeftEdge); + QScopedPointer popupShellSurface(Test::createXdgShellStablePopup(popupSurface.data(), mainWindowShellSurface.data(), positioner)); + QVERIFY(!popupShellSurface.isNull()); + ShellClient *popup = Test::renderAndWaitForShown(popupSurface.data(), positioner.initialSize(), Qt::red); + QVERIFY(popup); + QVERIFY(popup->isPopupWindow()); + QCOMPARE(popup->transientFor(), mainWindow); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Destroy the popup, it should not be animated. + QSignalSpy popupClosedSpy(popup, &ShellClient::windowClosed); + QVERIFY(popupClosedSpy.isValid()); + popupShellSurface.reset(); + popupSurface.reset(); + QVERIFY(popupClosedSpy.wait()); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Destroy the main window. + mainWindowSurface.reset(); + QVERIFY(Test::waitForWindowDestroyed(mainWindow)); +} + +void PopupOpenCloseAnimationTest::testAnimateUserActionsPopup() +{ + QSKIP("Can't animate the disappearing of the user actions popup."); + + // This test verifies that popup open/close animation effects try + // to animate the user actions popup. + + // Make sure that we have the right effects ptr. + auto effectsImpl = qobject_cast(effects); + QVERIFY(effectsImpl); + + // Create the test client. + using namespace KWayland::Client; + QScopedPointer surface(Test::createSurface()); + QVERIFY(!surface.isNull()); + QScopedPointer shellSurface(Test::createXdgShellStableSurface(surface.data())); + QVERIFY(!shellSurface.isNull()); + ShellClient *client = Test::renderAndWaitForShown(surface.data(), QSize(100, 50), Qt::blue); + QVERIFY(client); + + // Load effect that will be tested. + const QString effectName = QStringLiteral("kwin4_effect_fadingpopups"); + QVERIFY(effectsImpl->loadEffect(effectName)); + QCOMPARE(effectsImpl->loadedEffects().count(), 1); + QCOMPARE(effectsImpl->loadedEffects().first(), effectName); + Effect *effect = effectsImpl->findEffect(effectName); + QVERIFY(effect); + QVERIFY(!effect->isActive()); + + // Show the user actions popup. + workspace()->showWindowMenu(QRect(), client); + auto userActionsMenu = workspace()->userActionsMenu(); + QTRY_VERIFY(userActionsMenu->isShown()); + QVERIFY(userActionsMenu->hasClient()); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Close the user actions popup. + kwinApp()->platform()->keyboardKeyPressed(KEY_ESC, 0); + kwinApp()->platform()->keyboardKeyReleased(KEY_ESC, 1); + QTRY_VERIFY(!userActionsMenu->isShown()); + QVERIFY(!userActionsMenu->hasClient()); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Destroy the test client. + surface.reset(); + QVERIFY(Test::waitForWindowDestroyed(client)); +} + +void PopupOpenCloseAnimationTest::testAnimateDecorationTooltips() +{ + // This test verifies that popup open/close animation effects try + // to animate decoration tooltips. + + // Make sure that we have the right effects ptr. + auto effectsImpl = qobject_cast(effects); + QVERIFY(effectsImpl); + + // Create the test client. + using namespace KWayland::Client; + QScopedPointer surface(Test::createSurface()); + QVERIFY(!surface.isNull()); + QScopedPointer shellSurface(Test::createXdgShellStableSurface(surface.data())); + QVERIFY(!shellSurface.isNull()); + QScopedPointer deco(Test::xdgDecorationManager()->getToplevelDecoration(shellSurface.data())); + QVERIFY(!deco.isNull()); + deco->setMode(XdgDecoration::Mode::ServerSide); + ShellClient *client = Test::renderAndWaitForShown(surface.data(), QSize(100, 50), Qt::blue); + QVERIFY(client); + QVERIFY(client->isDecorated()); + + // Load effect that will be tested. + const QString effectName = QStringLiteral("kwin4_effect_fadingpopups"); + QVERIFY(effectsImpl->loadEffect(effectName)); + QCOMPARE(effectsImpl->loadedEffects().count(), 1); + QCOMPARE(effectsImpl->loadedEffects().first(), effectName); + Effect *effect = effectsImpl->findEffect(effectName); + QVERIFY(effect); + QVERIFY(!effect->isActive()); + + // Show a decoration tooltip. + QSignalSpy tooltipAddedSpy(waylandServer(), &WaylandServer::shellClientAdded); + QVERIFY(tooltipAddedSpy.isValid()); + client->decoratedClient()->requestShowToolTip(QStringLiteral("KWin rocks!")); + QVERIFY(tooltipAddedSpy.wait()); + ShellClient *tooltip = tooltipAddedSpy.first().first().value(); + QVERIFY(tooltip->isInternal()); + QVERIFY(tooltip->isPopupWindow()); + QVERIFY(tooltip->internalWindow()->flags().testFlag(Qt::ToolTip)); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Hide the decoration tooltip. + QSignalSpy tooltipClosedSpy(tooltip, &ShellClient::windowClosed); + QVERIFY(tooltipClosedSpy.isValid()); + client->decoratedClient()->requestHideToolTip(); + QVERIFY(tooltipClosedSpy.wait()); + QVERIFY(effect->isActive()); + + // Eventually, the animation will be complete. + QTRY_VERIFY(!effect->isActive()); + + // Destroy the test client. + surface.reset(); + QVERIFY(Test::waitForWindowDestroyed(client)); +} + +WAYLANDTEST_MAIN(PopupOpenCloseAnimationTest) +#include "popup_open_close_animation_test.moc" diff --git a/shell_client.cpp b/shell_client.cpp index bf47ecdafe..4255d6394d 100644 --- a/shell_client.cpp +++ b/shell_client.cpp @@ -1982,8 +1982,8 @@ bool ShellClient::isPopupWindow() const if (Toplevel::isPopupWindow()) { return true; } - if (isInternal() && m_internalWindow) { - return m_internalWindow->flags().testFlag(Qt::Popup); + if (isInternal()) { + return m_internalWindowFlags.testFlag(Qt::Popup); } if (m_shellSurface != nullptr) { return m_shellSurface->isPopup();