File indexing completed on 2024-04-14 03:54:15

 /*
     SPDX-FileCopyrightText: 2007 Bertjan Broeksema <b.broeksema@kdemail.net>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include "plasmoidpackagetest.h"
 #include "../src/kpackage/config-package.h"
 
 #include <KJob>
 #include <QDir>
 #include <QFile>
 #include <QSignalSpy>
 #include <QStandardPaths>
 #include <kzip.h>
 
 #include <QDebug>
 #include <QJsonDocument>
 #include <QJsonObject>
 #include <qtestcase.h>
 
 #include "packagejob.h"
 #include "packageloader.h"
 #include "private/utils.h"
 
 void PlasmoidPackageTest::initTestCase()
 {
     QStandardPaths::setTestModeEnabled(true);
 }
 
 void PlasmoidPackageTest::init()
 {
     qDebug() << "PlasmoidPackage::init()";
     qRegisterMetaType<KPackage::Package>(); // Needed for signal spy
     m_package = QStringLiteral("Package");
     m_packageRoot = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation) + "/packageRoot";
     const auto pack = KPackage::PackageLoader::self()->loadPackageStructure("Plasma/TestKPackageInternalPlasmoid");
     QVERIFY(pack);
     m_defaultPackage = KPackage::Package(pack);
     cleanup(); // to prevent previous runs from interfering with this one
 }
 
 void PlasmoidPackageTest::cleanup()
 {
     qDebug() << "cleaning up";
     // Clean things up.
     QDir(m_packageRoot).removeRecursively();
 }
 
 void PlasmoidPackageTest::createTestPackage(const QString &packageName, const QString &version)
 {
     qDebug() << "Create test package" << m_packageRoot;
     QDir pRoot(m_packageRoot);
     // Create the root and package dir.
     if (!pRoot.exists()) {
         QVERIFY(QDir().mkpath(m_packageRoot));
     }
 
     // Create the package dir
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + packageName));
     qDebug() << "Created" << (m_packageRoot + "/" + packageName);
 
     // Create the metadata.json file
     QFile file(m_packageRoot + "/" + packageName + "/metadata.json");
 
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     QJsonObject kplugin;
     kplugin.insert(QLatin1String("Id"), packageName);
     kplugin.insert(QLatin1String("Name"), packageName);
     kplugin.insert(QLatin1String("Version"), version);
     QJsonObject root{{QLatin1String("KPlugin"), kplugin}};
 
     QTextStream out(&file);
     file.write(QJsonDocument(root).toJson());
     file.flush();
     file.close();
 
     qDebug() << "OUT: " << packageName;
 
     // Create the ui dir.
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + packageName + "/contents/ui"));
 
     // Create the main file.
     file.setFileName(m_packageRoot + "/" + packageName + "/contents/ui/main.qml");
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     out << "THIS IS A PLASMOID SCRIPT.....";
     file.flush();
     file.close();
 
     qDebug() << "THIS IS A PLASMOID SCRIPT THING";
     // Now we have a minimal plasmoid package which is valid. Let's add some
     // files to it for test purposes.
 
     // Create the images dir.
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + packageName + "/contents/images"));
     file.setFileName(m_packageRoot + "/" + packageName + "/contents/images/image-1.svg");
 
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     out << "<svg>This is a test image</svg>";
     file.flush();
     file.close();
 
     file.setFileName(m_packageRoot + "/" + packageName + "/contents/images/image-2.svg");
 
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     out.setDevice(&file);
     out << "<svg>This is another test image</svg>";
     file.flush();
     file.close();
 
     // Create the scripts dir.
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + packageName + "/contents/code"));
 
     // Create 2 js files
     file.setFileName(m_packageRoot + "/" + packageName + "/contents/code/script.js");
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     out << "THIS IS A SCRIPT.....";
     file.flush();
     file.close();
 }
 
 void PlasmoidPackageTest::isValid()
 {
     KPackage::Package p(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
 #ifndef NDEBUG
     qDebug() << "package path is" << p.path();
 #endif
 
     // A PlasmoidPackage is valid when:
     // - The package root exists.
     // - The package root consists an file named "ui/main.qml"
     QVERIFY(!p.isValid());
 
     // Create the root and package dir.
     QVERIFY(QDir().mkpath(m_packageRoot));
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + m_package));
 
     // Should still be invalid.
     p = KPackage::Package(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
     QVERIFY(!p.isValid());
 
     // Create the ui dir.
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + m_package + "/contents/ui"));
 
     // No main file yet so should still be invalid.
     p = KPackage::Package(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
     QVERIFY(!p.isValid());
 
     // Create the main file.
     QFile file(m_packageRoot + "/" + m_package + "/contents/ui/main.qml");
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     QTextStream out(&file);
     out << "THIS IS A PLASMOID SCRIPT.....\n";
     file.flush();
     file.close();
 
     file.setPermissions(QFile::ReadUser | QFile::WriteUser);
     // Main file exists so should be valid now.
     p = KPackage::Package(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
     QVERIFY(p.isValid());
     QCOMPARE(p.cryptographicHash(QCryptographicHash::Sha1), QByteArrayLiteral("468c7934dfa635986a85e3364363b1f39d157cd5"));
 }
 
 void PlasmoidPackageTest::filePath()
 {
     // Package::filePath() returns
     // - {package_root}/{package_name}/path/to/file if the file exists
     // - QString() otherwise.
     KPackage::Package p(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
 
     QCOMPARE(p.filePath("scripts", QStringLiteral("main")), QString());
 
     QVERIFY(QDir().mkpath(m_packageRoot + "/" + m_package + "/contents/ui/"));
     QFile file(m_packageRoot + "/" + m_package + "/contents/ui/main.qml");
     QVERIFY(file.open(QIODevice::WriteOnly));
 
     QTextStream out(&file);
     out << "THIS IS A PLASMOID SCRIPT.....";
     file.flush();
     file.close();
 
     // The package is valid by now so a path for code/main should get returned.
     p = KPackage::Package(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
 
     const QString path = QFileInfo(m_packageRoot + "/" + m_package + "/contents/ui/main.qml").canonicalFilePath();
 
     // Two ways to get the same info.
     // 1. Give the file type which refers to a class of files (a directory) in
     //    the package structure and the file name.
     // 2. Give the file type which refers to a file in the package structure.
     //
     // NOTE: scripts, main and mainscript are defined in packages.cpp and are
     //       specific for a PlasmoidPackage.
     QCOMPARE(p.filePath("mainscript"), path);
     QCOMPARE(p.filePath("ui", QStringLiteral("main.qml")), path);
 }
 
 void PlasmoidPackageTest::entryList()
 {
     // Create a package named @p packageName which is valid and has some images.
     createTestPackage(m_package, QStringLiteral("1.1"));
 
     // Create a package object and verify that it is valid.
     KPackage::Package p(m_defaultPackage);
     p.setPath(m_packageRoot + '/' + m_package);
     QVERIFY(p.isValid());
 
     // Now we have a valid package that should contain the following files in
     // given filetypes:
     // fileTye - Files
     // scripts - {"script.js"}
     // images - {"image-1.svg", "image-2.svg"}
     QStringList files = p.entryList("scripts");
     QCOMPARE(files.size(), 1);
     QVERIFY(files.contains(QStringLiteral("script.js")));
 
     files = p.entryList("images");
     QCOMPARE(files.size(), 2);
     QVERIFY(files.contains(QStringLiteral("image-1.svg")));
     QVERIFY(files.contains(QStringLiteral("image-2.svg")));
 }
 
 void PlasmoidPackageTest::createAndInstallPackage()
 {
     qDebug() << "                   ";
     qDebug() << "   CreateAndInstall ";
     createTestPackage(QStringLiteral("plasmoid_to_package"), QStringLiteral("1.1"));
     const QString packagePath = m_packageRoot + '/' + "testpackage.plasmoid";
 
     KZip creator(packagePath);
     QVERIFY(creator.open(QIODevice::WriteOnly));
     creator.addLocalDirectory(m_packageRoot + '/' + "plasmoid_to_package", QStringLiteral("."));
     creator.close();
     QDir rootDir(m_packageRoot + "/plasmoid_to_package");
     rootDir.removeRecursively();
 
     QVERIFY2(QFile::exists(packagePath), qPrintable(packagePath));
 
     KZip package(packagePath);
     QVERIFY(package.open(QIODevice::ReadOnly));
     const KArchiveDirectory *dir = package.directory();
     QVERIFY(dir); //
     QVERIFY(dir->entry(QStringLiteral("metadata.json")));
     const KArchiveEntry *contentsEntry = dir->entry(QStringLiteral("contents"));
     QVERIFY(contentsEntry);
     QVERIFY(contentsEntry->isDirectory());
     const KArchiveDirectory *contents = static_cast<const KArchiveDirectory *>(contentsEntry);
     QVERIFY(contents->entry(QStringLiteral("ui")));
     QVERIFY(contents->entry(QStringLiteral("images")));
 
     KPackage::PackageLoader::self()->addKnownPackageStructure(m_defaultPackageStructure, new KPackage::PackageStructure(this));
     KPackage::Package p;
     qDebug() << "Installing " << packagePath;
     auto job = KPackage::PackageJob::install(m_defaultPackageStructure, packagePath, m_packageRoot);
     connect(job, &KJob::finished, this, [&p, job]() { // clazy:exclude=lambda-in-connect
         p = job->package();
     });
     QSignalSpy spy(job, &KJob::finished);
     QVERIFY(spy.wait(1000));
 
     // is the package instance usable (ie proper path) after the install job has been completed?
     QCOMPARE(p.path(), QString(QDir(m_packageRoot % "/plasmoid_to_package").canonicalPath() + QLatin1Char('/')));
     cleanupPackage(QStringLiteral("plasmoid_to_package"));
 }
 
 void PlasmoidPackageTest::createAndUpdatePackage()
 {
     // does the version number parsing work?
     QVERIFY(isVersionNewer(QStringLiteral("1.1"), QStringLiteral("1.1.1")));
     QVERIFY(!isVersionNewer(QStringLiteral("1.1.1"), QStringLiteral("1.1")));
     QVERIFY(isVersionNewer(QStringLiteral("1.1.1"), QStringLiteral("1.1.2")));
     QVERIFY(isVersionNewer(QStringLiteral("1.1.2"), QStringLiteral("2.1")));
     QVERIFY(isVersionNewer(QStringLiteral("0.1.2"), QStringLiteral("2")));
     QVERIFY(!isVersionNewer(QStringLiteral("1"), QStringLiteral("0.1.2")));
 
     qDebug() << "                   ";
     qDebug() << "   CreateAndUpdate ";
     createTestPackage(QStringLiteral("plasmoid_to_package"), QStringLiteral("1.1"));
     const QString packagePath = m_packageRoot + '/' + "testpackage.plasmoid";
 
     KZip creator(packagePath);
     QVERIFY(creator.open(QIODevice::WriteOnly));
     creator.addLocalDirectory(m_packageRoot + '/' + "plasmoid_to_package", QStringLiteral("."));
     creator.close();
     QDir rootDir(m_packageRoot + "/plasmoid_to_package");
     rootDir.removeRecursively();
 
     QVERIFY(QFile::exists(packagePath));
 
     KZip package(packagePath);
     QVERIFY(package.open(QIODevice::ReadOnly));
     const KArchiveDirectory *dir = package.directory();
     QVERIFY(dir); //
     QVERIFY(dir->entry(QStringLiteral("metadata.json")));
     const KArchiveEntry *contentsEntry = dir->entry(QStringLiteral("contents"));
     QVERIFY(contentsEntry);
     QVERIFY(contentsEntry->isDirectory());
     const KArchiveDirectory *contents = static_cast<const KArchiveDirectory *>(contentsEntry);
     QVERIFY(contents->entry(QStringLiteral("ui")));
     QVERIFY(contents->entry(QStringLiteral("images")));
 
     qDebug() << "Installing " << packagePath;
 
     KJob *job = KPackage::PackageJob::update(m_defaultPackageStructure, packagePath, m_packageRoot);
     connect(job, &KJob::finished, [this, job]() {
         packageInstalled(job);
     });
     QSignalSpy spy(job, &KJob::finished);
     QVERIFY(spy.wait(1000));
 
     // same version, should fail
     job = KPackage::PackageJob::update(m_defaultPackageStructure, packagePath, m_packageRoot);
     QSignalSpy spyFail(job, &KJob::finished);
     QVERIFY(spyFail.wait(1000));
     QVERIFY(job->error() == KPackage::PackageJob::JobError::NewerVersionAlreadyInstalledError);
     qDebug() << job->errorText();
 
     // create a new package with higher version
     createTestPackage(QStringLiteral("plasmoid_to_package"), QStringLiteral("1.2"));
 
     KZip creator2(packagePath);
     QVERIFY(creator2.open(QIODevice::WriteOnly));
     creator2.addLocalDirectory(m_packageRoot + '/' + "plasmoid_to_package", QStringLiteral("."));
     creator2.close();
     QDir rootDir2(m_packageRoot + "/plasmoid_to_package");
     rootDir2.removeRecursively();
 
     KJob *job2 = KPackage::PackageJob::update(m_defaultPackageStructure, packagePath, m_packageRoot);
     connect(job2, &KJob::finished, [this, job2]() {
         packageInstalled(job2);
     });
     QSignalSpy spy2(job2, &KJob::finished);
     QVERIFY(spy2.wait(1000));
 
     cleanupPackage(QStringLiteral("plasmoid_to_package"));
 }
 
 void PlasmoidPackageTest::uncompressPackageWithSubFolder()
 {
     KPackage::PackageStructure *structure = new KPackage::PackageStructure;
     KPackage::Package package(structure);
     package.setPath(QFINDTESTDATA("data/customcontent.tar.gz"));
 
     QCOMPARE(readKPackageType(package.metadata()), "KPackage/CustomContent");
 }
 
 void PlasmoidPackageTest::cleanupPackage(const QString &packageName)
 {
     KJob *j = KPackage::PackageJob::uninstall(m_defaultPackageStructure, packageName, m_packageRoot);
     connect(j, &KJob::finished, [this, j]() {
         packageUninstalled(j);
     });
 
     QSignalSpy spy(j, &KJob::finished);
     QVERIFY(spy.wait(1000));
 }
 
 void PlasmoidPackageTest::packageInstalled(KJob *j)
 {
     QVERIFY2(j->error() == KJob::NoError, qPrintable(j->errorText()));
 }
 
 void PlasmoidPackageTest::packageUninstalled(KJob *j)
 {
     QVERIFY2(j->error() == KJob::NoError, qPrintable(j->errorText()));
 }
 void PlasmoidPackageTest::testInstallNonExistentPackageStructure()
 {
     const QString packageName = "testpackage";
     createTestPackage(packageName, "1.0");
     auto job = KPackage::PackageJob::install("KPackage/DoesNotExist", packageName, m_packageRoot);
     connect(job, &KJob::result, this, [job]() {
         QVERIFY(!job->package().isValid());
         QCOMPARE(job->error(), KPackage::PackageJob::JobError::InvalidPackageStructure);
         QCOMPARE(job->errorText(), "Could not load package structure KPackage/DoesNotExist");
     });
     QSignalSpy spy(job, &KJob::result);
     QVERIFY(spy.wait(1000));
 }
 
 QTEST_MAIN(PlasmoidPackageTest)
 
 #include "moc_plasmoidpackagetest.cpp"