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
|
/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2017-2019 by The qTox Project Contributors
* Copyright © 2024-2025 The TokTok team.
*/
#include "src/persistence/paths.h"
#include <QStandardPaths>
#include <QString>
#include <QtTest/QtTest>
#include <ctime>
class TestPaths : public QObject
{
Q_OBJECT
private slots:
void constructAuto();
void constructPortable();
void constructNonPortable();
#if PATHS_VERSION_TCS_COMPLIANT
void checkPathsNonPortable();
void checkPathsPortable();
#endif
private:
static void verifyqToxPath(const QString& testPath, const QString& basePath,
const QString& subPath);
};
namespace {
#if PATHS_VERSION_TCS_COMPLIANT
const QLatin1String globalSettingsFile{"qtox.ini"};
const QLatin1String profileFolder{"profiles"};
const QLatin1String themeFolder{"themes"};
const QLatin1String avatarsFolder{"avatars"};
const QLatin1String transfersFolder{"transfers"};
const QLatin1String screenshotsFolder{"screenshots"};
#endif // PATHS_VERSION_TCS_COMPLIANT
const QString sep{QDir::separator()};
} // namespace
/**
* @brief Verifies construction in auto mode
*/
void TestPaths::constructAuto()
{
Paths paths{Paths::Portable::Auto};
// auto detection should succeed
// the test environment should not provide a `qtox.ini`
QVERIFY(paths.isPortable() == false);
}
/**
* @brief Verifies construction in portable mode
*/
void TestPaths::constructPortable()
{
Paths paths{Paths::Portable::Portable};
// portable construction should succeed even though qtox.ini doesn't exist
QVERIFY(paths.isPortable() == true);
}
/**
* @brief Verifies construction in non-portable mode
*/
void TestPaths::constructNonPortable()
{
Paths paths{Paths::Portable::NonPortable};
// Non portable should succeed
// the test environment should not provide a `qtox.ini`
QVERIFY(paths.isPortable() == false);
}
/**
* @brief Helper to verify qTox specific paths
*/
void TestPaths::verifyqToxPath(const QString& testPath, const QString& basePath, const QString& subPath)
{
const QString expectPath = basePath % sep % subPath;
QVERIFY(testPath == expectPath);
}
#if PATHS_VERSION_TCS_COMPLIANT
/**
* @brief Check generated paths against expected values in non-portable mode
*/
void TestPaths::checkPathsNonPortable()
{
Paths* paths = Paths::makePaths(Paths::Portable::NonPortable);
QVERIFY(paths != nullptr);
// Need non-portable environment to match our test cases
QVERIFY(paths->isPortable() == false);
// TODO(sudden6): write robust tests for Tox paths given by Tox Client Standard
QString avatarDir{paths->getAvatarsDir()};
QString toxSaveDir{paths->getToxSaveDir()};
// avatars directory must be one level below toxsave to follow TCS
QVERIFY(avatarDir.contains(toxSaveDir));
const QString appData{QStandardPaths::writableLocation(QStandardPaths::AppDataLocation)};
const QString appConfig{QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)};
verifyqToxPath(paths->getProfilesDir(), appData, profileFolder % sep);
verifyqToxPath(paths->getGlobalSettingsPath(), appConfig, globalSettingsFile);
verifyqToxPath(paths->getScreenshotsDir(), appData, screenshotsFolder % sep);
verifyqToxPath(paths->getTransfersDir(), appData, transfersFolder % sep);
QStringList themeFolders{};
themeFolders += QStandardPaths::locate(QStandardPaths::AppDataLocation, themeFolder,
QStandardPaths::LocateDirectory);
// look for themes beside the qTox binary with lowest priority
const QString curPath{qApp->applicationDirPath()};
themeFolders += curPath % sep % themeFolder % sep;
QVERIFY(paths->getThemeDirs() == themeFolders);
}
/**
* @brief Check generated paths against expected values in portable mode
*/
void TestPaths::checkPathsPortable()
{
Paths* paths = Paths::makePaths(Paths::Portable::Portable);
QVERIFY(paths != nullptr);
// Need portable environment to match our test cases
QVERIFY(paths->isPortable() == true);
const QString basePath{qApp->applicationDirPath()};
const QString avatarDir{paths->getAvatarsDir()};
verifyqToxPath(avatarDir, basePath, profileFolder % sep % avatarsFolder % sep);
const QString toxSaveDir{paths->getToxSaveDir()};
verifyqToxPath(toxSaveDir, basePath, profileFolder % sep);
// avatars directory must be one level below toxsave to follow TCS
QVERIFY(avatarDir.contains(toxSaveDir));
verifyqToxPath(paths->getProfilesDir(), basePath, profileFolder % sep);
verifyqToxPath(paths->getGlobalSettingsPath(), basePath, globalSettingsFile);
verifyqToxPath(paths->getScreenshotsDir(), basePath, screenshotsFolder % sep);
verifyqToxPath(paths->getTransfersDir(), basePath, transfersFolder % sep);
// look for themes beside the qTox binary with lowest priority
const QString curPath{qApp->applicationDirPath()};
QStringList themeFolders{curPath % sep % themeFolder % sep};
QVERIFY(paths->getThemeDirs() == themeFolders);
}
#endif
QTEST_MAIN(TestPaths)
#include "paths_test.moc"
|
