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 <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
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>
67 #include <QtGui/QGuiApplication>
68 #include <QtCore/QTranslator>
71 static void installCoverageTool(const char * appname, const char * testname)
73 #ifdef __COVERAGESCANNER__
74 // Install Coverage Tool
75 __coveragescanner_install(appname);
76 __coveragescanner_testname(testname);
77 __coveragescanner_clear();
84 static void saveCoverageTool(const char * appname, bool testfailed)
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();
101 class QTestRootObject : public QObject
104 Q_PROPERTY(bool windowShown READ windowShown NOTIFY windowShownChanged)
105 Q_PROPERTY(bool hasTestCase READ hasTestCase WRITE setHasTestCase NOTIFY hasTestCaseChanged)
107 QTestRootObject(QObject *parent = 0)
108 : QObject(parent), hasQuit(false), m_windowShown(false), m_hasTestCase(false) {}
111 bool hasTestCase() const { return m_hasTestCase; }
112 void setHasTestCase(bool value) { m_hasTestCase = value; emit hasTestCaseChanged(); }
114 bool windowShown() const { return m_windowShown; }
115 void setWindowShown(bool value) { m_windowShown = value; emit windowShownChanged(); }
118 void windowShownChanged();
119 void hasTestCaseChanged();
122 void quit() { hasQuit = true; }
125 bool m_windowShown : 1;
126 bool m_hasTestCase :1;
129 static inline QString stripQuotes(const QString &s)
131 if (s.length() >= 2 && s.startsWith(QLatin1Char('"')) && s.endsWith(QLatin1Char('"')))
132 return s.mid(1, s.length() - 2);
137 template <class View> void handleCompileErrors(const QFileInfo &fi, const View &view)
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 // Verbose warning output of all messages and relevant parameters
147 QTextStream str(&message);
148 str << "\n " << QDir::toNativeSeparators(fi.absoluteFilePath()) << " produced "
149 << errors.size() << " error(s):\n";
150 foreach (const QDeclarativeError &e, errors) {
152 if (e.url().isLocalFile()) {
153 str << e.url().toLocalFile();
155 str << e.url().toString();
158 str << ':' << e.line() << ',' << e.column();
159 str << ": " << e.description() << '\n';
161 str << " Working directory: " << QDir::toNativeSeparators(QDir::current().absolutePath()) << '\n';
162 if (QDeclarativeEngine *engine = view.engine()) {
163 str << " View: " << view.metaObject()->className() << ", import paths:\n";
164 foreach (const QString &i, engine->importPathList())
165 str << " '" << QDir::toNativeSeparators(i) << "'\n";
166 const QStringList pluginPaths = engine->pluginPathList();
167 str << " Plugin paths:\n";
168 foreach (const QString &p, pluginPaths)
169 str << " '" << QDir::toNativeSeparators(p) << "'\n";
171 qWarning("%s", qPrintable(message));
172 // Fail with error 0.
173 results.fail(errors.at(0).description(),
174 errors.at(0).url(), errors.at(0).line());
175 results.finishTestData();
176 results.finishTestFunction();
177 results.setFunctionName(QString());
178 results.stopLogging();
181 int quick_test_main(int argc, char **argv, const char *name, quick_test_viewport_create createViewport, const char *sourceDir)
183 QGuiApplication* app = 0;
184 if (!QCoreApplication::instance()) {
185 app = new QGuiApplication(argc, argv);
188 // Look for QML-specific command-line options.
189 // -import dir Specify an import directory.
190 // -input dir Specify the input directory for test cases.
191 // -qtquick1 Run with QtQuick 1 rather than QtQuick 2.
192 // -translation file Specify the translation file.
195 QString translationFile;
196 bool qtQuick2 = true;
199 while (index < argc) {
200 if (strcmp(argv[index], "-import") == 0 && (index + 1) < argc) {
201 imports += stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
203 } else if (strcmp(argv[index], "-input") == 0 && (index + 1) < argc) {
204 testPath = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
206 } else if (strcmp(argv[index], "-opengl") == 0) {
208 } else if (strcmp(argv[index], "-qtquick1") == 0) {
211 } else if (strcmp(argv[index], "-translation") == 0 && (index + 1) < argc) {
212 translationFile = stripQuotes(QString::fromLocal8Bit(argv[index + 1]));
214 } else if (outargc != index) {
215 argv[outargc++] = argv[index++];
224 // Parse the command-line arguments.
225 QuickTestResult::parseArgs(argc, argv);
226 QuickTestResult::setProgramName(name);
228 installCoverageTool(argv[0], name);
230 QTranslator translator;
231 if (!translationFile.isEmpty()) {
232 if (translator.load(translationFile)) {
233 app->installTranslator(&translator);
235 qWarning("Could not load the translation file '%s'.", qPrintable(translationFile));
239 // Determine where to look for the test data.
240 if (testPath.isEmpty() && sourceDir)
241 testPath = QString::fromLocal8Bit(sourceDir);
242 if (testPath.isEmpty()) {
243 QDir current = QDir::current();
245 // Skip release/debug subfolders
246 if (!current.dirName().compare(QLatin1String("Release"), Qt::CaseInsensitive)
247 || !current.dirName().compare(QLatin1String("Debug"), Qt::CaseInsensitive))
250 testPath = current.absolutePath();
254 const QFileInfo testPathInfo(testPath);
255 if (testPathInfo.isFile()) {
256 if (!testPath.endsWith(QStringLiteral(".qml"))) {
257 qWarning("'%s' does not have the suffix '.qml'.", qPrintable(testPath));
261 } else if (testPathInfo.isDir()) {
262 // Scan the test data directory recursively, looking for "tst_*.qml" files.
263 const QStringList filters(QStringLiteral("tst_*.qml"));
264 QDirIterator iter(testPathInfo.absoluteFilePath(), filters, QDir::Files,
265 QDirIterator::Subdirectories |
266 QDirIterator::FollowSymlinks);
267 while (iter.hasNext())
268 files += iter.next();
270 if (files.isEmpty()) {
271 qWarning("The directory '%s' does not contain any test files matching '%s'",
272 qPrintable(testPath), qPrintable(filters.front()));
276 qWarning("'%s' does not exist under '%s'.",
277 qPrintable(testPath), qPrintable(QDir::currentPath()));
281 // Scan through all of the "tst_*.qml" files and run each of them
282 // in turn with a QDeclarativeView.
283 #ifdef QUICK_TEST_SCENEGRAPH
286 QTestRootObject rootobj;
287 QEventLoop eventLoop;
288 QObject::connect(view.engine(), SIGNAL(quit()),
289 &rootobj, SLOT(quit()));
290 QObject::connect(view.engine(), SIGNAL(quit()),
291 &eventLoop, SLOT(quit()));
292 view.rootContext()->setContextProperty
293 (QLatin1String("qtest"), &rootobj);
294 foreach (const QString &path, imports)
295 view.engine()->addImportPath(path);
297 foreach (QString file, files) {
302 rootobj.setHasTestCase(false);
303 rootobj.setWindowShown(false);
304 rootobj.hasQuit = false;
305 QString path = fi.absoluteFilePath();
306 if (path.startsWith(QLatin1String(":/")))
307 view.setSource(QUrl(QLatin1String("qrc:") + path.mid(2)));
309 view.setSource(QUrl::fromLocalFile(path));
311 if (QTest::printAvailableFunctions)
313 if (view.status() == QQuickView::Error) {
314 handleCompileErrors(fi, view);
317 if (!rootobj.hasQuit) {
318 // If the test already quit, then it was performed
319 // synchronously during setSource(). Otherwise it is
320 // an asynchronous test and we need to show the window
321 // and wait for the quit indication.
323 QTest::qWaitForWindowShown(&view);
324 rootobj.setWindowShown(true);
325 if (!rootobj.hasQuit && rootobj.hasTestCase())
332 qWarning("No suitable QtQuick1 implementation is available!");
336 // Flush the current logging stream.
337 QuickTestResult::setProgramName(0);
339 saveCoverageTool(argv[0], QuickTestResult::exitCode() != 0);
341 //Sometimes delete app cause crash here with some qpa plugins,
342 //so we comment the follow line out to make them happy.
345 // Return the number of failures as the exit code.
346 return QuickTestResult::exitCode();
351 #include "quicktest.moc"