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
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "config.h"
#include <QtCore/qdir.h>
#include <QtCore/qfileinfo.h>
#include <QtCore/qhash.h>
#include <QtCore/qstringlist.h>
#include <QtTest/QtTest>
QT_BEGIN_NAMESPACE
Q_LOGGING_CATEGORY(lcQdoc, "qt.test")
QT_END_NAMESPACE
class tst_Config : public QObject
{
Q_OBJECT
private slots:
void classMembersInitializeToFalseOrEmpty();
void includePathsFromCommandLine();
void variables();
void paths();
void getExampleProjectFile();
void expandVars();
private:
Config &initConfig(const QStringList &args = QStringList(),
const char *qdocconf = nullptr);
Config &initConfig(const char *qdocconf)
{
return initConfig(QStringList(), qdocconf);
}
};
/*
Initializes the Config with optional arguments and a .qdocconf file
to load, and returns a reference to it.
*/
Config &tst_Config::initConfig(const QStringList &args, const char *qdocconf)
{
QStringList fullArgs = { QStringLiteral("./qdoc") };
fullArgs << args;
Config::instance().init("QDoc Test", fullArgs);
if (qdocconf) {
const auto configFile = QFINDTESTDATA(qdocconf);
if (!configFile.isEmpty())
Config::instance().load(configFile);
}
return Config::instance();
}
void tst_Config::classMembersInitializeToFalseOrEmpty()
{
auto &config = initConfig();
QCOMPARE(config.showInternal(), false);
QCOMPARE(config.singleExec(), false);
QVERIFY(config.defines().isEmpty());
QVERIFY(config.includePaths().isEmpty());
QVERIFY(config.dependModules().isEmpty());
QVERIFY(config.indexDirs().isEmpty());
QVERIFY(config.currentDir().isEmpty());
QVERIFY(config.previousCurrentDir().isEmpty());
}
void tst_Config::includePathsFromCommandLine()
{
const auto mockIncludePath1 = QString("-I" + QDir().absoluteFilePath("/qt5/qtdoc/doc/."));
const auto mockIncludePath2 = QString("-I" + QDir().absoluteFilePath("/qt5/qtbase/mkspecs/linux-g++"));
const QStringList commandLineArgs = { mockIncludePath1, mockIncludePath2 };
auto &config = initConfig(commandLineArgs);
const QStringList expected = { mockIncludePath1, mockIncludePath2 };
const QStringList actual = config.includePaths();
QCOMPARE(actual, expected);
}
// Tests different types of variables; string, string list, bool, int,
// empty and undefined variables, and subvariables.
void tst_Config::variables()
{
auto &config = initConfig("/testdata/configs/vars.qdocconf");
const QStringList list = { "testing", "line", "by\n", "line" };
QCOMPARE(config.getStringList("list"), list);
QCOMPARE(config.getString("list"), "testing line by\nline");
QCOMPARE(config.getBool("true"), true);
QCOMPARE(config.getBool("untrue"), false);
QCOMPARE(config.getInt("int"), 2);
QCOMPARE(config.getString("void"), QString());
QCOMPARE(config.getString("void", "undefined"), QString());
QCOMPARE(config.getString("undefined", "undefined"), "undefined");
QVERIFY(config.getString("undefined").isNull());
QSet<QString> subVars = { "thing", "where", "time" };
QCOMPARE(config.subVars("some"), subVars);
}
// Tests whether paths or variables are resolved correctly.
void tst_Config::paths()
{
auto &config = initConfig();
const auto docConfig = QFINDTESTDATA("/testdata/configs/paths.qdocconf");
if (!docConfig.isEmpty())
config.load(docConfig);
auto rootDir = QFileInfo(docConfig).dir();
QVERIFY(rootDir.cdUp());
const auto paths = config.getCanonicalPathList("sourcedirs");
QVERIFY(paths.size() == 3);
QCOMPARE(paths[0], rootDir.absoluteFilePath("paths/includes"));
QCOMPARE(paths[1], rootDir.absoluteFilePath("configs"));
QCOMPARE(paths[2], rootDir.absoluteFilePath("configs/includes"));
}
void::tst_Config::getExampleProjectFile()
{
auto &config = initConfig();
const auto docConfig = QFINDTESTDATA("/testdata/configs/exampletest.qdocconf");
if (!docConfig.isEmpty())
config.load(docConfig);
auto rootDir = QFileInfo(docConfig).dir();
QVERIFY(rootDir.cd("../exampletest/examples/test"));
QVERIFY(config.getExampleProjectFile("invalid").isEmpty());
QVERIFY(config.getExampleProjectFile("test/empty").isEmpty());
QCOMPARE(config.getExampleProjectFile("test/example1"),
rootDir.absoluteFilePath("example1/example1.pro"));
QCOMPARE(config.getExampleProjectFile("test/example2"),
rootDir.absoluteFilePath("example2/example2.qmlproject"));
QCOMPARE(config.getExampleProjectFile("test/example3"),
rootDir.absoluteFilePath("example3/example3.pyproject"));
QCOMPARE(config.getExampleProjectFile("test/example4"),
rootDir.absoluteFilePath("example4/CMakeLists.txt"));
}
void::tst_Config::expandVars()
{
qputenv("QDOC_TSTCONFIG_LIST", QByteArray("a b c"));
auto &config = initConfig("/testdata/configs/expandvars.qdocconf");
QCOMPARE(config.getString("expanded1"), "foo");
QCOMPARE(config.getString("expanded2"), "foo,bar");
QCOMPARE(config.getString("expanded3"), "foobar foobar baz");
QCOMPARE(config.getString("literally"), "$data ${data}");
QCOMPARE(config.getString("csvlist"), "a,b,c");
}
QTEST_APPLESS_MAIN(tst_Config)
#include "tst_config.moc"
|
