tests/auto/xmlpatternssdk/TestItem.h

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