cppmodelmanager_test.cpp 42.4 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 "builtineditordocumentparser.h"
32
#include "cppsourceprocessor.h"
33 34
#include "cpptoolsplugin.h"
#include "cpptoolstestcase.h"
35
#include "editordocumenthandle.h"
36 37
#include "modelmanagertesthelper.h"

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

#include <cplusplus/LookupContext.h>
45
#include <utils/hostosinfo.h>
46

47
#include <QDebug>
48 49
#include <QFileInfo>
#include <QtTest>
50

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

56
typedef CPlusPlus::Document Document;
57

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

60 61
namespace {

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

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

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

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

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

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

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

        Project *project = modelManagerTestHelper->createProject(name);
106
        projectInfo = ProjectInfo(project);
107 108

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

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

124 125 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
/// 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;
    }

151
    bool writeContents(const QByteArray &contents) const
152
    {
153
        return CppTools::Tests::TestCase::writeFile(m_filePath, contents);
154 155 156 157 158
    }

private:
    void restoreContents() const
    {
159
        CppTools::Tests::TestCase::writeFile(m_filePath, m_originalFileContents);
160 161 162 163 164 165
    }

    QByteArray m_originalFileContents;
    const QString &m_filePath;
};

166
static QSet<QString> updateProjectInfo(CppModelManager *modelManager, ModelManagerTestHelper *helper,
167 168 169 170 171 172 173 174
                                     const ProjectInfo &projectInfo)
{
    helper->resetRefreshedSourceFiles();
    modelManager->updateProjectInfo(projectInfo).waitForFinished();
    QCoreApplication::processEvents();
    return helper->waitForRefreshedSourceFiles();
}

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 189
    typedef ProjectPart::HeaderPath HeaderPath;

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 196
    part->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDir.includeDir(false), HeaderPath::IncludePath)
            << HeaderPath(testDataDir.frameworksDir(false), HeaderPath::FrameworkPath);
197
    pi.appendProjectPart(part);
198
    pi.finish();
199 200 201

    mm->updateProjectInfo(pi);

202 203 204 205 206
    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)));
207
}
208

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

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

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

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

223 224
    typedef ProjectPart::HeaderPath HeaderPath;

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

238
    mm->updateProjectInfo(pi).waitForFinished();
239 240
    QCoreApplication::processEvents();

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

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

266
    const MyTestDataDir testDataDir(_("testdata"));
267

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

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

275 276
    typedef ProjectPart::HeaderPath HeaderPath;

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

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

294 295 296 297
    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");
298

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

305
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
306 307 308 309 310 311

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));
312 313 314 315 316 317

    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");
318
}
319 320

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

328
    const MyTestDataDir testDataDir(_("testdata_refresh"));
329

330 331 332
    const QString testHeader1(testDataDir.file(_("defines.h")));
    const QString testHeader2(testDataDir.file(_("header.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
333

334
    Project *project = helper.createProject(_("test_modelmanager_refresh_several_times"));
335
    ProjectInfo pi = ProjectInfo(project);
336 337

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

    CPlusPlus::Snapshot snapshot;
348
    QSet<QString> refreshedFiles;
349 350
    CPlusPlus::Document::Ptr document;

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

366
        refreshedFiles = updateProjectInfo(mm, &helper, pi);
367
        QCOMPARE(refreshedFiles.size(), 3);
368

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

390 391 392 393 394 395 396
/// 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();

397 398
    const MyTestDataDir testDataDir(_("testdata_refresh"));
    const QString testCpp(testDataDir.file(_("source.cpp")));
399

400
    Project *project = helper.createProject(_("test_modelmanager_refresh_2"));
401
    ProjectInfo pi = ProjectInfo(project);
402 403

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

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

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

431
    const MyTestDataDir testDataDir(_("testdata_refresh"));
432

433 434 435
    const QString testHeader1(testDataDir.file(_("header.h")));
    const QString testHeader2(testDataDir.file(_("defines.h")));
    const QString testCpp(testDataDir.file(_("source.cpp")));
436

437
    Project *project = helper.createProject(_("test_modelmanager_refresh_3"));
438
    ProjectInfo pi = ProjectInfo(project);
439 440

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

    CPlusPlus::Snapshot snapshot;
449
    QSet<QString> refreshedFiles;
450

451
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
452 453 454 455 456 457 458 459 460 461

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

471
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

    // 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);
489 490 491 492 493 494 495 496
    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);
497 498 499 500

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

501
    Project *project = helper.createProject(_("test_modelmanager_refresh_timeStampModified"));
502
    ProjectInfo pi = ProjectInfo(project);
503 504

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

    Document::Ptr document;
    CPlusPlus::Snapshot snapshot;
515
    QSet<QString> refreshedFiles;
516

517
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
518 519 520

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

    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;";
537
    QVERIFY(fileChangerAndRestorer.writeContents(newFileContentes));
538 539 540

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

547
    refreshedFiles = updateProjectInfo(mm, &helper, pi);
548 549 550

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

569 570
    const QString testCpp = QLatin1String("source.cpp");
    const QString testCpp2 = QLatin1String("source2.cpp");
571 572

    const QString fileToChange = testCpp;
573 574
    const QStringList projectFiles1 = QStringList() << testCpp;
    const QStringList projectFiles2 = QStringList() << testCpp << testCpp2;
575 576 577 578 579 580 581 582

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

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

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

    // Project 1
594 595 596 597 598
    project1.create(_("test_modelmanager_snapshot_after_two_projects.1"),
                    _("testdata_project1"),
                    QStringList() << _("foo.h")
                                  << _("foo.cpp")
                                  << _("main.cpp"));
599

600
    refreshedFiles = updateProjectInfo(mm, &helper, project1.projectInfo);
601
    QCOMPARE(refreshedFiles, project1.projectFiles.toSet());
602 603 604 605 606 607
    const int snapshotSizeAfterProject1 = mm->snapshot().size();

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

    // Project 2
608 609 610 611 612
    project2.create(_("test_modelmanager_snapshot_after_two_projects.2"),
                    _("testdata_project2"),
                    QStringList() << _("bar.h")
                                  << _("bar.cpp")
                                  << _("main.cpp"));
613

614
    refreshedFiles = updateProjectInfo(mm, &helper, project2.projectInfo);
615
    QCOMPARE(refreshedFiles, project2.projectFiles.toSet());
616 617 618 619 620 621 622 623 624 625

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

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

633 634
void CppToolsPlugin::test_modelmanager_extraeditorsupport_uiFiles()
{
635
    VerifyCleanCppModelManager verify;
636

637 638 639
    TemporaryCopiedDir temporaryDir(MyTestDataDir(QLatin1String("testdata_guiproject1")).path());
    QVERIFY(temporaryDir.isValid());
    const QString projectFile = temporaryDir.absolutePath("testdata_guiproject1.pro");
640

641
    ProjectOpenerAndCloser projects;
642 643
    ProjectInfo projectInfo = projects.open(projectFile, /*configureAsExampleProject=*/ true);
    QVERIFY(projectInfo.isValid());
644 645 646

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

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

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

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

/// 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()
{
682 683
    ModelManagerTestHelper helper;

684 685
    MyTestDataDir testDataDirectory(_("testdata_guiproject1"));
    const QString file = testDataDirectory.file(_("main.cpp"));
686 687

    CppModelManager *mm = CppModelManager::instance();
688
    helper.resetRefreshedSourceFiles();
689 690

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

698 699
    // Wait until the file is refreshed
    helper.waitForRefreshedSourceFiles();
700 701

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

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

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

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

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

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

728 729
    // Wait until the file is refreshed and check whether it is in the working copy
    helper.waitForRefreshedSourceFiles();
730

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

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

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

void CppToolsPlugin::test_modelmanager_defines_per_project()
{
    ModelManagerTestHelper helper;

778 779 780 781
    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"));
782 783 784

    CppModelManager *mm = CppModelManager::instance();

785
    Project *project = helper.createProject(_("test_modelmanager_defines_per_project"));
786

787 788
    typedef ProjectPart::HeaderPath HeaderPath;

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

    ProjectPart::Ptr part2(new ProjectPart);
800
    part2->projectFile = QLatin1String("project1.projectfile");
801 802
    part2->files.append(ProjectFile(main2File, ProjectFile::CXXSource));
    part2->files.append(ProjectFile(header, ProjectFile::CXXHeader));
803
    part2->languageVersion = ProjectPart::CXX11;
804
    part2->qtVersion = ProjectPart::NoQt;
805
    part2->projectDefines = QByteArray("#define SUB2\n");
806 807
    part2->headerPaths = QList<HeaderPath>()
            << HeaderPath(testDataDirectory.includeDir(false), HeaderPath::IncludePath);
808

809
    ProjectInfo pi = ProjectInfo(project);
810 811
    pi.appendProjectPart(part1);
    pi.appendProjectPart(part2);
812
    pi.finish();
813

814
    updateProjectInfo(mm, &helper, pi);
815 816 817
    QCOMPARE(mm->snapshot().size(), 4);

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

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

838
        Document::Ptr doc = mm->document(fileName);
839
        QCOMPARE(nameOfFirstDeclaration(doc), firstDeclarationName);
840 841
    }
}
842

843
void CppToolsPlugin::test_modelmanager_precompiled_headers()
844 845 846
{
    ModelManagerTestHelper helper;

847 848 849 850 851 852
    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"));
853 854