File indexing completed on 2024-05-19 04:41:08

 /*
     SPDX-FileCopyrightText: 2010 Niko Sams <niko.sams@gmail.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include "test_projectload.h"
 
 #include <QTest>
 #include <QSignalSpy>
 #include <QProcess>
 #include <QTemporaryDir>
 #include <QDebug>
 #include <QRandomGenerator>
 
 #include <tests/autotestshell.h>
 #include <tests/testcore.h>
 
 #include <interfaces/icore.h>
 #include <interfaces/iprojectcontroller.h>
 #include <interfaces/iproject.h>
 #include <interfaces/ilanguagecontroller.h>
 
 #include <project/interfaces/iprojectfilemanager.h>
 #include <project/projectmodel.h>
 #include <language/backgroundparser/backgroundparser.h>
 
 #include <KIO/Global>
 
 QTEST_MAIN(TestProjectLoad)
 
 using namespace KDevelop;
 
 namespace {
 
 struct TestProject
 {
     // temp directory of project
     QTemporaryDir* dir;
     // name of the project (random)
     QString name;
     // project file (*.kdev4)
     QUrl file;
     ~TestProject() {
         IProject* p = ICore::self()->projectController()->findProjectByName(name);
         if (p) {
             ICore::self()->projectController()->closeProject(p);
         }
         delete dir;
     }
 };
 
 TestProject makeProject()
 {
     TestProject ret;
     ret.dir = new QTemporaryDir();
     QFileInfo dir(ret.dir->path());
     Q_ASSERT(dir.exists());
     ret.name = dir.fileName();
 
     QStringList projectFileContents;
     projectFileContents
     << QStringLiteral("[Project]")
     << QStringLiteral("Name=") + ret.name
     << QStringLiteral("Manager=KDevGenericManager");
 
     QUrl projecturl = QUrl::fromLocalFile( dir.absoluteFilePath() + "/simpleproject.kdev4" );
     QFile projectFile(projecturl.toLocalFile());
     projectFile.open(QIODevice::WriteOnly);
     projectFile.write(projectFileContents.join(QLatin1Char('\n')).toLatin1());
     projectFile.close();
     ret.file = projecturl;
 
     Q_ASSERT(ret.dir->isValid());
     Q_ASSERT(projecturl.adjusted(QUrl::RemoveFilename).toLocalFile() == ret.dir->path() + '/');
 
     return ret;
 }
 
 bool createFile(const QString& path)
 {
     QFile f(path);
     if (!f.open(QIODevice::WriteOnly)) {
         qWarning() << f.errorString() << path;
         return false;
     }
 
     auto* randomGenerator = QRandomGenerator::global();
     for (int i = 0; i < 4; ++i) {
         f.write(QByteArray::number(randomGenerator->generate()));
     }
 
     if (!f.flush()) {
         qWarning() << f.errorString() << path;
         return false;
     }
 
     f.close();
     return true;
 }
 
 bool writeRandomStructure(QString path, int files)
 {
     QDir p(path);
     const QString name = QString::number(QRandomGenerator::global()->generate());
     if (QRandomGenerator::global()->bounded(5) < 1) {
         if (!p.mkdir(name)) {
             return false;
         }
 
         //qDebug() << "wrote path" << path;
         path += '/' + name;
     } else {
         if (!createFile(path+'/'+name)) {
             return false;
         }
 
         //qDebug() << "wrote file" << path+"/"+name;
     }
     files--;
     if (files > 0) {
         if (!writeRandomStructure(path, files)) {
             return false;
         }
     }
     return true;
 }
 
 bool fillProject(int filesPerDir, int dirs, const TestProject& project, bool wait)
 {
     for(int i=0; i < dirs; ++i) {
         const QString name = "foox" + QString::number(i);
         if (!QDir(project.dir->path()).mkdir(name)) {
             return false;
         }
 
         if (!writeRandomStructure(project.dir->path() + "/" + name, filesPerDir)) {
             return false;
         }
 
         if (wait) {
             QTest::qWait(100);
         }
     }
     return true;
 }
 }
 
 void TestProjectLoad::initTestCase()
 {
     AutoTestShell::init({QStringLiteral("KDevGenericManager")});
     TestCore::initialize();
     ICore::self()->languageController()->backgroundParser()->disableProcessing();
 
     qRegisterMetaType<IProject*>();
 
     const auto projects = ICore::self()->projectController()->projects();
     for (IProject* p : projects) {
         ICore::self()->projectController()->closeProject(p);
     }
 }
 
 void TestProjectLoad::cleanupTestCase()
 {
     TestCore::shutdown();
 }
 
 void TestProjectLoad::init()
 {
     const auto projects = ICore::self()->projectController()->projects();
     for (IProject* p : projects) {
         ICore::self()->projectController()->closeProject(p);
     }
     QCOMPARE(ICore::self()->projectController()->projects().size(), 0);
 }
 
 void TestProjectLoad::addRemoveFiles()
 {
     const TestProject p = makeProject();
 
     createFile(p.dir->path()+"/sdf");
 
     ICore::self()->projectController()->openProject(p.file);
     QTRY_COMPARE(ICore::self()->projectController()->projects().size(), 1);
     IProject* project = ICore::self()->projectController()->projects().first();
     QCOMPARE(project->projectFile().toUrl(), p.file);
 
     //KDirWatch adds/removes the file automatically
     for (int i=0; i<100; ++i) {
         createFile(p.dir->path()+"/blub"+QString::number(i));
     }
     for (int i=0; i<50; ++i) {
         QFile::remove(p.dir->path()+"/blub"+QString::number(i));
     }
     QTRY_COMPARE(project->projectItem()->fileList().count(), 51);
 
     QUrl url = QUrl::fromLocalFile(p.dir->path()+"/blub"+QString::number(50)).adjusted(QUrl::NormalizePathSegments);
     QCOMPARE(project->filesForPath(IndexedString(url)).count(), 1);
     ProjectFileItem* file = project->filesForPath(IndexedString(url)).at(0);
     project->projectFileManager()->removeFilesAndFolders(QList<ProjectBaseItem*>() << file ); //message box has to be accepted manually :(
     QTRY_COMPARE(project->projectItem()->fileList().count(), 50);
 
     for (int i=51; i<100; ++i) {
         QFile::remove(p.dir->path()+"/blub"+QString::number(i));
     }
 
     QTRY_COMPARE(project->projectItem()->fileList().count(), 1);
 }
 
 void TestProjectLoad::removeDirRecursive()
 {
     const TestProject p = makeProject();
 
     createFile(p.dir->path()+"/sdf");
     {
         QDir d(p.dir->path());
         QVERIFY(d.mkdir(QStringLiteral("blub")));
         QVERIFY(d.cd(QStringLiteral("blub")));
         for (int i=0; i<10; ++i) {
             createFile(d.filePath("file"+QString::number(i)));
         }
     }
 
     QVERIFY(ICore::self()->projectController()->projects().isEmpty());
 
     ICore::self()->projectController()->openProject(p.file);
     QTRY_COMPARE(ICore::self()->projectController()->projects().size(), 1);
     IProject* project = ICore::self()->projectController()->projects().first();
     QCOMPARE(project->projectFile().toUrl(), p.file);
 
     for (int i=0; i<1; ++i) {
         QUrl url = QUrl::fromLocalFile(p.dir->path()+"/blub").adjusted(QUrl::NormalizePathSegments);
         QCOMPARE(project->foldersForPath(IndexedString(url)).count(), 1);
 
         ProjectFolderItem* file = project->foldersForPath(IndexedString(url)).at(0);
         project->projectFileManager()->removeFilesAndFolders(QList<ProjectBaseItem*>() << file );
     }
 
     QTRY_COMPARE(project->projectItem()->fileList().count(), 1);
 }
 
 void TestProjectLoad::addLotsOfFiles()
 {
     TestProject p = makeProject();
 
     ICore::self()->projectController()->openProject(p.file);
     QTRY_COMPARE(ICore::self()->projectController()->projects().size(), 1);
     IProject* project = ICore::self()->projectController()->projects().first();
     QCOMPARE(project->projectFile().toUrl(), p.file);
 
     QVERIFY(fillProject(50, 25, p, true));
 
     QTest::qWait(2000);
 }
 
 void TestProjectLoad::addMultipleJobs()
 {
     const TestProject p1 = makeProject();
     QVERIFY(fillProject(10, 25, p1, false));
     const TestProject p2 = makeProject();
     QVERIFY(fillProject(10, 25, p2, false));
 
     ICore::self()->projectController()->openProject(p1.file);
     ICore::self()->projectController()->openProject(p2.file);
 
     QTRY_COMPARE(ICore::self()->projectController()->projects().size(), 2);
 }
 
 void TestProjectLoad::raceJob()
 {
     // our goal here is to try to reproduce https://bugs.kde.org/show_bug.cgi?id=260741
     // my idea is that this can be triggered by the following:
     // - list dir foo/bar containing lots of files
     // - remove dir foo while listjob is still running
     TestProject p = makeProject();
     QDir dir(p.dir->path());
     QVERIFY(dir.mkpath(QStringLiteral("test/zzzzz")));
     for(int i = 0; i < 1000; ++i) {
         createFile(QString(p.dir->path() + "/test/zzzzz/%1").arg(i));
         createFile(QString(p.dir->path() + "/test/%1").arg(i));
     }
 
     ICore::self()->projectController()->openProject(p.file);
     QTRY_COMPARE(ICore::self()->projectController()->projectCount(), 1);
     IProject *project = ICore::self()->projectController()->projectAt(0);
     QCOMPARE(project->projectFile().toUrl(), p.file);
     ProjectFolderItem* root = project->projectItem();
     QCOMPARE(root->project(), project);
     QVERIFY(root->model());
     QCOMPARE(root->rowCount(), 1);
     ProjectBaseItem* testItem = root->child(0);
     QVERIFY(testItem->folder());
     QCOMPARE(testItem->baseName(), QStringLiteral("test"));
     QCOMPARE(testItem->rowCount(), 1001);
     int last = testItem->children().size() - 1;
     ProjectBaseItem* asdfItem = testItem->children().at(last);
     QVERIFY(asdfItem->folder());
 
     // reload to trigger new list job
     project->projectFileManager()->reload(testItem->folder());
     // move dir
     QVERIFY(dir.rename(QStringLiteral("test"), QStringLiteral("test2")));
     // move sub dir
     QVERIFY(dir.rename(QStringLiteral("test2/zzzzz"), QStringLiteral("test2/bla")));
 
     QTRY_COMPARE(root->rowCount() == 1 ? root->child(0)->baseName() : QString(), QStringLiteral("test2"));
 
     // reload full model and then move dir
     project->reloadModel();
     QVERIFY(dir.rename(QStringLiteral("test2"), QStringLiteral("test3")));
 
     // note: this actually invalidates the root, so query that again
     root = project->projectItem();
     QVERIFY(root);
 
     QTRY_COMPARE(root->rowCount() == 1 ? root->child(0)->baseName() : QString(), QStringLiteral("test3"));
 }
 
 void TestProjectLoad::addDuringImport()
 {
     // our goal here is to try to reproduce an issue in the optimized filesForPath implementation
     // which requires the project to be associated to the model to function properly
     // to trigger this we create a big project, import it and then call filesForPath during
     // the import action
     TestProject p = makeProject();
     QDir dir(p.dir->path());
     QVERIFY(dir.mkpath(QStringLiteral("test/zzzzz")));
     for(int i = 0; i < 1000; ++i) {
         createFile(QString(p.dir->path() + "/test/zzzzz/%1").arg(i));
         createFile(QString(p.dir->path() + "/test/%1").arg(i));
     }
 
     QSignalSpy spy(ICore::self()->projectController(),
                    SIGNAL(projectAboutToBeOpened(KDevelop::IProject*)));
     ICore::self()->projectController()->openProject(p.file);
     // not yet ready
     QCOMPARE(ICore::self()->projectController()->projectCount(), 0);
     // but about to be opened
     QCOMPARE(spy.count(), 1);
     auto* project = spy.value(0).at(0).value<IProject*>();
     QVERIFY(project);
     QCOMPARE(project->path(), Path(KIO::upUrl(p.file)));
     QUrl file = p.file.resolved(QUrl(QStringLiteral("test/zzzzz/999")));
     QVERIFY(QFile::exists(file.toLocalFile()));
     // this most probably is not yet loaded
     // and this should not crash
     QCOMPARE(project->itemsForPath(IndexedString(file)).size(), 0);
     // now delete that file and don't crash
     QFile::remove(file.toLocalFile());
     // now create another file
     QUrl file2 = file.adjusted(QUrl::RemoveFilename);
     file2.setPath(file2.path() + "999v2");
     createFile(file2.toLocalFile());
     QVERIFY(!project->isReady());
     // now wait for finish
     QTRY_VERIFY(project->isReady());
     // make sure our file removal + addition was properly tracked
     QCOMPARE(project->filesForPath(IndexedString(file)).size(), 0);
     QCOMPARE(project->filesForPath(IndexedString(file2)).size(), 1);
 
     //NOTE: this test is probably incomplete, I bet there are some race conditions left,
     //      esp. when adding a file at a point where the parent folder was already imported
     //      or removing a file that was already imported
 }
 
 #include "moc_test_projectload.cpp"