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

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

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

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

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

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

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

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

62
63
namespace {

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

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

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

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

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

    /// 'files' is expected to be a list of file names that reside in 'dir'.
    void create(const QString &name, const QString &dir, const QStringList files)
    {
92
        const MyTestDataDir projectDir(dir);
93
94
95
96
97
98
99
100
101
102
103
104
105
106
        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);
        }
107
        projectInfo.appendProjectPart(part);
108
109
110
111
112
113
114
    }

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

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

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

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

    ~FileChangerAndRestorer()
    {
        restoreContents();
    }

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

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

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

    QByteArray m_originalFileContents;
    const QString &m_filePath;
};

202
203
} // anonymous namespace

204
205
/// Check: The preprocessor cleans include and framework paths.
void CppToolsPlugin::test_modelmanager_paths_are_clean()
206
207
208
209
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

210
    const MyTestDataDir testDataDir(QLatin1String("testdata"));
211

212
    Project *project = helper.createProject(QLatin1String("test_modelmanager_paths_are_clean"));
213
214
215
216
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
217
    part->cxxVersion = ProjectPart::CXX98;
218
219
    part->qtVersion = ProjectPart::Qt5;
    part->defines = QByteArray("#define OH_BEHAVE -1\n");
220
221
    part->includePaths = QStringList() << testDataDir.includeDir(false);
    part->frameworkPaths = QStringList() << testDataDir.frameworksDir(false);
222
    pi.appendProjectPart(part);
223
224
225
226
227

    mm->updateProjectInfo(pi);

    QStringList includePaths = mm->includePaths();
    QCOMPARE(includePaths.size(), 1);
228
    QVERIFY(includePaths.contains(testDataDir.includeDir()));
229
230
231

    QStringList frameworkPaths = mm->frameworkPaths();
    QCOMPARE(frameworkPaths.size(), 1);
232
    QVERIFY(frameworkPaths.contains(testDataDir.frameworksDir()));
233
}
234

235
/// Check: Frameworks headers are resolved.
236
237
void CppToolsPlugin::test_modelmanager_framework_headers()
{
238
239
240
    if (Utils::HostOsInfo::isWindowsHost())
        MSKIP_SINGLE("Can't resolve framework soft links on Windows.");

241
242
243
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

244
    const MyTestDataDir testDataDir(QLatin1String("testdata"));
245

246
247
248
249
250
    Project *project = helper.createProject(QLatin1String("test_modelmanager_framework_headers"));
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
251
    part->cxxVersion = ProjectPart::CXX98;
252
253
    part->qtVersion = ProjectPart::Qt5;
    part->defines = QByteArray("#define OH_BEHAVE -1\n");
254
255
256
257
    part->includePaths << testDataDir.includeDir();
    part->frameworkPaths << testDataDir.frameworksDir();
    const QString &source = testDataDir.fileFromSourcesDir(
        QLatin1String("test_modelmanager_framework_headers.cpp"));
258
    part->files << ProjectFile(source, ProjectFile::CXXSource);
259
    pi.appendProjectPart(part);
260

261
    mm->updateProjectInfo(pi).waitForFinished();
262
263
    QCoreApplication::processEvents();

264
265
    QVERIFY(mm->snapshot().contains(source));
    Document::Ptr doc = mm->snapshot().document(source);
266
267
268
269
270
271
272
273
274
275
276
277
278
279
    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"));
    }
}
280
281

/// QTCREATORBUG-9056
282
283
284
/// 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()
285
286
287
288
{
    ModelManagerTestHelper helper;
    CppModelManager *mm = CppModelManager::instance();

289
    const MyTestDataDir testDataDir(QLatin1String("testdata"));
290
291
292
293
294

    const QString testCpp(testDataDir.fileFromSourcesDir(
        QLatin1String("test_modelmanager_refresh.cpp")));
    const QString testHeader(testDataDir.fileFromSourcesDir(
        QLatin1String("test_modelmanager_refresh.h")));
295

296
297
    Project *project = helper.createProject(
                QLatin1String("test_modelmanager_refresh_also_includes_of_project_files"));
298
299
300
301
302
303
304
    ProjectInfo pi = mm->projectInfo(project);
    QCOMPARE(pi.project().data(), project);

    ProjectPart::Ptr part(new ProjectPart);
    part->cxxVersion = ProjectPart::CXX98;
    part->qtVersion = ProjectPart::Qt5;
    part->defines = QByteArray("#define OH_BEHAVE -1\n");
305
    part->includePaths = QStringList() << testDataDir.includeDir(false);
306
    part->files.append(ProjectFile(testCpp, ProjectFile::CXXSource));
307
    pi.appendProjectPart(part);
308
309
310
311
312
313
314
315
316
317
    mm->updateProjectInfo(pi);

    QStringList refreshedFiles = helper.waitForRefreshedSourceFiles();

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    CPlusPlus::Snapshot snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));

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

323
324
325
326
327
    // Introduce a define that will enable another define once the document is reparsed.
    part->defines = QByteArray("#define TEST_DEFINE 1\n");
    pi.clearProjectParts();
    pi.appendProjectPart(part);
    mm->updateProjectInfo(pi);
328

329
330
331
332
333
334
335
    refreshedFiles = helper.waitForRefreshedSourceFiles();

    QCOMPARE(refreshedFiles.size(), 1);
    QVERIFY(refreshedFiles.contains(testCpp));
    snapshot = mm->snapshot();
    QVERIFY(snapshot.contains(testHeader));
    QVERIFY(snapshot.contains(testCpp));
336
337
338
339
340
341

    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");
342
}
343
344

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

352
    const MyTestDataDir testDataDir(QLatin1String("testdata_refresh"));
353
354
355
356
357

    const QString testHeader1(testDataDir.file(QLatin1String("defines.h")));
    const QString testHeader2(testDataDir.file(QLatin1String("header.h")));
    const QString testCpp(testDataDir.file(QLatin1String("source.cpp")));

358
359
    Project *project = helper.createProject(
                QLatin1String("test_modelmanager_refresh_several_times"));
360
361
362
363
364
365
366
367
368
    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));
369
    pi.appendProjectPart(part);
370
371
372
373
374
375
    mm->updateProjectInfo(pi);

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

376
    QByteArray defines = "#define FIRST_DEFINE";
377
    for (int i = 0; i < 2; ++i) {
378
379
380
381
382
383
384
385
386
387
388
389
390
        pi.clearProjectParts();
        ProjectPart::Ptr part(new ProjectPart);
        // Simulate project configuration change by having different defines each time.
        defines += "\n#define ANOTHER_DEFINE";
        part->defines = defines;
        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);

        mm->updateProjectInfo(pi);
391

392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
        refreshedFiles = helper.waitForRefreshedSourceFiles();

        QCOMPARE(refreshedFiles.size(), 3);
        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());
    }
}
415

416
417
418
419
420
421
422
/// 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();

423
    const MyTestDataDir testDataDir(QLatin1String("testdata_refresh"));
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
    const QString testCpp(testDataDir.file(QLatin1String("source.cpp")));

    Project *project = helper.createProject(QLatin1String("test_modelmanager_refresh_2"));
    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
    QFuture<void> firstFuture = mm->updateProjectInfo(pi);
    QVERIFY(firstFuture.isStarted() || firstFuture.isRunning());
    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());
}

448
449
450
451
452
453
454
/// 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();

455
    const MyTestDataDir testDataDir(QLatin1String("testdata_refresh"));
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588

    const QString testHeader1(testDataDir.file(QLatin1String("header.h")));
    const QString testHeader2(testDataDir.file(QLatin1String("defines.h")));
    const QString testCpp(testDataDir.file(QLatin1String("source.cpp")));

    Project *project = helper.createProject(QLatin1String("test_modelmanager_refresh_3"));
    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;

    mm->updateProjectInfo(pi);
    refreshedFiles = helper.waitForRefreshedSourceFiles();

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

    mm->updateProjectInfo(pi);
    refreshedFiles = helper.waitForRefreshedSourceFiles();

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

    Project *project = helper.createProject(
        QLatin1String("test_modelmanager_refresh_timeStampModified"));
    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;

    mm->updateProjectInfo(pi);
    refreshedFiles = helper.waitForRefreshedSourceFiles();

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

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

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

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

    mm->updateProjectInfo(pi);
    refreshedFiles = helper.waitForRefreshedSourceFiles();

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

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

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

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

    // Project 1
618
    project1.create(QLatin1String("test_modelmanager_snapshot_after_two_projects.1"),
619
620
621
622
623
624
625
626
627
628
629
630
631
632
                    QLatin1String("testdata_project1"),
                    QStringList() << QLatin1String("foo.h")
                                  << QLatin1String("foo.cpp")
                                  << QLatin1String("main.cpp"));

    mm->updateProjectInfo(project1.projectInfo);
    refreshedFiles = helper.waitForRefreshedSourceFiles();
    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
633
    project2.create(QLatin1String("test_modelmanager_snapshot_after_two_projects.2"),
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
                    QLatin1String("testdata_project2"),
                    QStringList() << QLatin1String("bar.h")
                                  << QLatin1String("bar.cpp")
                                  << QLatin1String("main.cpp"));

    mm->updateProjectInfo(project2.projectInfo);
    refreshedFiles = helper.waitForRefreshedSourceFiles();
    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));
}
652

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

661
    MyTestDataDir testDataDirectory(QLatin1String("testdata_guiproject1"));
662
663
664
    const QString projectFile = testDataDirectory.file(QLatin1String("testdata_guiproject1.pro"));

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

    // 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;
677
    QHashIterator<QString, QPair<QByteArray, unsigned> > it = workingCopy.iterator();
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
    while (it.hasNext()) {
        it.next();
        fileNamesInWorkinCopy << QFileInfo(it.key()).fileName();
    }
    fileNamesInWorkinCopy.sort();
    const QString expectedUiHeaderFileName = QLatin1String("ui_mainwindow.h");
    QCOMPARE(fileNamesInWorkinCopy.at(0), mm->configurationFileName());
    QCOMPARE(fileNamesInWorkinCopy.at(1), expectedUiHeaderFileName);

    // Check CppPreprocessor / includes.
    // The CppPreprocessor is expected to find the ui_* file in the working copy.
    const QString fileIncludingTheUiFile = testDataDirectory.file(QLatin1String("mainwindow.cpp"));
    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);
    QCOMPARE(QFileInfo(includedFiles.at(0)).fileName(), QLatin1String("mainwindow.h"));
    QCOMPARE(QFileInfo(includedFiles.at(1)).fileName(), QLatin1String("ui_mainwindow.h"));

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

/// 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()
{
710
711
    ModelManagerTestHelper helper;

712
    MyTestDataDir testDataDirectory(QLatin1String("testdata_guiproject1"));
713
714
715
716
717
718
    const QString file = testDataDirectory.file(QLatin1String("main.cpp"));

    CppModelManager *mm = CppModelManager::instance();

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

725
726
    // Wait until the file is refreshed
    helper.waitForRefreshedSourceFiles();
727
728

    // Close file/editor
729
    Core::Tests::closeAndDeleteEditor(editor);
730
    helper.waitForFinishedGc();
731
732
733
734
735

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

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

742
    MyTestDataDir testDataDirectory(QLatin1String("testdata_guiproject1"));
743
744
745
746
747
748
    const QString file = testDataDirectory.file(QLatin1String("main.cpp"));

    CppModelManager *mm = CppModelManager::instance();

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

754
755
    // Wait until the file is refreshed and check whether it is in the working copy
    helper.waitForRefreshedSourceFiles();
756
757
758
759
760
761
762
763
764
765
    QVERIFY(mm->workingCopy().contains(file));

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

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

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

namespace {
struct EditorCloser {
    Core::IEditor *editor;
    EditorCloser(Core::IEditor *editor): editor(editor) {}
    ~EditorCloser()
    {
        if (editor)
778
            Core::Tests::closeAndDeleteEditor(editor);
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
    }
};
}

void CppToolsPlugin::test_modelmanager_defines_per_project()
{
    ModelManagerTestHelper helper;

    MyTestDataDir testDataDirectory(QLatin1String("testdata_defines"));
    const QString main1File = testDataDirectory.file(QLatin1String("main1.cpp"));
    const QString main2File = testDataDirectory.file(QLatin1String("main2.cpp"));
    const QString header = testDataDirectory.file(QLatin1String("header.h"));

    CppModelManager *mm = CppModelManager::instance();

    Project *project = helper.createProject(QLatin1String("test_modelmanager_defines_per_project"));

    ProjectPart::Ptr part1(new ProjectPart);
    part1->files.append(ProjectFile(main1File, ProjectFile::CXXSource));
    part1->files.append(ProjectFile(header, ProjectFile::CXXHeader));
    part1->cxxVersion = ProjectPart::CXX11;
    part1->qtVersion = ProjectPart::NoQt;
    part1->defines = QByteArray("#define SUB1\n");
    part1->includePaths = QStringList() << testDataDirectory.includeDir(false);

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

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

    mm->updateProjectInfo(pi);

    helper.waitForRefreshedSourceFiles();

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

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

    {
        Core::IEditor *editor = Core::EditorManager::openEditor(main1File);
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

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

        Document::Ptr doc = mm->snapshot().document(main1File);
        QVERIFY(doc);
        QVERIFY(doc->globalNamespace());
        QCOMPARE(doc->globalSymbolCount(), 1U);
        CPlusPlus::Symbol *s = doc->globalSymbolAt(0);
        QVERIFY(s);
        CPlusPlus::Declaration *decl = s->asDeclaration();
        QVERIFY(decl);
        QVERIFY(decl->type()->isIntegerType());
        QCOMPARE(decl->name()->identifier()->chars(), "one");
    }

    {
        Core::IEditor *editor = Core::EditorManager::openEditor(main2File);
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

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

        Document::Ptr doc = mm->snapshot().document(main2File);
        QVERIFY(doc);
        QVERIFY(doc->globalNamespace());
        QCOMPARE(doc->globalSymbolCount(), 1U);
        CPlusPlus::Symbol *s = doc->globalSymbolAt(0);
        QVERIFY(s);
        CPlusPlus::Declaration *decl = s->asDeclaration();
        QVERIFY(decl);
        QVERIFY(decl->type()->isIntegerType());
        QCOMPARE(decl->name()->identifier()->chars(), "two");
    }
}
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972

void CppToolsPlugin::test_modelmanager_defines_per_project_pch()
{
    ModelManagerTestHelper helper;

    MyTestDataDir testDataDirectory(QLatin1String("testdata_defines"));
    const QString main1File = testDataDirectory.file(QLatin1String("main1.cpp"));
    const QString main2File = testDataDirectory.file(QLatin1String("main2.cpp"));
    const QString header = testDataDirectory.file(QLatin1String("header.h"));
    const QString pch1File = testDataDirectory.file(QLatin1String("pch1.h"));
    const QString pch2File = testDataDirectory.file(QLatin1String("pch2.h"));

    CppModelManager *mm = CppModelManager::instance();

    Project *project = helper.createProject(
                QLatin1String("test_modelmanager_defines_per_project_pch"));

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

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

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

    mm->updateProjectInfo(pi);

    helper.waitForRefreshedSourceFiles();

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

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

    {
        Core::IEditor *editor = Core::EditorManager::openEditor(main1File);
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

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

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

        Document::Ptr doc = mm->snapshot().document(main1File);
        QVERIFY(doc);
        QVERIFY(doc->globalNamespace());
        QCOMPARE(doc->globalSymbolCount(), 1U);
        CPlusPlus::Symbol *s = doc->globalSymbolAt(0);
        QVERIFY(s);
        CPlusPlus::Declaration *decl = s->asDeclaration();
        QVERIFY(decl);
        QVERIFY(decl->type()->isIntegerType());
        QCOMPARE(decl->name()->identifier()->chars(), "one");
    }

    {
        Core::IEditor *editor = Core::EditorManager::openEditor(main2File);
        EditorCloser closer(editor);
        QVERIFY(editor);
        QCOMPARE(Core::EditorManager::documentModel()->openedDocuments().size(), 1);
        QVERIFY(mm->isCppEditor(editor));

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

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

        Document::Ptr doc = mm->snapshot().document(main2File);
        QVERIFY(doc);
        QVERIFY(doc->globalNamespace());
        QCOMPARE(doc->globalSymbolCount(), 1U);
        CPlusPlus::Symbol *s = doc->globalSymbolAt(0);
        QVERIFY(s);
        CPlusPlus::Declaration *decl = s->asDeclaration();
        QVERIFY(decl);
        QVERIFY(decl->type()->isIntegerType());
        QCOMPARE(decl->name()->identifier()->chars(), "two");
    }
}