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
|
// Copyright (C) 2019 Jochen Seemann
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "catchoutputreader.h"
#include "catchresult.h"
#include "../autotesttr.h"
#include "../testtreeitem.h"
#include <utils/fileutils.h>
#include <utils/qtcassert.h>
namespace Autotest {
namespace Internal {
namespace CatchXml {
const char GroupElement[] = "Group";
const char TestCaseElement[] = "TestCase";
const char SectionElement[] = "Section";
const char ExpressionElement[] = "Expression";
const char ExpandedElement[] = "Expanded";
const char BenchmarkResults[] = "BenchmarkResults";
const char MeanElement[] = "mean";
const char StandardDevElement[] = "standardDeviation";
const char SectionResultElement[] = "OverallResults";
const char TestCaseResultElement[] = "OverallResult";
}
CatchOutputReader::CatchOutputReader(const QFutureInterface<TestResultPtr> &futureInterface,
Utils::QtcProcess *testApplication,
const Utils::FilePath &buildDirectory,
const Utils::FilePath &projectFile)
: TestOutputReader (futureInterface, testApplication, buildDirectory)
, m_projectFile(projectFile)
{
}
void CatchOutputReader::processOutputLine(const QByteArray &outputLineWithNewLine)
{
if (outputLineWithNewLine.trimmed().isEmpty())
return;
m_xmlReader.addData(QString::fromUtf8(outputLineWithNewLine));
while (!m_xmlReader.atEnd()) {
QXmlStreamReader::TokenType token = m_xmlReader.readNext();
switch (token) {
case QXmlStreamReader::StartDocument:
break;
case QXmlStreamReader::EndDocument:
m_xmlReader.clear();
break;
case QXmlStreamReader::StartElement: {
m_currentTagName = m_xmlReader.name().toString();
if (m_currentTagName == CatchXml::GroupElement) {
testOutputNodeStarted(GroupNode);
} else if (m_currentTagName == CatchXml::TestCaseElement) {
m_reportedResult = false;
testOutputNodeStarted(TestCaseNode);
recordTestInformation(m_xmlReader.attributes());
sendResult(ResultType::TestStart);
} else if (m_currentTagName == CatchXml::SectionElement) {
testOutputNodeStarted(SectionNode);
recordTestInformation(m_xmlReader.attributes());
sendResult(ResultType::TestStart);
} else if (m_currentTagName == CatchXml::TestCaseResultElement) {
if (m_currentTestNode == OverallNode || m_currentTestNode == GroupNode)
continue;
if (m_reportedResult)
continue;
if (m_xmlReader.attributes().value("success").toString() == QStringLiteral("true"))
sendResult(ResultType::Pass);
else if (m_shouldFail)
sendResult(ResultType::UnexpectedPass);
} else if (m_currentTagName == CatchXml::SectionResultElement) {
const QXmlStreamAttributes attributes = m_xmlReader.attributes();
if (m_currentTestNode == OverallNode) { // the final results for the executable
int passes = attributes.value("successes").toInt();
int fails = attributes.value("failures").toInt();
int xfails = attributes.value("expectedFailures").toInt();
m_summary[ResultType::Pass] = passes - m_xpassCount;
m_summary[ResultType::Fail] = fails;
if (xfails)
m_summary[ResultType::ExpectedFail] = xfails;
if (m_xpassCount)
m_summary[ResultType::UnexpectedPass] = m_xpassCount;
}
if (m_currentTestNode == OverallNode || m_currentTestNode == GroupNode)
continue;
if (attributes.value("failures").toInt() == 0)
if (!m_reportedSectionResult)
sendResult(ResultType::Pass);
} else if (m_currentTagName == CatchXml::ExpressionElement) {
recordTestInformation(m_xmlReader.attributes());
if (m_xmlReader.attributes().value("success").toString() == QStringLiteral("true"))
m_currentResult = m_shouldFail ? ResultType::UnexpectedPass : ResultType::Pass;
else
m_currentResult = m_mayFail || m_shouldFail ? ResultType::ExpectedFail : ResultType::Fail;
} else if (m_currentTagName == CatchXml::BenchmarkResults) {
recordBenchmarkInformation(m_xmlReader.attributes());
m_currentResult = ResultType::Benchmark;
} else if (m_currentTagName == CatchXml::MeanElement) {
recordBenchmarkDetails(m_xmlReader.attributes(), {{{"mean"}, {"value"}},
{{"low mean"}, {"lowerBound"}},
{{"high mean"}, {"upperBound"}}});
} else if (m_currentTagName == CatchXml::StandardDevElement) {
recordBenchmarkDetails(m_xmlReader.attributes(), {
{{"standard deviation"}, {"value"}},
{{"low std dev"}, {"lowerBound"}},
{{"high std dev"}, {"upperBound"}}});
}
break;
}
case QXmlStreamReader::Characters: {
const auto text = m_xmlReader.text();
if (m_currentTagName == CatchXml::ExpandedElement) {
m_currentExpression.append(text);
}
break;
}
case QXmlStreamReader::EndElement: {
const auto currentTag = m_xmlReader.name();
if (currentTag == QLatin1String(CatchXml::SectionElement)) {
sendResult(ResultType::TestEnd);
testOutputNodeFinished(SectionNode);
} else if (currentTag == QLatin1String(CatchXml::TestCaseElement)) {
sendResult(ResultType::TestEnd);
testOutputNodeFinished(TestCaseNode);
} else if (currentTag == QLatin1String(CatchXml::GroupElement)) {
testOutputNodeFinished(GroupNode);
} else if (currentTag == QLatin1String(CatchXml::ExpressionElement)
|| currentTag == QLatin1String(CatchXml::BenchmarkResults)) {
sendResult(m_currentResult);
m_currentExpression.clear();
m_testCaseInfo.pop();
}
break;
}
default:
// ignore
break;
}
}
}
TestResultPtr CatchOutputReader::createDefaultResult() const
{
CatchResult *result = nullptr;
if (m_testCaseInfo.size() > 0) {
result = new CatchResult(id(), m_testCaseInfo.first().name);
result->setDescription(m_testCaseInfo.last().name);
result->setLine(m_testCaseInfo.last().line);
const QString givenPath = m_testCaseInfo.last().filename;
if (!givenPath.isEmpty()) {
result->setFileName(constructSourceFilePath(m_buildDir, givenPath));
}
} else {
result = new CatchResult(id(), QString());
}
result->setSectionDepth(m_sectionDepth);
return TestResultPtr(result);
}
void CatchOutputReader::recordTestInformation(const QXmlStreamAttributes &attributes)
{
QString name;
if (attributes.hasAttribute("name")) // successful expressions do not have one
name = attributes.value("name").toString();
else if (!m_testCaseInfo.isEmpty())
name = m_testCaseInfo.top().name;
m_testCaseInfo.append(TestOutputNode{
name,
attributes.value("filename").toString(),
attributes.value("line").toInt()
});
if (attributes.hasAttribute("tags")) {
const QString tags = attributes.value("tags").toString();
m_mayFail = tags.contains("[!mayfail]");
m_shouldFail = tags.contains("[!shouldfail]");
}
}
void CatchOutputReader::recordBenchmarkInformation(const QXmlStreamAttributes &attributes)
{
QString name = attributes.value("name").toString();
QString fileName;
int line = 0;
if (!m_testCaseInfo.isEmpty()) {
fileName = m_testCaseInfo.top().filename;
line = m_testCaseInfo.top().line;
}
m_testCaseInfo.append(TestOutputNode{name, fileName, line});
m_currentExpression.append(name);
recordBenchmarkDetails(attributes, {{{"samples"}, {"samples"}},
{{"iterations"}, {"iterations"}},
{{"estimated duration"}, {"estimatedDuration"}}});
m_currentExpression.append(" ms"); // ugly
}
void CatchOutputReader::recordBenchmarkDetails(
const QXmlStreamAttributes &attributes,
const QList<QPair<QString, QString>> &stringAndAttrNames)
{
m_currentExpression.append('\n');
int counter = 0;
for (const QPair<QString, QString> &curr : stringAndAttrNames) {
m_currentExpression.append(curr.first).append(": ");
m_currentExpression.append(attributes.value(curr.second).toString());
if (counter < stringAndAttrNames.size() - 1)
m_currentExpression.append(", ");
++counter;
}
}
void CatchOutputReader::sendResult(const ResultType result)
{
TestResultPtr catchResult = createDefaultResult();
catchResult->setResult(result);
if (result == ResultType::TestStart && m_testCaseInfo.size() > 0) {
catchResult->setDescription(Tr::tr("Executing %1 \"%2\"").arg(testOutputNodeToString().toLower())
.arg(catchResult->description()));
} else if (result == ResultType::Pass || result == ResultType::UnexpectedPass) {
if (result == ResultType::UnexpectedPass)
++m_xpassCount;
if (m_currentExpression.isEmpty()) {
catchResult->setDescription(Tr::tr("%1 \"%2\" passed").arg(testOutputNodeToString())
.arg(catchResult->description()));
} else {
catchResult->setDescription(Tr::tr("Expression passed")
.append('\n').append(m_currentExpression));
}
m_reportedSectionResult = true;
m_reportedResult = true;
} else if (result == ResultType::Fail || result == ResultType::ExpectedFail) {
catchResult->setDescription(Tr::tr("Expression failed: %1").arg(m_currentExpression.trimmed()));
if (!m_reportedSectionResult)
m_reportedSectionResult = true;
m_reportedResult = true;
} else if (result == ResultType::TestEnd) {
catchResult->setDescription(Tr::tr("Finished executing %1 \"%2\"").arg(testOutputNodeToString().toLower())
.arg(catchResult->description()));
} else if (result == ResultType::Benchmark) {
catchResult->setDescription(m_currentExpression);
}
reportResult(catchResult);
}
void CatchOutputReader::testOutputNodeStarted(CatchOutputReader::TestOutputNodeType type)
{
m_currentTestNode = type;
if (type == SectionNode) {
++m_sectionDepth;
m_reportedSectionResult = false;
}
}
void CatchOutputReader::testOutputNodeFinished(CatchOutputReader::TestOutputNodeType type)
{
switch (type) {
case GroupNode:
m_currentTestNode = OverallNode;
return;
case TestCaseNode:
m_currentTestNode = GroupNode;
m_testCaseInfo.pop();
return;
case SectionNode:
--m_sectionDepth;
m_testCaseInfo.pop();
m_currentTestNode = m_sectionDepth == 0 ? TestCaseNode : SectionNode;
return;
default:
return;
}
}
QString CatchOutputReader::testOutputNodeToString() const
{
switch (m_currentTestNode) {
case OverallNode:
return QStringLiteral("Overall");
case GroupNode:
return QStringLiteral("Group");
case TestCaseNode:
return QStringLiteral("Test case");
case SectionNode:
return QStringLiteral("Section");
}
return QString();
}
} // namespace Internal
} // namespace Autotest
|
