Files
qt-creator/tests/auto/extensionsystem/pluginmanager/tst_pluginmanager.cpp
Eike Ziller 41b73594ad Add API for saving settings with default value
We should never actually write default values into the settings, because

- if the default value changes in a later Qt Creator version, the new
  default should automatically take effect if the user didn't change the
  value
- it senselessly grows the settings file

Add a QtcSettings class that extends QSettings by a
"setValueWithDefault" method, which does not write default values to the
settings, and actually removes the settingskey if the user switches back
to the default.

Use it at the places where we already do this manually.

Task-number: QTCREATORBUG-24762
Change-Id: Ia76414cb21e8521f3aeed1e37b43ae4fb3393ea3
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-12-04 08:25:17 +00:00

219 lines
7.6 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include <extensionsystem/pluginmanager.h>
#include <extensionsystem/pluginspec.h>
#include <extensionsystem/iplugin.h>
#include <QtTest>
#include <QObject>
using namespace ExtensionSystem;
class SignalReceiver;
class tst_PluginManager : public QObject
{
Q_OBJECT
private slots:
void init();
void cleanup();
void addRemoveObjects();
void getObject();
void circularPlugins();
void correctPlugins1();
private:
PluginManager *m_pm;
QSignalSpy *m_objectAdded;
QSignalSpy *m_aboutToRemoveObject;
QSignalSpy *m_pluginsChanged;
};
class MyClass1 : public QObject
{
Q_OBJECT
};
class MyClass2 : public QObject
{
Q_OBJECT
};
class MyClass11 : public MyClass1
{
Q_OBJECT
};
static QString pluginFolder(const QLatin1String &folder)
{
return QLatin1String(PLUGINMANAGER_TESTS_DIR) + QLatin1String("/") + folder;
}
void tst_PluginManager::init()
{
m_pm = new PluginManager;
PluginManager::setSettings(new Utils::QtcSettings);
PluginManager::setPluginIID(QLatin1String("plugin"));
m_objectAdded = new QSignalSpy(m_pm, SIGNAL(objectAdded(QObject*)));
m_aboutToRemoveObject = new QSignalSpy(m_pm, SIGNAL(aboutToRemoveObject(QObject*)));
m_pluginsChanged = new QSignalSpy(m_pm, SIGNAL(pluginsChanged()));
}
void tst_PluginManager::cleanup()
{
PluginManager::shutdown();
delete m_pm;
delete m_objectAdded;
delete m_aboutToRemoveObject;
delete m_pluginsChanged;
}
void tst_PluginManager::addRemoveObjects()
{
QObject *object1 = new QObject;
QObject *object2 = new QObject;
QCOMPARE(PluginManager::allObjects().size(), 0);
PluginManager::addObject(object1);
QCOMPARE(m_objectAdded->count(), 1);
QCOMPARE(m_objectAdded->at(0).first().value<QObject *>(), object1);
QCOMPARE(m_aboutToRemoveObject->count(), 0);
QVERIFY(PluginManager::allObjects().contains(object1));
QVERIFY(!PluginManager::allObjects().contains(object2));
QCOMPARE(PluginManager::allObjects().size(), 1);
PluginManager::addObject(object2);
QCOMPARE(m_objectAdded->count(), 2);
QCOMPARE(m_objectAdded->at(1).first().value<QObject *>(), object2);
QCOMPARE(m_aboutToRemoveObject->count(), 0);
QVERIFY(PluginManager::allObjects().contains(object1));
QVERIFY(PluginManager::allObjects().contains(object2));
QCOMPARE(PluginManager::allObjects().size(), 2);
PluginManager::removeObject(object1);
QCOMPARE(m_objectAdded->count(), 2);
QCOMPARE(m_aboutToRemoveObject->count(), 1);
QCOMPARE(m_aboutToRemoveObject->at(0).first().value<QObject *>(), object1);
QVERIFY(!PluginManager::allObjects().contains(object1));
QVERIFY(PluginManager::allObjects().contains(object2));
QCOMPARE(PluginManager::allObjects().size(), 1);
PluginManager::removeObject(object2);
QCOMPARE(m_objectAdded->count(), 2);
QCOMPARE(m_aboutToRemoveObject->count(), 2);
QCOMPARE(m_aboutToRemoveObject->at(1).first().value<QObject *>(), object2);
QVERIFY(!PluginManager::allObjects().contains(object1));
QVERIFY(!PluginManager::allObjects().contains(object2));
QCOMPARE(PluginManager::allObjects().size(), 0);
delete object1;
delete object2;
}
void tst_PluginManager::getObject()
{
MyClass2 *object2 = new MyClass2;
MyClass11 *object11 = new MyClass11;
MyClass2 *object2b = new MyClass2;
const QString objectName = QLatin1String("OBJECTNAME");
object2b->setObjectName(objectName);
PluginManager::addObject(object2);
QCOMPARE(PluginManager::getObject<MyClass11>(), static_cast<MyClass11 *>(0));
QCOMPARE(PluginManager::getObject<MyClass1>(), static_cast<MyClass1 *>(0));
QCOMPARE(PluginManager::getObject<MyClass2>(), object2);
PluginManager::addObject(object11);
QCOMPARE(PluginManager::getObject<MyClass11>(), object11);
QCOMPARE(PluginManager::getObject<MyClass1>(), qobject_cast<MyClass1 *>(object11));
QCOMPARE(PluginManager::getObject<MyClass2>(), object2);
QCOMPARE(PluginManager::getObjectByName(objectName), static_cast<QObject *>(0));
PluginManager::addObject(object2b);
QCOMPARE(PluginManager::getObjectByName(objectName), object2b);
QCOMPARE(PluginManager::getObject<MyClass2>(
[&objectName](MyClass2 *obj) { return obj->objectName() == objectName;}), object2b);
PluginManager::removeObject(object2);
PluginManager::removeObject(object11);
PluginManager::removeObject(object2b);
delete object2;
delete object11;
delete object2b;
}
void tst_PluginManager::circularPlugins()
{
PluginManager::setPluginPaths(QStringList() << pluginFolder(QLatin1String("circularplugins")));
PluginManager::loadPlugins();
QVector<PluginSpec *> plugins = PluginManager::plugins();
QCOMPARE(plugins.count(), 3);
foreach (PluginSpec *spec, plugins) {
if (spec->name() == "plugin1") {
QVERIFY(spec->hasError());
QCOMPARE(spec->state(), PluginSpec::Resolved);
QCOMPARE(spec->plugin(), static_cast<IPlugin *>(0));
} else if (spec->name() == "plugin2") {
QVERIFY2(!spec->hasError(), qPrintable(spec->errorString()));
QCOMPARE(spec->state(), PluginSpec::Running);
} else if (spec->name() == "plugin3") {
QVERIFY(spec->hasError());
QCOMPARE(spec->state(), PluginSpec::Resolved);
QCOMPARE(spec->plugin(), static_cast<IPlugin *>(0));
}
}
}
void tst_PluginManager::correctPlugins1()
{
PluginManager::setPluginPaths(QStringList() << pluginFolder(QLatin1String("correctplugins1")));
PluginManager::loadPlugins();
bool specError = false;
bool runError = false;
foreach (PluginSpec *spec, PluginManager::plugins()) {
if (spec->hasError()) {
qDebug() << spec->filePath();
qDebug() << spec->errorString();
}
specError = specError || spec->hasError();
runError = runError || (spec->state() != PluginSpec::Running);
}
QVERIFY(!specError);
QVERIFY(!runError);
bool plugin1running = false;
bool plugin2running = false;
bool plugin3running = false;
foreach (QObject *obj, PluginManager::allObjects()) {
if (obj->objectName() == "MyPlugin1_running")
plugin1running = true;
else if (obj->objectName() == "MyPlugin2_running")
plugin2running = true;
else if (obj->objectName() == "MyPlugin3_running")
plugin3running = true;
}
QVERIFY(plugin1running);
QVERIFY(plugin2running);
QVERIFY(plugin3running);
}
QTEST_MAIN(tst_PluginManager)
#include "tst_pluginmanager.moc"