Differential D8156 Diff 20570 kdevplatform/shell/tests/test_pluginenabling.cpp

Changeset View

Standalone View

View Options

kdevplatform/shell/tests/test_pluginenabling.cpp

  • This file was added.
1​/*
2​ * Copyright 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
3​ *
4​ * This program is free software; you can redistribute it and/or modify
5​ * it under the terms of the GNU Library General Public License as
6​ * published by the Free Software Foundation; either version 2 of the
7​ * License, or (at your option) any later version.
8​ *
9​ * This program is distributed in the hope that it will be useful,
10​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
11​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12​ * GNU General Public License for more details.
13​ *
14​ * You should have received a copy of the GNU General Public
15​ * License along with this program; if not, write to the
16​ * Free Software Foundation, Inc.,
17​ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18​ */
19​
20​#include "test_pluginenabling.h"
21​
22​#include "testfilepaths.h"
23​
24​#include <QSignalSpy>
25​#include <QTest>
26​
27​#include <KConfigGroup>
28​
29​#include <tests/autotestshell.h>
30​#include <tests/testcore.h>
31​#include <isession.h>
32​
33​#include "../core.h"
34​#include "../plugincontroller.h"
35​
36​using namespace KDevelop;
37​
38​void TestPluginEnabling::initTestCase()
39​{
40​ qApp->addLibraryPath(QStringLiteral(TEST_PLUGIN_DIR));
41​}
42​
43​void TestPluginEnabling::loadPlugin(const QString& pluginId, bool shouldBeEnabled)
44​{
45​ // check config storage
46​ KConfigGroup grp = Core::self()->activeSession()->config()->group(QStringLiteral("Plugins"));
mwolffUnsubmitted
Not Done

personally I'd prefer separate test functions instead of ifdef. afaik you can de-init the shell completely nowadays (or not?). so you could have one test method for the default scenario, and another one for the custom plugins

mwolff: personally I'd prefer separate test functions instead of ifdef. afaik you can de-init the shell…
kossebauAuthorUnsubmitted
Not Done

Problem here is that we want to especially test the initial setup when plugincontroller is instantiated.
So it needs to be two different tests.

Would you prefer going for subclassing the test instead and doing the specialization there?
Personally would prefer the ifdef over that, as this way there is a one file to look at.
But as you prefer.

kossebau: Problem here is that we want to especially test the initial setup when plugincontroller is…
kossebauAuthorUnsubmitted
Not Done

when plugincontroller is instantiated.

Which especially means a new session created, without any config yet stored.

Or did you mean to move the TestCore::initialize() & TestCore::shutdown() out of the init and cleanup methods and instead use them directly in the test functions, with different session arguments?
Hm... seems no other code does it. Though the API dox hints one might be able to use it more than once, and the current implementation on a first view does also not advise against it. So, shall I give that a try?

kossebau: > when plugincontroller is instantiated. Which especially means a new session created, without…
mwolffUnsubmitted
Done

Yes, that was what I had in mind. Just init + shutdown the TestCore within the tests. What might be tricky is shutting down the AutoTestShell, not sure that's supported yet. That said, maybe you should push this as-is and we can clean it up in the future (i.e., probably never). But it's not too bad to hold up your overall change, I guess.

mwolff: Yes, that was what I had in mind. Just init + shutdown the TestCore within the tests. What…
kossebauAuthorUnsubmitted
Not Done

Uploaded now a variant with init + shutdown of the TestCore within the tests. Not sure this is a lot better, but your call :)

Please have a look at the two TODOs in TestPluginEnabling::loadPluginCustomDefaults(), any feedback on those?

kossebau: Uploaded now a variant with init + shutdown of the TestCore within the tests. Not sure this is…
47​
48​ const QString pluginEnabledKey = pluginId + QLatin1String("Enabled");
49​ // logic in kdevelop
50​ const bool enabled = grp.hasKey(pluginEnabledKey) ? grp.readEntry(pluginEnabledKey, true) : false;
51​
52​ QCOMPARE(enabled, shouldBeEnabled);
53​
54​ // check plugin loading
55​ QCOMPARE((m_pluginCtrl->loadPlugin(pluginId) != nullptr), shouldBeEnabled);
56​ QCOMPARE((m_pluginCtrl->plugin(pluginId) != nullptr), shouldBeEnabled);
57​
58​ if (shouldBeEnabled) {
59​ m_pluginCtrl->unloadPlugin(pluginId);
60​ QVERIFY(!m_pluginCtrl->plugin(pluginId));
61​ }
62​
mwolffUnsubmitted
Done

if empty, remove those methods

mwolff: if empty, remove those methods
kossebauAuthorUnsubmitted
Not Done

Was copied over from some other test. Shall I then clean up the other tests as well from empty methods?

kossebau: Was copied over from some other test. Shall I then clean up the other tests as well from empty…
mwolffUnsubmitted
Not Done

Yes, in separate patches though.

mwolff: Yes, in separate patches though.
63​ // switch enabled state
64​ const bool shouldNowBeEnabled = !shouldBeEnabled;
65​ grp.writeEntry(pluginEnabledKey, shouldNowBeEnabled);
66​
67​ // check plugin loading again
68​ QCOMPARE((m_pluginCtrl->loadPlugin(pluginId) != nullptr), shouldNowBeEnabled);
69​ QCOMPARE((m_pluginCtrl->plugin(pluginId) != nullptr), shouldNowBeEnabled);
70​
71​ if (shouldNowBeEnabled) {
72​ m_pluginCtrl->unloadPlugin(pluginId);
73​ QVERIFY(!m_pluginCtrl->plugin(pluginId));
74​ }
75​
76​}
77​
78​void TestPluginEnabling::loadPluginCustomDefaults_data()
79​{
80​ QTest::addColumn<QString>("pluginId");
81​ QTest::addColumn<bool>("shouldBeEnabled");
82​
83​ QTest::newRow("test_globaldefault") << "test_globaldefault" << false;
84​ QTest::newRow("test_globalnondefault") << "test_globalnondefault" << true;
85​ QTest::newRow("test_projectdefault") << "test_projectdefault" << false;
86​ QTest::newRow("test_projectnondefault") << "test_projectnondefault" << true;
87​}
88​
89​void TestPluginEnabling::loadPluginCustomDefaults()
90​{
91​ QFETCH(QString, pluginId);
92​ QFETCH(bool, shouldBeEnabled);
93​
94​ AutoTestShell::init({
95​ // set those as default which would not be by own metadata
96​ // and do not set those which otherwise would, so both
97​ QStringLiteral("test_globalnondefault"),
98​ QStringLiteral("test_projectnondefault")
99​ });
100​ // TODO: somehow currently the clean-up of the previous session is not yet done
mwolffUnsubmitted
Not Done

I'd have to debug that myself, it should work... maybe add a signal spy on some signal to ensure the core gets destroyed or otherwise shutdown properly? I.e. maybe we need to run the event loop?

mwolff: I'd have to debug that myself, it should work... maybe add a signal spy on some signal to…
101​ // on the next data item test run, so the session with the name is still locked
102​ // so we work-around that for now by using a custom session name per session
103​ // TODO: consider adding a new bool temporarySession = true to TestCore::initialize()
mwolffUnsubmitted
Not Done

sure, why not. So far, the empty name == temporary rule worked fine afaik. If there's more needed, extend the API as needed.

mwolff: sure, why not. So far, the `empty name == temporary` rule worked fine afaik. If there's more…
104​ TestCore::initialize(Core::NoUi, QStringLiteral("test_pluginenabling_custom_")+pluginId);
105​ TestCore::self()->activeSession()->setTemporary(true);
106​ m_pluginCtrl = Core::self()->pluginControllerInternal();
107​
108​ loadPlugin(pluginId, shouldBeEnabled);
109​
110​ TestCore::shutdown();
111​}
112​
113​void TestPluginEnabling::loadPluginNormalDefaults_data()
114​{
115​ QTest::addColumn<QString>("pluginId");
116​ QTest::addColumn<bool>("shouldBeEnabled");
117​
118​ QTest::newRow("test_globaldefault") << "test_globaldefault" << true;
119​ QTest::newRow("test_globalnondefault") << "test_globalnondefault" << false;
120​ QTest::newRow("test_projectdefault") << "test_projectdefault" << true;
121​ QTest::newRow("test_projectnondefault") << "test_projectnondefault" << false;
122​}
123​
124​void TestPluginEnabling::loadPluginNormalDefaults()
125​{
126​ QFETCH(QString, pluginId);
127​ QFETCH(bool, shouldBeEnabled);
128​
129​ AutoTestShell::init();
130​ // see TODO in loadPluginCustomDefaults()
131​ TestCore::initialize(Core::NoUi, QStringLiteral("test_pluginenabling_normal_")+pluginId);
132​ TestCore::self()->activeSession()->setTemporary(true);
133​ m_pluginCtrl = Core::self()->pluginControllerInternal();
134​
135​ // check plugin metadata
136​ const auto pluginInfo = m_pluginCtrl->infoForPluginId(pluginId);
137​ // logic in kdevelop different from KPluginMetaData::isEnabledByDefault(), here defaults to true
138​ const auto enabledByDefaultValue = pluginInfo.rawData()["KPlugin"].toObject()["EnabledByDefault"];
139​ const bool enabledByDefault = (enabledByDefaultValue.isNull() || enabledByDefaultValue.toBool());
140​ QCOMPARE(enabledByDefault, shouldBeEnabled);
141​
142​ loadPlugin(pluginId, shouldBeEnabled);
143​
144​ TestCore::shutdown();
145​}
146​
147​QTEST_MAIN(TestPluginEnabling)