/* * Copyright 2016 Canonical Ltd. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; version 3. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see . */ #include #include #include #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0) #include #else #include #endif #include "uctestcase.h" #include "uctestextras.h" UT_USE_NAMESPACE // Certain versions of Qt 5.15 and 6.0 will crash if we call QQmlIncubator::clear() // from QQmlIncubator::setInitialState(). This is reported as QTBUG-91519 and // promptly fixed in later versions. To avoid crashing on those versions, we worked // around it by preventing AsyncLoader from reset()'ing in Initializing state. // https://bugreports.qt.io/browse/QTBUG-91519 static constexpr bool WORKAROUND_QTBUG_91519 = #if defined(HAS_QTBUG_91519_FIXED) // In case people backported the fix to the problemetic version. false #elif QT_VERSION >= QT_VERSION_CHECK(5, 15, 0) && QT_VERSION < QT_VERSION_CHECK(5, 15, 4) // The Qt 5.15.4 case is just in case, as we the open source users is // unlikely to encounter that version. true #elif QT_VERSION >= QT_VERSION_CHECK(6, 0, 0) && QT_VERSION < QT_VERSION_CHECK(6, 0, 3) true #else // Qt 6.1.0+ are fixed. Qt 5.14 and below are not affected. false #endif ; class LoaderSpy : public QObject { Q_OBJECT public: AsyncLoader *m_loader; QScopedPointer m_object; bool m_done = false; bool m_error = false; QList m_statusList; public: LoaderSpy(AsyncLoader *loader) : QObject(0) , m_loader(loader) { connect(loader, &AsyncLoader::loadingStatus, this, &LoaderSpy::onLoadingStatusChanged); } protected Q_SLOTS: virtual void onLoadingStatusChanged(UT_PREPEND_NAMESPACE(AsyncLoader)::LoadingStatus status, QObject *object) { m_statusList << status; if (status == AsyncLoader::Ready) { m_done = true; m_object.reset(object); } if (status == AsyncLoader::Error) { m_error = true; } } }; class ResetLoaderSpy : public LoaderSpy { Q_OBJECT public: bool m_reset = false; public: ResetLoaderSpy(AsyncLoader *loader) : LoaderSpy(loader) { } void onLoadingStatusChanged(UT_PREPEND_NAMESPACE(AsyncLoader)::LoadingStatus status, QObject *object) override { if (status == AsyncLoader::Loading) { m_loader->reset(); m_reset = true; } LoaderSpy::onLoadingStatusChanged(status, object); } }; class SecondLoaderSpy : public LoaderSpy { Q_OBJECT public: bool m_loadResult = false; public: SecondLoaderSpy(AsyncLoader *loader, AsyncLoader::LoadingStatus loadAt, const QUrl &url, QQmlContext *context) : LoaderSpy(loader) , m_loadAt(loadAt) , m_url(url) , m_context(context) { } void onLoadingStatusChanged(AsyncLoader::LoadingStatus status, QObject *object) override { if (status == (AsyncLoader::LoadingStatus)m_loadAt) { m_loadAt = -1; delete object; object = nullptr; m_loadResult = m_loader->load(m_url, m_context); } LoaderSpy::onLoadingStatusChanged(status, object); } private: int m_loadAt; QUrl m_url; QQmlContext *m_context; }; /******************************************************************** * Test ********************************************************************/ class tst_AsyncLoader : public QObject { Q_OBJECT private Q_SLOTS: void test_load_data() { QTest::addColumn("loadAsDocument"); QTest::addColumn("document"); QTest::addColumn("mode"); QTest::addColumn< QList >("statuses"); QTest::newRow("document") << true << "Document.qml" << (int)QQmlComponent::Asynchronous << (QList() << AsyncLoader::Compiling << AsyncLoader::Loading << AsyncLoader::Initializing << AsyncLoader::Ready ); QTest::newRow("component, asynchronous") << false << "Document.qml" << (int)QQmlComponent::Asynchronous << (QList() << AsyncLoader::Compiling << AsyncLoader::Loading << AsyncLoader::Initializing << AsyncLoader::Ready ); QTest::newRow("component, synchronous") << false << "Document.qml" << (int)QQmlComponent::PreferSynchronous << (QList() << AsyncLoader::Loading << AsyncLoader::Initializing << AsyncLoader::Ready ); } void test_load() { QFETCH(bool, loadAsDocument); QFETCH(QString, document); QFETCH(int, mode); QFETCH(QList, statuses); QScopedPointer view(new LomiriTestCase("TestApp.qml")); AsyncLoader loader; LoaderSpy spy(&loader); QScopedPointer component; if (loadAsDocument) { loader.load(QUrl::fromLocalFile(document), view->rootContext()); } else { // create a component component.reset(new QQmlComponent(view->engine(), QUrl::fromLocalFile(document), (QQmlComponent::CompilationMode)mode)); loader.load(component.data(), view->rootContext()); } QTRY_VERIFY_WITH_TIMEOUT(spy.m_object != nullptr, 20000); // check the statuses QCOMPARE(spy.m_statusList.length(), statuses.length()); for (int i = 0; i < spy.m_statusList.length(); i++) { QVERIFY2((int)spy.m_statusList[i] == statuses[i], (QString(" Status at index %1 differs").arg(i)).toLocal8Bit().constData()); } } void test_load_with_error() { QUrl document = QUrl::fromLocalFile("FaultyDocument.qml"); LomiriTestCase::ignoreWarning("FaultyDocument.qml", 20, "Label is not a type"); QScopedPointer view(new LomiriTestCase("TestApp.qml")); AsyncLoader loader; LoaderSpy spy(&loader); loader.load(document, view->rootContext()); QTRY_VERIFY_WITH_TIMEOUT(spy.m_error == true, 10000); } void test_load_no_context() { AsyncLoader loader; QVERIFY(!loader.load(nullptr, nullptr)); QVERIFY(!loader.load(QUrl(), nullptr)); } void test_load_invalid_url() { QQmlEngine engine; AsyncLoader loader; LoaderSpy spy(&loader); QVERIFY(!loader.load(QUrl(), engine.rootContext())); } void test_load_null_component() { QQmlEngine engine; AsyncLoader loader; LoaderSpy spy(&loader); QVERIFY(!loader.load(nullptr, engine.rootContext())); } void test_load_and_cancel_data() { QTest::addColumn("loadAsDocument"); QTest::addColumn("document"); QTest::addColumn("mode"); QTest::newRow("document") << true << "HeavyDocument.qml" << (int)QQmlComponent::Asynchronous; QTest::newRow("component, asynchronous") << false << "HeavyDocument.qml" << (int)QQmlComponent::Asynchronous; QTest::newRow("component, synchronous") << false << "HeavyDocument.qml" << (int)QQmlComponent::PreferSynchronous; } void test_load_and_cancel() { QFETCH(bool, loadAsDocument); QFETCH(QString, document); QFETCH(int, mode); QScopedPointer view(new LomiriTestCase("TestApp.qml")); AsyncLoader loader; ResetLoaderSpy spy(&loader); QScopedPointer component; if (loadAsDocument) { loader.load(QUrl::fromLocalFile(document), view->rootContext()); } else { // create a component component.reset(new QQmlComponent(view->engine(), QUrl::fromLocalFile(document), (QQmlComponent::CompilationMode)mode)); loader.load(component.data(), view->rootContext()); } if (loader.status() < AsyncLoader::Loading) { // cannot reset yet! QVERIFY(!loader.reset()); } QTRY_VERIFY_WITH_TIMEOUT(spy.m_reset, 10000); } void test_second_load_scenarios_data() { QTest::addColumn ("doc1"); QTest::addColumn ("doc2"); QTest::addColumn ("when"); QTest::addColumn ("success"); QTest::newRow("status = Compiling") << "Document.qml" << "HeavyDocument.qml" << (int)AsyncLoader::Compiling << false; QTest::newRow("status = Loading") << "Document.qml" << "HeavyDocument.qml" << (int)AsyncLoader::Loading << true; QTest::newRow("status = Initializing") << "Document.qml" << "HeavyDocument.qml" << (int)AsyncLoader::Initializing << true; QTest::newRow("status = Ready") << "Document.qml" << "HeavyDocument.qml" << (int)AsyncLoader::Ready << true; QTest::newRow("status = Error") << "FaultyDocument.qml" << "HeavyDocument.qml" << (int)AsyncLoader::Error << true; } void test_second_load_scenarios() { QFETCH(QString, doc1); QFETCH(QString, doc2); QFETCH(int, when); QFETCH(bool, success); // See above for what this works around, and AsyncLoader's code for how. if (WORKAROUND_QTBUG_91519 && when == (int) AsyncLoader::Initializing) { QSKIP("Some Qt 5.15 and Qt 6.0 will crash if we call QQmlIncubator::clear() " "from QQmlIncubator::setInitialState(). The code has been updated to " "prevent this. QTBUG-91519."); } QScopedPointer view(new LomiriTestCase("TestApp.qml")); AsyncLoader loader; if (when == (int)AsyncLoader::Error) { LomiriTestCase::ignoreWarning("FaultyDocument.qml", 20, "Label is not a type"); } SecondLoaderSpy spy(&loader, (AsyncLoader::LoadingStatus)when, QUrl::fromLocalFile(doc2), view->rootContext()); // load the first document QVERIFY(loader.load(QUrl::fromLocalFile(doc1), view->rootContext())); QTRY_VERIFY_WITH_TIMEOUT(spy.m_object != nullptr, 10000); QCOMPARE(spy.m_loadResult, success); } }; QTEST_MAIN(tst_AsyncLoader) #include "tst_asyncloader.moc"