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
|
/****************************************************************************
**
** Copyright (C) 2019 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 <QProcess>
#include <QTemporaryDir>
#include <QtTest>
class tst_generatedOutput : public QObject
{
Q_OBJECT
private slots:
void initTestCase();
void init();
void htmlFromQDocFile();
void htmlFromQml();
private:
QScopedPointer<QTemporaryDir> m_outputDir;
QString m_qdoc;
void runQDocProcess(const QStringList &arguments);
void compareLineByLine(const QStringList &expectedFiles);
void testAndCompare(const char *input,
const char *outNames,
const char *extraParams = nullptr);
};
void tst_generatedOutput::initTestCase()
{
// Build the path to the QDoc binary the same way moc tests do for moc.
const auto binpath = QLibraryInfo::location(QLibraryInfo::BinariesPath);
const auto extension = QSysInfo::productType() == "windows" ? ".exe" : "";
m_qdoc = binpath + QLatin1String("/qdoc") + extension;
}
void tst_generatedOutput::init()
{
m_outputDir.reset(new QTemporaryDir());
if (!m_outputDir->isValid()) {
const QString errorMessage =
"Couldn't create temporary directory: " + m_outputDir->errorString();
QFAIL(qPrintable(errorMessage));
}
}
void tst_generatedOutput::runQDocProcess(const QStringList &arguments)
{
QProcess qdocProcess;
qdocProcess.setProgram(m_qdoc);
qdocProcess.setArguments(arguments);
qdocProcess.start();
qdocProcess.waitForFinished();
if (qdocProcess.exitCode() == 0)
return;
QString output = qdocProcess.readAllStandardOutput();
QString errors = qdocProcess.readAllStandardError();
qInfo() << "QDoc exited with exit code" << qdocProcess.exitCode();
if (output.size() > 0)
qInfo() << "Received output:\n" << output;
if (errors.size() > 0)
qInfo() << "Received errors:\n" << errors;
QFAIL("Running QDoc failed. See output above.");
}
void tst_generatedOutput::compareLineByLine(const QStringList &expectedFiles)
{
for (const auto &file : expectedFiles) {
QString expected(QFINDTESTDATA("/expected_output/" + file));
QString actual(m_outputDir->path() + "/" + file);
QFile expectedFile(expected);
if (!expectedFile.open(QIODevice::ReadOnly))
QFAIL("Cannot open expected data file!");
QTextStream expectedIn(&expectedFile);
QFile actualFile(actual);
if (!actualFile.open(QIODevice::ReadOnly))
QFAIL("Cannot open actual data file!");
QTextStream actualIn(&actualFile);
int lineNumber = 0;
while (!expectedIn.atEnd() && !actualIn.atEnd()) {
lineNumber++;
QString prefix = QString::number(lineNumber) + QLatin1String(": ");
QString expectedLine = prefix + expectedIn.readLine();
QString actualLine = prefix + actualIn.readLine();
QCOMPARE(actualLine, expectedLine);
}
}
}
void tst_generatedOutput::testAndCompare(const char *input,
const char *outNames,
const char *extraParams)
{
QStringList args{ "-outputdir", m_outputDir->path(), QFINDTESTDATA(input) };
if (extraParams)
args << QString(QLatin1String(extraParams)).split(QChar(' '));
runQDocProcess(args);
if (QTest::currentTestFailed())
return;
compareLineByLine(QString(QLatin1String(outNames)).split(QChar(' ')));
}
void tst_generatedOutput::htmlFromQDocFile()
{
testAndCompare("test.qdocconf",
"qdoctests-qdocfileoutput.html");
}
void tst_generatedOutput::htmlFromQml()
{
testAndCompare("testqml.qdocconf",
"test-componentset-example.html "
"uicomponents-qmlmodule.html");
}
QTEST_APPLESS_MAIN(tst_generatedOutput)
#include "tst_generatedoutput.moc"
|
