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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/**************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 http://qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
**
** $QT_END_LICENSE$
**
**************************************************************************/
#include <utils.h>
#include <settingsoperation.h>
#include <qinstallerglobal.h>
#include <QObject>
#include <QTest>
#include <QSettings>
#include <QDir>
using namespace KDUpdater;
using namespace QInstaller;
class tst_settingsoperation : public QObject
{
Q_OBJECT
private slots:
// called before all tests
void initTestCase()
{
m_testSettingsDirPath = qApp->applicationDirPath();
m_testSettingsFilename = "test.ini";
QSettings testSettings(QDir(m_testSettingsDirPath).filePath(m_testSettingsFilename),
QSettings::IniFormat);
m_cleanupFilePaths << QDir(m_testSettingsDirPath).filePath(m_testSettingsFilename);
testSettings.setValue("testkey", "testvalue");
testSettings.setValue("testcategory/categorytestkey", "categorytestvalue");
testSettings.setValue("testcategory/categoryarrayvalue1", QStringList() << "value1" <<
"value2" << "value3");
testSettings.setValue("testcategory/categoryarrayvalue2", "value1,value2,value3");
testSettings.setValue("testcategory/categoryarrayvalue3", "value1 ,value2, value3");
}
void testWrongArguments()
{
SettingsOperation noArgumentsOperation(0);
QVERIFY(noArgumentsOperation.testOperation());
// operation should do nothing if there are no arguments
QCOMPARE(noArgumentsOperation.performOperation(), false);
QCOMPARE(UpdateOperation::Error(noArgumentsOperation.error()),
UpdateOperation::InvalidArguments);
QString compareString("Missing argument(s) \"path; method; key; value\" calling Settings "
"with arguments \"\".");
QCOMPARE(noArgumentsOperation.errorString(), compareString);
// same for undo
QCOMPARE(noArgumentsOperation.undoOperation(), false);
SettingsOperation wrongMethodArgumentOperation(0);
wrongMethodArgumentOperation.setArguments(QStringList() << "path=first" << "method=second"
<< "key=third" << "value=fourth");
QVERIFY(wrongMethodArgumentOperation.testOperation());
// operation should do nothing if there are no arguments
QCOMPARE(wrongMethodArgumentOperation.performOperation(), false);
QCOMPARE(UpdateOperation::Error(wrongMethodArgumentOperation.error()),
UpdateOperation::InvalidArguments);
compareString = "Current method argument calling \"Settings\" with arguments \"path=first; "
"method=second; key=third; value=fourth\" is not supported. Please use set, remove, "
"add_array_value or remove_array_value.";
QCOMPARE(wrongMethodArgumentOperation.errorString(), compareString);
// same for undo
QCOMPARE(wrongMethodArgumentOperation.undoOperation(), false);
}
void setSettingsValue()
{
const QString verifyFilePath = createFilePath(QTest::currentTestFunction());
const QString testFilePath = createFilePath(QString("_") + QTest::currentTestFunction());
m_cleanupFilePaths << verifyFilePath << testFilePath;
const QString key = "category/key";
const QString value = "value";
{
QSettings testSettings(verifyFilePath, QSettings::IniFormat);
testSettings.setValue(key, value);
}
SettingsOperation settingsOperation(0);
settingsOperation.setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=set" << QString("key=%1").arg(key) << QString("value=%1").arg(value));
settingsOperation.backup();
QVERIFY2(settingsOperation.performOperation(), settingsOperation.errorString().toLatin1());
QVERIFY2(compareFiles(verifyFilePath, testFilePath), QString("\"%1\" and \"%2\" are different.")
.arg(verifyFilePath, testFilePath).toLatin1());
}
void undoSettingsValueInCreatedSubDirectories()
{
const QString testFilePath = createFilePath(QString("sub/directory/") +
QTest::currentTestFunction());
const QString key = "key";
const QString value = "value";
SettingsOperation settingsOperation(0);
settingsOperation.setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=set" << QString("key=%1").arg(key) << QString("value=%1").arg(value));
settingsOperation.backup();
QVERIFY2(settingsOperation.performOperation(), settingsOperation.errorString().toLatin1());
QCOMPARE(QFile(testFilePath).exists(), true);
QVERIFY2(settingsOperation.undoOperation(), settingsOperation.errorString().toLatin1());
QCOMPARE(QFile(testFilePath).exists(), false);
QCOMPARE(QDir(QFileInfo(testFilePath).absolutePath()).exists(), false);
}
void removeSettingsValue()
{
const QString testFilePath = createFilePath(QTest::currentTestFunction());
QFile testFile(QDir(m_testSettingsDirPath).filePath(m_testSettingsFilename));
QVERIFY2(testFile.copy(testFilePath), testFile.errorString().toLatin1());
m_cleanupFilePaths << testFilePath;
const QString key = "testkey";
QString testValueString;
{
QSettings testSettings(testFilePath, QSettings::IniFormat);
testValueString = testSettings.value(key).toString();
}
QCOMPARE(testValueString.isEmpty(), false);
SettingsOperation settingsOperation(0);
settingsOperation.setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=remove" << QString("key=%1").arg(key));
settingsOperation.backup();
QVERIFY2(settingsOperation.performOperation(), settingsOperation.errorString().toLatin1());
QVariant testValueVariant;
{
QSettings testSettings(testFilePath, QSettings::IniFormat);
testValueVariant = testSettings.value(key);
}
QVERIFY(testValueVariant.isNull());
}
void addSettingsArrayValue()
{
const QString testFilePath = createFilePath(QTest::currentTestFunction());
QFile contentFile(QDir(m_testSettingsDirPath).filePath(m_testSettingsFilename));
QVERIFY2(contentFile.open(QIODevice::ReadOnly | QIODevice::Text), contentFile.errorString().toLatin1());
QFile testFile(testFilePath);
QVERIFY2(testFile.open(QIODevice::WriteOnly | QIODevice::Text), contentFile.errorString().toLatin1());
QTextStream out(&testFile);
QTextStream in(&contentFile);
QString line = in.readLine();
while (!line.isNull()) {
// remove the " to have some maybe invalid data
out << line.replace("\"", QLatin1String("")) << QLatin1String("\n");
line = in.readLine();
}
testFile.close();
QMap<QString, SettingsOperation*> testSettingsOperationMap;
testSettingsOperationMap["testcategory/categoryarrayvalue1"] = new SettingsOperation(0);
testSettingsOperationMap["testcategory/categoryarrayvalue2"] = new SettingsOperation(0);
testSettingsOperationMap["testcategory/categoryarrayvalue3"] = new SettingsOperation(0);
testSettingsOperationMap["testcategory/categoryarrayvalue4"] = new SettingsOperation(0);
QMap<QString, SettingsOperation*>::iterator i = testSettingsOperationMap.begin();
while (i != testSettingsOperationMap.end()) {
i.value()->setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=add_array_value" << QString("key=%1").arg(i.key()) << "value=value4");
i.value()->backup();
QVERIFY2(i.value()->performOperation(), i.value()->errorString().toLatin1());
++i;
}
QStringList testKeys(testSettingsOperationMap.keys());
{
QSettings verifySettings(testFilePath, QSettings::IniFormat);
QCOMPARE(verifySettings.value(testKeys.at(0)).isNull(), false);
QCOMPARE(verifySettings.value(testKeys.at(0)), verifySettings.value(testKeys.at(1)));
QCOMPARE(verifySettings.value(testKeys.at(1)), verifySettings.value(testKeys.at(2)));
QCOMPARE(verifySettings.value(testKeys.at(3)).toString(), QLatin1String("value4"));
}
i = testSettingsOperationMap.begin();
while (i != testSettingsOperationMap.end()) {
i.value()->setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=add_array_value" << QString("key=%1").arg(i.key()) << "value=value4");
QVERIFY2(i.value()->undoOperation(), i.value()->errorString().toLatin1());
++i;
}
{
QStringList verifyStringList;
verifyStringList << "value1" << "value2" << "value3";
QVariant verifyUndoValue = verifyStringList;
QSettings verifySettings(testFilePath, QSettings::IniFormat);
QCOMPARE(verifySettings.value(testKeys.at(0)), verifyUndoValue);
QCOMPARE(verifySettings.value(testKeys.at(1)), verifyUndoValue);
QCOMPARE(verifySettings.value(testKeys.at(2)), verifyUndoValue);
// checking the none array value is removed
QVERIFY(verifySettings.value(testKeys.at(3)).isNull());
}
}
void removeSettingsArrayValue()
{
const QString testFilePath = createFilePath(QTest::currentTestFunction());
QFile contentFile(QDir(m_testSettingsDirPath).filePath(m_testSettingsFilename));
QVERIFY2(contentFile.open(QIODevice::ReadOnly | QIODevice::Text), contentFile.errorString()
.toLatin1());
QFile testFile(testFilePath);
QVERIFY2(testFile.open(QIODevice::WriteOnly | QIODevice::Text), contentFile.errorString()
.toLatin1());
QTextStream out(&testFile);
QTextStream in(&contentFile);
QString line = in.readLine();
while (!line.isNull()) {
// remove the " to have some maybe invalid data
out << line.replace("\"", QLatin1String("")) << QLatin1String("\n");
line = in.readLine();
}
testFile.close();
QMap<QString, SettingsOperation*> testSettingsOperationMap;
testSettingsOperationMap["testcategory/categoryarrayvalue1"] = new SettingsOperation(0);
testSettingsOperationMap["testcategory/categoryarrayvalue2"] = new SettingsOperation(0);
testSettingsOperationMap["testcategory/categoryarrayvalue3"] = new SettingsOperation(0);
QMap<QString, SettingsOperation*>::iterator i = testSettingsOperationMap.begin();
while (i != testSettingsOperationMap.end()) {
i.value()->setArguments(QStringList() << QString("path=%1").arg(testFilePath) <<
"method=remove_array_value" << QString("key=%1").arg(i.key()) << "value=value3");
i.value()->backup();
QVERIFY2(i.value()->performOperation(), i.value()->errorString().toLatin1());
++i;
}
QStringList testKeys(testSettingsOperationMap.keys());
{
QSettings verifySettings(testFilePath, QSettings::IniFormat);
QCOMPARE(verifySettings.value(testKeys.at(0)).isNull(), false);
QStringList verifyFirstValue = verifySettings.value(testKeys.at(0)).toStringList();
QCOMPARE(verifyFirstValue.contains(QLatin1String("value3")), false);
QCOMPARE(verifySettings.value(testKeys.at(0)), verifySettings.value(testKeys.at(1)));
QCOMPARE(verifySettings.value(testKeys.at(1)), verifySettings.value(testKeys.at(2)));
}
}
// called after all tests
void cleanupTestCase()
{
foreach (const QString &filePath, m_cleanupFilePaths)
QFile(filePath).remove();
}
private:
QString createFilePath(const QString &fileNamePrependix)
{
return QDir(m_testSettingsDirPath).filePath(QString(fileNamePrependix) + m_testSettingsFilename);
}
bool compareFiles(const QString &filePath1, const QString &filePath2)
{
if (!QFile::exists(filePath1) || !QFile::exists(filePath2))
return false;
const QByteArray fileHash1 = QInstaller::calculateHash(filePath1, QCryptographicHash::Sha1);
const QByteArray fileHash2 = QInstaller::calculateHash(filePath2, QCryptographicHash::Sha1);
return fileHash1 == fileHash2;
}
QString m_testSettingsFilename;
QString m_testSettingsDirPath;
QStringList m_cleanupFilePaths;
};
QTEST_MAIN(tst_settingsoperation)
#include "tst_settingsoperation.moc"
|
