typehierarchybuilder_test.cpp 6.78 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 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 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 151 152 153 154 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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
** 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"

#include "cppmodelmanagerinterface.h"
#include "typehierarchybuilder.h"

#include <cplusplus/SymbolVisitor.h>
#include <cplusplus/Overview.h>
#include <utils/fileutils.h>

#include <QDir>
#include <QtTest>

using namespace CPlusPlus;
using namespace CppTools;
using namespace CppTools::Internal;

namespace {

bool hierarchySorter(const TypeHierarchy &h1, const TypeHierarchy &h2)
{
    Overview oo;
    return oo.prettyName(h1.symbol()->name()) < oo.prettyName(h2.symbol()->name());
}

QString toString(const TypeHierarchy &hierarchy, int indent = 0)
{
    Symbol *symbol = hierarchy.symbol();
    QString result = QString(indent, QLatin1Char(' '))
        + Overview().prettyName(symbol->name()) + QLatin1Char('\n');

    QList<TypeHierarchy> sortedHierarchy = hierarchy.hierarchy();
    qSort(sortedHierarchy.begin(), sortedHierarchy.end(), hierarchySorter);
    foreach (TypeHierarchy childHierarchy, sortedHierarchy)
        result += toString(childHierarchy, indent + 2);
    return result;
}

class FindFirstClassInDocument: private SymbolVisitor
{
public:
    FindFirstClassInDocument() : m_clazz(0) {}

    Class *operator()(const Document::Ptr &document)
    {
        accept(document->globalNamespace());
        return m_clazz;
    }

private:
    bool preVisit(Symbol *symbol)
    {
        if (m_clazz)
            return false;

        if (Class *c = symbol->asClass()) {
            m_clazz = c;
            return false;
        }

        return true;
    }

    Class *m_clazz;
};

struct TestDocument
{
public:
    TestDocument(const QString &fileName, const QString &contents)
        : fileName(fileName), contents(contents) {}

    QString fileName;
    QString contents;
};

class TestCase
{
public:
    TestCase(const QList<TestDocument> &documents, const QString &expectedHierarchy)
        : m_modelManager(CppModelManagerInterface::instance())
        , m_documents(documents)
        , m_expectedHierarchy(expectedHierarchy)
    {
        QVERIFY(m_modelManager->snapshot().isEmpty());
    }

    void run()
    {
        // Write files
        QStringList filePaths;
        foreach (const TestDocument &document, m_documents) {
            const QString filePath = QDir::tempPath() + QLatin1Char('/') + document.fileName;
            Utils::FileSaver documentSaver(filePath);
            documentSaver.write(document.contents.toUtf8());
            documentSaver.finalize();
            filePaths << filePath;
        }

        // Parse files
        m_modelManager->updateSourceFiles(filePaths).waitForFinished();

        // Get class for which to generate the hierarchy
        const Snapshot snapshot = m_modelManager->snapshot();
        QVERIFY(!snapshot.isEmpty());
        const Document::Ptr firstDocument = snapshot.document(filePaths.first());
        Class *clazz = FindFirstClassInDocument()(firstDocument);
        QVERIFY(clazz);

        // Generate and compare hierarchies
        TypeHierarchyBuilder typeHierarchyBuilder(clazz, snapshot);
        const TypeHierarchy hierarchy = typeHierarchyBuilder.buildDerivedTypeHierarchy();

        const QString actualHierarchy = toString(hierarchy);
//        Uncomment for updating/generating reference data:
//        qDebug() << actualHierarchy;
        QCOMPARE(actualHierarchy, m_expectedHierarchy);
    }

    ~TestCase()
    {
        m_modelManager->GC();
        QVERIFY(m_modelManager->snapshot().isEmpty());
    }

private:
    CppModelManagerInterface *m_modelManager;
    QList<TestDocument> m_documents;
    QString m_expectedHierarchy;
};

} // anonymous namespace

Q_DECLARE_METATYPE(QList<TestDocument>)

void CppToolsPlugin::test_typehierarchy_data()
{
    QTest::addColumn<QList<TestDocument> >("documents");
    QTest::addColumn<QString>("expectedHierarchy");

    typedef QLatin1String _;

    QTest::newRow("basic-single-document")
        << (QList<TestDocument>()
            << TestDocument(_("a.h"),
                            _("class A {};\n"
                              "class B : public A {};\n"
                              "class C1 : public B {};\n"
                              "class C2 : public B {};\n"
                              "class D : public C1 {};\n")))
        << QString::fromLatin1(
            "A\n"
            "  B\n"
            "    C1\n"
            "      D\n"
            "    C2\n" );

    QTest::newRow("basic-multiple-documents")
        << (QList<TestDocument>()
            << TestDocument(_("a.h"),
                            _("class A {};"))
            << TestDocument(_("b.h"),
                            _("#include \"a.h\"\n"
                              "class B : public A {};"))
            << TestDocument(_("c1.h"),
                            _("#include \"b.h\"\n"
                              "class C1 : public B {};"))
            << TestDocument(_("c2.h"),
                            _("#include \"b.h\"\n"
                              "class C2 : public B {};"))
            << TestDocument(_("d.h"),
                            _("#include \"c1.h\"\n"
                              "class D : public C1 {};")))
        << QString::fromLatin1(
            "A\n"
            "  B\n"
            "    C1\n"
            "      D\n"
            "    C2\n"
            );
}

void CppToolsPlugin::test_typehierarchy()
{
    QFETCH(QList<TestDocument>, documents);
    QFETCH(QString, expectedHierarchy);

    TestCase testCase(documents, expectedHierarchy);
    testCase.run();
}