qt-everywhere-src-5.15.1/qtdeclarative/tests/auto/quick/examples/tst_examples.cpp - orbit - Git at Google

 /****************************************************************************
 **
 ** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the test suite of the Qt Toolkit.
 **
 ** $QT_BEGIN_LICENSE:GPL-EXCEPT$
 ** Commercial License Usage
 ** Licensees holding valid commercial Qt licenses may use this file in
 ** accordance with the commercial license agreement provided with the
 ** Software or, alternatively, in accordance with the terms contained in
 ** a written agreement between you and The Qt Company. For licensing terms
 ** and conditions see https://www.qt.io/terms-conditions. For further
 ** information use the contact form at https://www.qt.io/contact-us.
 **
 ** GNU General Public License Usage
 ** Alternatively, this file may be used under the terms of the GNU
 ** General Public License version 3 as published by the Free Software
 ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
 ** included in the packaging of this file. Please review the following
 ** information to ensure the GNU General Public License requirements will
 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
 **
 ** $QT_END_LICENSE$
 **
 ****************************************************************************/

 #include <qtest.h>
 #include <QLibraryInfo>
 #include <QDir>
 #include <QDebug>
 #include <QtQuick/QQuickItem>
 #include <QtQuick/QQuickView>
 #include <QQmlComponent>
 #include <QQmlEngine>
 #include <QQmlError>

 static QtMessageHandler testlibMsgHandler = nullptr;
 void msgHandlerFilter(QtMsgType type, const QMessageLogContext &ctxt, const QString &msg)
 {
     if (type == QtCriticalMsg || type == QtFatalMsg)
         (*testlibMsgHandler)(type, ctxt, msg);
 }

 class tst_examples : public QObject
 {
     Q_OBJECT
 public:
     tst_examples();
     ~tst_examples();

 private slots:
     void init();
     void cleanup();

     void sgexamples_data();
     void sgexamples();
     void sgsnippets_data();
     void sgsnippets();

     void namingConvention();
 private:
     QStringList excludedDirs;
     QStringList excludedFiles;

     void namingConvention(const QDir &);
     QStringList findQmlFiles(const QDir &);

     QQmlEngine engine;
 };

 tst_examples::tst_examples()
 {
     // Add files to exclude here
     excludedFiles << "snippets/qml/listmodel/listmodel.qml"; //Just a ListModel, no root QQuickItem
     excludedFiles << "snippets/qml/tablemodel/fruit-example-delegatechooser.qml"; // Requires QtQuick.Controls import.

     // Add directories you want excluded here
     excludedDirs << "shared"; //Not an example
     excludedDirs << "snippets/qml/path"; //No root QQuickItem
     excludedDirs << "examples/qml/qmlextensionplugins"; //Requires special import search path

     // These snippets are not expected to run on their own.
     excludedDirs << "snippets/qml/visualdatamodel_rootindex";
     excludedDirs << "snippets/qml/qtbinding";
     excludedDirs << "snippets/qml/imports";
     excludedFiles << "snippets/qml/image-ext.qml";
     excludedFiles << "examples/quick/shapes/content/main.qml"; // relies on resources
     excludedFiles << "examples/quick/shapes/content/interactive.qml"; // relies on resources

 #if !QT_CONFIG(opengl)
     //No support for Particles
     excludedFiles << "examples/qml/dynamicscene/dynamicscene.qml";
     excludedFiles << "examples/quick/animation/basics/color-animation.qml";
     excludedFiles << "examples/quick/particles/affectors/content/age.qml";
     excludedFiles << "examples/quick/touchinteraction/multipointtouch/bearwhack.qml";
     excludedFiles << "examples/quick/touchinteraction/multipointtouch/multiflame.qml";
     excludedDirs << "examples/quick/particles";
     // No Support for ShaderEffect
     excludedFiles << "src/quick/doc/snippets/qml/animators.qml";
 #endif

 }

 tst_examples::~tst_examples()
 {
 }

 void tst_examples::init()
 {
     if (!qstrcmp(QTest::currentTestFunction(), "sgsnippets"))
         testlibMsgHandler = qInstallMessageHandler(msgHandlerFilter);
 }

 void tst_examples::cleanup()
 {
     if (!qstrcmp(QTest::currentTestFunction(), "sgsnippets"))
         qInstallMessageHandler(testlibMsgHandler);
 }

 /*
 This tests that the examples follow the naming convention required
 to have them tested by the examples() test.
 */
 void tst_examples::namingConvention(const QDir &d)
 {
     for (int ii = 0; ii < excludedDirs.count(); ++ii) {
         QString s = excludedDirs.at(ii);
         if (d.absolutePath().endsWith(s))
             return;
     }

     QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
                                     QDir::Files);

     bool seenQml = !files.isEmpty();
     bool seenLowercase = false;

     foreach (const QString &file, files) {
         if (file.at(0).isLower())
             seenLowercase = true;
     }

     if (!seenQml) {
         QStringList dirs = d.entryList(QDir::Dirs | QDir::NoDotAndDotDot |
                 QDir::NoSymLinks);
         foreach (const QString &dir, dirs) {
             QDir sub = d;
             sub.cd(dir);
             namingConvention(sub);
         }
     } else if(!seenLowercase) {
         // QTBUG-28271 don't fail, but rather warn only
         qWarning() << QString(
             "Directory %1 violates naming convention; expected at least one qml file "
             "starting with lower case, got: %2"
         ).arg(d.absolutePath()).arg(files.join(","));

 //        QFAIL(qPrintable(QString(
 //            "Directory %1 violates naming convention; expected at least one qml file "
 //            "starting with lower case, got: %2"
 //        ).arg(d.absolutePath()).arg(files.join(","))));
     }
 }

 void tst_examples::namingConvention()
 {
     QStringList examplesLocations;
     examplesLocations << QLibraryInfo::location(QLibraryInfo::ExamplesPath) + QLatin1String("/qml");
     examplesLocations << QLibraryInfo::location(QLibraryInfo::ExamplesPath) + QLatin1String("/quick");

     foreach(const QString &examples, examplesLocations) {
         QDir d(examples);
         if (d.exists())
             namingConvention(d);
     }
 }

 QStringList tst_examples::findQmlFiles(const QDir &d)
 {
     for (int ii = 0; ii < excludedDirs.count(); ++ii) {
         QString s = excludedDirs.at(ii);
         if (d.absolutePath().endsWith(s))
             return QStringList();
     }

     QStringList rv;

     QStringList cppfiles = d.entryList(QStringList() << QLatin1String("*.cpp"), QDir::Files);
     if (cppfiles.isEmpty()) {
         QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
                                         QDir::Files);
         foreach (const QString &file, files) {
             if (file.at(0).isLower()) {
                 bool superContinue = false;
                 for (int ii = 0; ii < excludedFiles.count(); ++ii) {
                     QString e = excludedFiles.at(ii);
                     if (d.absoluteFilePath(file).endsWith(e)) {
                         superContinue = true;
                         break;
                     }
                 }
                 if (superContinue)
                     continue;
                 rv << d.absoluteFilePath(file);
             }
         }
     }


     QStringList dirs = d.entryList(QDir::Dirs | QDir::NoDotAndDotDot |
                                    QDir::NoSymLinks);
     foreach (const QString &dir, dirs) {
         QDir sub = d;
         sub.cd(dir);
         rv << findQmlFiles(sub);
     }

     return rv;
 }

 /*
 This test runs all the examples in the QtQml UI source tree and ensures
 that they start and exit cleanly.

 Examples are any .qml files under the examples/ directory that start
 with a lower case letter.
 */
 void tst_examples::sgexamples_data()
 {
     QTest::addColumn<QString>("file");

     QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";

     QStringList files;
     files << findQmlFiles(QDir(examples));

     foreach (const QString &file, files)
         QTest::newRow(qPrintable(file)) << file;
 }

 void tst_examples::sgexamples()
 {
     QFETCH(QString, file);
     QQuickWindow window;
     window.setPersistentOpenGLContext(true);
     window.setPersistentSceneGraph(true);

     QQmlComponent component(&engine, QUrl::fromLocalFile(file));
     if (component.status() == QQmlComponent::Error)
         qWarning() << component.errors();
     QCOMPARE(component.status(), QQmlComponent::Ready);

     QScopedPointer<QObject> object(component.beginCreate(engine.rootContext()));
     QQuickItem *root = qobject_cast<QQuickItem *>(object.data());
     if (!root)
         component.completeCreate();
     QVERIFY(root);

     window.resize(240, 320);
     window.show();
     QVERIFY(QTest::qWaitForWindowExposed(&window));

     root->setParentItem(window.contentItem());
     component.completeCreate();

     qApp->processEvents();
 }

 void tst_examples::sgsnippets_data()
 {
     QTest::addColumn<QString>("file");

     QString snippets = QLatin1String(SRCDIR) + "/../../../../src/qml/doc/snippets/qml";
     QStringList files;
     files << findQmlFiles(QDir(snippets));
     foreach (const QString &file, files)
         QTest::newRow(qPrintable(file)) << file;

     snippets = QLatin1String(SRCDIR) + "/../../../../src/quick/doc/snippets/qml";
     files.clear();
     files << findQmlFiles(QDir(snippets));
     foreach (const QString &file, files)
         QTest::newRow(qPrintable(file)) << file;
 }

 void tst_examples::sgsnippets()
 {

     QFETCH(QString, file);

     QQmlComponent component(&engine, QUrl::fromLocalFile(file));
     if (component.status() == QQmlComponent::Error)
         qWarning() << component.errors();
     QCOMPARE(component.status(), QQmlComponent::Ready);

     QScopedPointer<QObject> object(component.beginCreate(engine.rootContext()));
     QQuickWindow *window = qobject_cast<QQuickWindow*>(object.data());
     QQuickItem *root = qobject_cast<QQuickItem *>(object.data());
     if (!root && !window) {
         component.completeCreate();
         QVERIFY(false);
     }
     if (!window)
         window = new QQuickWindow;

     window->resize(240, 320);
     window->show();
     QVERIFY(QTest::qWaitForWindowExposed(window));

     if (root)
         root->setParentItem(window->contentItem());
     component.completeCreate();

     qApp->processEvents();
     if (root)
         delete window;
 }

 QTEST_MAIN(tst_examples)

 #include "tst_examples.moc"
	/****************************************************************************
	**
	** Copyright (C) 2016 The Qt Company Ltd.
	** Contact: https://www.qt.io/licensing/
	**
	** This file is part of the test suite of the Qt Toolkit.
	**
	** $QT_BEGIN_LICENSE:GPL-EXCEPT$
	** Commercial License Usage
	** Licensees holding valid commercial Qt licenses may use this file in
	** accordance with the commercial license agreement provided with the
	** Software or, alternatively, in accordance with the terms contained in
	** a written agreement between you and The Qt Company. For licensing terms
	** and conditions see https://www.qt.io/terms-conditions. For further
	** information use the contact form at https://www.qt.io/contact-us.
	**
	** GNU General Public License Usage
	** Alternatively, this file may be used under the terms of the GNU
	** General Public License version 3 as published by the Free Software
	** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
	** included in the packaging of this file. Please review the following
	** information to ensure the GNU General Public License requirements will
	** be met: https://www.gnu.org/licenses/gpl-3.0.html.
	**
	** $QT_END_LICENSE$
	**
	****************************************************************************/

	#include <qtest.h>
	#include <QLibraryInfo>
	#include <QDir>
	#include <QDebug>
	#include <QtQuick/QQuickItem>
	#include <QtQuick/QQuickView>
	#include <QQmlComponent>
	#include <QQmlEngine>
	#include <QQmlError>

	static QtMessageHandler testlibMsgHandler = nullptr;
	void msgHandlerFilter(QtMsgType type, const QMessageLogContext &ctxt, const QString &msg)
	{
	if (type == QtCriticalMsg \|\| type == QtFatalMsg)
	(*testlibMsgHandler)(type, ctxt, msg);
	}

	class tst_examples : public QObject
	{
	Q_OBJECT
	public:
	tst_examples();
	~tst_examples();

	private slots:
	void init();
	void cleanup();

	void sgexamples_data();
	void sgexamples();
	void sgsnippets_data();
	void sgsnippets();

	void namingConvention();
	private:
	QStringList excludedDirs;
	QStringList excludedFiles;

	void namingConvention(const QDir &);
	QStringList findQmlFiles(const QDir &);

	QQmlEngine engine;
	};

	tst_examples::tst_examples()
	{
	// Add files to exclude here
	excludedFiles << "snippets/qml/listmodel/listmodel.qml"; //Just a ListModel, no root QQuickItem
	excludedFiles << "snippets/qml/tablemodel/fruit-example-delegatechooser.qml"; // Requires QtQuick.Controls import.

	// Add directories you want excluded here
	excludedDirs << "shared"; //Not an example
	excludedDirs << "snippets/qml/path"; //No root QQuickItem
	excludedDirs << "examples/qml/qmlextensionplugins"; //Requires special import search path

	// These snippets are not expected to run on their own.
	excludedDirs << "snippets/qml/visualdatamodel_rootindex";
	excludedDirs << "snippets/qml/qtbinding";
	excludedDirs << "snippets/qml/imports";
	excludedFiles << "snippets/qml/image-ext.qml";
	excludedFiles << "examples/quick/shapes/content/main.qml"; // relies on resources
	excludedFiles << "examples/quick/shapes/content/interactive.qml"; // relies on resources

	#if !QT_CONFIG(opengl)
	//No support for Particles
	excludedFiles << "examples/qml/dynamicscene/dynamicscene.qml";
	excludedFiles << "examples/quick/animation/basics/color-animation.qml";
	excludedFiles << "examples/quick/particles/affectors/content/age.qml";
	excludedFiles << "examples/quick/touchinteraction/multipointtouch/bearwhack.qml";
	excludedFiles << "examples/quick/touchinteraction/multipointtouch/multiflame.qml";
	excludedDirs << "examples/quick/particles";
	// No Support for ShaderEffect
	excludedFiles << "src/quick/doc/snippets/qml/animators.qml";
	#endif

	}

	tst_examples::~tst_examples()
	{
	}

	void tst_examples::init()
	{
	if (!qstrcmp(QTest::currentTestFunction(), "sgsnippets"))
	testlibMsgHandler = qInstallMessageHandler(msgHandlerFilter);
	}

	void tst_examples::cleanup()
	{
	if (!qstrcmp(QTest::currentTestFunction(), "sgsnippets"))
	qInstallMessageHandler(testlibMsgHandler);
	}

	/*
	This tests that the examples follow the naming convention required
	to have them tested by the examples() test.
	*/
	void tst_examples::namingConvention(const QDir &d)
	{
	for (int ii = 0; ii < excludedDirs.count(); ++ii) {
	QString s = excludedDirs.at(ii);
	if (d.absolutePath().endsWith(s))
	return;
	}

	QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
	QDir::Files);

	bool seenQml = !files.isEmpty();
	bool seenLowercase = false;

	foreach (const QString &file, files) {
	if (file.at(0).isLower())
	seenLowercase = true;
	}

	if (!seenQml) {
	QStringList dirs = d.entryList(QDir::Dirs \| QDir::NoDotAndDotDot \|
	QDir::NoSymLinks);
	foreach (const QString &dir, dirs) {
	QDir sub = d;
	sub.cd(dir);
	namingConvention(sub);
	}
	} else if(!seenLowercase) {
	// QTBUG-28271 don't fail, but rather warn only
	qWarning() << QString(
	"Directory %1 violates naming convention; expected at least one qml file "
	"starting with lower case, got: %2"
	).arg(d.absolutePath()).arg(files.join(","));

	// QFAIL(qPrintable(QString(
	// "Directory %1 violates naming convention; expected at least one qml file "
	// "starting with lower case, got: %2"
	// ).arg(d.absolutePath()).arg(files.join(","))));
	}
	}

	void tst_examples::namingConvention()
	{
	QStringList examplesLocations;
	examplesLocations << QLibraryInfo::location(QLibraryInfo::ExamplesPath) + QLatin1String("/qml");
	examplesLocations << QLibraryInfo::location(QLibraryInfo::ExamplesPath) + QLatin1String("/quick");

	foreach(const QString &examples, examplesLocations) {
	QDir d(examples);
	if (d.exists())
	namingConvention(d);
	}
	}

	QStringList tst_examples::findQmlFiles(const QDir &d)
	{
	for (int ii = 0; ii < excludedDirs.count(); ++ii) {
	QString s = excludedDirs.at(ii);
	if (d.absolutePath().endsWith(s))
	return QStringList();
	}

	QStringList rv;

	QStringList cppfiles = d.entryList(QStringList() << QLatin1String("*.cpp"), QDir::Files);
	if (cppfiles.isEmpty()) {
	QStringList files = d.entryList(QStringList() << QLatin1String("*.qml"),
	QDir::Files);
	foreach (const QString &file, files) {
	if (file.at(0).isLower()) {
	bool superContinue = false;
	for (int ii = 0; ii < excludedFiles.count(); ++ii) {
	QString e = excludedFiles.at(ii);
	if (d.absoluteFilePath(file).endsWith(e)) {
	superContinue = true;
	break;
	}
	}
	if (superContinue)
	continue;
	rv << d.absoluteFilePath(file);
	}
	}
	}


	QStringList dirs = d.entryList(QDir::Dirs \| QDir::NoDotAndDotDot \|
	QDir::NoSymLinks);
	foreach (const QString &dir, dirs) {
	QDir sub = d;
	sub.cd(dir);
	rv << findQmlFiles(sub);
	}

	return rv;
	}

	/*
	This test runs all the examples in the QtQml UI source tree and ensures
	that they start and exit cleanly.

	Examples are any .qml files under the examples/ directory that start
	with a lower case letter.
	*/
	void tst_examples::sgexamples_data()
	{
	QTest::addColumn<QString>("file");

	QString examples = QLatin1String(SRCDIR) + "/../../../../examples/";

	QStringList files;
	files << findQmlFiles(QDir(examples));

	foreach (const QString &file, files)
	QTest::newRow(qPrintable(file)) << file;
	}

	void tst_examples::sgexamples()
	{
	QFETCH(QString, file);
	QQuickWindow window;
	window.setPersistentOpenGLContext(true);
	window.setPersistentSceneGraph(true);

	QQmlComponent component(&engine, QUrl::fromLocalFile(file));
	if (component.status() == QQmlComponent::Error)
	qWarning() << component.errors();
	QCOMPARE(component.status(), QQmlComponent::Ready);

	QScopedPointer<QObject> object(component.beginCreate(engine.rootContext()));
	QQuickItem root = qobject_cast<QQuickItem >(object.data());
	if (!root)
	component.completeCreate();
	QVERIFY(root);

	window.resize(240, 320);
	window.show();
	QVERIFY(QTest::qWaitForWindowExposed(&window));

	root->setParentItem(window.contentItem());
	component.completeCreate();

	qApp->processEvents();
	}

	void tst_examples::sgsnippets_data()
	{
	QTest::addColumn<QString>("file");

	QString snippets = QLatin1String(SRCDIR) + "/../../../../src/qml/doc/snippets/qml";
	QStringList files;
	files << findQmlFiles(QDir(snippets));
	foreach (const QString &file, files)
	QTest::newRow(qPrintable(file)) << file;

	snippets = QLatin1String(SRCDIR) + "/../../../../src/quick/doc/snippets/qml";
	files.clear();
	files << findQmlFiles(QDir(snippets));
	foreach (const QString &file, files)
	QTest::newRow(qPrintable(file)) << file;
	}

	void tst_examples::sgsnippets()
	{

	QFETCH(QString, file);

	QQmlComponent component(&engine, QUrl::fromLocalFile(file));
	if (component.status() == QQmlComponent::Error)
	qWarning() << component.errors();
	QCOMPARE(component.status(), QQmlComponent::Ready);

	QScopedPointer<QObject> object(component.beginCreate(engine.rootContext()));
	QQuickWindow window = qobject_cast<QQuickWindow>(object.data());
	QQuickItem root = qobject_cast<QQuickItem >(object.data());
	if (!root && !window) {
	component.completeCreate();
	QVERIFY(false);
	}
	if (!window)
	window = new QQuickWindow;

	window->resize(240, 320);
	window->show();
	QVERIFY(QTest::qWaitForWindowExposed(window));

	if (root)
	root->setParentItem(window->contentItem());
	component.completeCreate();

	qApp->processEvents();
	if (root)
	delete window;
	}

	QTEST_MAIN(tst_examples)

	#include "tst_examples.moc"