cpptoolstestcase.cpp 9.26 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 31 32 33
**
** 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 "cpptoolstestcase.h"

#include <coreplugin/editormanager/editormanager.h>
34 35
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/session.h>
36
#include <texteditor/texteditor.h>
37 38
#include <texteditor/codeassist/iassistproposal.h>
#include <texteditor/codeassist/iassistproposalmodel.h>
39 40 41 42 43 44

#include <cplusplus/CppDocument.h>
#include <utils/fileutils.h>

#include <QtTest>

45 46
using namespace ProjectExplorer;

47 48
static bool closeEditorsWithoutGarbageCollectorInvocation(const QList<Core::IEditor *> &editors)
{
49
    CppTools::CppModelManager::instance()->enableGarbageCollector(false);
50
    const bool closeEditorsSucceeded = Core::EditorManager::closeEditors(editors, false);
51
    CppTools::CppModelManager::instance()->enableGarbageCollector(true);
52 53 54
    return closeEditorsSucceeded;
}

55
static bool snapshotContains(const CPlusPlus::Snapshot &snapshot, const QSet<QString> &filePaths)
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
{
    foreach (const QString &filePath, filePaths) {
        if (!snapshot.contains(filePath)) {
            const QString warning = QLatin1String("Missing file in snapshot: ") + filePath;
            QWARN(qPrintable(warning));
            return false;
        }
    }
    return true;
}

namespace CppTools {
namespace Tests {

TestDocument::TestDocument(const QByteArray &fileName, const QByteArray &source, char cursorMarker)
71 72 73
    : m_fileName(QString::fromUtf8(fileName))
    , m_source(QString::fromUtf8(source))
    , m_cursorMarker(cursorMarker)
74 75 76 77
{}

QString TestDocument::filePath() const
{
78 79 80
    if (!QFileInfo(m_fileName).isAbsolute())
        return QDir::tempPath() + QLatin1Char('/') + m_fileName;
    return m_fileName;
81 82 83 84
}

bool TestDocument::writeToDisk() const
{
85
    return TestCase::writeFile(filePath(), m_source.toUtf8());
86 87 88
}

TestCase::TestCase(bool runGarbageCollector)
89
    : m_modelManager(CppModelManager::instance())
90
    , m_succeededSoFar(false)
91 92 93 94
    , m_runGarbageCollector(runGarbageCollector)
{
    if (m_runGarbageCollector)
        QVERIFY(garbageCollectGlobalSnapshot());
95
    m_succeededSoFar = true;
96 97 98 99
}

TestCase::~TestCase()
{
100
    QVERIFY(closeEditorsWithoutGarbageCollectorInvocation(m_editorsToClose));
101 102 103 104 105 106
    QCoreApplication::processEvents();

    if (m_runGarbageCollector)
        QVERIFY(garbageCollectGlobalSnapshot());
}

107 108 109 110 111
bool TestCase::succeededSoFar() const
{
    return m_succeededSoFar;
}

Nikolai Kosjar's avatar
Nikolai Kosjar committed
112 113 114 115 116 117 118 119 120 121 122 123
bool TestCase::openBaseTextEditor(const QString &fileName, TextEditor::BaseTextEditor **editor)
{
    typedef TextEditor::BaseTextEditor BTEditor;
    if (BTEditor *e = qobject_cast<BTEditor *>(Core::EditorManager::openEditor(fileName))) {
        if (editor) {
            *editor = e;
            return true;
        }
    }
    return false;
}

124 125
CPlusPlus::Snapshot TestCase::globalSnapshot()
{
126
    return CppModelManager::instance()->snapshot();
127 128 129 130
}

bool TestCase::garbageCollectGlobalSnapshot()
{
131
    CppModelManager::instance()->GC();
132 133 134
    return globalSnapshot().isEmpty();
}

135
bool TestCase::parseFiles(const QSet<QString> &filePaths)
136
{
137
    CppModelManager::instance()->updateSourceFiles(filePaths).waitForFinished();
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
    QCoreApplication::processEvents();
    const CPlusPlus::Snapshot snapshot = globalSnapshot();
    if (snapshot.isEmpty()) {
        QWARN("After parsing: snapshot is empty.");
        return false;
    }
    if (!snapshotContains(snapshot, filePaths)) {
        QWARN("After parsing: snapshot does not contain all expected files.");
        return false;
    }
    return true;
}

bool TestCase::parseFiles(const QString &filePath)
{
153
    return parseFiles(QSet<QString>() << filePath);
154 155 156 157 158 159 160 161
}

void TestCase::closeEditorAtEndOfTestCase(Core::IEditor *editor)
{
    if (editor && !m_editorsToClose.contains(editor))
        m_editorsToClose.append(editor);
}

162 163 164 165 166
bool TestCase::closeEditorWithoutGarbageCollectorInvocation(Core::IEditor *editor)
{
    return closeEditorsWithoutGarbageCollectorInvocation(QList<Core::IEditor *>() << editor);
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
CPlusPlus::Document::Ptr TestCase::waitForFileInGlobalSnapshot(const QString &filePath)
{
    return waitForFilesInGlobalSnapshot(QStringList(filePath)).first();
}

QList<CPlusPlus::Document::Ptr> TestCase::waitForFilesInGlobalSnapshot(
        const QStringList &filePaths)
{
    QList<CPlusPlus::Document::Ptr> result;
    foreach (const QString &filePath, filePaths) {
        forever {
            if (CPlusPlus::Document::Ptr document = globalSnapshot().document(filePath)) {
                result.append(document);
                break;
            }
            QCoreApplication::processEvents();
        }
    }
    return result;
}

188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
bool TestCase::waitUntilCppModelManagerIsAwareOf(Project *project, int timeOut)
{
    if (!project)
        return false;

    QTime t;
    t.start();

    CppModelManager *modelManager = CppModelManager::instance();
    forever {
        if (modelManager->projectInfo(project).isValid())
            return true;
        if (t.elapsed() > timeOut)
            return false;
        QCoreApplication::processEvents();
    }
}

206 207 208 209 210 211 212 213 214 215 216
bool TestCase::writeFile(const QString &filePath, const QByteArray &contents)
{
    Utils::FileSaver saver(filePath);
    if (!saver.write(contents) || !saver.finalize()) {
        const QString warning = QLatin1String("Failed to write file to disk: ") + filePath;
        QWARN(qPrintable(warning));
        return false;
    }
    return true;
}

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
ProjectOpenerAndCloser::ProjectOpenerAndCloser()
{
    QVERIFY(!SessionManager::hasProjects());
}

ProjectOpenerAndCloser::~ProjectOpenerAndCloser()
{
    foreach (Project *project, m_openProjects)
        ProjectExplorerPlugin::unloadProject(project);
}

ProjectInfo ProjectOpenerAndCloser::open(const QString &projectFile)
{
    QString error;
    Project *project = ProjectExplorerPlugin::openProject(projectFile, &error);
    if (!error.isEmpty())
        qWarning() << error;
    if (!project)
        return ProjectInfo();
    m_openProjects.append(project);

    if (TestCase::waitUntilCppModelManagerIsAwareOf(project))
        return CppModelManager::instance()->projectInfo(project);

    return ProjectInfo();
}

TemporaryCopiedDir::TemporaryCopiedDir(const QString &sourceDirPath)
    : m_temporaryDir(QDir::tempPath() + QLatin1String("/qtcreator-tests-XXXXXX"))
    , m_isValid(m_temporaryDir.isValid())
{
    if (!m_isValid)
        return;

    if (!sourceDirPath.isEmpty()) {
        QFileInfo fi(sourceDirPath);
        if (!fi.exists() || !fi.isReadable()) {
            m_isValid = false;
            return;
        }

        if (!Utils::FileUtils::copyRecursively(Utils::FileName::fromString(sourceDirPath),
                                               Utils::FileName::fromString(path()))) {
            m_isValid = false;
            return;
        }
    }
}

QString TemporaryCopiedDir::absolutePath(const QByteArray &relativePath) const
{
    return m_temporaryDir.path() + QLatin1Char('/') + QString::fromUtf8(relativePath);
}

271 272 273
FileWriterAndRemover::FileWriterAndRemover(const QString &filePath, const QByteArray &contents)
    : m_filePath(filePath)
{
274
    if (QFileInfo::exists(filePath)) {
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
        const QString warning = QString::fromLatin1(
            "Will not overwrite existing file: \"%1\"."
            " If this file is left over due to a(n) abort/crash, please remove manually.")
                .arg(m_filePath);
        QWARN(qPrintable(warning));
        m_writtenSuccessfully = false;
    } else {
        m_writtenSuccessfully = TestCase::writeFile(filePath, contents);
    }
}

FileWriterAndRemover::~FileWriterAndRemover()
{
    if (m_writtenSuccessfully && !QFile::remove(m_filePath)) {
        const QString warning = QLatin1String("Failed to remove file from disk: ") + m_filePath;
        QWARN(qPrintable(warning));
    }
}

294 295 296 297 298 299 300 301 302 303
IAssistProposalScopedPointer::IAssistProposalScopedPointer(TextEditor::IAssistProposal *proposal)
    : d(proposal)
{}

IAssistProposalScopedPointer::~IAssistProposalScopedPointer()
{
    if (d && d->model())
        delete d->model();
}

304 305
} // namespace Tests
} // namespace CppTools