1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the test suite of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
42 #include "quicktest.h"
43 #include "quicktestresult_p.h"
44 #include <QtTest/qtestsystem.h>
45 #include "qtestoptions_p.h"
46 #include <QtQml/qqml.h>
47 #include <QtQml/qqmlengine.h>
48 #include <QtQml/qqmlcontext.h>
49 #include <QtQuick/qquickview.h>
50 #include <QtQml/qjsvalue.h>
51 #include <QtQml/qjsengine.h>
52 #include <QtGui/qopengl.h>
53 #include <QtCore/qurl.h>
54 #include <QtCore/qfileinfo.h>
55 #include <QtCore/qdir.h>
56 #include <QtCore/qdiriterator.h>
57 #include <QtCore/qfile.h>
58 #include <QtCore/qdebug.h>
59 #include <QtCore/qeventloop.h>
60 #include <QtCore/qtextstream.h>
61 #include <QtGui/qtextdocument.h>
63 #include <QtGui/QGuiApplication>
64 #include <QtCore/QTranslator>
67 class QTestRootObject : public QObject
70 Q_PROPERTY(bool windowShown READ windowShown NOTIFY windowShownChanged)
71 Q_PROPERTY(bool hasTestCase READ hasTestCase WRITE setHasTestCase NOTIFY hasTestCaseChanged)
73 QTestRootObject(QObject *parent = 0)
74 : QObject(parent), hasQuit(false), m_windowShown(false), m_hasTestCase(false) {}
77 bool hasTestCase() const { return m_hasTestCase; }
78 void setHasTestCase(bool value) { m_hasTestCase = value; emit hasTestCaseChanged(); }
80 bool windowShown() const { return m_windowShown; }
81 void setWindowShown(bool value) { m_windowShown = value; emit windowShownChanged(); }
84 void windowShownChanged();
85 void hasTestCaseChanged();
88 void quit() { hasQuit = true; }
91 bool m_windowShown : 1;
92 bool m_hasTestCase :1;
95 static inline QString stripQuotes(const QString &s)
97 if (s.length() >= 2 && s.startsWith(QLatin1Char('"')) && s.endsWith(QLatin1Char('"')))
98 return s.mid(1, s.length() - 2);
103 void handleCompileErrors(const QFileInfo &fi, QQuickView *view)
105 // Error compiling the test - flag failure in the log and continue.
106 const QList<QQmlError> errors = view->errors();
107 QuickTestResult results;
108 results.setTestCaseName(fi.baseName());
109 results.startLogging();
110 results.setFunctionName(QLatin1String("compile"));
111 // Verbose warning output of all messages and relevant parameters
113 QTextStream str(&message);
114 str << "\n " << QDir::toNativeSeparators(fi.absoluteFilePath()) << " produced "
115 << errors.size() << " error(s):\n";
116 foreach (const QQmlError &e, errors) {
118 if (e.url().isLocalFile()) {
119 str << e.url().toLocalFile();
121 str << e.url().toString();
124 str << ':' << e.line() << ',' << e.column();
125 str << ": " << e.description() << '\n';
127 str << " Working directory: " << QDir::toNativeSeparators(QDir::current().absolutePath()) << '\n';
128 if (QQmlEngine *engine = view->engine()) {
129 str << " View: " << view->metaObject()->className() << ", import paths:\n";
130 foreach (const QString &i, engine->importPathList())
131 str << " '" << QDir::toNativeSeparators(i) << "'\n";
132 const QStringList pluginPaths = engine->pluginPathList();
133 str << " Plugin paths:\n";
134 foreach (const QString &p, pluginPaths)
135 str << " '" << QDir::toNativeSeparators(p) << "'\n";
137 qWarning("%s", qPrintable(message));
138 // Fail with error 0.
139 results.fail(errors.at(0).description(),
140 errors.at(0).url(), errors.at(0).line());
141 results.finishTestData();
142 results.finishTestDataCleanup();
143 results.finishTestFunction();
144 results.setFunctionName(QString());
145 results.stopLogging();
148 int quick_test_main(int argc, char **argv, const char *name, quick_test_viewport_create createViewport, const char *sourceDir)
150 Q_UNUSED(createViewport);
151 QGuiApplication* app = 0;
152 if (!QCoreApplication::instance()) {
153 app = new QGuiApplication(argc, argv);
156 // Look for QML-specific command-line options.
157 // -import dir Specify an import directory.
158 // -input dir Specify the input directory for test cases.
159 // -translation file Specify the translation file.
162 QString translationFile;
165 while (index < argc) {
166 if (strcmp(argv[index], "-import") == 0 && (index + 1) < argc) {
167 imports += stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
169 } else if (strcmp(argv[index], "-input") == 0 && (index + 1) < argc) {
170 testPath = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
172 } else if (strcmp(argv[index], "-opengl") == 0) {
174 } else if (strcmp(argv[index], "-translation") == 0 && (index + 1) < argc) {
175 translationFile = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
177 } else if (outargc != index) {
178 argv[outargc++] = argv[index++];
187 // Parse the command-line arguments.
189 // Setting currentAppname and currentTestObjectName (via setProgramName) are needed
190 // for the code coverage analysis. Must be done before parseArgs is called.
191 QuickTestResult::setCurrentAppname(argv[0]);
192 QuickTestResult::setProgramName(name);
194 QuickTestResult::parseArgs(argc, argv);
196 QTranslator translator;
197 if (!translationFile.isEmpty()) {
198 if (translator.load(translationFile)) {
199 app->installTranslator(&translator);
201 qWarning("Could not load the translation file '%s'.", qPrintable(translationFile));
205 // Determine where to look for the test data.
206 if (testPath.isEmpty() && sourceDir) {
207 const QString s = QString::fromLocal8Bit(sourceDir);
208 if (QFile::exists(s))
211 if (testPath.isEmpty()) {
212 QDir current = QDir::current();
214 // Skip release/debug subfolders
215 if (!current.dirName().compare(QLatin1String("Release"), Qt::CaseInsensitive)
216 || !current.dirName().compare(QLatin1String("Debug"), Qt::CaseInsensitive))
219 testPath = current.absolutePath();
223 const QFileInfo testPathInfo(testPath);
224 if (testPathInfo.isFile()) {
225 if (!testPath.endsWith(QStringLiteral(".qml"))) {
226 qWarning("'%s' does not have the suffix '.qml'.", qPrintable(testPath));
230 } else if (testPathInfo.isDir()) {
231 // Scan the test data directory recursively, looking for "tst_*.qml" files.
232 const QStringList filters(QStringLiteral("tst_*.qml"));
233 QDirIterator iter(testPathInfo.absoluteFilePath(), filters, QDir::Files,
234 QDirIterator::Subdirectories |
235 QDirIterator::FollowSymlinks);
236 while (iter.hasNext())
237 files += iter.next();
239 if (files.isEmpty()) {
240 qWarning("The directory '%s' does not contain any test files matching '%s'",
241 qPrintable(testPath), qPrintable(filters.front()));
245 qWarning("'%s' does not exist under '%s'.",
246 qPrintable(testPath), qPrintable(QDir::currentPath()));
250 // Scan through all of the "tst_*.qml" files and run each of them
251 // in turn with a QQuickView.
252 QQuickView *view = new QQuickView;
253 QTestRootObject rootobj;
254 QEventLoop eventLoop;
255 QObject::connect(view->engine(), SIGNAL(quit()),
256 &rootobj, SLOT(quit()));
257 QObject::connect(view->engine(), SIGNAL(quit()),
258 &eventLoop, SLOT(quit()));
259 view->rootContext()->setContextProperty
260 (QLatin1String("qtest"), &rootobj);
261 foreach (const QString &path, imports)
262 view->engine()->addImportPath(path);
264 foreach (QString file, files) {
269 rootobj.setHasTestCase(false);
270 rootobj.setWindowShown(false);
271 rootobj.hasQuit = false;
272 QString path = fi.absoluteFilePath();
273 if (path.startsWith(QLatin1String(":/")))
274 view->setSource(QUrl(QLatin1String("qrc:") + path.mid(2)));
276 view->setSource(QUrl::fromLocalFile(path));
278 if (QTest::printAvailableFunctions)
280 if (view->status() == QQuickView::Error) {
281 handleCompileErrors(fi, view);
284 if (!rootobj.hasQuit) {
285 // If the test already quit, then it was performed
286 // synchronously during setSource(). Otherwise it is
287 // an asynchronous test and we need to show the window
288 // and wait for the quit indication.
290 QTest::qWaitForWindowShown(view);
291 rootobj.setWindowShown(true);
292 if (!rootobj.hasQuit && rootobj.hasTestCase())
297 // Flush the current logging stream.
298 QuickTestResult::setProgramName(0);
302 // Return the number of failures as the exit code.
303 return QuickTestResult::exitCode();
308 #include "quicktest.moc"