Wizards: Add a simple wizard for unit tests.

src/plugins/qt4projectmanager/wizards/testwizard.cpp

@@ -0,0 +1,179 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include "testwizard.h"
+#include "testwizarddialog.h"
+#include <cpptools/cppmodelmanager.h>
+
+#include <utils/qtcassert.h>
+
+#include <QtCore/QTextStream>
+#include <QtCore/QFileInfo>
+
+#include <QtGui/QIcon>
+
+namespace Qt4ProjectManager {
+namespace Internal {
+
+TestWizard::TestWizard() :
+    QtWizard(QLatin1String("E.Qt4Test"),
+             tr("Qt4 Unit Test"),
+             tr("Creates a Qt4 Unit Test."),
+             QIcon(QLatin1String(":/wizards/images/console.png")))
+{
+}
+
+QWizard *TestWizard::createWizardDialog(QWidget *parent,
+                                        const QString &defaultPath,
+                                        const WizardPageList &extensionPages) const
+{
+    TestWizardDialog *dialog = new TestWizardDialog(name(), icon(), extensionPages, parent);
+    dialog->setPath(defaultPath);
+    dialog->setName(TestWizardDialog::projectName(defaultPath));
+    return dialog;
+}
+
+// ---------------- code generation helpers
+static const char initTestCaseC[] = "initTestCase";
+static const char cleanupTestCaseC[] = "cleanupTestCase";
+static const char closeFunctionC[] = "}\n\n";
+static const char testDataTypeC[] = "QString";
+
+static inline void writeVoidMemberDeclaration(QTextStream &str,
+                                              const QString &indent,
+                                              const QString &methodName)
+{
+    str << indent << "void " << methodName << "();\n";
+}
+
+static inline void writeVoidMemberBody(QTextStream &str,
+                                       const QString &className,
+                                       const QString &methodName,
+                                       bool close = true)
+{
+    str << "void " << className << "::" << methodName << "()\n{\n";
+    if (close)
+        str << closeFunctionC;
+}
+
+static QString generateTestCode(const TestWizardParameters &testParams,
+                                const QString &sourceBaseName)
+{
+    QString rc;
+    const QString indent = QString(4, QLatin1Char(' '));
+    QTextStream str(&rc);
+    // Includes
+    str << CppTools::AbstractEditorSupport::licenseTemplate()
+        << "#include <QtCore/QString>\n#include <QtTest/QtTest>\n";
+    if (testParams.requiresQApplication)
+        str << "#include <QtCore/QCoreApplication>\n";
+    // Class declaration
+    str  << "\nclass " << testParams.className << " : public QObject\n"
+        "{\n" << indent << "Q_OBJECT\n\npublic:\n"
+        << indent << testParams.className << "();\n\nprivate Q_SLOTS:\n";
+    if (testParams.initializationCode) {
+        writeVoidMemberDeclaration(str, indent, QLatin1String(initTestCaseC));
+        writeVoidMemberDeclaration(str, indent, QLatin1String(cleanupTestCaseC));
+    }
+    const QString dataSlot = testParams.testSlot + QLatin1String("_data");
+    writeVoidMemberDeclaration(str, indent, testParams.testSlot);
+    if (testParams.useDataSet)
+        writeVoidMemberDeclaration(str, indent, dataSlot);
+    str << "};\n\n";
+    // Code: Constructor
+    str << testParams.className << "::" << testParams.className << "()\n{\n}\n\n";
+    // Code: Initialization slots
+    if (testParams.initializationCode) {
+        writeVoidMemberBody(str, testParams.className, QLatin1String(initTestCaseC));
+        writeVoidMemberBody(str, testParams.className, QLatin1String(cleanupTestCaseC));
+    }
+    // Test slot with data or dummy
+    writeVoidMemberBody(str, testParams.className, testParams.testSlot, false);
+    if (testParams.useDataSet) {
+        str << indent << "QFETCH(" << testDataTypeC << ", data);\n";
+    }
+    switch (testParams.type) {
+    case TestWizardParameters::Test:
+        str << indent << "QVERIFY2(true, \"Failure\");\n";
+        break;
+    case TestWizardParameters::Benchmark:
+        str << indent << "QBENCHMARK {\n" << indent << "}\n";
+        break;
+    }
+    str << closeFunctionC;
+    // test data generation slot
+    if (testParams.useDataSet) {
+        writeVoidMemberBody(str, testParams.className, dataSlot, false);
+        str << indent << "QTest::addColumn<" << testDataTypeC << ">(\"data\");\n"
+            << indent << "QTest::newRow(\"0\") << " << testDataTypeC << "();\n"
+            << closeFunctionC;
+    }
+    // Main & moc include
+    str << (testParams.requiresQApplication ? "QTEST_MAIN" : "QTEST_APPLESS_MAIN")
+        << '(' << testParams.className << ");\n\n"
+        << "#include \"" << sourceBaseName << ".moc\"\n";
+    return rc;
+}
+
+Core::GeneratedFiles TestWizard::generateFiles(const QWizard *w, QString *errorMessage) const
+{
+    Q_UNUSED(errorMessage)
+
+    const TestWizardDialog *wizardDialog = qobject_cast<const TestWizardDialog *>(w);
+    QTC_ASSERT(wizardDialog, return Core::GeneratedFiles())
+
+    const QtProjectParameters projectParams = wizardDialog->projectParameters();
+    const TestWizardParameters testParams = wizardDialog->testParameters();
+    const QString projectPath = projectParams.projectPath();
+
+    // Create files: Source
+    const QString sourceFilePath = Core::BaseFileWizard::buildFileName(projectPath, testParams.fileName, sourceSuffix());
+    const QFileInfo sourceFileInfo(sourceFilePath);
+
+    Core::GeneratedFile source(sourceFilePath);
+    source.setContents(generateTestCode(testParams, sourceFileInfo.baseName()));
+
+    // Create profile with define for base dir to find test data
+    const QString profileName = Core::BaseFileWizard::buildFileName(projectPath, projectParams.name, profileSuffix());
+    Core::GeneratedFile profile(profileName);
+    QString contents;
+    {
+        QTextStream proStr(&contents);
+        QtProjectParameters::writeProFileHeader(proStr);
+        projectParams.writeProFile(proStr);
+        proStr << "\n\nSOURCES += " << QFileInfo(sourceFilePath).fileName() << '\n'
+               << "DEFINES += SRCDIR=\\\\\\\"$$PWD/\\\\\\\"\n";
+    }
+    profile.setContents(contents);
+
+    return Core::GeneratedFiles() <<  source << profile;
+}
+
+} // namespace Internal
+} // namespace Qt4ProjectManager