1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the test suite of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL-EXCEPT$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 as published by the Free Software
20** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
21** included in the packaging of this file. Please review the following
22** information to ensure the GNU General Public License requirements will
23** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24**
25** $QT_END_LICENSE$
26**
27****************************************************************************/
28
29#ifndef PatternistSDK_TestItem_H
30#define PatternistSDK_TestItem_H
31
32#include "TestResult.h"
33#include "TreeItem.h"
34
35QT_BEGIN_NAMESPACE
36
37template<typename A, typename B> struct QPair;
38
39namespace QPatternistSDK
40{
41 class XMLWriter;
42 class TestSuite;
43
44 /**
45 * @short base class for all classes which
46 * represent an element in an XQuery Test Suite catalog.
47 *
48 * @ingroup PatternistSDK
49 * @author Frans Englich <frans.englich@nokia.com>
50 */
51 class TestItem : public TreeItem
52 {
53 public:
54
55 /**
56 * Determines how far an test case execution should go.
57 */
58 enum ExecutionStage
59 {
60 /**
61 * The query will not be run. It will only go through the (whole) compilation stage.
62 */
63 CompileOnly = 1,
64
65 /**
66 * The query will be compiled and run, as ordinary.
67 */
68 CompileAndRun
69 };
70
71 /**
72 * Represents a summary of test results for a collection
73 * of tests. QPair::first contains the amount of
74 * passed tests; QPair::second contains the count of
75 * all tests. For example TestCase::summary() returns
76 * ResultSummary(0, 1) or ResultSummary(1, 1) depending
77 * on whether the TestCase have succeeded or not.
78 */
79 typedef QPair<int, int> ResultSummary;
80
81 /**
82 * Executes the test case(s) this TestItem represents,
83 * and return the TestResult. For example, the TestGroup
84 * returns the result of its children concatenated, while
85 * TestCase always returns a list containing one
86 * TestResult(what it evaluated to).
87 */
88 virtual TestResult::List execute(const ExecutionStage stage,
89 TestSuite *ts) = 0;
90
91 /**
92 * @todo Rename this function. Perhaps create a type() hierarchy
93 * instead.
94 */
95 virtual bool isFinalNode() const = 0;
96
97 /**
98 * @returns a ResultSummary for this TestItem.
99 */
100 virtual ResultSummary resultSummary() const = 0;
101
102 /**
103 * Serializes into the corresponding elements attributes
104 * specified in XQTSCatalog.xsd.
105 *
106 * @note Sub-classes must assume the XQTSCatalog namespace
107 * is the default namespace, and not add any namespace declarations.
108 */
109 //virtual void toXML(XMLWriter &receiver) const = 0;
110 };
111}
112
113QT_END_NAMESPACE
114
115#endif
116// vim: et:ts=4:sw=4:sts=4
117

source code of qtxmlpatterns/tests/auto/xmlpatternssdk/TestItem.h