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
|
/*
* SPDX-FileCopyrightText: 2012 Peter Penz <[email protected]>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "views/viewproperties.h"
#include "dolphin_generalsettings.h"
#include "testdir.h"
#include <KFileMetaData/UserMetaData>
#include <QStorageInfo>
#include <QTest>
class ViewPropertiesTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void cleanup();
void testReadOnlyBehavior();
void testReadOnlyDirectory();
void testAutoSave();
void testParamMigrationToFileAttr();
void testParamMigrationToFileAttrKeepDirectory();
void testExtendedAttributeFull();
private:
bool m_globalViewProps;
TestDir *m_testDir;
};
void ViewPropertiesTest::initTestCase()
{
QStandardPaths::setTestModeEnabled(true);
}
void ViewPropertiesTest::init()
{
m_globalViewProps = GeneralSettings::self()->globalViewProps();
GeneralSettings::self()->setGlobalViewProps(false);
GeneralSettings::self()->save();
// It is mandatory to create the test-directory inside the home-directory
// of the user: ViewProperties does not write inside directories
// outside the home-directory to prevent overwriting other user-settings
// in case if write-permissions are given.
m_testDir = new TestDir(QDir::homePath() + "/.viewPropertiesTest-");
}
void ViewPropertiesTest::cleanup()
{
delete m_testDir;
m_testDir = nullptr;
GeneralSettings::self()->setGlobalViewProps(m_globalViewProps);
GeneralSettings::self()->save();
}
/**
* Test whether only reading properties won't result in creating
* a .directory file when destructing the ViewProperties instance
* and autosaving is enabled.
*/
void ViewPropertiesTest::testReadOnlyBehavior()
{
QString dotDirectoryFile = m_testDir->url().toLocalFile() + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFile));
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QVERIFY(props->isAutoSaveEnabled());
const QByteArray sortRole = props->sortRole();
Q_UNUSED(sortRole)
props.reset();
QVERIFY(!QFile::exists(dotDirectoryFile));
}
void ViewPropertiesTest::testReadOnlyDirectory()
{
auto localFolder = m_testDir->url().toLocalFile();
QString dotDirectoryFile = localFolder + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFile));
// restrict write permissions
QVERIFY(QFile(localFolder).setPermissions(QFileDevice::ReadOwner));
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QVERIFY(props->isAutoSaveEnabled());
props->setSortRole("someNewSortRole");
props.reset();
const auto destinationDir = props->destinationDir(QStringLiteral("local")) + localFolder;
qDebug() << destinationDir;
QVERIFY(QDir(destinationDir).exists());
QVERIFY(!QFile::exists(dotDirectoryFile));
KFileMetaData::UserMetaData metadata(localFolder);
auto viewProperties = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1"));
QVERIFY(viewProperties.isEmpty());
props.reset(new ViewProperties(m_testDir->url()));
QVERIFY(props->isAutoSaveEnabled());
QCOMPARE(props->sortRole(), "someNewSortRole");
props.reset();
metadata = KFileMetaData::UserMetaData(destinationDir);
if (metadata.isSupported()) {
QVERIFY(metadata.hasAttribute("kde.fm.viewproperties#1"));
} else {
QVERIFY(QFile::exists(destinationDir + "/.directory"));
}
// un-restrict write permissions
QFile(localFolder).setPermissions(QFileDevice::ReadOwner | QFileDevice::WriteOwner);
}
void ViewPropertiesTest::testAutoSave()
{
QString dotDirectoryFile = m_testDir->url().toLocalFile() + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFile));
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QVERIFY(props->isAutoSaveEnabled());
props->setSortRole("someNewSortRole");
props.reset();
KFileMetaData::UserMetaData metadata(m_testDir->url().toLocalFile());
if (metadata.isSupported()) {
auto viewProperties = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1"));
QVERIFY(!viewProperties.isEmpty());
QVERIFY(!QFile::exists(dotDirectoryFile));
} else {
QVERIFY(QFile::exists(dotDirectoryFile));
}
}
void ViewPropertiesTest::testParamMigrationToFileAttr()
{
QString dotDirectoryFilePath = m_testDir->url().toLocalFile() + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFilePath));
const char *settingsContent = R"SETTINGS("
[Dolphin]
Version=4
ViewMode=1
Timestamp=2023,12,29,10,44,15.793
VisibleRoles=text,CustomizedDetails,Details_text,Details_modificationtime,Details_type
[Settings]
HiddenFilesShown=true)SETTINGS";
auto dotDirectoryFile = QFile(dotDirectoryFilePath);
QVERIFY(dotDirectoryFile.open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate));
QTextStream out(&dotDirectoryFile);
out << settingsContent;
dotDirectoryFile.close();
KFileMetaData::UserMetaData metadata(m_testDir->url().toLocalFile());
{
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QCOMPARE(props->viewMode(), DolphinView::Mode::DetailsView);
QVERIFY(props->hiddenFilesShown());
props->save();
if (metadata.isSupported()) {
auto viewProperties = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1"));
QVERIFY(!viewProperties.isEmpty());
QVERIFY(!QFile::exists(dotDirectoryFilePath));
} else {
QVERIFY(QFile::exists(dotDirectoryFilePath));
}
}
ViewProperties props(m_testDir->url());
QCOMPARE(props.viewMode(), DolphinView::Mode::DetailsView);
QVERIFY(props.hiddenFilesShown());
}
void ViewPropertiesTest::testParamMigrationToFileAttrKeepDirectory()
{
QString dotDirectoryFilePath = m_testDir->url().toLocalFile() + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFilePath));
const char *settingsContent = R"SETTINGS("
[Dolphin]
Version=4
ViewMode=1
Timestamp=2023,12,29,10,44,15.793
VisibleRoles=text,CustomizedDetails,Details_text,Details_modificationtime,Details_type
[Settings]
HiddenFilesShown=true
[Other]
ThoseShouldBeKept=true
)SETTINGS";
auto dotDirectoryFile = QFile(dotDirectoryFilePath);
QVERIFY(dotDirectoryFile.open(QIODevice::WriteOnly | QIODevice::Text | QIODevice::Truncate));
QTextStream out(&dotDirectoryFile);
out << settingsContent;
dotDirectoryFile.close();
KFileMetaData::UserMetaData metadata(m_testDir->url().toLocalFile());
{
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QCOMPARE(props->viewMode(), DolphinView::Mode::DetailsView);
QVERIFY(props->hiddenFilesShown());
props->save();
if (metadata.isSupported()) {
auto viewProperties = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1"));
QVERIFY(!viewProperties.isEmpty());
}
QVERIFY(QFile::exists(dotDirectoryFilePath));
KConfig directorySettings(dotDirectoryFilePath, KConfig::SimpleConfig);
QCOMPARE(directorySettings.groupList(), {"Other"});
}
ViewProperties props(m_testDir->url());
QVERIFY(props.hiddenFilesShown());
QCOMPARE(props.viewMode(), DolphinView::Mode::DetailsView);
QVERIFY(QFile::exists(dotDirectoryFilePath));
}
void ViewPropertiesTest::testExtendedAttributeFull()
{
#ifndef Q_OS_UNIX
QSKIP("Only unix is supported, for this test");
#endif
QString dotDirectoryFile = m_testDir->url().toLocalFile() + "/.directory";
QVERIFY(!QFile::exists(dotDirectoryFile));
KFileMetaData::UserMetaData metadata(m_testDir->url().toLocalFile());
if (!metadata.isSupported()) {
QSKIP("need extended attribute/filesystem metadata to be usefull");
}
QStorageInfo storageInfo(m_testDir->url().toLocalFile());
auto blockSize = storageInfo.blockSize();
KFileMetaData::UserMetaData::Error result;
// write a close to block size theorical maximum size for attributes in Linux for ext4
// and btrfs (4Kib typically) when ReiserFS/XFS allow XATTR_SIZE_MAX (64Kib)
result = metadata.setAttribute("data", QString(blockSize - 50, 'a'));
if (result != KFileMetaData::UserMetaData::NoSpace) {
QSKIP("File system supports metadata bigger than file system block size");
}
// write a close to 4k attribute, maximum size in Linux for ext4
// so next writing the file metadata fails
result = metadata.setAttribute("data", QString(blockSize - 60, 'a'));
QCOMPARE(result, KFileMetaData::UserMetaData::NoError);
QScopedPointer<ViewProperties> props(new ViewProperties(m_testDir->url()));
QVERIFY(props->isAutoSaveEnabled());
props->setSortRole("someNewSortRole");
props.reset();
if (metadata.isSupported()) {
auto viewProperties = metadata.attribute(QStringLiteral("kde.fm.viewproperties#1"));
QVERIFY(viewProperties.isEmpty());
QVERIFY(QFile::exists(dotDirectoryFile));
QFile dotDirectory(dotDirectoryFile);
KConfig viewSettings(dotDirectoryFile, KConfig::SimpleConfig);
QCOMPARE(viewSettings.groupList(), {"Dolphin"});
QCOMPARE(viewSettings.group("Dolphin").readEntry("SortRole"), "someNewSortRole");
} else {
QVERIFY(QFile::exists(dotDirectoryFile));
}
}
QTEST_GUILESS_MAIN(ViewPropertiesTest)
#include "viewpropertiestest.moc"
|
