CppEditor/CppTools: Fix plugin tests.

Starting with commit 243a625 EditorManager::closeEditors() does not
delete the editors anymore, but calls deleteLater(). When the call
returns, all kind of checks fail since the editor widget destructor was
not yet called.

Fixed by providing and calling Core::Tests::closeAndDeleteEditors(),
which explicitly sends QEvent::DeferredDelete to the widget.

Change-Id: I3287abbe74ccf7d7a18b997a847701c8be17cb55
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>

src/plugins/coreplugin/coreplugin.pro

@@ -241,3 +241,8 @@ else:unix {
     }
 }
 OTHER_FILES += editormanager/BinFiles.mimetypes.xml
+
+equals(TEST, 1) {
+    SOURCES += plugintestutils.cpp
+    HEADERS += plugintestutils.h
+}

src/plugins/coreplugin/coreplugin.qbs

@@ -1,5 +1,6 @@
 import qbs.base 1.0
 import "../QtcPlugin.qbs" as QtcPlugin
+import "../../../qbs/defaults.js" as Defaults
 
 QtcPlugin {
     name: "Core"
@@ -258,6 +259,15 @@ QtcPlugin {
         ]
     }
 
+    Group {
+        name: "Tests"
+        condition: Defaults.testsEnabled(qbs)
+        files: [
+            "plugintestutils.cpp",
+            "plugintestutils.h"
+        ]
+    }
+
     Export {
         Depends { name: "Aggregation" }
         Depends { name: "Utils" }

src/plugins/coreplugin/plugintestutils.cpp

@@ -0,0 +1,50 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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 "plugintestutils.h"
+
+#include "editormanager/editormanager.h"
+#include "editormanager/ieditor.h"
+
+#include <QCoreApplication>
+
+void Core::Tests::closeAndDeleteEditors(QList<IEditor *> editorsToClose)
+{
+    EditorManager::instance()->closeEditors(editorsToClose, /*askAboutModifiedEditors=*/ false);
+    // The editors are going to be deleted by the event loop (deleteLater()),
+    // but for tests we need them deleted now.
+    foreach (Core::IEditor *editor, editorsToClose)
+        QCoreApplication::sendPostedEvents(editor, QEvent::DeferredDelete);
+}
+
+void Core::Tests::closeAndDeleteEditor(Core::IEditor *editor)
+{
+    closeAndDeleteEditors(QList<IEditor *>() << editor);
+}

src/plugins/coreplugin/plugintestutils.h

@@ -0,0 +1,50 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** 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.
+**
+****************************************************************************/
+
+
+#ifndef PLUGINTESTUTILS_H
+#define PLUGINTESTUTILS_H
+
+#include "core_global.h"
+
+#include <QList>
+
+namespace Core {
+
+class IEditor;
+
+namespace Tests {
+
+void CORE_EXPORT closeAndDeleteEditor(Core::IEditor *editor);
+void CORE_EXPORT closeAndDeleteEditors(QList<Core::IEditor *> editorsToClose);
+
+} // namespace Tests
+} // namespace Core
+
+#endif // PLUGINTESTUTILS_H

src/plugins/cppeditor/cppdoxygen_test.cpp

@@ -30,6 +30,7 @@
 #include "cppeditor.h"
 
 #include <coreplugin/editormanager/editormanager.h>
+#include <coreplugin/plugintestutils.h>
 #include <cplusplus/CppDocument.h>
 #include <cppeditor/cppeditor.h>
 #include <cppeditor/cppeditorplugin.h>
@@ -115,8 +116,7 @@ TestCase::TestCase(const QByteArray &input)
 
 TestCase::~TestCase()
 {
-    EditorManager::instance()->closeEditors(QList<Core::IEditor *>() << editor, false);
-    QCoreApplication::processEvents(); // process any pending events
+    Core::Tests::closeAndDeleteEditor(editor);
 
     // Remove the test file from the code-model
     CppTools::CppModelManagerInterface *mmi = CppTools::CppModelManagerInterface::instance();

src/plugins/cppeditor/cppquickfix_test.cpp

@@ -34,6 +34,7 @@
 #include "cppquickfixassistant.h"
 #include "cppquickfixes.h"
 
+#include <coreplugin/plugintestutils.h>
 #include <cpptools/cppcodestylepreferences.h>
 #include <cpptools/cppmodelmanager.h>
 #include <cpptools/cpppreprocessor.h>
@@ -237,6 +238,7 @@ void TestCase::init(const QStringList &includePaths)
 
         // Rehighlight
         testFile->editorWidget->semanticRehighlight(true);
+
         // Wait for the semantic info from the future
         while (testFile->editorWidget->semanticInfo().doc.isNull())
             QCoreApplication::processEvents();
@@ -262,8 +264,7 @@ TestCase::~TestCase()
         if (testFile->editor)
             editorsToClose << testFile->editor;
     }
-    EditorManager::instance()->closeEditors(editorsToClose, false);
-    QCoreApplication::processEvents(); // process any pending events
+    Core::Tests::closeAndDeleteEditors(editorsToClose);
 
     // Remove the test files from the code-model
     CppModelManagerInterface *mmi = CppModelManagerInterface::instance();

src/plugins/cppeditor/followsymbol_switchmethoddecldef_test.cpp

@@ -30,6 +30,7 @@
 #include "cppeditor.h"
 #include "cppeditorplugin.h"
 
+#include <coreplugin/plugintestutils.h>
 #include <utils/fileutils.h>
 
 #include <QDebug>
@@ -251,8 +252,7 @@ TestCase::~TestCase()
         if (testFile->editor)
             editorsToClose << testFile->editor;
     }
-    EditorManager::instance()->closeEditors(editorsToClose, false);
-    QCoreApplication::processEvents(); // process any pending events
+    Core::Tests::closeAndDeleteEditors(editorsToClose);
 
     // Remove the test files from the code-model
     CppModelManagerInterface *mmi = CppTools::CppModelManagerInterface::instance();

src/plugins/cpptools/cppcompletion_test.cpp

@@ -31,6 +31,7 @@
 #include "cppcompletionassist.h"
 #include "cppmodelmanager.h"
 
+#include <coreplugin/plugintestutils.h>
 #include <texteditor/plaintexteditor.h>
 #include <texteditor/codeassist/iassistproposal.h>
 
@@ -90,8 +91,7 @@ public:
 
     ~CompletionTestCase()
     {
-        EditorManager::instance()->closeEditors(QList<IEditor*>() << editor,
-                                                /*askAboutModifiedEditors=*/ false);
+        Core::Tests::closeAndDeleteEditor(editor);
         cmm->GC();
         QVERIFY(cmm->snapshot().isEmpty());
     }