cppmodelmanager_test.cpp 37.5 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "cpptoolsplugin.h"
31
#include "cpppreprocessor.h"
32
#include "cpptoolseditorsupport.h"
33 34
#include "modelmanagertesthelper.h"

35
#include <coreplugin/editormanager/editormanager.h>
36
#include <coreplugin/testdatadir.h>
37 38
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
39
#include <utils/hostosinfo.h>
40

41
#include <QDebug>
42 43
#include <QFileInfo>
#include <QtTest>
44

45 46 47 48 49 50
#if  QT_VERSION >= 0x050000
#define MSKIP_SINGLE(x) QSKIP(x)
#else
#define MSKIP_SINGLE(x) QSKIP(x, SkipSingle)
#endif

51
using namespace CppTools::Internal;
hjk's avatar
hjk committed
52
using namespace ProjectExplorer;
53

54
typedef CPlusPlus::Document Document;
55 56 57
typedef CppTools::CppModelManagerInterface::ProjectInfo ProjectInfo;
typedef CppTools::ProjectPart ProjectPart;
typedef CppTools::ProjectFile ProjectFile;
58

Orgad Shaneh's avatar
Orgad Shaneh committed
59
Q_DECLARE_METATYPE(QList<ProjectFile>)
60

61 62
namespace {

63 64
inline QString _(const QByteArray &ba) { return QString::fromLatin1(ba, ba.size()); }

65
class MyTestDataDir : public Core::Internal::Tests::TestDataDir
66
{
67
public:
68
    MyTestDataDir(const QString &dir)
69
        : TestDataDir(_(SRCDIR "/../../../tests/cppmodelmanager/") + dir)
70
    {}
71

72
    QString includeDir(bool cleaned = true) const
73
    { return directory(_("include"), cleaned); }
74 75

    QString frameworksDir(bool cleaned = true) const
76
    { return directory(_("frameworks"), cleaned); }
77 78

    QString fileFromSourcesDir(const QString &fileName) const
79
    { return directory(_("sources")) + fileName; }
80 81
};

82 83 84 85 86 87 88 89 90 91 92
// TODO: When possible, use this helper class in all tests
class ProjectCreator
{
public:
    ProjectCreator(ModelManagerTestHelper *modelManagerTestHelper)
        : modelManagerTestHelper(modelManagerTestHelper)
    {}

    /// 'files' is expected to be a list of file names that reside in 'dir'.
    void create(const QString &name, const QString &dir, const QStringList files)
    {
93
        const MyTestDataDir projectDir(dir);
94 95 96 97 98 99 100 101 102 103 104 105 106 107
        foreach (const QString &file, files)
            projectFiles << projectDir.file(file);

        Project *project = modelManagerTestHelper->createProject(name);
        projectInfo = CppModelManager::instance()->projectInfo(project);
        QCOMPARE(projectInfo.project().data(), project);

        ProjectPart::Ptr part(new ProjectPart);
        part->cxxVersion = ProjectPart::CXX98;
        part->qtVersion = ProjectPart::Qt5;
        foreach (const QString &file, projectFiles) {
            ProjectFile projectFile(file, ProjectFile::classify(file));
            part->files.append(projectFile);
        }
108
        projectInfo.appendProjectPart(part);
109 110 111 112 113 114 115
    }

    ModelManagerTestHelper *modelManagerTestHelper;
    ProjectInfo projectInfo;
    QStringList projectFiles;
};

116 117 118 119 120 121 122 123
/// Open and configure given project as example project and remove
/// generated *.user file on destruction.
///
/// Requirement: No *.user file exists for the project.
class ExampleProjectConfigurator
{
public:
    ExampleProjectConfigurator(const QString &projectFile,
hjk's avatar
hjk committed
124
                               ProjectExplorerPlugin *projectExplorer)
125
    {
126
        const QString projectUserFile = projectFile + _(".user");
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
        QVERIFY(!QFileInfo(projectUserFile).exists());

        // Open project
        QString errorOpeningProject;
        m_project = projectExplorer->openProject(projectFile, &errorOpeningProject);
        QVERIFY(m_project);
        QVERIFY(errorOpeningProject.isEmpty());

        // Configure project
        m_project->configureAsExampleProject(QStringList());

        m_fileToRemove = projectUserFile;
    }

    ~ExampleProjectConfigurator()
    {
        QVERIFY(!m_fileToRemove.isEmpty());
        QVERIFY(QFile::remove(m_fileToRemove));
    }

hjk's avatar
hjk committed
147
    Project *project() const
148 149 150 151 152
    {
        return m_project;
    }

private:
hjk's avatar
hjk committed
153
    Project *m_project;
154 155
    QString m_fileToRemove;
};
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
/// Changes a file on the disk and restores its original contents on destruction
class FileChangerAndRestorer
{
public:
    FileChangerAndRestorer(const QString &filePath)
        : m_filePath(filePath)
    {
    }

    ~FileChangerAndRestorer()
    {
        restoreContents();
    }

    /// Saves the contents also internally so it can be restored on destruction
    bool readContents(QByteArray *contents)
    {
        Utils::FileReader fileReader;
        const bool isFetchOk = fileReader.fetch(m_filePath);
        if (isFetchOk) {
            m_originalFileContents = fileReader.data();
            if (contents)
                *contents = m_originalFileContents;
        }
        return isFetchOk;
    }

    void writeContents(const QByteArray &contents) const
    {
        Utils::FileSaver fileSaver(m_filePath);
        fileSaver.write(contents);
        fileSaver.finalize();
    }

private:
    void restoreContents() const
    {
        Utils::FileSaver fileSaver(m_filePath);
        fileSaver.write(m_originalFileContents);
        fileSaver.finalize();
    }

    QByteArray m_originalFileContents;
    const QString &m_filePath;
};

203 204 205 206 207 208 209 210 211
static QStringList updateProjectInfo(CppModelManager *modelManager, ModelManagerTestHelper *helper,
                                     const ProjectInfo &projectInfo)
{
    helper->resetRefreshedSourceFiles();
    modelManager->updateProjectInfo(projectInfo).waitForFinished();
    QCoreApplication::processEvents();
    return helper->waitForRefreshedSourceFiles();
}

212 213
} // anonymous namespace

214 215
/// Check: The preprocessor cleans include and framework paths.
void CppToolsPlugin::test_modelmanager_paths_are_clean()
216 217 218 219
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

220
    const MyTestDataDir testDataDir(_("testdata"));
221

222
    Project *project = helper.createProject(_("test_modelmanager_paths_are_clean"));
223 224 225 226
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
227
    part->cxxVersion = ProjectPart::CXX98;
228
    part->qtVersion = ProjectPart::Qt5;
229
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
230 231
    part->includePaths = QStringList() << testDataDir.includeDir(false);
    part->frameworkPaths = QStringList() << testDataDir.frameworksDir(false);
232
    pi.appendProjectPart(part);
233 234 235 236 237

    mm->updateProjectInfo(pi);

    QStringList includePaths = mm->includePaths();
    QCOMPARE(includePaths.size(), 1);
238
    QVERIFY(includePaths.contains(testDataDir.includeDir()));
239 240 241

    QStringList frameworkPaths = mm->frameworkPaths();
    QCOMPARE(frameworkPaths.size(), 1);
242
    QVERIFY(frameworkPaths.contains(testDataDir.frameworksDir()));
243
}
244

245
/// Check: Frameworks headers are resolved.
246 247
void CppToolsPlugin::test_modelmanager_framework_headers()
{
248 249 250
    if (Utils::HostOsInfo::isWindowsHost())
        MSKIP_SINGLE("Can't resolve framework soft links on Windows.");

251 252 253
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

254
    const MyTestDataDir testDataDir(_("testdata"));
255

256
    Project *project = helper.createProject(_("test_modelmanager_framework_headers"));
257 258 259 260
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
261
    part->cxxVersion = ProjectPart::CXX98;
262
    part->qtVersion = ProjectPart::Qt5;
263
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
264 265 266
    part->includePaths << testDataDir.includeDir();
    part->frameworkPaths << testDataDir.frameworksDir();
    const QString &source = testDataDir.fileFromSourcesDir(
267
        _("test_modelmanager_framework_headers.cpp"));
268
    part->files << ProjectFile(source, ProjectFile::CXXSource);
269
    pi.appendProjectPart(part);
270

271
    mm->updateProjectInfo(pi).waitForFinished();
272 273
    QCoreApplication::processEvents();

274 275
    QVERIFY(mm->snapshot().contains(source));
    Document::Ptr doc = mm->snapshot().document(source);
276 277 278 279 280 281 282 283 284 285 286 287 288 289
    QVERIFY(!doc.isNull());
    CPlusPlus::Namespace *ns = doc->globalNamespace();
    QVERIFY(ns);
    QVERIFY(ns->memberCount() > 0);
    for (unsigned i = 0, ei = ns->memberCount(); i < ei; ++i) {
        CPlusPlus::Symbol *s = ns->memberAt(i);
        QVERIFY(s);
        QVERIFY(s->name());
        const CPlusPlus::Identifier *id = s->name()->asNameId();
        QVERIFY(id);
        QByteArray chars = id->chars();
        QVERIFY(chars.startsWith("success"));
    }
}
290 291

/// QTCREATORBUG-9056
292 293 294
/// Check: If the project configuration changes, all project files and their
///        includes have to be reparsed.
void CppToolsPlugin::test_modelmanager_refresh_also_includes_of_project_files()
295 296 297 298
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

299
    const MyTestDataDir testDataDir(_("testdata"));
300

301 302
    const QString testCpp(testDataDir.fileFromSourcesDir(_("test_modelmanager_refresh.cpp")));
    const QString testHeader(testDataDir.fileFromSourcesDir( _("test_modelmanager_refresh.h")));
303

304
    Project *project = helper.createProject(
305
                _("test_modelmanager_refresh_also_includes_of_project_files"));
306 307 308 309 310 311
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
312
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
313
    part->includePaths = QStringList() << testDataDir.includeDir(false);
314
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
315
    pi.appendProjectPart(part);
316

317
    QStringList refreshedFiles = updateProjectInfo(mm, &helper, pi);
318 319 320 321 322 323
    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    CPlusPlus::Snapshot snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));

324 325 326 327
    Document::Ptr headerDocumentBefore = snapshot.document(testHeader);
    const QList<CPlusPlus::Macro> macrosInHeaderBefore = headerDocumentBefore->definedMacros();
    QCOMPARE(macrosInHeaderBefore.size(), 1);
    QVERIFY(macrosInHeaderBefore.first().name() == "test_modelmanager_refresh_h");
328

329
    // Introduce a define that will enable another define once the document is reparsed.
330
    part->projectDefines = QByteArray("#define TEST_DEFINE 1\n");
331 332
    pi.clearProjectParts();
    pi.appendProjectPart(part);
333

334
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
335 336 337 338 339 340

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));
341 342 343 344 345 346

    Document::Ptr headerDocumentAfter = snapshot.document(testHeader);
    const QList<CPlusPlus::Macro> macrosInHeaderAfter = headerDocumentAfter->definedMacros();
    QCOMPARE(macrosInHeaderAfter.size(), 2);
    QVERIFY(macrosInHeaderAfter.at(0).name() == "test_modelmanager_refresh_h");
    QVERIFY(macrosInHeaderAfter.at(1).name() == "TEST_DEFINE_DEFINED");
347
}
348 349

/// QTCREATORBUG-9205
350 351 352
/// Check: When reparsing the same files again, no errors occur
///        (The CppPreprocessor's already seen files are properly cleared!).
void CppToolsPlugin::test_modelmanager_refresh_several_times()
353 354 355 356
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

357
    const MyTestDataDir testDataDir(_("testdata_refresh"));
358

359 360 361
    const QString testHeader1(testDataDir.file(_("defines.h")));
    const QString testHeader2(testDataDir.file(_("header.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
362

363
    Project *project = helper.createProject(_("test_modelmanager_refresh_several_times"));
364 365 366 367 368 369 370 371 372
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
    part->files.append(ProjectFile(testHeader1, ProjectFile::CXXHeader));
    part->files.append(ProjectFile(testHeader2, ProjectFile::CXXHeader));
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
373
    pi.appendProjectPart(part);
374 375 376 377 378 379
    mm->updateProjectInfo(pi);

    CPlusPlus::Snapshot snapshot;
    QStringList refreshedFiles;
    CPlusPlus::Document::Ptr document;

380
    QByteArray defines = "#define FIRST_DEFINE";
381
    for (int i = 0; i < 2; ++i) {
382 383 384 385
        pi.clearProjectParts();
        ProjectPart::Ptr part(new ProjectPart);
        // Simulate project configuration change by having different defines each time.
        defines += "\n#define ANOTHER_DEFINE";
386
        part->projectDefines = defines;
387 388 389 390 391 392 393
        part->cxxVersion = ProjectPart::CXX98;
        part->qtVersion = ProjectPart::Qt5;
        part->files.append(ProjectFile(testHeader1, ProjectFile::CXXHeader));
        part->files.append(ProjectFile(testHeader2, ProjectFile::CXXHeader));
        part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
        pi.appendProjectPart(part);

394
        refreshedFiles = updateProjectInfo(mm, &helper, pi);
395
        QCOMPARE(refreshedFiles.size(), 3);
396

397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
        QVERIFY(refreshedFiles.contains(testHeader1));
        QVERIFY(refreshedFiles.contains(testHeader2));
        QVERIFY(refreshedFiles.contains(testCpp));

        snapshot = mm->snapshot();
        QVERIFY(snapshot.contains(testHeader1));
        QVERIFY(snapshot.contains(testHeader2));
        QVERIFY(snapshot.contains(testCpp));

        // No diagnostic messages expected
        document = snapshot.document(testHeader1);
        QVERIFY(document->diagnosticMessages().isEmpty());

        document = snapshot.document(testHeader2);
        QVERIFY(document->diagnosticMessages().isEmpty());

        document = snapshot.document(testCpp);
        QVERIFY(document->diagnosticMessages().isEmpty());
    }
}
417

418 419 420 421 422 423 424
/// QTCREATORBUG-9581
/// Check: If nothing has changes, nothing should be reindexed.
void CppToolsPlugin::test_modelmanager_refresh_test_for_changes()
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

425 426
    const MyTestDataDir testDataDir(_("testdata_refresh"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
427

428
    Project *project = helper.createProject(_("test_modelmanager_refresh_2"));
429 430 431 432 433 434 435 436 437 438
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    pi.appendProjectPart(part);

    // Reindexing triggers a reparsing thread
439
    helper.resetRefreshedSourceFiles();
440 441
    QFuture<void> firstFuture = mm->updateProjectInfo(pi);
    QVERIFY(firstFuture.isStarted() || firstFuture.isRunning());
442
    firstFuture.waitForFinished();
443 444 445 446 447 448 449 450 451
    const QStringList refreshedFiles = helper.waitForRefreshedSourceFiles();
    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));

    // No reindexing since nothing has changed
    QFuture<void> subsequentFuture = mm->updateProjectInfo(pi);
    QVERIFY(subsequentFuture.isCanceled() && subsequentFuture.isFinished());
}

452 453 454 455 456 457 458
/// Check: (1) Added project files are recognized and parsed.
/// Check: (2) Removed project files are recognized and purged from the snapshot.
void CppToolsPlugin::test_modelmanager_refresh_added_and_purge_removed()
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

459
    const MyTestDataDir testDataDir(_("testdata_refresh"));
460

461 462 463
    const QString testHeader1(testDataDir.file(_("header.h")));
    const QString testHeader2(testDataDir.file(_("defines.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
464

465
    Project *project = helper.createProject(_("test_modelmanager_refresh_3"));
466 467 468 469 470 471 472 473 474 475 476 477 478
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    part->files.append(ProjectFile(testHeader1, ProjectFile::CXXHeader));
    pi.appendProjectPart(part);

    CPlusPlus::Snapshot snapshot;
    QStringList refreshedFiles;

479
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

    QCOMPARE(refreshedFiles.size(), 2);
    QVERIFY(refreshedFiles.contains(testHeader1));
    QVERIFY(refreshedFiles.contains(testCpp));

    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader1));
    QVERIFY(snapshot.contains(testCpp));

    // Now add testHeader2 and remove testHeader1
    pi.clearProjectParts();
    ProjectPart::Ptr newPart(new ProjectPart);
    newPart->cxxVersion = ProjectPart::CXX98;
    newPart->qtVersion = ProjectPart::Qt5;
    newPart->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    newPart->files.append(ProjectFile(testHeader2, ProjectFile::CXXHeader));
    pi.appendProjectPart(newPart);

498
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521

    // Only the added project file was reparsed
    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testHeader2));

    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader2));
    QVERIFY(snapshot.contains(testCpp));
    // The removed project file is not anymore in the snapshot
    QVERIFY(!snapshot.contains(testHeader1));
}

/// Check: Timestamp modified files are reparsed if project files are added or removed
///        while the project configuration stays the same
void CppToolsPlugin::test_modelmanager_refresh_timeStampModified_if_sourcefiles_change()
{
    QFETCH(QString, fileToChange);
    QFETCH(QList<ProjectFile>, initialProjectFiles);
    QFETCH(QList<ProjectFile>, finalProjectFiles);

    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

522
    Project *project = helper.createProject(_("test_modelmanager_refresh_timeStampModified"));
523 524 525 526 527 528 529 530 531 532 533 534 535 536
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
    foreach (const ProjectFile &file, initialProjectFiles)
        part->files.append(file);
    pi.appendProjectPart(part);

    Document::Ptr document;
    CPlusPlus::Snapshot snapshot;
    QStringList refreshedFiles;

537
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

    QCOMPARE(refreshedFiles.size(), initialProjectFiles.size());
    snapshot = mm->snapshot();
    foreach (const ProjectFile &file, initialProjectFiles) {
        QVERIFY(refreshedFiles.contains(file.path));
        QVERIFY(snapshot.contains(file.path));
    }

    document = snapshot.document(fileToChange);
    const QDateTime lastModifiedBefore = document->lastModified();
    QCOMPARE(document->globalSymbolCount(), 1U);
    QCOMPARE(document->globalSymbolAt(0)->name()->identifier()->chars(), "someGlobal");

    // Modify the file
    QTest::qSleep(1000); // Make sure the timestamp is different
    FileChangerAndRestorer fileChangerAndRestorer(fileToChange);
    QByteArray originalContents;
    QVERIFY(fileChangerAndRestorer.readContents(&originalContents));
    const QByteArray newFileContentes = originalContents + "\nint addedOtherGlobal;";
    fileChangerAndRestorer.writeContents(newFileContentes);

    // Add or remove source file. The configuration stays the same.
    part->files.clear();
    foreach (const ProjectFile &file, finalProjectFiles)
        part->files.append(file);
    pi.clearProjectParts();
    pi.appendProjectPart(part);

566
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587

    QCOMPARE(refreshedFiles.size(), finalProjectFiles.size());
    snapshot = mm->snapshot();
    foreach (const ProjectFile &file, finalProjectFiles) {
        QVERIFY(refreshedFiles.contains(file.path));
        QVERIFY(snapshot.contains(file.path));
    }
    document = snapshot.document(fileToChange);
    const QDateTime lastModifiedAfter = document->lastModified();
    QVERIFY(lastModifiedAfter > lastModifiedBefore);
    QCOMPARE(document->globalSymbolCount(), 2U);
    QCOMPARE(document->globalSymbolAt(0)->name()->identifier()->chars(), "someGlobal");
    QCOMPARE(document->globalSymbolAt(1)->name()->identifier()->chars(), "addedOtherGlobal");
}

void CppToolsPlugin::test_modelmanager_refresh_timeStampModified_if_sourcefiles_change_data()
{
    QTest::addColumn<QString>("fileToChange");
    QTest::addColumn<QList<ProjectFile> >("initialProjectFiles");
    QTest::addColumn<QList<ProjectFile> >("finalProjectFiles");

588 589 590
    const MyTestDataDir testDataDir(_("testdata_refresh2"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
    const QString testCpp2(testDataDir.file(_("source2.cpp")));
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

    const QString fileToChange = testCpp;
    QList<ProjectFile> projectFiles1 = QList<ProjectFile>()
        << ProjectFile(testCpp, ProjectFile::CXXSource);
    QList<ProjectFile> projectFiles2 = QList<ProjectFile>()
        << ProjectFile(testCpp, ProjectFile::CXXSource)
        << ProjectFile(testCpp2, ProjectFile::CXXSource);

    // Add a file
    QTest::newRow("case: add project file") << fileToChange << projectFiles1 << projectFiles2;

    // Remove a file
    QTest::newRow("case: remove project file") << fileToChange << projectFiles2 << projectFiles1;
}

606 607
/// Check: If a second project is opened, the code model is still aware of
///        files of the first project.
608 609 610 611 612 613 614 615 616
void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
{
    QStringList refreshedFiles;
    ModelManagerTestHelper helper;
    ProjectCreator project1(&helper);
    ProjectCreator project2(&helper);
    CppModelManager *mm = CppModelManager::instance();

    // Project 1
617 618 619 620 621
    project1.create(_("test_modelmanager_snapshot_after_two_projects.1"),
                    _("testdata_project1"),
                    QStringList() << _("foo.h")
                                  << _("foo.cpp")
                                  << _("main.cpp"));
622

623
    refreshedFiles = updateProjectInfo(mm, &helper, project1.projectInfo);
624 625 626 627 628 629 630
    QCOMPARE(refreshedFiles.toSet(), project1.projectFiles.toSet());
    const int snapshotSizeAfterProject1 = mm->snapshot().size();

    foreach (const QString &file, project1.projectFiles)
        QVERIFY(mm->snapshot().contains(file));

    // Project 2
631 632 633 634 635
    project2.create(_("test_modelmanager_snapshot_after_two_projects.2"),
                    _("testdata_project2"),
                    QStringList() << _("bar.h")
                                  << _("bar.cpp")
                                  << _("main.cpp"));
636

637
    refreshedFiles = updateProjectInfo(mm, &helper, project2.projectInfo);
638 639 640 641 642 643 644 645 646 647 648
    QCOMPARE(refreshedFiles.toSet(), project2.projectFiles.toSet());

    const int snapshotSizeAfterProject2 = mm->snapshot().size();
    QVERIFY(snapshotSizeAfterProject2 > snapshotSizeAfterProject1);
    QVERIFY(snapshotSizeAfterProject2 >= snapshotSizeAfterProject1 + project2.projectFiles.size());

    foreach (const QString &file, project1.projectFiles)
        QVERIFY(mm->snapshot().contains(file));
    foreach (const QString &file, project2.projectFiles)
        QVERIFY(mm->snapshot().contains(file));
}
649

650 651 652 653
/// Check: (1) For a project with a *.ui file an AbstractEditorSupport object
///            is added for the ui_* file.
/// Check: (2) The CppPreprocessor can successfully resolve the ui_* file
///            though it might not be actually generated in the build dir.
654 655
void CppToolsPlugin::test_modelmanager_extraeditorsupport_uiFiles()
{
656 657
    ModelManagerTestHelper helper;

658 659
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString projectFile = testDataDirectory.file(_("testdata_guiproject1.pro"));
660 661

    // Open project with *.ui file
hjk's avatar
hjk committed
662
    ProjectExplorerPlugin *pe = ProjectExplorerPlugin::instance();
663 664
    ExampleProjectConfigurator exampleProjectConfigurator(projectFile, pe);
    Project *project = exampleProjectConfigurator.project();
665 666 667 668 669 670 671 672 673

    // Check working copy.
    // An AbstractEditorSupport object should have been added for the ui_* file.
    CppModelManagerInterface *mm = CppModelManagerInterface::instance();
    CppModelManagerInterface::WorkingCopy workingCopy = mm->workingCopy();

    QCOMPARE(workingCopy.size(), 2); // mm->configurationFileName() and "ui_*.h"

    QStringList fileNamesInWorkinCopy;
674
    QHashIterator<QString, QPair<QByteArray, unsigned> > it = workingCopy.iterator();
675 676 677 678 679
    while (it.hasNext()) {
        it.next();
        fileNamesInWorkinCopy << QFileInfo(it.key()).fileName();
    }
    fileNamesInWorkinCopy.sort();
680
    const QString expectedUiHeaderFileName = _("ui_mainwindow.h");
681 682 683 684 685
    QCOMPARE(fileNamesInWorkinCopy.at(0), mm->configurationFileName());
    QCOMPARE(fileNamesInWorkinCopy.at(1), expectedUiHeaderFileName);

    // Check CppPreprocessor / includes.
    // The CppPreprocessor is expected to find the ui_* file in the working copy.
686
    const QString fileIncludingTheUiFile = testDataDirectory.file(_("mainwindow.cpp"));
687 688 689 690 691 692 693 694
    while (!mm->snapshot().document(fileIncludingTheUiFile))
        QCoreApplication::processEvents();

    const CPlusPlus::Snapshot snapshot = mm->snapshot();
    const Document::Ptr document = snapshot.document(fileIncludingTheUiFile);
    QVERIFY(document);
    const QStringList includedFiles = document->includedFiles();
    QCOMPARE(includedFiles.size(), 2);
695 696
    QCOMPARE(QFileInfo(includedFiles.at(0)).fileName(), _("mainwindow.h"));
    QCOMPARE(QFileInfo(includedFiles.at(1)).fileName(), _("ui_mainwindow.h"));
697 698

    // Close Project
hjk's avatar
hjk committed
699
    SessionManager::removeProject(project);
700
    helper.waitForFinishedGc();
701
}
702 703 704 705 706

/// QTCREATORBUG-9828: Locator shows symbols of closed files
/// Check: The garbage collector should be run if the last CppEditor is closed.
void CppToolsPlugin::test_modelmanager_gc_if_last_cppeditor_closed()
{
707 708
    ModelManagerTestHelper helper;

709 710
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
711 712

    CppModelManager *mm = CppModelManager::instance();
713
    helper.resetRefreshedSourceFiles();
714 715 716

    // Open a file in the editor
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 0);
717
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
718 719 720 721 722
    QVERIFY(editor);
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
    QVERIFY(mm->isCppEditor(editor));
    QVERIFY(mm->workingCopy().contains(file));

723 724
    // Wait until the file is refreshed
    helper.waitForRefreshedSourceFiles();
725 726

    // Close file/editor
727
    Core::EditorManager::closeEditor(editor, /*askAboutModifiedEditors=*/ false);
728
    helper.waitForFinishedGc();
729 730 731 732 733

    // Check: File is removed from the snapshpt
    QVERIFY(!mm->workingCopy().contains(file));
    QVERIFY(!mm->snapshot().contains(file));
}
734 735 736 737 738 739

/// Check: Files that are open in the editor are not garbage collected.
void CppToolsPlugin::test_modelmanager_dont_gc_opened_files()
{
    ModelManagerTestHelper helper;

740 741
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
742 743

    CppModelManager *mm = CppModelManager::instance();
744
    helper.resetRefreshedSourceFiles();
745 746 747

    // Open a file in the editor
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 0);
748
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
749 750 751 752
    QVERIFY(editor);
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
    QVERIFY(mm->isCppEditor(editor));

753 754
    // Wait until the file is refreshed and check whether it is in the working copy
    helper.waitForRefreshedSourceFiles();
755

756 757 758 759 760 761 762 763 764 765
    QVERIFY(mm->workingCopy().contains(file));

    // Run the garbage collector
    mm->GC();

    // Check: File is still there
    QVERIFY(mm->workingCopy().contains(file));
    QVERIFY(mm->snapshot().contains(file));

    // Close editor
766
    Core::EditorManager::closeEditor(editor);
767 768 769
    helper.waitForFinishedGc();
    QVERIFY(mm->snapshot().isEmpty());
}
770 771 772 773 774 775 776 777

namespace {
struct EditorCloser {
    Core::IEditor *editor;
    EditorCloser(Core::IEditor *editor): editor(editor) {}
    ~EditorCloser()
    {
        if (editor)
778
            Core::EditorManager::closeEditor(editor);
779 780
    }
};
781 782 783 784 785 786 787 788

QString nameOfFirstDeclaration(const Document::Ptr &doc)
{
    if (doc && doc->globalNamespace()) {
        if (CPlusPlus::Symbol *s = doc->globalSymbolAt(0)) {
            if (CPlusPlus::Declaration *decl = s->asDeclaration()) {
                if (const CPlusPlus::Name *name = decl->name()) {
                    if (const CPlusPlus::Identifier *identifier = name->identifier())
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
789
                        return QString::fromLatin1(identifier->chars(), identifier->size());
790 791 792 793 794 795
                }
            }
        }
    }
    return QString();
}
796 797 798 799 800 801
}

void CppToolsPlugin::test_modelmanager_defines_per_project()
{
    ModelManagerTestHelper helper;

802 803 804 805
    MyTestDataDir testDataDirectory(_("testdata_defines"));
    const QString main1File = testDataDirectory.file(_("main1.cpp"));
    const QString main2File = testDataDirectory.file(_("main2.cpp"));
    const QString header = testDataDirectory.file(_("header.h"));
806 807 808

    CppModelManager *mm = CppModelManager::instance();

809
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project"));
810 811 812 813 814 815

    ProjectPart::Ptr part1(new ProjectPart);
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part1->cxxVersion = ProjectPart::CXX11;
    part1->qtVersion = ProjectPart::NoQt;
816
    part1->projectDefines = QByteArray("#define SUB1\n");
817 818 819 820 821 822 823
    part1->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectPart::Ptr part2(new ProjectPart);
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part2->cxxVersion = ProjectPart::CXX11;
    part2->qtVersion = ProjectPart::NoQt;
824
    part2->projectDefines = QByteArray("#define SUB2\n");
825 826 827 828 829 830
    part2->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectInfo pi = mm->projectInfo(project);
    pi.appendProjectPart(part1);
    pi.appendProjectPart(part2);

831
    updateProjectInfo(mm, &helper, pi);
832 833 834 835 836
    QCOMPARE(mm->snapshot().size(), 4);

    // Open a file in the editor
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 0);

837 838 839 840 841 842 843 844 845 846 847 848 849
    struct Data {
        QString firstDeclarationName;
        QString fileName;
    } d[] = {
        { _("one"), main1File },
        { _("two"), main2File }
    };
    const int size = sizeof(d) / sizeof(d[0]);
    for (int i = 0; i < size; ++i) {
        const QString firstDeclarationName = d[i].firstDeclarationName;
        const QString fileName = d[i].fileName;

        Core::IEditor *editor = Core::EditorManager::openEditor(fileName);
850 851 852 853 854 855 856 857 858 859
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

        CppEditorSupport *sup = mm->cppEditorSupport(
                    qobject_cast<TextEditor::BaseTextEditor *>(editor));
        while (sup->lastSemanticInfoDocument().isNull())
            QCoreApplication::processEvents();

860 861
        Document::Ptr doc = mm->snapshot().document(fileName);
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
862 863
    }
}
864 865 866 867 868

void CppToolsPlugin::test_modelmanager_defines_per_project_pch()
{
    ModelManagerTestHelper helper;

869 870 871 872 873 874
    MyTestDataDir testDataDirectory(_("testdata_defines"));
    const QString main1File = testDataDirectory.file(_("main1.cpp"));
    const QString main2File = testDataDirectory.file(_("main2.cpp"));
    const QString header = testDataDirectory.file(_("header.h"));
    const QString pch1File = testDataDirectory.file(_("pch1.h"));
    const QString pch2File = testDataDirectory.file(_("pch2.h"));
875 876 877

    CppModelManager *mm = CppModelManager::instance();

878
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project_pch"));
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899

    ProjectPart::Ptr part1(new ProjectPart);
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part1->cxxVersion = ProjectPart::CXX11;
    part1->qtVersion = ProjectPart::NoQt;
    part1->precompiledHeaders.append(pch1File);
    part1->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectPart::Ptr part2(new ProjectPart);
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part2->cxxVersion = ProjectPart::CXX11;
    part2->qtVersion = ProjectPart::NoQt;
    part2->precompiledHeaders.append(pch2File);
    part2->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectInfo pi = mm->projectInfo(project);
    pi.appendProjectPart(part1);
    pi.appendProjectPart(part2);

900
    updateProjectInfo(mm, &helper, pi);
901 902 903 904 905
    QCOMPARE(mm->snapshot().size(), 4);

    // Open a file in the editor
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 0);

906 907 908 909 910 911 912 913 914 915 916 917 918
    struct Data {
        QString firstDeclarationName;
        QString fileName;
    } d[] = {
        { _("one"), main1File },
        { _("two"), main2File }
    };
    const int size = sizeof(d) / sizeof(d[0]);
    for (int i = 0; i < size; ++i) {
        const QString firstDeclarationName = d[i].firstDeclarationName;
        const QString fileName = d[i].fileName;

        Core::IEditor *editor = Core::EditorManager::openEditor(fileName);
919 920 921 922 923 924 925 926 927 928 929 930 931
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

        CppEditorSupport *sup = mm->cppEditorSupport(
                    qobject_cast<TextEditor::BaseTextEditor *>(editor));
        while (sup->lastSemanticInfoDocument().isNull())
            QCoreApplication::processEvents();

        sup->snapshotUpdater()->setUsePrecompiledHeaders(true);
        sup->snapshotUpdater()->update(mm->workingCopy());

932 933
        Document::Ptr doc = mm->snapshot().document(fileName);
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
934 935
    }
}
936 937 938 939 940

void CppToolsPlugin::test_modelmanager_defines_per_editor()
{
    ModelManagerTestHelper helper;

941 942 943 944
    MyTestDataDir testDataDirectory(_("testdata_defines"));
    const QString main1File = testDataDirectory.file(_("main1.cpp"));
    const QString main2File = testDataDirectory.file(_("main2.cpp"));
    const QString header = testDataDirectory.file(_("header.h"));
945 946 947

    CppModelManager *mm = CppModelManager::instance();

948
    Project *project = helper.createProject(_("test_modelmanager_defines_per_editor"));
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967

    ProjectPart::Ptr part1(new ProjectPart);
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part1->cxxVersion = ProjectPart::CXX11;
    part1->qtVersion = ProjectPart::NoQt;
    part1->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectPart::Ptr part2(new ProjectPart);
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part2->cxxVersion = ProjectPart::CXX11;
    part2->qtVersion = ProjectPart::NoQt;
    part2->includePaths = QStringList() << testDataDirectory.includeDir(false);

    ProjectInfo pi = mm->projectInfo(project);
    pi.appendProjectPart(part1);
    pi.appendProjectPart(part2);

968
    updateProjectInfo(mm, &helper, pi);
969 970 971 972 973 974

    QCOMPARE(mm->snapshot().size(), 4);

    // Open a file in the editor
    QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 0);

975 976 977 978 979 980 981 982 983 984 985 986
    struct Data {
        QString editorDefines;
        QString firstDeclarationName;
    } d[] = {
        { _("#define SUB1\n"), _("one") },
        { _("#define SUB2\n"), _("two") }
    };
    const int size = sizeof(d) / sizeof(d[0]);
    for (int i = 0; i < size; ++i) {
        const QString editorDefines = d[i].editorDefines;
        const QString firstDeclarationName = d[i].firstDeclarationName;

987 988 989 990 991 992 993 994 995 996 997
        Core::IEditor *editor = Core::EditorManager::openEditor(main1File);
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

        CppEditorSupport *sup = mm->cppEditorSupport(
                    qobject_cast<TextEditor::BaseTextEditor *>(editor));
        while (sup->lastSemanticInfoDocument().isNull())
            QCoreApplication::processEvents();

998
        sup->snapshotUpdater()->setEditorDefines(editorDefines.toUtf8());
999 1000 1001
        sup->snapshotUpdater()->update(mm->workingCopy());

        Document::Ptr doc = mm->snapshot().document(main1File);
1002
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
1003 1004
    }
}