tests/auto/xmlpatternssdk/XSDTSTestCase.h
changeset 7 f7bc934e204c
equal deleted inserted replaced
3:41300fa6a67c 7:f7bc934e204c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 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 autotests of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 #ifndef PatternistSDK_XSDTSTestCase_H
       
    43 #define PatternistSDK_XSDTSTestCase_H
       
    44 
       
    45 #include <QDate>
       
    46 #include <QString>
       
    47 #include <QUrl>
       
    48 
       
    49 #include "TestBaseLine.h"
       
    50 #include "TestCase.h"
       
    51 
       
    52 QT_BEGIN_HEADER
       
    53 QT_BEGIN_NAMESPACE
       
    54 
       
    55 namespace QPatternistSDK
       
    56 {
       
    57     /**
       
    58      * @short Represents a test case in a test suite in the XML Query Test Suite.
       
    59      *
       
    60      * TestCase is a memory representation of a test case, and maps
       
    61      * to the @c test-case element in the XQuery Test Suite test
       
    62      * case catalog.
       
    63      *
       
    64      * @ingroup PatternistSDK
       
    65      * @author Frans Englich <frans.englich@nokia.com>
       
    66      */
       
    67     class Q_PATTERNISTSDK_EXPORT XSDTSTestCase : public TestCase
       
    68     {
       
    69     public:
       
    70         enum TestType
       
    71         {
       
    72             SchemaTest,
       
    73             InstanceTest
       
    74         };
       
    75 
       
    76         XSDTSTestCase(const Scenario scen, TreeItem *parent, TestType testType);
       
    77         virtual ~XSDTSTestCase();
       
    78 
       
    79         /**
       
    80          * Executes the test, and returns the result. The returned list
       
    81          * will always contain exactly one TestResult.
       
    82          *
       
    83          * @p stage is ignored when running out-of-process.
       
    84          */
       
    85         virtual TestResult::List execute(const ExecutionStage stage,
       
    86                                          TestSuite *ts);
       
    87         /**
       
    88          * The identifier, the name of the test. For example, "Literals034".
       
    89          * The name of a test case must be unique.
       
    90          */
       
    91         virtual QString name() const;
       
    92         virtual QString creator() const;
       
    93         virtual QString description() const;
       
    94         /**
       
    95          * @returns the query inside the file, specified by testCasePath(). Loading
       
    96          * of the file is not cached in order to avoid complications.
       
    97          * @param ok is set to @c false if loading the query file fails
       
    98          */
       
    99         virtual QString sourceCode(bool &ok) const;
       
   100         virtual QUrl schemaUri() const;
       
   101         virtual QUrl instanceUri() const;
       
   102         virtual QUrl testCasePath() const {return QUrl();}
       
   103         virtual QDate lastModified() const;
       
   104 
       
   105         bool isXPath() const;
       
   106 
       
   107         /**
       
   108          * What kind of test case this is, what kind of scenario it takes part
       
   109          * of. For example, whether the test case should evaluate normally or fail.
       
   110          */
       
   111         Scenario scenario() const;
       
   112 
       
   113         void setCreator(const QString &creator);
       
   114         void setLastModified(const QDate &date);
       
   115         void setDescription(const QString &description);
       
   116         void setName(const QString &name);
       
   117         void setSchemaUri(const QUrl &uri);
       
   118         void setInstanceUri(const QUrl &uri);
       
   119         void setTestCasePath(const QUrl & /* uri */) {}
       
   120         void setContextItemSource(const QUrl &uri);
       
   121         void addBaseLine(TestBaseLine *lines);
       
   122 
       
   123         virtual TreeItem *parent() const;
       
   124 
       
   125         virtual QVariant data(const Qt::ItemDataRole role, int column) const;
       
   126 
       
   127         virtual QString title() const;
       
   128         virtual TestBaseLine::List baseLines() const;
       
   129 
       
   130         virtual int columnCount() const;
       
   131 
       
   132         virtual QUrl contextItemSource() const;
       
   133         void setParent(TreeItem *const parent);
       
   134         virtual QPatternist::ExternalVariableLoader::Ptr externalVariableLoader() const;
       
   135         virtual TestResult *testResult() const;
       
   136         virtual ResultSummary resultSummary() const;
       
   137 
       
   138     private:
       
   139         void executeSchemaTest(TestResult::Status &resultStatus, QString &serialized, QAbstractMessageHandler *handler);
       
   140         void executeInstanceTest(TestResult::Status &resultStatus, QString &serialized, QAbstractMessageHandler *handler);
       
   141 
       
   142         QString                                     m_name;
       
   143         QString                                     m_creator;
       
   144         QString                                     m_description;
       
   145         QUrl                                        m_schemaUri;
       
   146         QUrl                                        m_instanceUri;
       
   147         QDate                                       m_lastModified;
       
   148         const Scenario                              m_scenario;
       
   149         TreeItem *                                  m_parent;
       
   150         TestBaseLine::List                          m_baseLines;
       
   151         QUrl                                        m_contextItemSource;
       
   152         TestType                                    m_testType;
       
   153         QPointer<TestResult>                        m_result;
       
   154     };
       
   155 }
       
   156 
       
   157 QT_END_NAMESPACE
       
   158 QT_END_HEADER
       
   159 
       
   160 #endif
       
   161 // vim: et:ts=4:sw=4:sts=4