1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
* Copyright 2017 Friedrich W. H. Kossebau <kossebau@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library 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, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include "test_pluginenabling.h"
#include "testfilepaths.h"
#include <QSignalSpy>
#include <QTest>
#include <KConfigGroup>
#include <tests/autotestshell.h>
#include <tests/testcore.h>
#include <isession.h>
#include "../core.h"
#include "../plugincontroller.h"
using namespace KDevelop;
void TestPluginEnabling::initTestCase()
{
qApp->addLibraryPath(QStringLiteral(TEST_PLUGIN_DIR));
}
void TestPluginEnabling::loadPlugin(const QString& pluginId, bool shouldBeEnabled)
{
// check config storage
KConfigGroup grp = Core::self()->activeSession()->config()->group(QStringLiteral("Plugins"));
const QString pluginEnabledKey = pluginId + QLatin1String("Enabled");
// logic in kdevelop
const bool enabled = grp.hasKey(pluginEnabledKey) ? grp.readEntry(pluginEnabledKey, true) : false;
QCOMPARE(enabled, shouldBeEnabled);
// check plugin loading
QCOMPARE((m_pluginCtrl->loadPlugin(pluginId) != nullptr), shouldBeEnabled);
QCOMPARE((m_pluginCtrl->plugin(pluginId) != nullptr), shouldBeEnabled);
if (shouldBeEnabled) {
m_pluginCtrl->unloadPlugin(pluginId);
QVERIFY(!m_pluginCtrl->plugin(pluginId));
}
// switch enabled state
const bool shouldNowBeEnabled = !shouldBeEnabled;
grp.writeEntry(pluginEnabledKey, shouldNowBeEnabled);
// check plugin loading again
QCOMPARE((m_pluginCtrl->loadPlugin(pluginId) != nullptr), shouldNowBeEnabled);
QCOMPARE((m_pluginCtrl->plugin(pluginId) != nullptr), shouldNowBeEnabled);
if (shouldNowBeEnabled) {
m_pluginCtrl->unloadPlugin(pluginId);
QVERIFY(!m_pluginCtrl->plugin(pluginId));
}
}
void TestPluginEnabling::loadPluginCustomDefaults_data()
{
QTest::addColumn<QString>("pluginId");
QTest::addColumn<bool>("shouldBeEnabled");
QTest::newRow("test_globaldefault") << "test_globaldefault" << false;
QTest::newRow("test_globalnondefault") << "test_globalnondefault" << true;
QTest::newRow("test_projectdefault") << "test_projectdefault" << false;
QTest::newRow("test_projectnondefault") << "test_projectnondefault" << true;
}
void TestPluginEnabling::loadPluginCustomDefaults()
{
QFETCH(QString, pluginId);
QFETCH(bool, shouldBeEnabled);
AutoTestShell::init({
// set those as default which would not be by own metadata
// and do not set those which otherwise would, so both
QStringLiteral("test_globalnondefault"),
QStringLiteral("test_projectnondefault")
});
// TODO: somehow currently the clean-up of the previous session is not yet done
// on the next data item test run, so the session with the name is still locked
// so we work-around that for now by using a custom session name per session
// TODO: consider adding a new bool temporarySession = true to TestCore::initialize()
TestCore::initialize(Core::NoUi, QStringLiteral("test_pluginenabling_custom_")+pluginId);
TestCore::self()->activeSession()->setTemporary(true);
m_pluginCtrl = Core::self()->pluginControllerInternal();
loadPlugin(pluginId, shouldBeEnabled);
TestCore::shutdown();
}
void TestPluginEnabling::loadPluginNormalDefaults_data()
{
QTest::addColumn<QString>("pluginId");
QTest::addColumn<bool>("shouldBeEnabled");
QTest::newRow("test_globaldefault") << "test_globaldefault" << true;
QTest::newRow("test_globalnondefault") << "test_globalnondefault" << false;
QTest::newRow("test_projectdefault") << "test_projectdefault" << true;
QTest::newRow("test_projectnondefault") << "test_projectnondefault" << false;
}
void TestPluginEnabling::loadPluginNormalDefaults()
{
QFETCH(QString, pluginId);
QFETCH(bool, shouldBeEnabled);
AutoTestShell::init();
// see TODO in loadPluginCustomDefaults()
TestCore::initialize(Core::NoUi, QStringLiteral("test_pluginenabling_normal_")+pluginId);
TestCore::self()->activeSession()->setTemporary(true);
m_pluginCtrl = Core::self()->pluginControllerInternal();
// check plugin metadata
const auto pluginInfo = m_pluginCtrl->infoForPluginId(pluginId);
// logic in kdevelop different from KPluginMetaData::isEnabledByDefault(), here defaults to true
const QJsonValue enabledByDefaultValue = pluginInfo.rawData()["KPlugin"].toObject()["EnabledByDefault"];
const bool enabledByDefault = (enabledByDefaultValue.isNull() || enabledByDefaultValue.toBool());
QCOMPARE(enabledByDefault, shouldBeEnabled);
loadPlugin(pluginId, shouldBeEnabled);
TestCore::shutdown();
}
QTEST_MAIN(TestPluginEnabling)
|
