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
|
/****************************************************************************
**
** Copyright (C) 2012 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_TestCase_H
#define PatternistSDK_TestCase_H
#include <QtXmlPatterns/QXmlQuery>
#include "qexternalvariableloader_p.h"
#include "ErrorHandler.h"
#include "TestBaseLine.h"
#include "Global.h"
#include "TestItem.h"
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
class QDate;
class QString;
class QUrl;
namespace QPatternistSDK
{
class XMLWriter;
/**
* @short A generic abstract base class for test cases.
*
* @ingroup PatternistSDK
* @author Frans Englich <frans.englich@nokia.com>
*/
class Q_PATTERNISTSDK_EXPORT TestCase : public TestItem
{
public:
/**
* Corresponds to the simpleType test:scenarios-enum
*/
enum Scenario
{
/**
* The test case should evaluate normally and that the output
* should match the supplied base line.
*/
Standard = 1,
/**
* The test case should result in a static error, a parser error.
*/
ParseError = 2,
/**
* The test case should result in a dynamic error, a runtime error.
*/
RuntimeError = 4,
Trivial = 8,
/**
* ParseError and RuntimeError OR'd.
*/
AnyError = RuntimeError | ParseError
};
TestCase();
virtual ~TestCase();
/**
* Executes the test, and returns the result. The returned list
* will always contain exactly one TestResult.
*
* @p stage is ignored when running out-of-process.
*/
virtual TestResult::List execute(const ExecutionStage stage,
TestSuite *ts);
/**
* Determines the corresponding Scenario enumerator from the string
* representation @p string.
*
* The following mappings are in effect:
* @arg @c Standard "standard"
* @arg @c ParseError "parse-error"
* @arg @c RuntimeError "runtime-error"
*/
static Scenario scenarioFromString(const QString &string);
/**
* @return always @c true
*/
virtual bool isFinalNode() const;
/**
* Calling this function makes no sense, so it always
* performs an Q_ASSERT check.
*/
virtual void appendChild(TreeItem *);
/**
* Calling this function makes no sense, so it always
* performs an Q_ASSERT check.
*/
virtual TreeItem *child(const unsigned int) const;
/**
* @return always zero
*/
virtual unsigned int childCount() const;
/**
* @return always an empty list.
*/
virtual TreeItem::List children() const;
/**
* A description of the test case for human consumption.
*/
virtual QString description() const = 0;
/**
* The title of the test. This can be the identifier of the test, for example.
*/
virtual QString title() const = 0;
/**
* Whether this test case only make use of XPath features.
*
* @returns @c false if the test case exercises any XQuery feature
* which is not available in XPath 2.0.
*/
virtual bool isXPath() const = 0;
/**
* The full name of the creator of the test case. For example, "Frans Englich".
*/
virtual QString creator() const = 0;
/**
* The date of when the test case was created or last modified.
*/
virtual QDate lastModified() const = 0;
/**
* The test's source code. That is, the XPath/XQuery code for the test.
*
* @param ok the function sets this value to @c false if loading the query
* failed, and returns a description of the error for human consumption. If
* everything went ok, @p ok is set to @c true, and the query is returned.
*/
virtual QString sourceCode(bool &ok) const = 0;
/**
* The path to the file containing the code of the test case.
*/
virtual QUrl testCasePath() const = 0;
/**
* The test case's identifier. For example, "Literals001".
*/
virtual QString name() const = 0;
/**
* What kind of test this is. For example, whether the test case
* should result in a parser error or should evaluate without errors.
*
* The vast common case is that one Scenario is returned; the bit signifiance
* is for the TestCase sub-class UserTestCase.
*/
virtual Scenario scenario() const = 0;
static QString displayName(const Scenario scen);
/**
* @returns the valid test baselines for this test case. If only
* one outcome is valid, the returned list only contains
* that baseline.
*/
virtual TestBaseLine::List baseLines() const = 0;
virtual TestResult *testResult() const;
virtual ResultSummary resultSummary() const;
void toXML(XMLWriter &receiver) const;
virtual QPatternist::ExternalVariableLoader::Ptr externalVariableLoader() const = 0;
/**
* @short The XML document that should be used as focus. If none should
* be used, and hence the focus be undefined, a default constructed
* QUrl is returned.
*/
virtual QUrl contextItemSource() const = 0;
/**
* Returns by default QXmlQuery::XQuery10.
*/
virtual QXmlQuery::QueryLanguage language() const;
virtual QXmlName initialTemplateName() const;
private:
TestResult::List execute(const ExecutionStage stage);
TestResult *createTestResult(const TestResult::Status status,
const QString &comment) const;
QPointer<TestResult> m_result;
};
}
QT_END_NAMESPACE
QT_END_HEADER
#endif
// vim: et:ts=4:sw=4:sts=4
|
