/**************************************************************************** ** ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** This file is part of the test suite of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL$ ** No Commercial Usage ** This file contains pre-release code and may not be distributed. ** You may use this file in accordance with the terms and conditions ** contained in the either Technology Preview License Agreement or the ** Beta Release License Agreement. ** ** 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, Nokia gives you certain ** additional rights. These rights are described in the Nokia Qt LGPL ** Exception version 1.0, 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. ** ** If you are unsure which license is appropriate for your use, please ** contact the sales department at http://qt.nokia.com/contact. ** $QT_END_LICENSE$ ** ****************************************************************************/ /**************************************************************************** ** ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). ** Contact: Nokia Corporation (qt-info@nokia.com) ** ** This file is part of the Patternist project on Trolltech Labs. ** ** $QT_BEGIN_LICENSE:LGPL$ ** No Commercial Usage ** This file contains pre-release code and may not be distributed. ** You may use this file in accordance with the terms and conditions ** contained in the either Technology Preview License Agreement or the ** Beta Release License Agreement. ** ** 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, Nokia gives you certain ** additional rights. These rights are described in the Nokia Qt LGPL ** Exception version 1.0, 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. ** ** If you are unsure which license is appropriate for your use, please ** contact the sales department at http://qt.nokia.com/contact. ** $QT_END_LICENSE$ ** *************************************************************************** */ #ifndef PatternistSDK_TestSuite_H #define PatternistSDK_TestSuite_H #include #include #include "TestContainer.h" QT_BEGIN_HEADER QT_BEGIN_NAMESPACE class QIODevice; class QUrl; class QVariant; namespace QPatternistSDK { class TestCase; class TestSuiteResult; /** * @short Represents a test suite in the W3C XML Query Test Suite format. * * TestSuite contains the test suite's test cases and meta data. * * @ingroup PatternistSDK * @author Frans Englich */ class Q_PATTERNISTSDK_EXPORT TestSuite : public TestContainer { public: /** * Describes the type of test suite. */ enum SuiteType { XQuerySuite, ///< The test suite for XQuery XsltSuite, ///< The test suite for XSLT XsdSuite ///< The test suite for XML Schema }; TestSuite(); virtual QVariant data(const Qt::ItemDataRole role, int column) const; /** * The version of the catalog test suite. For example, "0.8.0". */ QString version() const; /** * When the catalog was designed, last modified. */ QDate designDate() const; void setVersion(const QString &version); void setDesignDate(const QDate &version); /** * @return always @c null */ virtual TestContainer *parent() const; /** * Creates and returns a pointer to a TestSuite instance, which * was instantiated from the XQuery Test Suite catalog file @p catalogFile. * * If loading went wrong, @c null is returned and @p errorMsg is set with a * human readable message string. However, @p catalogFile is not validated; * if the XML file is not valid against the XQTS task force's W3C XML Schema, the * behavior and result for this function is undefined. * * This function blocks. Currently is only local files supported. */ static TestSuite *openCatalog(const QUrl &catalogFile, QString &errorMsg, const bool useExclusionList, SuiteType type); void toXML(XMLWriter &receiver, TestCase *const tc) const; /** * Evaluates all the test cases in this TestSuite, and returns * it all in a TestSuiteResult. */ TestSuiteResult *runSuite(); private: /** * Essentially similar to open(const QUrl &, QString &errorMsg), * with the difference that it takes directly a QIODevice as input, * as opposed to a file name locating the catalog file to read. * * @param input the test suite catalog * @param fileName this URI is used for resolving relative paths inside * the catalog file into absolute. * @param errorMsg if an error occurs, this QString is set to contain the message. * Whether an error occurred can therefore be determined by checking if this variable * still is @c null after the call * @param useExclusionList whether the excludeTestGroups.txt file should be used * to exclude test groups for this catalog */ static TestSuite *openCatalog(QIODevice *input, QString &errorMsg, const QUrl &fileName, const bool useExclusionList, SuiteType type); QString m_version; QDate m_designDate; }; } QT_END_NAMESPACE QT_END_HEADER #endif // vim: et:ts=4:sw=4:sts=4