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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef PatternistSDK_TestResult_H
#define PatternistSDK_TestResult_H
#include <QList>
#include <QObject>
#include <QPointer>
#include <QString>
#include <QtXmlPatterns/private/qitem_p.h>
#include "ErrorHandler.h"
#include "ASTItem.h"
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
namespace QPatternistSDK
{
class ASTItem;
class XMLWriter;
/**
* @short represents the result produced by running a test case.
*
* This information TestResult houses is:
*
* - The result status() of the run. Whether the test case succeeded or not, for example.
* - The astTree() which reflects the compiled test case
* - The messages issued when compiling and running the test case, retrievable via messages()
* - The data -- XPath Data Model items() -- the test case evaluated to, if any.
*
* @ingroup PatternistSDK
* @author Frans Englich <frans.englich@nokia.com>
*/
class Q_PATTERNISTSDK_EXPORT TestResult : public QObject
{
Q_OBJECT
public:
enum Status
{
/**
* Used when the status is unknown.
*/
Unknown = 0,
/**
* The test case passed.
*/
Pass,
/**
* The test case failed.
*/
Fail,
/**
* The test was not run. Similar to "SKIP".
*/
NotTested
};
/**
* A list of TestResult instances.
*/
typedef QList<QPointer<TestResult> > List;
/**
* Constructs a TestResult.
*
* @param testName the name of the test. For example, @c Literal-001.
* @param astTree may be @c null, signalling no AST being available, or point to one.
* @param status the result status of running the test-case. Whether the test-case
* passed or failed, and so forth.
* @param errors the errors and warnings that were reported while running the test-case
* @param items the XDM items that were outputted, if any
* @param serialized the output when serialized
*/
TestResult(const QString &testName,
const Status status,
ASTItem *astTree,
const ErrorHandler::Message::List &errors,
const QPatternist::Item::List &items,
const QString &serialized);
virtual ~TestResult();
Status status() const;
QString comment() const;
void setComment(const QString &comment);
QPatternist::Item::List items() const;
ErrorHandler::Message::List messages() const;
/**
* Serializes itself to @p receiver, into a test-case element,
* as per @c XQTSResult.xsd.
*/
void toXML(XMLWriter &receiver) const;
ASTItem *astTree() const;
/**
* @returns a string representation for @p status, as per the anonymous
* type inside the type test-case, in @c XQTSResult.xsd. For example, if @p status
* is NotTested, is "not tested" returned.
*/
static QString displayName(const TestResult::Status status);
static Status statusFromString(const QString &string);
/**
* @returns the output of this test result(if any) as when
* being serialized.
*/
QString asSerialized() const;
private:
const Status m_status;
QString m_comment;
const ErrorHandler::Message::List m_messages;
QPointer<ASTItem> m_astTree;
QString m_testName;
const QPatternist::Item::List m_items;
const QString m_asSerialized;
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
// vim: et:ts=4:sw=4:sts=4
|
