src/qmltest/quicktestresult_p.h

   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 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 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 QuickTestResultPrivate;
  54
  55 class Q_QUICK_TEST_EXPORT QuickTestResult : public QObject
  56 {
  57     Q_OBJECT
  58     Q_ENUMS(FunctionType RunMode)
  59     Q_PROPERTY(QString testCaseName READ testCaseName WRITE setTestCaseName NOTIFY testCaseNameChanged)
  60     Q_PROPERTY(QString functionName READ functionName WRITE setFunctionName NOTIFY functionNameChanged)
  61     Q_PROPERTY(FunctionType functionType READ functionType WRITE setFunctionType NOTIFY functionTypeChanged)
  62     Q_PROPERTY(QString dataTag READ dataTag WRITE setDataTag NOTIFY dataTagChanged)
  63     Q_PROPERTY(bool failed READ isFailed)
  64     Q_PROPERTY(bool dataFailed READ isDataFailed)
  65     Q_PROPERTY(bool skipped READ isSkipped WRITE setSkipped NOTIFY skippedChanged)
  66     Q_PROPERTY(int passCount READ passCount)
  67     Q_PROPERTY(int failCount READ failCount)
  68     Q_PROPERTY(int skipCount READ skipCount)
  69     Q_PROPERTY(QStringList functionsToRun READ functionsToRun)
  70 public:
  71     QuickTestResult(QObject *parent = 0);
  72     ~QuickTestResult();
  73
  74     // Values must match QTestResult::TestLocation.
  75     enum FunctionType
  76     {
  77         NoWhere = 0,
  78         DataFunc = 1,
  79         InitFunc = 2,
  80         Func = 3,
  81         CleanupFunc = 4
  82     };
  83
  84     // Values must match QBenchmarkIterationController::RunMode.
  85     enum RunMode
  86     {
  87         RepeatUntilValidMeasurement,
  88         RunOnce
  89     };
  90
  91     QString testCaseName() const;
  92     void setTestCaseName(const QString &name);
  93
  94     QString functionName() const;
  95     void setFunctionName(const QString &name);
  96
  97     FunctionType functionType() const;
  98     void setFunctionType(FunctionType type);
  99
 100     QString dataTag() const;
 101     void setDataTag(const QString &tag);
 102
 103     bool isFailed() const;
 104     bool isDataFailed() const;
 105
 106     bool isSkipped() const;
 107     void setSkipped(bool skip);
 108
 109     int passCount() const;
 110     int failCount() const;
 111     int skipCount() const;
 112
 113     QStringList functionsToRun() const;
 114
 115 public Q_SLOTS:
 116     void reset();
 117
 118     void startLogging();
 119     void stopLogging();
 120
 121     void initTestTable();
 122     void clearTestTable();
 123
 124     void finishTestFunction();
 125
 126     void fail(const QString &message, const QString &file, int line);
 127     bool verify(bool success, const QString &message,
 128                 const QString &file, int line);
 129     bool compare(bool success, const QString &message,
 130                  const QString &val1, const QString &val2,
 131                  const QString &file, int line);
 132     void skipSingle(const QString &message, const QString &file, int line);
 133     void skipAll(const QString &message, const QString &file, int line);
 134     bool expectFail(const QString &tag, const QString &comment,
 135                     const QString &file, int line);
 136     bool expectFailContinue(const QString &tag, const QString &comment,
 137                             const QString &file, int line);
 138     void warn(const QString &message);
 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