quicktestresult_p.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QUICKTESTRESULT_P_H
#define QUICKTESTRESULT_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtQuickTest/private/quicktestglobal_p.h>
#include <QtCore/qobject.h>
#include <QtCore/qstring.h>
#include <QtCore/qstringlist.h>
#include <QtCore/qscopedpointer.h>
#include <QtQuick/qquickitem.h>
#include <QtQuick/qquickwindow.h>
 
QT_BEGIN_NAMESPACE
 
class QUrl;
class QuickTestResultPrivate;
 
class Q_QMLTEST_EXPORT QuickTestResult : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString testCaseName READ testCaseName WRITE setTestCaseName NOTIFY testCaseNameChanged)
    Q_PROPERTY(QString functionName READ functionName WRITE setFunctionName NOTIFY functionNameChanged)
    Q_PROPERTY(QString dataTag READ dataTag WRITE setDataTag NOTIFY dataTagChanged)
    Q_PROPERTY(bool failed READ isFailed)
    Q_PROPERTY(bool skipped READ isSkipped WRITE setSkipped NOTIFY skippedChanged)
    Q_PROPERTY(int passCount READ passCount)
    Q_PROPERTY(int failCount READ failCount)
    Q_PROPERTY(int skipCount READ skipCount)
    Q_PROPERTY(QStringList functionsToRun READ functionsToRun)
    Q_PROPERTY(QStringList tagsToRun READ tagsToRun)
 
    QML_NAMED_ELEMENT(TestResult)
    QML_ADDED_IN_VERSION(1, 0)
 
public:
    QuickTestResult(QObject *parent = nullptr);
    ~QuickTestResult() override;
 
    // Values must match QBenchmarkIterationController::RunMode.
    enum RunMode
    {
        RepeatUntilValidMeasurement,
        RunOnce
    };
    Q_ENUM(RunMode)
 
    QString testCaseName() const;
    void setTestCaseName(const QString &name);
 
    QString functionName() const;
    void setFunctionName(const QString &name);
 
    QString dataTag() const;
    void setDataTag(const QString &tag);
 
    bool isFailed() const;
 
    bool isSkipped() const;
    void setSkipped(bool skip);
 
    int passCount() const;
    int failCount() const;
    int skipCount() const;
 
    QStringList functionsToRun() const;
    QStringList tagsToRun() const;
 
public Q_SLOTS:
    void reset();
 
    void startLogging();
    void stopLogging();
 
    void initTestTable();
    void clearTestTable();
 
    void finishTestData();
    void finishTestDataCleanup();
    void finishTestFunction();
 
    void stringify(QQmlV4FunctionPtr args);
 
    void fail(const QString &message, const QUrl &location, int line);
    bool verify(bool success, const QString &message,
                const QUrl &location, int line);
    bool compare(bool success, const QString &message,
                 const QVariant &val1, const QVariant &val2,
                 const QUrl &location, int line);
    bool fuzzyCompare(const QVariant &actual, const QVariant &expected, qreal delta);
    void skip(const QString &message, const QUrl &location, int line);
    bool expectFail(const QString &tag, const QString &comment,
                    const QUrl &location, int line);
    bool expectFailContinue(const QString &tag, const QString &comment,
                            const QUrl &location, int line);
    void warn(const QString &message, const QUrl &location, int line);
 
    void ignoreWarning(const QJSValue &message);
    Q_REVISION(6, 3) void failOnWarning(const QJSValue &message);
 
    void wait(int ms);
    void sleep(int ms);
    bool waitForRendering(QQuickItem *item, int timeout = 5000);
 
    void startMeasurement();
    void beginDataRun();
    void endDataRun();
    bool measurementAccepted();
    bool needsMoreMeasurements();
 
    void startBenchmark(RunMode runMode, const QString &tag);
    bool isBenchmarkDone() const;
    void nextBenchmark();
    void stopBenchmark();
 
    QObject *grabImage(QQuickItem *item);
 
    Q_REVISION(1, 1) QObject *findChild(QObject *parent, const QString &objectName);
 
    Q_REVISION(1, 13) bool isPolishScheduled(QObject *itemOrWindow) const;
    Q_REVISION(6, 5) bool waitForPolish(QObject *itemOrWindow, int timeout) const;
 
public:
    // Helper functions for the C++ main() shell.
    static void parseArgs(int argc, char *argv[]);
    static void setProgramName(const char *name);
    static void setCurrentAppname(const char *appname);
    static int exitCode();
 
Q_SIGNALS:
    void programNameChanged();
    void testCaseNameChanged();
    void functionNameChanged();
    void dataTagChanged();
    void skippedChanged();
 
private:
    QScopedPointer<QuickTestResultPrivate> d_ptr;
 
    Q_DECLARE_PRIVATE(QuickTestResult)
    Q_DISABLE_COPY(QuickTestResult)
};
 
QT_END_NAMESPACE
 
#endif