qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qtdeclarative/tests/auto/qml/qqmlmoduleplugin/tst_qqmlmoduleplugin.cpp

586 lines
21 KiB
C++
Raw Blame History

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <qtest.h>
#include <qdir.h>
#include <QtQml/qqmlengine.h>
#include <QtQml/qqmlcomponent.h>
#include <QDebug>
#if defined(Q_OS_MAC)
// For _PC_CASE_SENSITIVE
#include <unistd.h>
#endif
#include "../../shared/testhttpserver.h"
#include "../../shared/util.h"
// Note: this test does not use module identifier directives in the qmldir files, because
// it would result in repeated attempts to insert types into the same namespace.
// This occurs because type registration is process-global, while the test
// cases should really be run in proper per-process isolation.
class tst_qqmlmoduleplugin : public QQmlDataTest
{
Q_OBJECT
public:
private slots:
virtual void initTestCase();
void importsPlugin();
void importsPlugin2();
void importsPlugin21();
void importsMixedQmlCppPlugin();
void incorrectPluginCase();
void importPluginWithQmlFile();
void remoteImportWithQuotedUrl();
void remoteImportWithUnquotedUri();
void versionNotInstalled();
void versionNotInstalled_data();
void implicitQmldir();
void implicitQmldir_data();
void importsNested();
void importsNested_data();
void importLocalModule();
void importLocalModule_data();
void importStrictModule();
void importStrictModule_data();
void importProtectedModule();
private:
QString m_importsDirectory;
QString m_dataImportsDirectory;
};
void tst_qqmlmoduleplugin::initTestCase()
{
QQmlDataTest::initTestCase();
m_importsDirectory = QFINDTESTDATA(QStringLiteral("imports"));
QVERIFY2(QFileInfo(m_importsDirectory).isDir(),
qPrintable(QString::fromLatin1("Imports directory '%1' does not exist.").arg(m_importsDirectory)));
m_dataImportsDirectory = directory() + QStringLiteral("/imports");
QVERIFY2(QFileInfo(m_dataImportsDirectory).isDir(),
qPrintable(QString::fromLatin1("Imports directory '%1' does not exist.").arg(m_dataImportsDirectory)));
}
#define VERIFY_ERRORS(errorfile) \
if (!errorfile) { \
if (qgetenv("DEBUG") != "" && !component.errors().isEmpty()) \
qWarning() << "Unexpected Errors:" << component.errors(); \
QVERIFY(!component.isError()); \
QVERIFY(component.errors().isEmpty()); \
} else { \
QString verify_errors_file_name = testFile(errorfile); \
QFile file(verify_errors_file_name); \
QVERIFY(file.open(QIODevice::ReadOnly | QIODevice::Text)); \
QByteArray data = file.readAll(); \
file.close(); \
QList<QByteArray> expected = data.split('\n'); \
expected.removeAll(QByteArray("")); \
QList<QQmlError> errors = component.errors(); \
QList<QByteArray> actual; \
for (int ii = 0; ii < errors.count(); ++ii) { \
const QQmlError &error = errors.at(ii); \
QByteArray errorStr = QByteArray::number(error.line()) + ':' + \
QByteArray::number(error.column()) + ':' + \
error.description().toUtf8(); \
actual << errorStr; \
} \
if (qgetenv("DEBUG") != "" && expected != actual) { \
qWarning() << "Expected:" << expected << "Actual:" << actual; \
} \
if (qgetenv("QDECLARATIVELANGUAGE_UPDATEERRORS") != "" && expected != actual) {\
QFile file(testFile(errorfile)); \
QVERIFY(file.open(QIODevice::WriteOnly)); \
for (int ii = 0; ii < actual.count(); ++ii) { \
file.write(actual.at(ii)); file.write("\n"); \
} \
file.close(); \
} else { \
QCOMPARE(expected, actual); \
} \
}
void tst_qqmlmoduleplugin::importsPlugin()
{
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QTest::ignoreMessage(QtWarningMsg, "plugin created");
QTest::ignoreMessage(QtWarningMsg, "import worked");
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFileUrl(QStringLiteral("works.qml")));
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
QObject *object = component.create();
QVERIFY(object != 0);
QCOMPARE(object->property("value").toInt(),123);
delete object;
}
void tst_qqmlmoduleplugin::importsPlugin2()
{
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QTest::ignoreMessage(QtWarningMsg, "plugin2 created");
QTest::ignoreMessage(QtWarningMsg, "import2 worked");
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFileUrl(QStringLiteral("works2.qml")));
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
QObject *object = component.create();
QVERIFY(object != 0);
QCOMPARE(object->property("value").toInt(),123);
delete object;
}
void tst_qqmlmoduleplugin::importsPlugin21()
{
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QTest::ignoreMessage(QtWarningMsg, "plugin2.1 created");
QTest::ignoreMessage(QtWarningMsg, "import2.1 worked");
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFileUrl(QStringLiteral("works21.qml")));
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
QObject *object = component.create();
QVERIFY(object != 0);
QCOMPARE(object->property("value").toInt(),123);
delete object;
}
void tst_qqmlmoduleplugin::incorrectPluginCase()
{
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QQmlComponent component(&engine, testFileUrl(QStringLiteral("incorrectCase.qml")));
QList<QQmlError> errors = component.errors();
QCOMPARE(errors.count(), 1);
QString expectedError = QLatin1String("module \"org.qtproject.WrongCase\" plugin \"PluGin\" not found");
#if defined(Q_OS_MAC) || defined(Q_OS_WIN32)
bool caseSensitive = true;
#if defined(Q_OS_MAC)
caseSensitive = pathconf(QDir::currentPath().toLatin1().constData(), _PC_CASE_SENSITIVE);
QString libname = "libPluGin.dylib";
#elif defined(Q_OS_WIN32)
caseSensitive = false;
QString libname = "PluGin.dll";
#endif
if (!caseSensitive) {
expectedError = QLatin1String("plugin cannot be loaded for module \"org.qtproject.WrongCase\": File name case mismatch for \"")
+ QDir(m_importsDirectory).filePath("org/qtproject/WrongCase/" + libname)
+ QLatin1Char('"');
}
#endif
QCOMPARE(errors.at(0).description(), expectedError);
}
void tst_qqmlmoduleplugin::importPluginWithQmlFile()
{
QString path = m_importsDirectory;
// QTBUG-16885: adding an import path with a lower-case "c:" causes assert failure
// (this only happens if the plugin includes pure QML files)
#ifdef Q_OS_WIN
QVERIFY(path.at(0).isUpper() && path.at(1) == QLatin1Char(':'));
path = path.at(0).toLower() + path.mid(1);
#endif
QQmlEngine engine;
engine.addImportPath(path);
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestPluginWithQmlFile' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFileUrl(QStringLiteral("pluginWithQmlFile.qml")));
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
QObject *object = component.create();
QVERIFY(object != 0);
delete object;
}
void tst_qqmlmoduleplugin::remoteImportWithQuotedUrl()
{
ThreadedTestHTTPServer server(m_dataImportsDirectory);
QQmlEngine engine;
QQmlComponent component(&engine);
const QString qml = "import \"" + server.urlString("/org/qtproject/PureQmlModule") + "\" \nComponentA { width: 300; ComponentB{} }";
component.setData(qml.toUtf8(), QUrl());
QTRY_COMPARE(component.status(), QQmlComponent::Ready);
QObject *object = component.create();
QCOMPARE(object->property("width").toInt(), 300);
QVERIFY(object != 0);
delete object;
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
}
void tst_qqmlmoduleplugin::remoteImportWithUnquotedUri()
{
TestHTTPServer server;
QVERIFY2(server.listen(), qPrintable(server.errorString()));
server.serveDirectory(m_dataImportsDirectory);
QQmlEngine engine;
engine.addImportPath(m_dataImportsDirectory);
QQmlComponent component(&engine);
component.setData("import org.qtproject.PureQmlModule 1.0 \nComponentA { width: 300; ComponentB{} }", QUrl());
QTRY_COMPARE(component.status(), QQmlComponent::Ready);
QObject *object = component.create();
QVERIFY(object != 0);
QCOMPARE(object->property("width").toInt(), 300);
delete object;
foreach (QQmlError err, component.errors())
qWarning() << err;
VERIFY_ERRORS(0);
}
// QTBUG-17324
void tst_qqmlmoduleplugin::importsMixedQmlCppPlugin()
{
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlMixedPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
{
QQmlComponent component(&engine, testFileUrl(QStringLiteral("importsMixedQmlCppPlugin.qml")));
QObject *o = component.create();
QVERIFY2(o != 0, QQmlDataTest::msgComponentError(component, &engine));
QCOMPARE(o->property("test").toBool(), true);
delete o;
}
{
QQmlComponent component(&engine, testFileUrl(QStringLiteral("importsMixedQmlCppPlugin.2.qml")));
QObject *o = component.create();
QVERIFY2(o != 0, QQmlDataTest::msgComponentError(component, &engine));
QCOMPARE(o->property("test").toBool(), true);
QCOMPARE(o->property("test2").toBool(), true);
delete o;
}
}
void tst_qqmlmoduleplugin::versionNotInstalled_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("errorFile");
QTest::newRow("versionNotInstalled") << "versionNotInstalled.qml" << "versionNotInstalled.errors.txt";
QTest::newRow("versionNotInstalled") << "versionNotInstalled.2.qml" << "versionNotInstalled.2.errors.txt";
}
void tst_qqmlmoduleplugin::versionNotInstalled()
{
QFETCH(QString, file);
QFETCH(QString, errorFile);
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
static int count = 0;
if (++count == 1)
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlVersionPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFileUrl(file));
VERIFY_ERRORS(errorFile.toLatin1().constData());
}
// test that errors are reporting correctly for plugin loading and qmldir parsing
void tst_qqmlmoduleplugin::implicitQmldir_data()
{
QTest::addColumn<QString>("directory");
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("errorFile");
// parsing qmldir succeeds, but plugin specified in the qmldir file doesn't exist
QTest::newRow("implicitQmldir") << "implicit1" << "temptest.qml" << "implicitQmldir.errors.txt";
// parsing qmldir fails due to syntax errors, etc.
QTest::newRow("implicitQmldir2") << "implicit2" << "temptest2.qml" << "implicitQmldir.2.errors.txt";
}
void tst_qqmlmoduleplugin::implicitQmldir()
{
QFETCH(QString, directory);
QFETCH(QString, file);
QFETCH(QString, errorFile);
QString importPath = testFile(directory);
QString fileName = directory + QDir::separator() + file;
QString errorFileName = directory + QDir::separator() + errorFile;
QUrl testUrl = testFileUrl(fileName);
QQmlEngine engine;
engine.addImportPath(importPath);
QQmlComponent component(&engine, testUrl);
QList<QQmlError> errors = component.errors();
VERIFY_ERRORS(errorFileName.toLatin1().constData());
QTest::ignoreMessage(QtWarningMsg, "QQmlComponent: Component is not ready");
QObject *obj = component.create();
QVERIFY(!obj);
delete obj;
}
void tst_qqmlmoduleplugin::importsNested_data()
{
QTest::addColumn<QString>("file");
QTest::addColumn<QString>("errorFile");
// Note: no other test case should import the plugin used for this test, or the
// wrong order test will pass spuriously
QTest::newRow("wrongOrder") << "importsNested.1.qml" << "importsNested.1.errors.txt";
QTest::newRow("missingImport") << "importsNested.3.qml" << "importsNested.3.errors.txt";
QTest::newRow("invalidVersion") << "importsNested.4.qml" << "importsNested.4.errors.txt";
QTest::newRow("correctOrder") << "importsNested.2.qml" << QString();
}
void tst_qqmlmoduleplugin::importsNested()
{
QFETCH(QString, file);
QFETCH(QString, errorFile);
// Note: because imports are cached between test case data rows (and the plugins remain loaded),
// these tests should really be run in new instances of the app...
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
if (!errorFile.isEmpty()) {
QTest::ignoreMessage(QtWarningMsg, "QQmlComponent: Component is not ready");
}
static int count = 0;
if (++count == 1)
QTest::ignoreMessage(QtWarningMsg, "Module 'org.qtproject.AutoTestQmlNestedPluginType' does not contain a module identifier directive - it cannot be protected from external registrations.");
QQmlComponent component(&engine, testFile(file));
QObject *obj = component.create();
if (errorFile.isEmpty()) {
if (qgetenv("DEBUG") != "" && !component.errors().isEmpty())
qWarning() << "Unexpected Errors:" << component.errors();
QVERIFY(obj);
delete obj;
} else {
QList<QQmlError> errors = component.errors();
VERIFY_ERRORS(errorFile.toLatin1().constData());
QVERIFY(!obj);
}
}
void tst_qqmlmoduleplugin::importLocalModule()
{
QFETCH(QString, qml);
QFETCH(int, majorVersion);
QFETCH(int, minorVersion);
QQmlEngine engine;
QQmlComponent component(&engine);
component.setData(qml.toUtf8(), testFileUrl("empty.qml"));
QScopedPointer<QObject> object(component.create());
QVERIFY(object != 0);
QCOMPARE(object->property("majorVersion").value<int>(), majorVersion);
QCOMPARE(object->property("minorVersion").value<int>(), minorVersion);
}
void tst_qqmlmoduleplugin::importLocalModule_data()
{
QTest::addColumn<QString>("qml");
QTest::addColumn<int>("majorVersion");
QTest::addColumn<int>("minorVersion");
QTest::newRow("default version")
<< "import \"localModule\"\n"
"TestComponent {}"
<< 2 << 0;
QTest::newRow("specific version")
<< "import \"localModule\" 1.1\n"
"TestComponent {}"
<< 1 << 1;
QTest::newRow("lesser version")
<< "import \"localModule\" 1.0\n"
"TestComponent {}"
<< 1 << 0;
// Note: this does not match the behaviour of installed modules, which fail for this case:
QTest::newRow("nonexistent version")
<< "import \"localModule\" 1.3\n"
"TestComponent {}"
<< 1 << 1;
QTest::newRow("high version")
<< "import \"localModule\" 2.0\n"
"TestComponent {}"
<< 2 << 0;
}
void tst_qqmlmoduleplugin::importStrictModule()
{
QFETCH(QString, qml);
QFETCH(QString, warning);
QFETCH(QString, error);
if (!warning.isEmpty())
QTest::ignoreMessage(QtWarningMsg, qPrintable(warning));
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QUrl url(testFileUrl("empty.qml"));
QQmlComponent component(&engine);
component.setData(qml.toUtf8(), url);
if (error.isEmpty()) {
QScopedPointer<QObject> object(component.create());
QVERIFY(object != 0);
} else {
QVERIFY(!component.isReady());
QCOMPARE(component.errors().count(), 1);
QCOMPARE(component.errors().first().toString(), url.toString() + error);
}
}
void tst_qqmlmoduleplugin::importStrictModule_data()
{
QTest::addColumn<QString>("qml");
QTest::addColumn<QString>("warning");
QTest::addColumn<QString>("error");
QTest::newRow("success")
<< "import org.qtproject.StrictModule 1.0\n"
"MyPluginType {}"
<< QString()
<< QString();
QTest::newRow("two strict modules with different major version")
<< "import org.qtproject.StrictModule 1.0\n"
"import org.qtproject.StrictModule 2.0\n"
"MyPluginType {}"
<< QString()
<< QString();
QTest::newRow("old namespaced strict module")
<< "import org.qtproject.StrictModule 1.0 as Old\n"
"import org.qtproject.StrictModule 2.0 as New\n"
"Old.MyPluginType {}"
<< QString()
<< QString();
QTest::newRow("new namespaced strict modules")
<< "import org.qtproject.StrictModule 1.0 as Old\n"
"import org.qtproject.StrictModule 2.0 as New\n"
"New.MyPluginType {}"
<< QString()
<< QString();
QTest::newRow("wrong target")
<< "import org.qtproject.InvalidStrictModule 1.0\n"
"MyPluginType {}"
<< QString()
<< ":1:1: plugin cannot be loaded for module \"org.qtproject.InvalidStrictModule\": Cannot install element 'MyPluginType' into unregistered namespace 'org.qtproject.SomeOtherModule'";
QTest::newRow("non-strict clash")
<< "import org.qtproject.NonstrictModule 1.0\n"
"MyPluginType {}"
<< "Module 'org.qtproject.NonstrictModule' does not contain a module identifier directive - it cannot be protected from external registrations."
<< ":1:1: plugin cannot be loaded for module \"org.qtproject.NonstrictModule\": Cannot install element 'MyPluginType' into protected namespace 'org.qtproject.StrictModule'";
QTest::newRow("non-strict preemption")
<< "import org.qtproject.PreemptiveModule 1.0\n"
"import org.qtproject.PreemptedStrictModule 1.0\n"
"MyPluginType {}"
<< "Module 'org.qtproject.PreemptiveModule' does not contain a module identifier directive - it cannot be protected from external registrations."
<< ":2:1: plugin cannot be loaded for module \"org.qtproject.PreemptedStrictModule\": Namespace 'org.qtproject.PreemptedStrictModule' has already been used for type registration";
QTest::newRow("invalid namespace")
<< "import org.qtproject.InvalidNamespaceModule 1.0\n"
"MyPluginType {}"
<< QString()
<< ":1:1: plugin cannot be loaded for module \"org.qtproject.InvalidNamespaceModule\": Module namespace 'org.qtproject.AwesomeModule' does not match import URI 'org.qtproject.InvalidNamespaceModule'";
QTest::newRow("module directive must be first")
<< "import org.qtproject.InvalidFirstCommandModule 1.0\n"
"MyPluginType {}"
<< QString()
<< ":1:1: module identifier directive must be the first directive in a qmldir file";
}
void tst_qqmlmoduleplugin::importProtectedModule()
{
//TODO: More than basic test (test errors,test inverse works...)
qmlRegisterType<QObject>("org.qtproject.ProtectedModule", 1, 0, "TestType");
qmlProtectModule("org.qtproject.ProtectedModule", 1);
QQmlEngine engine;
engine.addImportPath(m_importsDirectory);
QUrl url(testFileUrl("empty.qml"));
QString qml = "import org.qtproject.ProtectedModule 1.0\n TestType {}\n";
QQmlComponent component(&engine);
component.setData(qml.toUtf8(), url);
//If plugin is loaded due to import, should assert
QScopedPointer<QObject> object(component.create());
//qDebug() << component.errorString();
QVERIFY(object != 0);
}
QTEST_MAIN(tst_qqmlmoduleplugin)
#include "tst_qqmlmoduleplugin.moc"
Reference in New Issue View Git Blame Copy Permalink