CppEditor: tests for "Include Hierarchy"

Very simple tests for include hierarchy model:
* test if checked file includes one file
* test if checked file is included by one file
* test if checked file includes one file and is included by one file

Change-Id: I3688f9ddb86a569f780fc156bdfcf6b81a9fb0c1
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@digia.com>

src/plugins/cppeditor/cppeditor.pro

@@ -63,7 +63,8 @@ equals(TEST, 1) {
         cppquickfix_test_utils.cpp \
         cppdoxygen_test.cpp \
         fileandtokenactions_test.cpp \
-        followsymbol_switchmethoddecldef_test.cpp
+        followsymbol_switchmethoddecldef_test.cpp \
+        cppincludehierarchy_test.cpp
 
     DEFINES += SRCDIR=\\\"$$PWD\\\"
 }

src/plugins/cppeditor/cppeditor.qbs

@@ -79,6 +79,7 @@ QtcPlugin {
             "cppquickfix_test_utils.h",
             "fileandtokenactions_test.cpp",
             "followsymbol_switchmethoddecldef_test.cpp",
+            "cppincludehierarchy_test.cpp",
         ]
 
         cpp.defines: outer.concat(['SRCDIR="' + FileInfo.path(filePath) + '"'])

src/plugins/cppeditor/cppeditorplugin.h

@@ -308,6 +308,11 @@ private slots:
     void test_functionhelper_virtualFunctions();
     void test_functionhelper_virtualFunctions_data();
 
+    // tests for "Include Hiererchy"
+    void test_includeHierarchyModel_simpleIncludes();
+    void test_includeHierarchyModel_simpleIncludedBy();
+    void test_includeHierarchyModel_simpleIncludesAndIncludedBy();
+
     // The following tests depend on the projects that are loaded on startup
     // and will be skipped in case no projects are loaded.
     void test_openEachFile();

src/plugins/cppeditor/cppincludehierarchy_test.cpp

@@ -0,0 +1,134 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Przemyslaw Gorszkowski <pgorszkowski@gmail.com>
+** 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 "cppeditorplugin.h"
+#include "cppincludehierarchymodel.h"
+
+#include <cpptools/cppmodelmanagerinterface.h>
+#include <utils/fileutils.h>
+
+#include <QByteArray>
+#include <QList>
+#include <QtTest>
+
+using namespace CPlusPlus;
+using namespace CppEditor::Internal;
+using namespace CppTools;
+
+namespace {
+class TestCase
+{
+public:
+    TestCase(const QList<QByteArray> &sourceList)
+        : m_cmm(CppModelManagerInterface::instance())
+    {
+        QStringList filePaths;
+        const int sourceListSize = sourceList.size();
+        for (int i = 0; i < sourceListSize; ++i) {
+            const QByteArray &source = sourceList.at(i);
+
+            // Write source to file
+            const QString fileName = QString::fromLatin1("%1/file%2.h").arg(QDir::tempPath())
+                    .arg(i+1);
+            Utils::FileSaver srcSaver(fileName);
+            srcSaver.write(source);
+            srcSaver.finalize();
+
+            filePaths << fileName;
+        }
+
+        // Update Code Model
+        m_cmm->updateSourceFiles(filePaths);
+
+        // Wait for the parser in the future to give us the document
+        QStringList filePathsNotYetInSnapshot(filePaths);
+        forever {
+            const Snapshot snapshot = m_cmm->snapshot();
+            foreach (const QString &filePath, filePathsNotYetInSnapshot) {
+                if (snapshot.contains(filePath))
+                    filePathsNotYetInSnapshot.removeOne(filePath);
+            }
+            if (filePathsNotYetInSnapshot.isEmpty())
+                break;
+            QCoreApplication::processEvents();
+        }
+    }
+
+    ~TestCase()
+    {
+        m_cmm->GC();
+        QVERIFY(m_cmm->snapshot().isEmpty());
+    }
+
+    void run(int includesCount, int includedByCount) const
+    {
+        const QString fileName = QDir::tempPath() + QLatin1String("/file1.h");
+
+        CppIncludeHierarchyModel model(0);
+        model.buildHierarchy(fileName);
+        QCOMPARE(model.rowCount(model.index(0, 0)), includesCount);
+        QCOMPARE(model.rowCount(model.index(1, 0)), includedByCount);
+    }
+
+private:
+    CppModelManagerInterface *m_cmm;
+};
+}
+
+void CppEditorPlugin::test_includeHierarchyModel_simpleIncludes()
+{
+    QList<QByteArray> sourceList;
+    sourceList.append(QByteArray("#include \"file2.h\"\n"));
+    sourceList.append(QByteArray());
+
+    TestCase testCase(sourceList);
+    testCase.run(1, 0);
+}
+
+void CppEditorPlugin::test_includeHierarchyModel_simpleIncludedBy()
+{
+    QList<QByteArray> sourceList;
+    sourceList.append(QByteArray());
+    sourceList.append(QByteArray("#include \"file1.h\"\n"));
+
+    TestCase testCase(sourceList);
+    testCase.run(0, 1);
+}
+
+void CppEditorPlugin::test_includeHierarchyModel_simpleIncludesAndIncludedBy()
+{
+    QList<QByteArray> sourceList;
+    QByteArray source;
+    sourceList.append(QByteArray("#include \"file2.h\"\n"));
+    sourceList.append(QByteArray());
+    sourceList.append(QByteArray("#include \"file1.h\"\n"));
+
+    TestCase testCase(sourceList);
+    testCase.run(1, 1);
+}