yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kwin/autotests/mock_workspace.h

84 lines
2.1 KiB
C
Raw Normal View History

[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2014 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/>.
*********************************************************************/
#ifndef KWIN_MOCK_WORKSPACE_H
#define KWIN_MOCK_WORKSPACE_H
#include <QObject>
Add an auto-test for ScreenEdges The new test does not cover ScreenEdges completely, so far the following areas are handled: * creating of the edges * reserving of edges * trigger callback * cursor pushback * blocking of edges for fullscreen active clients
2014-09-26 12:01:44 +00:00
#include <kwinglobals.h>
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
namespace KWin
{
[autotests] Adjust to changes regarding AbstractClient We need a Mock for AbstractClient and our mock Client needs to inherit from it.
2015-04-29 12:13:20 +00:00
class AbstractClient;
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
class Client;
[screens] Replace DesktopWidgetScreens by XRandRScreens A new implementation of the Screens interface is added which uses XRandR directly instead of relying on QDesktopWidget. The implementation is provided in a new implementation file screens_xrandr.cpp. XRandRScreens comes with a unit test. Unfortunately it's rather difficult to provide a proper unit test against XRandR. Xvfb (which is obviously used on the CI system) doesn't provide the XRandR extension. Also on a "normal" developer system one would not want to just execute the test as the results are not predictable (number of available outputs?) and the test would mess up the setup resulting in nobody wanting to execute the test. As a solution to both problems the unit test starts Xephyr as a nested X server. This allows to have at least some limited tests against XRandR. Nevertheless there are a few things which I was not able to test: * multiple outputs * no output at all The nested X Server approach makes the interaction rather complex. Qt opens it's connection against the main X Server thus QX11Info provides a wrong connection and also KWin::connection() which is heavily used by xcbutils and thus all the RandR wrappers have the wrong connection. To circumvent this problem the test is GUILESS. In case it would call into any code using QX11Info, it would probably either runtime fail or crash. REVIEW: 117614
2014-04-17 15:33:11 +00:00
class X11EventFilter;
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
class MockWorkspace;
typedef MockWorkspace Workspace;
class MockWorkspace : public QObject
{
Q_OBJECT
public:
explicit MockWorkspace(QObject *parent = nullptr);
Run clang-tidy with modernize-use-override check Summary: Currently code base of kwin can be viewed as two pieces. One is very ancient, and the other one is more modern, which uses new C++ features. The main problem with the ancient code is that it was written before C++11 era. So, no override or final keywords, lambdas, etc. Quite recently, KDE compiler settings were changed to show a warning if a virtual method has missing override keyword. As you might have already guessed, this fired back at us because of that ancient code. We had about 500 new compiler warnings. A "solution" was proposed to that problem - disable -Wno-suggest-override and the other similar warning for clang. It's hard to call a solution because those warnings are disabled not only for the old code, but also for new. This is not what we want! The main argument for not actually fixing the problem was that git history will be screwed as well because of human factor. While good git history is a very important thing, we should not go crazy about it and block every change that somehow alters git history. git blame allows to specify starting revision for a reason. The other argument (human factor) can be easily solved by using tools such as clang-tidy. clang-tidy is a clang-based linter for C++. It can be used for various things, e.g. fixing coding style(e.g. add missing braces to if statements, readability-braces-around-statements check), or in our case add missing override keywords. Test Plan: Compiles. Reviewers: #kwin, davidedmundson Reviewed By: #kwin, davidedmundson Subscribers: davidedmundson, apol, romangg, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D22371
2019-07-22 16:52:26 +00:00
~MockWorkspace() override;
[autotests] Adjust to changes regarding AbstractClient We need a Mock for AbstractClient and our mock Client needs to inherit from it.
2015-04-29 12:13:20 +00:00
AbstractClient *activeClient() const;
Use more accurate name for Workspace::getMovingClient method Summary: The name of Workspace::getMovingClient() method implies that the returned value is a client that is currently being moved around by the user, but this is of course incorrect. Reviewers: #kwin, apol Reviewed By: apol Subscribers: apol, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D20663
2019-04-18 12:28:11 +00:00
AbstractClient *moveResizeClient() const;
Add an auto-test for ScreenEdges The new test does not cover ScreenEdges completely, so far the following areas are handled: * creating of the edges * reserving of edges * trigger callback * cursor pushback * blocking of edges for fullscreen active clients
2014-09-26 12:01:44 +00:00
void setShowingDesktop(bool showing);
bool showingDesktop() const;
QRect clientArea(clientAreaOption, int screen, int desktop) const;
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
[autotests] Adjust to changes regarding AbstractClient We need a Mock for AbstractClient and our mock Client needs to inherit from it.
2015-04-29 12:13:20 +00:00
void setActiveClient(AbstractClient *c);
Use more accurate name for Workspace::getMovingClient method Summary: The name of Workspace::getMovingClient() method implies that the returned value is a client that is currently being moved around by the user, but this is of course incorrect. Reviewers: #kwin, apol Reviewed By: apol Subscribers: apol, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D20663
2019-04-18 12:28:11 +00:00
void setMoveResizeClient(AbstractClient *c);
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
[screens] Replace DesktopWidgetScreens by XRandRScreens A new implementation of the Screens interface is added which uses XRandR directly instead of relying on QDesktopWidget. The implementation is provided in a new implementation file screens_xrandr.cpp. XRandRScreens comes with a unit test. Unfortunately it's rather difficult to provide a proper unit test against XRandR. Xvfb (which is obviously used on the CI system) doesn't provide the XRandR extension. Also on a "normal" developer system one would not want to just execute the test as the results are not predictable (number of available outputs?) and the test would mess up the setup resulting in nobody wanting to execute the test. As a solution to both problems the unit test starts Xephyr as a nested X server. This allows to have at least some limited tests against XRandR. Nevertheless there are a few things which I was not able to test: * multiple outputs * no output at all The nested X Server approach makes the interaction rather complex. Qt opens it's connection against the main X Server thus QX11Info provides a wrong connection and also KWin::connection() which is heavily used by xcbutils and thus all the RandR wrappers have the wrong connection. To circumvent this problem the test is GUILESS. In case it would call into any code using QX11Info, it would probably either runtime fail or crash. REVIEW: 117614
2014-04-17 15:33:11 +00:00
void registerEventFilter(X11EventFilter *filter);
void unregisterEventFilter(X11EventFilter *filter);
Move XRandR event filter into XRandRScreens Summary: The code in events.cpp was problematic as it was called in a Wayland session. So KWin changed outputs, this gets mirrored to XWayland and then KWin reacted on the XRandR event and might have even changed the refresh rate due to that - bad idea. This change moves the code into the already existing X11EventFilter for XRandR events in XRandRScreens. Test Plan: Run kwin_x11 in gdb on Xephyr, breakpoint in new code and triggered XRandR event Reviewers: #kwin, #plasma Subscribers: plasma-devel, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D7654
2017-09-02 09:47:42 +00:00
bool compositing() const {
return false;
}
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
static Workspace *self();
Add an auto-test for ScreenEdges The new test does not cover ScreenEdges completely, so far the following areas are handled: * creating of the edges * reserving of edges * trigger callback * cursor pushback * blocking of edges for fullscreen active clients
2014-09-26 12:01:44 +00:00
Q_SIGNALS:
void clientRemoved(KWin::Client*);
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
private:
[autotests] Adjust to changes regarding AbstractClient We need a Mock for AbstractClient and our mock Client needs to inherit from it.
2015-04-29 12:13:20 +00:00
AbstractClient *m_activeClient;
Use more accurate name for Workspace::getMovingClient method Summary: The name of Workspace::getMovingClient() method implies that the returned value is a client that is currently being moved around by the user, but this is of course incorrect. Reviewers: #kwin, apol Reviewed By: apol Subscribers: apol, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D20663
2019-04-18 12:28:11 +00:00
AbstractClient *m_moveResizeClient;
Add an auto-test for ScreenEdges The new test does not cover ScreenEdges completely, so far the following areas are handled: * creating of the edges * reserving of edges * trigger callback * cursor pushback * blocking of edges for fullscreen active clients
2014-09-26 12:01:44 +00:00
bool m_showingDesktop;
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
static Workspace *s_self;
};
inline
Workspace *MockWorkspace::self()
{
return s_self;
}
Add an auto-test for ScreenEdges The new test does not cover ScreenEdges completely, so far the following areas are handled: * creating of the edges * reserving of edges * trigger callback * cursor pushback * blocking of edges for fullscreen active clients
2014-09-26 12:01:44 +00:00
inline Workspace *workspace()
{
return Workspace::self();
}
[auto-tests] Add an initial test for Screens This is a very interesting auto test as Screens uses both Workspace and Client. Thus it operates in the "impossible to mock" area. The solution is to provide mock includes in autotests and ensure that when building the auto-test the mock header includes will be picked first. There is now a mock class for Workspace and Client providing just the API pieces used inside Screens. As Screens is abstract and we cannot properly interact with QDesktopWidget there is also a MockScreens class inheriting from Screens and mocking the required functionality (by just operating on a list of QRects). The auto-test itself is only performing checks on the abstract class. The mock class is indirectly tested by Screens calling into the virtual methods. The test case is not yet complete, but looking quite good already.
2014-09-17 08:29:03 +00:00
}
#endif
Reference in a new issue Copy permalink