tests/auto/xmlpatternsxqts/tst_suitetest.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the test suite of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42
  43 #ifndef Q_tst_SuiteTest
  44 #define Q_tst_SuiteTest
  45
  46 #include <QtCore/QObject>
  47 #include "../qxmlquery/TestFundament.h"
  48
  49 /*!
  50  \class tst_SuiteTest
  51  \internal
  52  \since 4.5
  53  \brief Base class for tst_XmlPatternsXQTS, tst_XmlPatternsXSLTS and tst_XmlPatternsXSDTS.
  54  */
  55 class tst_SuiteTest : public QObject
  56                     , private TestFundament
  57 {
  58     Q_OBJECT
  59
  60 public:
  61     enum SuiteType
  62     {
  63         XQuerySuite,
  64         XsltSuite,
  65         XsdSuite
  66     };
  67
  68 protected:
  69     /**
  70      * @p isXSLT is @c true if the catalog opened is an
  71      * XSL-T test suite.
  72      *
  73      * @p alwaysRun is @c true if the test should always be run,
  74      * regardless of if the file runTests exists.
  75      */
  76     tst_SuiteTest(SuiteType type,
  77                   const bool alwaysRun = false);
  78
  79     /**
  80      * The reason why we pass in a mutable reference and have void as return
  81      * value instead of simply returning the string, is that we in some
  82      * implementations use QTestLib's macros such as QVERIFY, which contains
  83      * return statements. Yay for QTestLib.
  84      */
  85     virtual void catalogPath(QString &write) const = 0;
  86
  87     bool dontRun() const;
  88
  89 private Q_SLOTS:
  90     void initTestCase();
  91     void runTestSuite() const;
  92     void checkTestSuiteResult() const;
  93
  94 private:
  95     /**
  96      * An absolute path to the catalog.
  97      */
  98     QString         m_catalogPath;
  99     const QString   m_existingBaseline;
 100     const QString   m_candidateBaseline;
 101     const bool      m_abortRun;
 102     const SuiteType m_suiteType;
 103 };
 104
 105 #endif
 106
 107 // vim: et:ts=4:sw=4:sts=4