cppmodelmanager_test.cpp 46.3 KB
Newer Older
1 2
/****************************************************************************
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5 6 7 8 9 10 11
**
** 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
12 13 14
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
15
**
16 17 18 19 20 21 22
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
23 24 25
**
****************************************************************************/

26
#include "baseeditordocumentprocessor.h"
27
#include "builtineditordocumentparser.h"
28
#include "cppsourceprocessor.h"
29 30
#include "cpptoolsplugin.h"
#include "cpptoolstestcase.h"
31
#include "editordocumenthandle.h"
32
#include "modelmanagertesthelper.h"
33
#include "projectinfo.h"
34

35
#include <coreplugin/documentmanager.h>
36
#include <coreplugin/editormanager/editormanager.h>
37
#include <coreplugin/fileutils.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/executeondestruction.h>
44
#include <utils/hostosinfo.h>
45

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

49 50 51 52
#define VERIFY_DOCUMENT_REVISION(document, expectedRevision) \
    QVERIFY(document); \
    QCOMPARE(document->revision(), expectedRevision);

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

58
typedef CPlusPlus::Document Document;
59

60
Q_DECLARE_METATYPE(QVector<ProjectFile>)
61

62 63
namespace {

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

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

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

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

    QString fileFromSourcesDir(const QString &fileName) const
80
    { return directory(_("sources")) + QLatin1Char('/') + fileName; }
81 82
};

83 84 85 86 87 88 89 90 91
QStringList toAbsolutePaths(const QStringList &relativePathList,
                            const Tests::TemporaryCopiedDir &temporaryDir)
{
    QStringList result;
    foreach (const QString &file, relativePathList)
        result << temporaryDir.absolutePath(file.toUtf8());
    return result;
}

92 93 94 95 96 97 98 99 100
// 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'.
101
    void create(const QString &name, const QString &dir, const QStringList &files)
102
    {
103
        const MyTestDataDir projectDir(dir);
104 105 106 107
        foreach (const QString &file, files)
            projectFiles << projectDir.file(file);

        Project *project = modelManagerTestHelper->createProject(name);
108
        projectInfo = ProjectInfo(project);
109 110

        ProjectPart::Ptr part(new ProjectPart);
111
        part->languageVersion = ProjectPart::CXX14;
112 113 114 115 116
        part->qtVersion = ProjectPart::Qt5;
        foreach (const QString &file, projectFiles) {
            ProjectFile projectFile(file, ProjectFile::classify(file));
            part->files.append(projectFile);
        }
117
        projectInfo.appendProjectPart(part);
118
        projectInfo.finish();
119 120 121 122 123 124 125
    }

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

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/// 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;
    }

153
    bool writeContents(const QByteArray &contents) const
154
    {
155
        return TestCase::writeFile(m_filePath, contents);
156 157 158 159 160
    }

private:
    void restoreContents() const
    {
161
        TestCase::writeFile(m_filePath, m_originalFileContents);
162 163 164 165 166 167
    }

    QByteArray m_originalFileContents;
    const QString &m_filePath;
};

168
ProjectPart::Ptr projectPartOfEditorDocument(const QString &filePath)
169
{
170 171 172
    auto *editorDocument = CppModelManager::instance()->cppEditorDocument(filePath);
    QTC_ASSERT(editorDocument, return ProjectPart::Ptr());
    return editorDocument->processor()->parser()->projectPart();
173 174
}

175 176
} // anonymous namespace

177 178
/// Check: The preprocessor cleans include and framework paths.
void CppToolsPlugin::test_modelmanager_paths_are_clean()
179 180 181 182
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

183
    const MyTestDataDir testDataDir(_("testdata"));
184

185
    Project *project = helper.createProject(_("test_modelmanager_paths_are_clean"));
186
    ProjectInfo pi = ProjectInfo(project);
187

188
    typedef ProjectPartHeaderPath HeaderPath;
189

190
    ProjectPart::Ptr part(new ProjectPart);
191
    part->languageVersion = ProjectPart::CXX14;
192
    part->qtVersion = ProjectPart::Qt5;
193
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
194 195
    part->headerPaths = { HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath),
                          HeaderPath(testDataDir.frameworksDir(false), HeaderPath::FrameworkPath) };
196
    pi.appendProjectPart(part);
197
    pi.finish();
198 199 200

    mm->updateProjectInfo(pi);

201
    ProjectPartHeaderPaths headerPaths = mm->headerPaths();
202 203 204 205
    QCOMPARE(headerPaths.size(), 2);
    QVERIFY(headerPaths.contains(HeaderPath(testDataDir.includeDir(), HeaderPath::IncludePath)));
    QVERIFY(headerPaths.contains(HeaderPath(testDataDir.frameworksDir(),
                                            HeaderPath::FrameworkPath)));
206
}
207

208
/// Check: Frameworks headers are resolved.
209 210
void CppToolsPlugin::test_modelmanager_framework_headers()
{
211
    if (Utils::HostOsInfo::isWindowsHost())
212
        QSKIP("Can't resolve framework soft links on Windows.");
213

214 215 216
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

217
    const MyTestDataDir testDataDir(_("testdata"));
218

219
    Project *project = helper.createProject(_("test_modelmanager_framework_headers"));
220
    ProjectInfo pi = ProjectInfo(project);
221

222
    typedef ProjectPartHeaderPath HeaderPath;
223

224
    ProjectPart::Ptr part(new ProjectPart);
225
    part->languageVersion = ProjectPart::CXX14;
226
    part->qtVersion = ProjectPart::Qt5;
227
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
228 229
    part->headerPaths = { HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath),
                          HeaderPath(testDataDir.frameworksDir(false), HeaderPath::FrameworkPath) };
230
    const QString &source = testDataDir.fileFromSourcesDir(
231
        _("test_modelmanager_framework_headers.cpp"));
232
    part->files << ProjectFile(source, ProjectFile::CXXSource);
233
    pi.appendProjectPart(part);
234
    pi.finish();
235

236
    mm->updateProjectInfo(pi).waitForFinished();
237 238
    QCoreApplication::processEvents();

239
    QVERIFY(mm->snapshot().contains(source));
240
    Document::Ptr doc = mm->document(source);
241 242 243 244 245 246 247 248 249 250 251 252 253 254
    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"));
    }
}
255 256

/// QTCREATORBUG-9056
257 258 259
/// 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()
260 261 262 263
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

264
    const MyTestDataDir testDataDir(_("testdata"));
265

266 267
    const QString testCpp(testDataDir.fileFromSourcesDir(_("test_modelmanager_refresh.cpp")));
    const QString testHeader(testDataDir.fileFromSourcesDir( _("test_modelmanager_refresh.h")));
268

269
    Project *project = helper.createProject(
270
                _("test_modelmanager_refresh_also_includes_of_project_files"));
271
    ProjectInfo pi = ProjectInfo(project);
272

273
    typedef ProjectPartHeaderPath HeaderPath;
274

275
    ProjectPart::Ptr part(new ProjectPart);
276
    part->languageVersion = ProjectPart::CXX14;
277
    part->qtVersion = ProjectPart::Qt5;
278
    part->projectDefines = QByteArray("#define OH_BEHAVE -1\n");
279
    part->headerPaths = { HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath) };
280
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
281
    pi.appendProjectPart(part);
282
    pi.finish();
283

284
    QSet<QString> refreshedFiles = helper.updateProjectInfo(pi);
285 286 287 288 289 290
    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    CPlusPlus::Snapshot snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));

291 292 293 294
    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");
295

296
    // Introduce a define that will enable another define once the document is reparsed.
297
    part->projectDefines = QByteArray("#define TEST_DEFINE 1\n");
298
    pi = ProjectInfo(project);
299
    pi.appendProjectPart(part);
300
    pi.finish();
301

302
    refreshedFiles = helper.updateProjectInfo(pi);
303 304 305 306 307 308

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));
309 310 311 312 313 314

    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");
315
}
316 317

/// QTCREATORBUG-9205
318
/// Check: When reparsing the same files again, no errors occur
319
///        (The CppSourceProcessor's already seen files are properly cleared!).
320
void CppToolsPlugin::test_modelmanager_refresh_several_times()
321 322 323 324
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

325
    const MyTestDataDir testDataDir(_("testdata_refresh"));
326

327 328 329
    const QString testHeader1(testDataDir.file(_("defines.h")));
    const QString testHeader2(testDataDir.file(_("header.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
330

331
    Project *project = helper.createProject(_("test_modelmanager_refresh_several_times"));
332
    ProjectInfo pi = ProjectInfo(project);
333 334

    ProjectPart::Ptr part(new ProjectPart);
335
    part->languageVersion = ProjectPart::CXX14;
336 337 338 339
    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));
340
    pi.appendProjectPart(part);
341
    pi.finish();
342 343 344
    mm->updateProjectInfo(pi);

    CPlusPlus::Snapshot snapshot;
345
    QSet<QString> refreshedFiles;
346 347
    CPlusPlus::Document::Ptr document;

348
    QByteArray defines = "#define FIRST_DEFINE";
349
    for (int i = 0; i < 2; ++i) {
350
        pi = ProjectInfo(project);
351 352 353
        ProjectPart::Ptr part(new ProjectPart);
        // Simulate project configuration change by having different defines each time.
        defines += "\n#define ANOTHER_DEFINE";
354
        part->projectDefines = defines;
355
        part->languageVersion = ProjectPart::CXX14;
356 357 358 359 360
        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);
361
        pi.finish();
362

363
        refreshedFiles = helper.updateProjectInfo(pi);
364
        QCOMPARE(refreshedFiles.size(), 3);
365

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
        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());
    }
}
386

387 388 389 390 391 392 393
/// 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();

394 395
    const MyTestDataDir testDataDir(_("testdata_refresh"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
396

397
    Project *project = helper.createProject(_("test_modelmanager_refresh_2"));
398
    ProjectInfo pi = ProjectInfo(project);
399 400

    ProjectPart::Ptr part(new ProjectPart);
401
    part->languageVersion = ProjectPart::CXX14;
402 403 404
    part->qtVersion = ProjectPart::Qt5;
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    pi.appendProjectPart(part);
405
    pi.finish();
406 407

    // Reindexing triggers a reparsing thread
408
    helper.resetRefreshedSourceFiles();
409 410
    QFuture<void> firstFuture = mm->updateProjectInfo(pi);
    QVERIFY(firstFuture.isStarted() || firstFuture.isRunning());
411
    firstFuture.waitForFinished();
412
    const QSet<QString> refreshedFiles = helper.waitForRefreshedSourceFiles();
413 414 415 416 417 418 419 420
    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());
}

421 422 423 424 425 426 427
/// 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();

428
    const MyTestDataDir testDataDir(_("testdata_refresh"));
429

430 431 432
    const QString testHeader1(testDataDir.file(_("header.h")));
    const QString testHeader2(testDataDir.file(_("defines.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
433

434
    Project *project = helper.createProject(_("test_modelmanager_refresh_3"));
435
    ProjectInfo pi = ProjectInfo(project);
436 437

    ProjectPart::Ptr part(new ProjectPart);
438
    part->languageVersion = ProjectPart::CXX14;
439 440 441 442
    part->qtVersion = ProjectPart::Qt5;
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    part->files.append(ProjectFile(testHeader1, ProjectFile::CXXHeader));
    pi.appendProjectPart(part);
443
    pi.finish();
444 445

    CPlusPlus::Snapshot snapshot;
446
    QSet<QString> refreshedFiles;
447

448
    refreshedFiles = helper.updateProjectInfo(pi);
449 450 451 452 453 454 455 456 457 458

    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
459
    pi = ProjectInfo(project);
460
    ProjectPart::Ptr newPart(new ProjectPart);
461
    newPart->languageVersion = ProjectPart::CXX14;
462 463 464 465
    newPart->qtVersion = ProjectPart::Qt5;
    newPart->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
    newPart->files.append(ProjectFile(testHeader2, ProjectFile::CXXHeader));
    pi.appendProjectPart(newPart);
466
    pi.finish();
467

468
    refreshedFiles = helper.updateProjectInfo(pi);
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485

    // 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);
486 487 488 489 490 491 492 493
    QFETCH(QStringList, initialProjectFiles);
    QFETCH(QStringList, finalProjectFiles);

    Tests::TemporaryCopiedDir temporaryDir(
                MyTestDataDir(QLatin1String("testdata_refresh2")).path());
    fileToChange = temporaryDir.absolutePath(fileToChange.toUtf8());
    initialProjectFiles = toAbsolutePaths(initialProjectFiles, temporaryDir);
    finalProjectFiles = toAbsolutePaths(finalProjectFiles, temporaryDir);
494 495 496 497

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

498
    Project *project = helper.createProject(_("test_modelmanager_refresh_timeStampModified"));
499
    ProjectInfo pi = ProjectInfo(project);
500 501

    ProjectPart::Ptr part(new ProjectPart);
502
    part->languageVersion = ProjectPart::CXX14;
503
    part->qtVersion = ProjectPart::Qt5;
504 505
    foreach (const QString &file, initialProjectFiles)
        part->files.append(ProjectFile(file, ProjectFile::CXXSource));
506
    pi = ProjectInfo(project);
507
    pi.appendProjectPart(part);
508
    pi.finish();
509 510 511

    Document::Ptr document;
    CPlusPlus::Snapshot snapshot;
512
    QSet<QString> refreshedFiles;
513

514
    refreshedFiles = helper.updateProjectInfo(pi);
515 516 517

    QCOMPARE(refreshedFiles.size(), initialProjectFiles.size());
    snapshot = mm->snapshot();
518 519 520
    foreach (const QString &file, initialProjectFiles) {
        QVERIFY(refreshedFiles.contains(file));
        QVERIFY(snapshot.contains(file));
521 522 523 524 525 526 527 528 529 530 531 532 533
    }

    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;";
534
    QVERIFY(fileChangerAndRestorer.writeContents(newFileContentes));
535 536 537

    // Add or remove source file. The configuration stays the same.
    part->files.clear();
538 539
    foreach (const QString &file, finalProjectFiles)
        part->files.append(ProjectFile(file, ProjectFile::CXXSource));
540
    pi = ProjectInfo(project);
541
    pi.appendProjectPart(part);
542
    pi.finish();
543

544
    refreshedFiles = helper.updateProjectInfo(pi);
545 546 547

    QCOMPARE(refreshedFiles.size(), finalProjectFiles.size());
    snapshot = mm->snapshot();
548 549 550
    foreach (const QString &file, finalProjectFiles) {
        QVERIFY(refreshedFiles.contains(file));
        QVERIFY(snapshot.contains(file));
551 552 553 554 555 556 557 558 559 560 561 562
    }
    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");
563 564
    QTest::addColumn<QStringList>("initialProjectFiles");
    QTest::addColumn<QStringList>("finalProjectFiles");
565

566 567
    const QString testCpp = QLatin1String("source.cpp");
    const QString testCpp2 = QLatin1String("source2.cpp");
568 569

    const QString fileToChange = testCpp;
570 571
    const QStringList projectFiles1 = QStringList() << testCpp;
    const QStringList projectFiles2 = QStringList() << testCpp << testCpp2;
572 573 574 575 576 577 578 579

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

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

580 581
/// Check: If a second project is opened, the code model is still aware of
///        files of the first project.
582 583
void CppToolsPlugin::test_modelmanager_snapshot_after_two_projects()
{
584
    QSet<QString> refreshedFiles;
585 586 587 588 589 590
    ModelManagerTestHelper helper;
    ProjectCreator project1(&helper);
    ProjectCreator project2(&helper);
    CppModelManager *mm = CppModelManager::instance();

    // Project 1
591 592 593 594 595
    project1.create(_("test_modelmanager_snapshot_after_two_projects.1"),
                    _("testdata_project1"),
                    QStringList() << _("foo.h")
                                  << _("foo.cpp")
                                  << _("main.cpp"));
596

597
    refreshedFiles = helper.updateProjectInfo(project1.projectInfo);
598
    QCOMPARE(refreshedFiles, project1.projectFiles.toSet());
599 600 601 602 603 604
    const int snapshotSizeAfterProject1 = mm->snapshot().size();

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

    // Project 2
605 606 607 608 609
    project2.create(_("test_modelmanager_snapshot_after_two_projects.2"),
                    _("testdata_project2"),
                    QStringList() << _("bar.h")
                                  << _("bar.cpp")
                                  << _("main.cpp"));
610

611
    refreshedFiles = helper.updateProjectInfo(project2.projectInfo);
612
    QCOMPARE(refreshedFiles, project2.projectFiles.toSet());
613 614 615 616 617 618 619 620 621 622

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

624 625
/// Check: (1) For a project with a *.ui file an AbstractEditorSupport object
///            is added for the ui_* file.
626
/// Check: (2) The CppSourceProcessor can successfully resolve the ui_* file
627
///            though it might not be actually generated in the build dir.
628 629
///

630 631
void CppToolsPlugin::test_modelmanager_extraeditorsupport_uiFiles()
{
632
    VerifyCleanCppModelManager verify;
633

634 635 636
    TemporaryCopiedDir temporaryDir(MyTestDataDir(QLatin1String("testdata_guiproject1")).path());
    QVERIFY(temporaryDir.isValid());
    const QString projectFile = temporaryDir.absolutePath("testdata_guiproject1.pro");
637

638
    ProjectOpenerAndCloser projects;
639 640
    ProjectInfo projectInfo = projects.open(projectFile, /*configureAsExampleProject=*/ true);
    QVERIFY(projectInfo.isValid());
641 642 643

    // Check working copy.
    // An AbstractEditorSupport object should have been added for the ui_* file.
644
    CppModelManager *mm = CppModelManager::instance();
645
    WorkingCopy workingCopy = mm->workingCopy();
646 647 648 649

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

    QStringList fileNamesInWorkinCopy;
650
    QHashIterator<Utils::FileName, QPair<QByteArray, unsigned> > it = workingCopy.iterator();
651 652
    while (it.hasNext()) {
        it.next();
653
        fileNamesInWorkinCopy << Utils::FileName::fromString(it.key().toString()).fileName();
654 655
    }
    fileNamesInWorkinCopy.sort();
656
    const QString expectedUiHeaderFileName = _("ui_mainwindow.h");
657 658 659
    QCOMPARE(fileNamesInWorkinCopy.at(0), mm->configurationFileName());
    QCOMPARE(fileNamesInWorkinCopy.at(1), expectedUiHeaderFileName);

660 661
    // Check CppSourceProcessor / includes.
    // The CppSourceProcessor is expected to find the ui_* file in the working copy.
662
    const QString fileIncludingTheUiFile = temporaryDir.absolutePath("mainwindow.cpp");
663 664 665 666 667 668 669 670
    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);
671 672
    QCOMPARE(Utils::FileName::fromString(includedFiles.at(0)).fileName(), _("mainwindow.h"));
    QCOMPARE(Utils::FileName::fromString(includedFiles.at(1)).fileName(), _("ui_mainwindow.h"));
673
}
674 675 676 677 678

/// 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()
{
679 680
    ModelManagerTestHelper helper;

681 682
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
683 684

    CppModelManager *mm = CppModelManager::instance();
685
    helper.resetRefreshedSourceFiles();
686 687

    // Open a file in the editor
hjk's avatar
hjk committed
688
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
689
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
690
    QVERIFY(editor);
hjk's avatar
hjk committed
691
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
692 693 694
    QVERIFY(mm->isCppEditor(editor));
    QVERIFY(mm->workingCopy().contains(file));

695 696
    // Wait until the file is refreshed
    helper.waitForRefreshedSourceFiles();
697 698

    // Close file/editor
699
    Core::EditorManager::closeDocument(editor->document(), /*askAboutModifiedEditors=*/ false);
700
    helper.waitForFinishedGc();
701 702 703 704 705

    // Check: File is removed from the snapshpt
    QVERIFY(!mm->workingCopy().contains(file));
    QVERIFY(!mm->snapshot().contains(file));
}
706 707 708 709 710 711

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

712 713
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
714 715

    CppModelManager *mm = CppModelManager::instance();
716
    helper.resetRefreshedSourceFiles();
717 718

    // Open a file in the editor
hjk's avatar
hjk committed
719
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 0);
720
    Core::IEditor *editor = Core::EditorManager::openEditor(file);
721
    QVERIFY(editor);
hjk's avatar
hjk committed
722
    QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
723 724
    QVERIFY(mm->isCppEditor(editor));

725 726
    // Wait until the file is refreshed and check whether it is in the working copy
    helper.waitForRefreshedSourceFiles();
727

728 729 730 731 732 733 734 735 736 737
    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
738
    Core::EditorManager::closeDocument(editor->document());
739 740 741
    helper.waitForFinishedGc();
    QVERIFY(mm->snapshot().isEmpty());
}
742 743 744 745 746 747 748

namespace {
struct EditorCloser {
    Core::IEditor *editor;
    EditorCloser(Core::IEditor *editor): editor(editor) {}
    ~EditorCloser()
    {
749
        using namespace CppTools;
750
        if (editor)
751
            QVERIFY(Tests::TestCase::closeEditorWithoutGarbageCollectorInvocation(editor));
752 753
    }
};
754 755 756 757 758 759 760 761

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())
762
                        return QString::fromUtf8(identifier->chars(), identifier->size());
763 764 765 766 767 768
                }
            }
        }
    }
    return QString();
}
769 770 771 772 773 774
}

void CppToolsPlugin::test_modelmanager_defines_per_project()
{
    ModelManagerTestHelper helper;

775 776 777 778
    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"));
779 780 781

    CppModelManager *mm = CppModelManager::instance();

782
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project"));
783

784
    typedef ProjectPartHeaderPath HeaderPath;
785

786
    ProjectPart::Ptr part1(new ProjectPart);
787
    part1->projectFile = QLatin1String("project1.projectfile");
788 789
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
790
    part1->languageVersion = ProjectPart::CXX11;
791
    part1->qtVersion = ProjectPart::NoQt;
792
    part1->projectDefines = QByteArray("#define SUB1\n");
793
    part1->headerPaths = { HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath) };
794 795

    ProjectPart::Ptr part2(new ProjectPart);
796
    part2->projectFile = QLatin1String("project1.projectfile");
797 798
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
799
    part2->languageVersion = ProjectPart::CXX11;
800
    part2->qtVersion = ProjectPart::NoQt;
801
    part2->projectDefines = QByteArray("#define SUB2\n");
802
    part2->headerPaths = { HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath) };
803

804
    ProjectInfo pi = ProjectInfo(project);
805 806
    pi.appendProjectPart(part1);
    pi.appendProjectPart(part2);
807
    pi.finish();
808

809
    helper.updateProjectInfo(pi);
810 811 812
    QCOMPARE(mm->snapshot().size(), 4);

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

815 816 817 818 819 820 821 822 823 824 825 826 827
    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);
828 829
        EditorCloser closer(editor);
        QVERIFY(editor);
hjk's avatar
hjk committed
830
        QCOMPARE(Core::DocumentModel::openedDocuments().size(), 1);
831 832
        QVERIFY(mm->isCppEditor(editor));

833
        Document::Ptr doc = mm->document(fileName);
834
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
835 836
    }
}
837

838
void CppToolsPlugin::test_modelmanager_precompiled_headers()
839 840 841
{
    ModelManagerTestHelper helper;

842 843 844 845 846 847
    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"));
848 849 850

    CppModelManager *mm = CppModelManager::instance();

851
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project_pch"));
852

853
    typedef ProjectPartHeaderPath HeaderPath;
854

855
    ProjectPart::Ptr part1(new ProjectPart);
856
    part1->projectFile = QLatin1String("project1.project