src/qmltest/quicktest.cpp

   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 #include "quicktest.h"
  43 #include "quicktestresult_p.h"
  44 #include <QtTest/qtestsystem.h>
  45 #include "qtestoptions_p.h"
  46 #include <QApplication>
  47 #include <QtDeclarative/qdeclarative.h>
  48 #include <QtQuick1/qdeclarativeview.h>
  49 #include <QtDeclarative/qdeclarativeengine.h>
  50 #include <QtDeclarative/qdeclarativecontext.h>
  51 #if defined(QML_VERSION) && QML_VERSION >= 0x020000
  52 #include <QtDeclarative/qsgview.h>
  53 #define QUICK_TEST_SCENEGRAPH 1
  54 #endif
  55 #include <QtDeclarative/qjsvalue.h>
  56 #include <QtDeclarative/qjsengine.h>
  57 #include <QtOpenGL/qgl.h>
  58 #include <QtCore/qurl.h>
  59 #include <QtCore/qfileinfo.h>
  60 #include <QtCore/qdir.h>
  61 #include <QtCore/qdiriterator.h>
  62 #include <QtCore/qfile.h>
  63 #include <QtCore/qdebug.h>
  64 #include <QtCore/qeventloop.h>
  65 #include <QtGui/qtextdocument.h>
  66 #include <stdio.h>
  67
  68 QT_BEGIN_NAMESPACE
  69
  70
  71 class QTestRootObject : public QObject
  72 {
  73     Q_OBJECT
  74     Q_PROPERTY(bool windowShown READ windowShown NOTIFY windowShownChanged)
  75 public:
  76     QTestRootObject(QObject *parent = 0)
  77         : QObject(parent), hasQuit(false), m_windowShown(false) {}
  78
  79     bool hasQuit;
  80
  81     bool windowShown() const { return m_windowShown; }
  82     void setWindowShown(bool value) { m_windowShown = value; emit windowShownChanged(); }
  83
  84 Q_SIGNALS:
  85     void windowShownChanged();
  86
  87 private Q_SLOTS:
  88     void quit() { hasQuit = true; }
  89
  90 private:
  91     bool m_windowShown;
  92 };
  93
  94 static inline QString stripQuotes(const QString &s)
  95 {
  96     if (s.length() >= 2 && s.startsWith(QLatin1Char('"')) && s.endsWith(QLatin1Char('"')))
  97         return s.mid(1, s.length() - 2);
  98     else
  99         return s;
 100 }
 101
 102 int quick_test_main(int argc, char **argv, const char *name, quick_test_viewport_create createViewport, const char *sourceDir)
 103 {
 104     QApplication* app = 0;
 105     if (!QCoreApplication::instance()) {
 106         app = new QApplication(argc, argv);
 107     }
 108
 109     // Look for QML-specific command-line options.
 110     //      -import dir         Specify an import directory.
 111     //      -input dir          Specify the input directory for test cases.
 112     //      -qtquick1           Run with QtQuick 1 rather than QtQuick 2.
 113     QStringList imports;
 114     QString testPath;
 115     bool qtQuick2 = true;
 116     int outargc = 1;
 117     int index = 1;
 118     while (index < argc) {
 119         if (strcmp(argv[index], "-import") == 0 && (index + 1) < argc) {
 120             imports += stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
 121             index += 2;
 122         } else if (strcmp(argv[index], "-input") == 0 && (index + 1) < argc) {
 123             testPath = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
 124             index += 2;
 125         } else if (strcmp(argv[index], "-opengl") == 0) {
 126             ++index;
 127         } else if (strcmp(argv[index], "-qtquick1") == 0) {
 128             qtQuick2 = false;
 129             ++index;
 130         } else if (outargc != index) {
 131             argv[outargc++] = argv[index++];
 132         } else {
 133             ++outargc;
 134             ++index;
 135         }
 136     }
 137     argv[outargc] = 0;
 138     argc = outargc;
 139
 140     // Parse the command-line arguments.
 141     QuickTestResult::parseArgs(argc, argv);
 142     QuickTestResult::setProgramName(name);
 143
 144     // Determine where to look for the test data.
 145     if (testPath.isEmpty() && sourceDir)
 146         testPath = QString::fromLocal8Bit(sourceDir);
 147     if (testPath.isEmpty())
 148         testPath = QLatin1String(".");
 149
 150     // Scan the test data directory recursively, looking for "tst_*.qml" files.
 151     QStringList filters;
 152     filters += QLatin1String("tst_*.qml");
 153     QStringList files;
 154     QDirIterator iter(testPath, filters, QDir::Files,
 155                       QDirIterator::Subdirectories |
 156                       QDirIterator::FollowSymlinks);
 157     while (iter.hasNext())
 158         files += iter.next();
 159     files.sort();
 160
 161     // Bail out if we didn't find any test cases.
 162     if (files.isEmpty()) {
 163         qWarning() << argv[0] << ": could not find any test cases under"
 164                    << testPath;
 165         return 1;
 166     }
 167
 168
 169     // Scan through all of the "tst_*.qml" files and run each of them
 170     // in turn with a QDeclarativeView.
 171 #ifdef QUICK_TEST_SCENEGRAPH
 172     if (qtQuick2) {
 173         foreach (QString file, files) {
 174             QFileInfo fi(file);
 175             if (!fi.exists())
 176                 continue;
 177             QSGView view;
 178             QTestRootObject rootobj;
 179             QEventLoop eventLoop;
 180             QObject::connect(view.engine(), SIGNAL(quit()),
 181                              &rootobj, SLOT(quit()));
 182             QObject::connect(view.engine(), SIGNAL(quit()),
 183                              &eventLoop, SLOT(quit()));
 184             view.rootContext()->setContextProperty
 185                 (QLatin1String("qtest"), &rootobj);
 186             foreach (QString path, imports)
 187                 view.engine()->addImportPath(path);
 188             QString path = fi.absoluteFilePath();
 189             if (path.startsWith(QLatin1String(":/")))
 190                 view.setSource(QUrl(QLatin1String("qrc:") + path.mid(2)));
 191             else
 192                 view.setSource(QUrl::fromLocalFile(path));
 193             if (QTest::printAvailableFunctions)
 194                 continue;
 195             if (view.status() == QSGView::Error) {
 196                 // Error compiling the test - flag failure in the log and continue.
 197                 QList<QDeclarativeError> errors = view.errors();
 198                 QuickTestResult results;
 199                 results.setTestCaseName(fi.baseName());
 200                 results.startLogging();
 201                 results.setFunctionName(QLatin1String("compile"));
 202                 results.setFunctionType(QuickTestResult::Func);
 203                 results.fail(errors.at(0).description(),
 204                              errors.at(0).url().toString(),
 205                              errors.at(0).line());
 206                 results.finishTestFunction();
 207                 results.setFunctionName(QString());
 208                 results.setFunctionType(QuickTestResult::NoWhere);
 209                 results.stopLogging();
 210                 continue;
 211             }
 212             if (!rootobj.hasQuit) {
 213                 // If the test already quit, then it was performed
 214                 // synchronously during setSource().  Otherwise it is
 215                 // an asynchronous test and we need to show the window
 216                 // and wait for the quit indication.
 217                 view.show();
 218                 QTest::qWaitForWindowShown(&view);
 219                 rootobj.setWindowShown(true);
 220                 if (!rootobj.hasQuit)
 221                     eventLoop.exec();
 222             }
 223         }
 224     } else
 225 #endif
 226     {
 227         foreach (QString file, files) {
 228             QFileInfo fi(file);
 229             if (!fi.exists())
 230                 continue;
 231             QDeclarativeView view;
 232             QTestRootObject rootobj;
 233             QEventLoop eventLoop;
 234             QObject::connect(view.engine(), SIGNAL(quit()),
 235                              &rootobj, SLOT(quit()));
 236             QObject::connect(view.engine(), SIGNAL(quit()),
 237                              &eventLoop, SLOT(quit()));
 238             if (createViewport)
 239                 view.setViewport((*createViewport)());
 240             view.rootContext()->setContextProperty
 241                 (QLatin1String("qtest"), &rootobj);
 242             foreach (QString path, imports)
 243                 view.engine()->addImportPath(path);
 244             QString path = fi.absoluteFilePath();
 245             if (path.startsWith(QLatin1String(":/")))
 246                 view.setSource(QUrl(QLatin1String("qrc:") + path.mid(2)));
 247             else
 248                 view.setSource(QUrl::fromLocalFile(path));
 249             if (QTest::printAvailableFunctions)
 250                 continue;
 251             if (view.status() == QDeclarativeView::Error) {
 252                 // Error compiling the test - flag failure in the log and continue.
 253                 QList<QDeclarativeError> errors = view.errors();
 254                 QuickTestResult results;
 255                 results.setTestCaseName(fi.baseName());
 256                 results.startLogging();
 257                 results.setFunctionName(QLatin1String("compile"));
 258                 results.setFunctionType(QuickTestResult::Func);
 259                 results.fail(errors.at(0).description(),
 260                              errors.at(0).url().toString(),
 261                              errors.at(0).line());
 262                 results.finishTestFunction();
 263                 results.setFunctionName(QString());
 264                 results.setFunctionType(QuickTestResult::NoWhere);
 265                 results.stopLogging();
 266                 continue;
 267             }
 268             if (!rootobj.hasQuit) {
 269                 // If the test already quit, then it was performed
 270                 // synchronously during setSource().  Otherwise it is
 271                 // an asynchronous test and we need to show the window
 272                 // and wait for the quit indication.
 273                 view.show();
 274                 QTest::qWaitForWindowShown(&view);
 275                 rootobj.setWindowShown(true);
 276                 if (!rootobj.hasQuit)
 277                     eventLoop.exec();
 278             }
 279         }
 280     }
 281
 282     // Flush the current logging stream.
 283     QuickTestResult::setProgramName(0);
 284
 285     delete app;
 286     // Return the number of failures as the exit code.
 287     return QuickTestResult::exitCode();
 288 }
 289
 290 QT_END_NAMESPACE
 291
 292 #include "quicktest.moc"