src/qmltest/quicktest.cpp

   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 #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 <QtDeclarative/qdeclarativeengine.h>
  49 #include <QtDeclarative/qdeclarativecontext.h>
  50 #if defined(QML_VERSION) && QML_VERSION >= 0x020000
  51 #include <QtQuick/qquickview.h>
  52 #define QUICK_TEST_SCENEGRAPH 1
  53 #endif
  54 #include <QtDeclarative/qjsvalue.h>
  55 #include <QtDeclarative/qjsengine.h>
  56 #include <QtGui/qopengl.h>
  57 #include <QtCore/qurl.h>
  58 #include <QtCore/qfileinfo.h>
  59 #include <QtCore/qdir.h>
  60 #include <QtCore/qdiriterator.h>
  61 #include <QtCore/qfile.h>
  62 #include <QtCore/qdebug.h>
  63 #include <QtCore/qeventloop.h>
  64 #include <QtCore/qtextstream.h>
  65 #include <QtGui/qtextdocument.h>
  66 #include <stdio.h>
  67 #include <QtGui/QGuiApplication>
  68 #include <QtCore/QTranslator>
  69 QT_BEGIN_NAMESPACE
  70
  71 static void installCoverageTool(const char * appname, const char * testname)
  72 {
  73 #ifdef __COVERAGESCANNER__
  74     // Install Coverage Tool
  75     __coveragescanner_install(appname);
  76     __coveragescanner_testname(testname);
  77     __coveragescanner_clear();
  78 #else
  79     Q_UNUSED(appname);
  80     Q_UNUSED(testname);
  81 #endif
  82 }
  83
  84 static void saveCoverageTool(const char * appname, bool testfailed)
  85 {
  86 #ifdef __COVERAGESCANNER__
  87     // install again to make sure the filename is correct.
  88     // without this, a plugin or similar may have changed the filename.
  89     __coveragescanner_install(appname);
  90     __coveragescanner_teststate(testfailed ? "FAILED" : "PASSED");
  91     __coveragescanner_save();
  92     __coveragescanner_testname("");
  93     __coveragescanner_clear();
  94 #else
  95     Q_UNUSED(appname);
  96     Q_UNUSED(testfailed);
  97 #endif
  98 }
  99
 100
 101 class QTestRootObject : public QObject
 102 {
 103     Q_OBJECT
 104     Q_PROPERTY(bool windowShown READ windowShown NOTIFY windowShownChanged)
 105     Q_PROPERTY(bool hasTestCase READ hasTestCase WRITE setHasTestCase NOTIFY hasTestCaseChanged)
 106 public:
 107     QTestRootObject(QObject *parent = 0)
 108         : QObject(parent), hasQuit(false), m_windowShown(false), m_hasTestCase(false)  {}
 109
 110     bool hasQuit:1;
 111     bool hasTestCase() const { return m_hasTestCase; }
 112     void setHasTestCase(bool value) { m_hasTestCase = value; emit hasTestCaseChanged(); }
 113
 114     bool windowShown() const { return m_windowShown; }
 115     void setWindowShown(bool value) { m_windowShown = value; emit windowShownChanged(); }
 116
 117 Q_SIGNALS:
 118     void windowShownChanged();
 119     void hasTestCaseChanged();
 120
 121 private Q_SLOTS:
 122     void quit() { hasQuit = true; }
 123
 124 private:
 125     bool m_windowShown : 1;
 126     bool m_hasTestCase :1;
 127 };
 128
 129 static inline QString stripQuotes(const QString &s)
 130 {
 131     if (s.length() >= 2 && s.startsWith(QLatin1Char('"')) && s.endsWith(QLatin1Char('"')))
 132         return s.mid(1, s.length() - 2);
 133     else
 134         return s;
 135 }
 136
 137 template <class View> void handleCompileErrors(const QFileInfo &fi, const View &view)
 138 {
 139     // Error compiling the test - flag failure in the log and continue.
 140     const QList<QDeclarativeError> errors = view.errors();
 141     QuickTestResult results;
 142     results.setTestCaseName(fi.baseName());
 143     results.startLogging();
 144     results.setFunctionName(QLatin1String("compile"));
 145     results.setFunctionType(QuickTestResult::Func);
 146     // Verbose warning output of all messages and relevant parameters
 147     QString message;
 148     QTextStream str(&message);
 149     str << "\n  " << QDir::toNativeSeparators(fi.absoluteFilePath()) << " produced "
 150         << errors.size() << " error(s):\n";
 151     foreach (const QDeclarativeError &e, errors) {
 152         str << "    ";
 153         if (e.url().isLocalFile()) {
 154             str << e.url().toLocalFile();
 155         } else {
 156             str << e.url().toString();
 157         }
 158         if (e.line() > 0)
 159             str << ':' << e.line() << ',' << e.column();
 160         str << ": " << e.description() << '\n';
 161     }
 162     str << "  Working directory: " << QDir::toNativeSeparators(QDir::current().absolutePath()) << '\n';
 163     if (QDeclarativeEngine *engine = view.engine()) {
 164         str << "  View: " << view.metaObject()->className() << ", import paths:\n";
 165         foreach (const QString &i, engine->importPathList())
 166             str << "    '" << QDir::toNativeSeparators(i) << "'\n";
 167         const QStringList pluginPaths = engine->pluginPathList();
 168         str << "  Plugin paths:\n";
 169         foreach (const QString &p, pluginPaths)
 170             str << "    '" << QDir::toNativeSeparators(p) << "'\n";
 171     }
 172     qWarning("%s", qPrintable(message));
 173     // Fail with error 0.
 174     results.fail(errors.at(0).description(),
 175                  errors.at(0).url(), errors.at(0).line());
 176     results.finishTestData();
 177     results.finishTestFunction();
 178     results.setFunctionName(QString());
 179     results.setFunctionType(QuickTestResult::NoWhere);
 180     results.stopLogging();
 181 }
 182
 183 int quick_test_main(int argc, char **argv, const char *name, quick_test_viewport_create createViewport, const char *sourceDir)
 184 {
 185     QGuiApplication* app = 0;
 186     if (!QCoreApplication::instance()) {
 187         app = new QGuiApplication(argc, argv);
 188     }
 189
 190     // Look for QML-specific command-line options.
 191     //      -import dir         Specify an import directory.
 192     //      -input dir          Specify the input directory for test cases.
 193     //      -qtquick1           Run with QtQuick 1 rather than QtQuick 2.
 194     //      -translation file   Specify the translation file.
 195     QStringList imports;
 196     QString testPath;
 197     QString translationFile;
 198     bool qtQuick2 = true;
 199     int outargc = 1;
 200     int index = 1;
 201     while (index < argc) {
 202         if (strcmp(argv[index], "-import") == 0 && (index + 1) < argc) {
 203             imports += stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
 204             index += 2;
 205         } else if (strcmp(argv[index], "-input") == 0 && (index + 1) < argc) {
 206             testPath = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
 207             index += 2;
 208         } else if (strcmp(argv[index], "-opengl") == 0) {
 209             ++index;
 210         } else if (strcmp(argv[index], "-qtquick1") == 0) {
 211             qtQuick2 = false;
 212             ++index;
 213         } else if (strcmp(argv[index], "-translation") == 0 && (index + 1) < argc) {
 214             translationFile = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
 215             index += 2;
 216         } else if (outargc != index) {
 217             argv[outargc++] = argv[index++];
 218         } else {
 219             ++outargc;
 220             ++index;
 221         }
 222     }
 223     argv[outargc] = 0;
 224     argc = outargc;
 225
 226     // Parse the command-line arguments.
 227     QuickTestResult::parseArgs(argc, argv);
 228     QuickTestResult::setProgramName(name);
 229
 230     installCoverageTool(argv[0], name);
 231
 232     QTranslator translator;
 233     if (!translationFile.isEmpty()) {
 234         if (translator.load(translationFile)) {
 235             app->installTranslator(&translator);
 236         } else {
 237             qWarning("Could not load the translation file '%s'.", qPrintable(translationFile));
 238         }
 239     }
 240
 241     // Determine where to look for the test data.
 242     if (testPath.isEmpty() && sourceDir)
 243         testPath = QString::fromLocal8Bit(sourceDir);
 244     if (testPath.isEmpty()) {
 245         QDir current = QDir::current();
 246 #ifdef Q_OS_WIN
 247         // Skip release/debug subfolders
 248         if (!current.dirName().compare(QLatin1String("Release"), Qt::CaseInsensitive)
 249             || !current.dirName().compare(QLatin1String("Debug"), Qt::CaseInsensitive))
 250             current.cdUp();
 251 #endif // Q_OS_WIN
 252         testPath = current.absolutePath();
 253     }
 254     QStringList files;
 255
 256     const QFileInfo testPathInfo(testPath);
 257     if (testPathInfo.isFile()) {
 258         if (!testPath.endsWith(QStringLiteral(".qml"))) {
 259             qWarning("'%s' does not have the suffix '.qml'.", qPrintable(testPath));
 260             return 1;
 261         }
 262         files << testPath;
 263     } else if (testPathInfo.isDir()) {
 264         // Scan the test data directory recursively, looking for "tst_*.qml" files.
 265         const QStringList filters(QStringLiteral("tst_*.qml"));
 266         QDirIterator iter(testPathInfo.absoluteFilePath(), filters, QDir::Files,
 267                           QDirIterator::Subdirectories |
 268                           QDirIterator::FollowSymlinks);
 269         while (iter.hasNext())
 270             files += iter.next();
 271         files.sort();
 272         if (files.isEmpty()) {
 273             qWarning("The directory '%s' does not contain any test files matching '%s'",
 274                      qPrintable(testPath), qPrintable(filters.front()));
 275             return 1;
 276         }
 277     } else {
 278         qWarning("'%s' does not exist under '%s'.",
 279                  qPrintable(testPath), qPrintable(QDir::currentPath()));
 280         return 1;
 281     }
 282
 283     // Scan through all of the "tst_*.qml" files and run each of them
 284     // in turn with a QDeclarativeView.
 285 #ifdef QUICK_TEST_SCENEGRAPH
 286     if (qtQuick2) {
 287         QQuickView view;
 288         QTestRootObject rootobj;
 289         QEventLoop eventLoop;
 290         QObject::connect(view.engine(), SIGNAL(quit()),
 291                          &rootobj, SLOT(quit()));
 292         QObject::connect(view.engine(), SIGNAL(quit()),
 293                          &eventLoop, SLOT(quit()));
 294         view.rootContext()->setContextProperty
 295             (QLatin1String("qtest"), &rootobj);
 296         foreach (const QString &path, imports)
 297             view.engine()->addImportPath(path);
 298
 299         foreach (QString file, files) {
 300             QFileInfo fi(file);
 301             if (!fi.exists())
 302                 continue;
 303
 304             rootobj.setHasTestCase(false);
 305             rootobj.setWindowShown(false);
 306             rootobj.hasQuit = false;
 307             QString path = fi.absoluteFilePath();
 308             if (path.startsWith(QLatin1String(":/")))
 309                 view.setSource(QUrl(QLatin1String("qrc:") + path.mid(2)));
 310             else
 311                 view.setSource(QUrl::fromLocalFile(path));
 312
 313             if (QTest::printAvailableFunctions)
 314                 continue;
 315             if (view.status() == QQuickView::Error) {
 316                 handleCompileErrors(fi, view);
 317                 continue;
 318             }
 319             if (!rootobj.hasQuit) {
 320                 // If the test already quit, then it was performed
 321                 // synchronously during setSource().  Otherwise it is
 322                 // an asynchronous test and we need to show the window
 323                 // and wait for the quit indication.
 324                 view.show();
 325                 QTest::qWaitForWindowShown(&view);
 326                 rootobj.setWindowShown(true);
 327                 if (!rootobj.hasQuit && rootobj.hasTestCase())
 328                     eventLoop.exec();
 329             }
 330         }
 331     } else
 332 #endif
 333     {
 334         qWarning("No suitable QtQuick1 implementation is available!");
 335         return 1;
 336     }
 337
 338     // Flush the current logging stream.
 339     QuickTestResult::setProgramName(0);
 340
 341     saveCoverageTool(argv[0], QuickTestResult::exitCode() != 0);
 342
 343     //Sometimes delete app cause crash here with some qpa plugins,
 344     //so we comment the follow line out to make them happy.
 345     //delete app;
 346
 347     // Return the number of failures as the exit code.
 348     return QuickTestResult::exitCode();
 349 }
 350
 351 QT_END_NAMESPACE
 352
 353 #include "quicktest.moc"