cppmodelmanager_test.cpp 39.3 KB
Newer Older
1 2
/****************************************************************************
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 5 6 7 8 9 10 11 12
** 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
Eike Ziller's avatar
Eike Ziller committed
13 14
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
15 16 17
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** 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.
24 25 26 27 28 29 30
**
** 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.
**
****************************************************************************/

31
#include "cppsourceprocessor.h"
32
#include "cpptoolseditorsupport.h"
33 34
#include "cpptoolsplugin.h"
#include "cpptoolstestcase.h"
35 36
#include "modelmanagertesthelper.h"

37
#include <coreplugin/editormanager/editormanager.h>
38
#include <coreplugin/testdatadir.h>
39 40
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
41 42

#include <cplusplus/LookupContext.h>
43
#include <utils/hostosinfo.h>
44

45
#include <QDebug>
46 47
#include <QFileInfo>
#include <QtTest>
48

49 50 51 52 53 54
#if  QT_VERSION >= 0x050000
#define MSKIP_SINGLE(x) QSKIP(x)
#else
#define MSKIP_SINGLE(x) QSKIP(x, SkipSingle)
#endif

55
using namespace CppTools::Internal;
hjk's avatar
hjk committed
56
using namespace ProjectExplorer;
57

58
typedef CPlusPlus::Document Document;
59 60 61
typedef CppTools::CppModelManagerInterface::ProjectInfo ProjectInfo;
typedef CppTools::ProjectPart ProjectPart;
typedef CppTools::ProjectFile ProjectFile;
62

Orgad Shaneh's avatar
Orgad Shaneh committed
63
Q_DECLARE_METATYPE(QList<ProjectFile>)
64

65 66
namespace {

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

69
class MyTestDataDir : public Core::Tests::TestDataDir
70
{
71
public:
72
    MyTestDataDir(const QString &dir)
73
        : TestDataDir(_(SRCDIR "/../../../tests/cppmodelmanager/") + dir)
74
    {}
75

76
    QString includeDir(bool cleaned = true) const
77
    { return directory(_("include"), cleaned); }
78 79

    QString frameworksDir(bool cleaned = true) const
80
    { return directory(_("frameworks"), cleaned); }
81 82

    QString fileFromSourcesDir(const QString &fileName) const
83
    { return directory(_("sources")) + fileName; }
84 85
};

86 87 88 89 90 91 92 93 94
// 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'.
95
    void create(const QString &name, const QString &dir, const QStringList &files)
96
    {
97
        const MyTestDataDir projectDir(dir);
98 99 100 101 102 103 104 105 106 107 108 109 110 111
        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);
        }
112
        projectInfo.appendProjectPart(part);
113 114 115 116 117 118 119
    }

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

120 121 122 123 124 125 126 127
/// 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
128
                               ProjectExplorerPlugin *projectExplorer)
129
    {
130
        const QString projectUserFile = projectFile + _(".user");
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
        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
151
    Project *project() const
152 153 154 155 156
    {
        return m_project;
    }

private:
hjk's avatar
hjk committed
157
    Project *m_project;
158 159
    QString m_fileToRemove;
};
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
/// 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;
    }

188
    bool writeContents(const QByteArray &contents) const
189
    {
190
        return CppTools::Tests::TestCase::writeFile(m_filePath, contents);
191 192 193 194 195
    }

private:
    void restoreContents() const
    {
196
        CppTools::Tests::TestCase::writeFile(m_filePath, m_originalFileContents);
197 198 199 200 201 202
    }

    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
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

226 227
    typedef ProjectPart::HeaderPath HeaderPath;

228
    ProjectPart::Ptr part(new ProjectPart);
229
    part->cxxVersion = ProjectPart::CXX98;
230
    part->qtVersion = ProjectPart::Qt5;
231
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
232 233 234
    part->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath)
            << HeaderPath(testDataDir.frameworksDir(false), HeaderPath::FrameworkPath);
235
    pi.appendProjectPart(part);
236 237 238

    mm->updateProjectInfo(pi);

239 240 241 242 243
    QList<HeaderPath> headerPaths = mm->headerPaths();
    QCOMPARE(headerPaths.size(), 2);
    QVERIFY(headerPaths.contains(HeaderPath(testDataDir.includeDir(), HeaderPath::IncludePath)));
    QVERIFY(headerPaths.contains(HeaderPath(testDataDir.frameworksDir(),
                                            HeaderPath::FrameworkPath)));
244
}
245

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

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

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

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

261 262
    typedef ProjectPart::HeaderPath HeaderPath;

263
    ProjectPart::Ptr part(new ProjectPart);
264
    part->cxxVersion = ProjectPart::CXX98;
265
    part->qtVersion = ProjectPart::Qt5;
266
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
267 268 269
    part->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath)
            << HeaderPath(testDataDir.frameworksDir(false), HeaderPath::FrameworkPath);
270
    const QString &source = testDataDir.fileFromSourcesDir(
271
        _("test_modelmanager_framework_headers.cpp"));
272
    part->files << ProjectFile(source, ProjectFile::CXXSource);
273
    pi.appendProjectPart(part);
274

275
    mm->updateProjectInfo(pi).waitForFinished();
276 277
    QCoreApplication::processEvents();

278
    QVERIFY(mm->snapshot().contains(source));
279
    Document::Ptr doc = mm->document(source);
280 281 282 283 284 285 286 287 288 289 290 291 292 293
    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"));
    }
}
294 295

/// QTCREATORBUG-9056
296 297 298
/// 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()
299 300 301 302
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

303
    const MyTestDataDir testDataDir(_("testdata"));
304

305 306
    const QString testCpp(testDataDir.fileFromSourcesDir(_("test_modelmanager_refresh.cpp")));
    const QString testHeader(testDataDir.fileFromSourcesDir( _("test_modelmanager_refresh.h")));
307

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

313 314
    typedef ProjectPart::HeaderPath HeaderPath;

315 316 317
    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
318
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
319 320
    part->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath);
321
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
322
    pi.appendProjectPart(part);
323

324
    QStringList refreshedFiles = updateProjectInfo(mm, &helper, pi);
325 326 327 328 329 330
    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    CPlusPlus::Snapshot snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));

331 332 333 334
    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");
335

336
    // Introduce a define that will enable another define once the document is reparsed.
337
    part->projectDefines = QByteArray("#define TEST_DEFINE 1\n");
338 339
    pi.clearProjectParts();
    pi.appendProjectPart(part);
340

341
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
342 343 344 345 346 347

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));
348 349 350 351 352 353

    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");
354
}
355 356

/// QTCREATORBUG-9205
357
/// Check: When reparsing the same files again, no errors occur
358
///        (The CppSourceProcessor's already seen files are properly cleared!).
359
void CppToolsPlugin::test_modelmanager_refresh_several_times()
360 361 362 363
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

364
    const MyTestDataDir testDataDir(_("testdata_refresh"));
365

366 367 368
    const QString testHeader1(testDataDir.file(_("defines.h")));
    const QString testHeader2(testDataDir.file(_("header.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
369

370
    Project *project = helper.createProject(_("test_modelmanager_refresh_several_times"));
371 372 373 374 375 376 377 378 379
    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));
380
    pi.appendProjectPart(part);
381 382 383 384 385 386
    mm->updateProjectInfo(pi);

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

387
    QByteArray defines = "#define FIRST_DEFINE";
388
    for (int i = 0; i < 2; ++i) {
389 390 391 392
        pi.clearProjectParts();
        ProjectPart::Ptr part(new ProjectPart);
        // Simulate project configuration change by having different defines each time.
        defines += "\n#define ANOTHER_DEFINE";
393
        part->projectDefines = defines;
394 395 396 397 398 399 400
        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);

401
        refreshedFiles = updateProjectInfo(mm, &helper, pi);
402
        QCOMPARE(refreshedFiles.size(), 3);
403

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
        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());
    }
}
424

425 426 427 428 429 430 431
/// 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();

432 433
    const MyTestDataDir testDataDir(_("testdata_refresh"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
434

435
    Project *project = helper.createProject(_("test_modelmanager_refresh_2"));
436 437 438 439 440 441 442 443 444 445
    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
446
    helper.resetRefreshedSourceFiles();
447 448
    QFuture<void> firstFuture = mm->updateProjectInfo(pi);
    QVERIFY(firstFuture.isStarted() || firstFuture.isRunning());
449
    firstFuture.waitForFinished();
450 451 452 453 454 455 456 457 458
    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());
}

459 460 461 462 463 464 465
/// 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();

466
    const MyTestDataDir testDataDir(_("testdata_refresh"));
467

468 469 470
    const QString testHeader1(testDataDir.file(_("header.h")));
    const QString testHeader2(testDataDir.file(_("defines.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
471

472
    Project *project = helper.createProject(_("test_modelmanager_refresh_3"));
473 474 475 476 477 478 479 480 481 482 483 484 485
    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;

486
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504

    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);

505
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528

    // 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();

529
    Project *project = helper.createProject(_("test_modelmanager_refresh_timeStampModified"));
530 531 532 533 534 535 536 537 538 539 540 541 542 543
    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;

544
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

    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;";
564
    QVERIFY(fileChangerAndRestorer.writeContents(newFileContentes));
565 566 567 568 569 570 571 572

    // 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);

573
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594

    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");

595 596 597
    const MyTestDataDir testDataDir(_("testdata_refresh2"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
    const QString testCpp2(testDataDir.file(_("source2.cpp")));
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612

    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;
}

613 614
/// Check: If a second project is opened, the code model is still aware of
///        files of the first project.
615 616 617 618 619 620 621 622 623
void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
{
    QStringList refreshedFiles;
    ModelManagerTestHelper helper;
    ProjectCreator project1(&helper);
    ProjectCreator project2(&helper);
    CppModelManager *mm = CppModelManager::instance();

    // Project 1
624 625 626 627 628
    project1.create(_("test_modelmanager_snapshot_after_two_projects.1"),
                    _("testdata_project1"),
                    QStringList() << _("foo.h")
                                  << _("foo.cpp")
                                  << _("main.cpp"));
629

630
    refreshedFiles = updateProjectInfo(mm, &helper, project1.projectInfo);
631 632 633 634 635 636 637
    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
638 639 640 641 642
    project2.create(_("test_modelmanager_snapshot_after_two_projects.2"),
                    _("testdata_project2"),
                    QStringList() << _("bar.h")
                                  << _("bar.cpp")
                                  << _("main.cpp"));
643

644
    refreshedFiles = updateProjectInfo(mm, &helper, project2.projectInfo);
645 646 647 648 649 650 651 652 653 654 655
    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));
}
656

657 658
/// Check: (1) For a project with a *.ui file an AbstractEditorSupport object
///            is added for the ui_* file.
659
/// Check: (2) The CppSourceProcessor can successfully resolve the ui_* file
660
///            though it might not be actually generated in the build dir.
661 662
void CppToolsPlugin::test_modelmanager_extraeditorsupport_uiFiles()
{
663 664
    ModelManagerTestHelper helper;

665 666
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString projectFile = testDataDirectory.file(_("testdata_guiproject1.pro"));
667 668

    // Open project with *.ui file
hjk's avatar
hjk committed
669
    ProjectExplorerPlugin *pe = ProjectExplorerPlugin::instance();
670 671
    ExampleProjectConfigurator exampleProjectConfigurator(projectFile, pe);
    Project *project = exampleProjectConfigurator.project();
672 673 674 675 676 677 678 679 680

    // 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;
681
    QHashIterator<QString, QPair<QByteArray, unsigned> > it = workingCopy.iterator();
682 683 684 685 686
    while (it.hasNext()) {
        it.next();
        fileNamesInWorkinCopy << QFileInfo(it.key()).fileName();
    }
    fileNamesInWorkinCopy.sort();
687
    const QString expectedUiHeaderFileName = _("ui_mainwindow.h");
688 689 690
    QCOMPARE(fileNamesInWorkinCopy.at(0), mm->configurationFileName());
    QCOMPARE(fileNamesInWorkinCopy.at(1), expectedUiHeaderFileName);

691 692
    // Check CppSourceProcessor / includes.
    // The CppSourceProcessor is expected to find the ui_* file in the working copy.
693
    const QString fileIncludingTheUiFile = testDataDirectory.file(_("mainwindow.cpp"));
694 695 696 697 698 699 700 701
    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);
702 703
    QCOMPARE(QFileInfo(includedFiles.at(0)).fileName(), _("mainwindow.h"));
    QCOMPARE(QFileInfo(includedFiles.at(1)).fileName(), _("ui_mainwindow.h"));
704 705

    // Close Project
hjk's avatar
hjk committed
706
    SessionManager::removeProject(project);
707
    helper.waitForFinishedGc();
708
}
709 710 711 712 713

/// 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()
{
714 715
    ModelManagerTestHelper helper;

716 717
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
718 719

    CppModelManager *mm = CppModelManager::instance();
720
    helper.resetRefreshedSourceFiles();
721 722

    // Open a file in the editor
hjk's avatar
hjk committed
723
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
724
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
725
    QVERIFY(editor);
hjk's avatar
hjk committed
726
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
727 728 729
    QVERIFY(mm->isCppEditor(editor));
    QVERIFY(mm->workingCopy().contains(file));

730 731
    // Wait until the file is refreshed
    helper.waitForRefreshedSourceFiles();
732 733

    // Close file/editor
734
    Core::EditorManager::closeEditor(editor, /*askAboutModifiedEditors=*/ false);
735
    helper.waitForFinishedGc();
736 737 738 739 740

    // Check: File is removed from the snapshpt
    QVERIFY(!mm->workingCopy().contains(file));
    QVERIFY(!mm->snapshot().contains(file));
}
741 742 743 744 745 746

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

747 748
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
749 750

    CppModelManager *mm = CppModelManager::instance();
751
    helper.resetRefreshedSourceFiles();
752 753

    // Open a file in the editor
hjk's avatar
hjk committed
754
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
755
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
756
    QVERIFY(editor);
hjk's avatar
hjk committed
757
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
758 759
    QVERIFY(mm->isCppEditor(editor));

760 761
    // Wait until the file is refreshed and check whether it is in the working copy
    helper.waitForRefreshedSourceFiles();
762

763 764 765 766 767 768 769 770 771 772
    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
773
    Core::EditorManager::closeEditor(editor);
774 775 776
    helper.waitForFinishedGc();
    QVERIFY(mm->snapshot().isEmpty());
}
777 778 779 780 781 782 783

namespace {
struct EditorCloser {
    Core::IEditor *editor;
    EditorCloser(Core::IEditor *editor): editor(editor) {}
    ~EditorCloser()
    {
784
        using namespace CppTools;
785
        if (editor)
786
            QVERIFY(Tests::TestCase::closeEditorWithoutGarbageCollectorInvocation(editor));
787 788
    }
};
789 790 791 792 793 794 795 796

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())
797
                        return QString::fromUtf8(identifier->chars(), identifier->size());
798 799 800 801 802 803
                }
            }
        }
    }
    return QString();
}
804 805 806 807 808 809
}

void CppToolsPlugin::test_modelmanager_defines_per_project()
{
    ModelManagerTestHelper helper;

810 811 812 813
    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"));
814 815 816

    CppModelManager *mm = CppModelManager::instance();

817
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project"));
818

819 820
    typedef ProjectPart::HeaderPath HeaderPath;

821
    ProjectPart::Ptr part1(new ProjectPart);
822
    part1->projectFile = QLatin1String("project1.projectfile");
823 824 825 826
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part1->cxxVersion = ProjectPart::CXX11;
    part1->qtVersion = ProjectPart::NoQt;
827
    part1->projectDefines = QByteArray("#define SUB1\n");
828 829
    part1->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
830 831

    ProjectPart::Ptr part2(new ProjectPart);
832
    part2->projectFile = QLatin1String("project1.projectfile");
833 834 835 836
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part2->cxxVersion = ProjectPart::CXX11;
    part2->qtVersion = ProjectPart::NoQt;
837
    part2->projectDefines = QByteArray("#define SUB2\n");
838 839
    part2->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
840 841 842 843 844

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

845
    updateProjectInfo(mm, &helper, pi);
846 847 848
    QCOMPARE(mm->snapshot().size(), 4);

    // Open a file in the editor
hjk's avatar
hjk committed
849
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
850

851 852 853 854 855 856 857 858 859 860 861 862 863
    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);
864 865
        EditorCloser closer(editor);
        QVERIFY(editor);
hjk's avatar
hjk committed
866
        QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
867 868 869 870 871 872 873
        QVERIFY(mm->isCppEditor(editor));

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

874
        Document::Ptr doc = mm->document(fileName);
875
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
876 877
    }
}
878

879
void CppToolsPlugin::test_modelmanager_precompiled_headers()
880 881 882
{
    ModelManagerTestHelper helper;

883 884 885 886 887 888
    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"));
889 890 891

    CppModelManager *mm = CppModelManager::instance();

892
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project_pch"));
893

894 895
    typedef ProjectPart::HeaderPath HeaderPath;

896
    ProjectPart::Ptr part1(new ProjectPart);
897
    part1->projectFile = QLatin1String("project1.projectfile");
898 899 900 901 902
    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);
903 904
    part1->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
905 906

    ProjectPart::Ptr part2(new ProjectPart);
907
    part2->projectFile = QLatin1String("project2.projectfile");
908 909 910 911 912
    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);
913 914
    part2->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
915 916 917 918 919

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

920
    updateProjectInfo(mm, &helper, pi);
921 922 923
    QCOMPARE(mm->snapshot().size(), 4);

    // Open a file in the editor
hjk's avatar
hjk committed
924
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
925

926 927
    struct Data {
        QString firstDeclarationName;
928
        QString firstClassInPchFile;
929 930
        QString fileName;
    } d[] = {
931 932
        { _("one"), _("ClassInPch1"), main1File },
        { _("two"), _("ClassInPch2"), main2File }
933 934 935 936
    };
    const int size = sizeof(d) / sizeof(d[0]);
    for (int i = 0; i < size; ++i) {
        const QString firstDeclarationName = d[i].firstDeclarationName;
937
        const QByteArray firstClassInPchFile = d[i].firstClassInPchFile.toUtf8();
938 939 940
        const QString fileName = d[i].fileName;

        Core::IEditor *editor = Core::EditorManager::openEditor(fileName);
941 942
        EditorCloser closer(editor);
        QVERIFY(editor);
hjk's avatar
hjk committed
943
        QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
944 945 946 947 948 949 950
        QVERIFY(mm->isCppEditor(editor));

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

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
        const QSharedPointer<SnapshotUpdater> updater = sup->snapshotUpdater();
        updater->setUsePrecompiledHeaders(true);
        updater->update(mm->workingCopy());

        // Check if defines from pch are considered
        Document::Ptr document = mm->document(fileName);
        QCOMPARE(nameOfFirstDeclaration(document), firstDeclarationName);

        // Check if declarations from pch are considered
        CPlusPlus::LookupContext context(document, updater->snapshot());
        const CPlusPlus::Identifier *identifier
            = document->control()->identifier(firstClassInPchFile.data());
        const QList<CPlusPlus::LookupItem> results = context.lookup(identifier,
                                                                    document->globalNamespace());
        QVERIFY(!results.isEmpty());
        QVERIFY(results.first().declaration()->type()->asClassType());
967 968
    }
}
969 970 971 972 973

void CppToolsPlugin::test_modelmanager_defines_per_editor()
{
    ModelManagerTestHelper helper;

974 975 976 977
    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"));
978 979 980

    CppModelManager *mm = CppModelManager::instance();

981
    Project *project = helper.createProject(_("test_modelmanager_defines_per_editor"));
982

983 984
    typedef ProjectPart::HeaderPath HeaderPath;

985 986 987 988 989
    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;
990 991
    part1->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
992 993 994 995 996 997

    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;