src/qmltest/quicktestresult_p.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 #ifndef QUICKTESTRESULT_P_H
  43 #define QUICKTESTRESULT_P_H
  44
  45 #include <QtQuickTest/quicktestglobal.h>
  46 #include <QtCore/qobject.h>
  47 #include <QtCore/qstring.h>
  48 #include <QtCore/qstringlist.h>
  49 #include <QtCore/qscopedpointer.h>
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QUrl;
  54 class QuickTestResultPrivate;
  55
  56 class Q_QUICK_TEST_EXPORT QuickTestResult : public QObject
  57 {
  58     Q_OBJECT
  59     Q_ENUMS(FunctionType RunMode)
  60     Q_PROPERTY(QString testCaseName READ testCaseName WRITE setTestCaseName NOTIFY testCaseNameChanged)
  61     Q_PROPERTY(QString functionName READ functionName WRITE setFunctionName NOTIFY functionNameChanged)
  62     Q_PROPERTY(FunctionType functionType READ functionType WRITE setFunctionType NOTIFY functionTypeChanged)
  63     Q_PROPERTY(QString dataTag READ dataTag WRITE setDataTag NOTIFY dataTagChanged)
  64     Q_PROPERTY(bool failed READ isFailed)
  65     Q_PROPERTY(bool dataFailed READ isDataFailed)
  66     Q_PROPERTY(bool skipped READ isSkipped WRITE setSkipped NOTIFY skippedChanged)
  67     Q_PROPERTY(int passCount READ passCount)
  68     Q_PROPERTY(int failCount READ failCount)
  69     Q_PROPERTY(int skipCount READ skipCount)
  70     Q_PROPERTY(QStringList functionsToRun READ functionsToRun)
  71 public:
  72     QuickTestResult(QObject *parent = 0);
  73     ~QuickTestResult();
  74
  75     // Values must match QTestResult::TestLocation.
  76     enum FunctionType
  77     {
  78         NoWhere = 0,
  79         DataFunc = 1,
  80         InitFunc = 2,
  81         Func = 3,
  82         CleanupFunc = 4
  83     };
  84
  85     // Values must match QBenchmarkIterationController::RunMode.
  86     enum RunMode
  87     {
  88         RepeatUntilValidMeasurement,
  89         RunOnce
  90     };
  91
  92     QString testCaseName() const;
  93     void setTestCaseName(const QString &name);
  94
  95     QString functionName() const;
  96     void setFunctionName(const QString &name);
  97
  98     FunctionType functionType() const;
  99     void setFunctionType(FunctionType type);
 100
 101     QString dataTag() const;
 102     void setDataTag(const QString &tag);
 103
 104     bool isFailed() const;
 105     bool isDataFailed() const;
 106
 107     bool isSkipped() const;
 108     void setSkipped(bool skip);
 109
 110     int passCount() const;
 111     int failCount() const;
 112     int skipCount() const;
 113
 114     QStringList functionsToRun() const;
 115
 116 public Q_SLOTS:
 117     void reset();
 118
 119     void startLogging();
 120     void stopLogging();
 121
 122     void initTestTable();
 123     void clearTestTable();
 124
 125     void finishTestFunction();
 126
 127     void fail(const QString &message, const QUrl &location, int line);
 128     bool verify(bool success, const QString &message,
 129                 const QUrl &location, int line);
 130     bool compare(bool success, const QString &message,
 131                  const QString &val1, const QString &val2,
 132                  const QUrl &location, int line);
 133     void skip(const QString &message, const QUrl &location, int line);
 134     bool expectFail(const QString &tag, const QString &comment,
 135                     const QUrl &location, int line);
 136     bool expectFailContinue(const QString &tag, const QString &comment,
 137                             const QUrl &location, int line);
 138     void warn(const QString &message, const QUrl &location, int line);
 139
 140     void ignoreWarning(const QString &message);
 141
 142     void wait(int ms);
 143     void sleep(int ms);
 144
 145     void startMeasurement();
 146     void beginDataRun();
 147     void endDataRun();
 148     bool measurementAccepted();
 149     bool needsMoreMeasurements();
 150
 151     void startBenchmark(RunMode runMode, const QString &tag);
 152     bool isBenchmarkDone() const;
 153     void nextBenchmark();
 154     void stopBenchmark();
 155
 156 public:
 157     // Helper functions for the C++ main() shell.
 158     static void parseArgs(int argc, char *argv[]);
 159     static void setProgramName(const char *name);
 160     static int exitCode();
 161
 162 Q_SIGNALS:
 163     void programNameChanged();
 164     void testCaseNameChanged();
 165     void functionNameChanged();
 166     void functionTypeChanged();
 167     void dataTagChanged();
 168     void skippedChanged();
 169
 170 private:
 171     QScopedPointer<QuickTestResultPrivate> d_ptr;
 172
 173     Q_DECLARE_PRIVATE(QuickTestResult)
 174     Q_DISABLE_COPY(QuickTestResult)
 175 };
 176
 177 QT_END_NAMESPACE
 178
 179 #endif