Wizards: add basic tests

Change-Id: I647227d458540b0271070cc56106165058929d29
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>

src/plugins/coreplugin/iwizardfactory.cpp

@@ -280,6 +280,7 @@ Utils::Wizard *IWizardFactory::runWizard(const QString &path, QWidget *parent, I
     if (wizard) {
         s_currentWizard = wizard;
         // Connect while wizard exists:
+        if (m_action)
             connect(m_action, &QAction::triggered, wizard, [wizard]() { ICore::raiseWindow(wizard); });
         connect(s_inspectWizardAction, &QAction::triggered,
                 wizard, [wizard]() { wizard->showVariables(); });

src/plugins/projectexplorer/jsonwizard/jsonwizard.cpp

@@ -42,6 +42,10 @@
 #include <QMessageBox>
 #include <QVariant>
 
+#ifdef WITH_TESTS
+#include "jsonwizard_test.cpp"
+#endif
+
 namespace ProjectExplorer {
 
 JsonWizard::JsonWizard(QWidget *parent) : Utils::Wizard(parent)

src/plugins/projectexplorer/jsonwizard/jsonwizard_test.cpp

@@ -0,0 +1,244 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "jsonwizardfactory.h"
+
+#include <projectexplorer/projectexplorer.h>
+
+#include <QJsonDocument>
+#include <QJsonArray>
+#include <QJsonObject>
+#include <QTest>
+#include <QCheckBox>
+#include <QLineEdit>
+#include <QComboBox>
+
+#include <functional>
+namespace {
+QJsonObject createWidget(const QString &type, const QString& nameSuffix, const QJsonObject &data)
+{
+    return QJsonObject{
+        {"name", QJsonValue(nameSuffix + type)},
+        {"type", type},
+        {"trDisplayName", QJsonValue(nameSuffix + "DisplayName")},
+        {"data", data}
+    };
+}
+
+QJsonObject createFieldPageJsonObject(const QJsonArray &widgets)
+{
+    return QJsonObject{
+        {"name", "testpage"},
+        {"trDisplayName", "mytestpage"},
+        {"typeId", "Fields"},
+        {"data", widgets}
+    };
+}
+
+QJsonObject createGeneralWizard(const QJsonObject &pages)
+{
+    return QJsonObject {
+        {"category", "TestCategory"},
+        {"enabled", true},
+        {"id", "mytestwizard"},
+        {"trDisplayName", "mytest"},
+        {"trDisplayCategory", "mytestcategory"},
+        {"trDescription", "this is a test wizard"},
+        {"generators",
+            QJsonObject{
+                {"typeId", "File"},
+                {"data",
+                    QJsonObject{
+                        {"source", "myFile.txt"}
+                    }
+                }
+            }
+        },
+        {"pages", pages}
+    };
+}
+
+auto findCheckBox(Utils::Wizard *wizard, const QString &objectName) {
+    return wizard->findChild<QCheckBox *>(objectName + "CheckBox");
+}
+auto findLineEdit(Utils::Wizard *wizard, const QString &objectName) {
+    return wizard->findChild<QLineEdit *>(objectName + "LineEdit");
+}
+auto findComboBox(Utils::Wizard *wizard, const QString &objectName) {
+    return wizard->findChild<QComboBox *>(objectName + "ComboBox");
+};
+
+} // namespace
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsEmptyWizard()
+{
+    QString errorMessage;
+    QWidget parent;
+    const QJsonObject wizard = createGeneralWizard(QJsonObject());
+
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizard.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY(factory == nullptr);
+    QCOMPARE(qPrintable(errorMessage), "Page has no typeId set.");
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsEmptyPage()
+{
+    QString errorMessage;
+    QWidget parent;
+    const QJsonObject pages = createFieldPageJsonObject(QJsonArray());
+    const QJsonObject wizard = createGeneralWizard(pages);
+
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizard.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY(factory == nullptr);
+    QCOMPARE(qPrintable(errorMessage), "When parsing fields of page \"PE.Wizard.Page.Fields\": ");
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsUnusedKeyAtFields_data()
+{
+    const QPair<QString, QJsonValue> wrongData = {"wrong", false};
+
+    QTest::addColumn<QJsonObject>("wrongDataJsonObect");
+    QTest::addRow("Label") << QJsonObject({{wrongData, {"trText", "someText"}}});
+    QTest::addRow("Spacer") << QJsonObject({wrongData});
+    QTest::addRow("LineEdit") << QJsonObject({wrongData});
+    QTest::addRow("TextEdit") << QJsonObject({wrongData});
+    QTest::addRow("PathChooser") << QJsonObject({wrongData});
+    QTest::addRow("CheckBox") << QJsonObject({wrongData});
+    QTest::addRow("ComboBox") << QJsonObject({{wrongData, {"items", QJsonArray()}}});
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsUnusedKeyAtFields()
+{
+    QString fieldType(QString::fromLatin1(QTest::currentDataTag()));
+    QFETCH(QJsonObject, wrongDataJsonObect);
+    QString errorMessage;
+    QWidget parent;
+    const QJsonObject pages = QJsonObject{
+        {"name", "testpage"},
+        {"trDisplayName", "mytestpage"},
+        {"typeId", "Fields"},
+        {"data", createWidget(fieldType, "WrongKey", wrongDataJsonObect)},
+    };
+    const QJsonObject wizard = createGeneralWizard(pages);
+
+    QTest::ignoreMessage(QtWarningMsg, QRegularExpression("has unsupported keys: wrong"));
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizard.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY(factory);
+    QVERIFY(errorMessage.isEmpty());
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsCheckBox()
+{
+    QString errorMessage;
+
+    QWidget parent;
+    const QJsonArray widgets({
+        createWidget("CheckBox", "Default", QJsonObject()),
+        createWidget("CheckBox", "Checked", QJsonObject({{"checked", true}})),
+        createWidget("CheckBox", "UnChecked", QJsonObject({{"checked", false}})),
+        createWidget("CheckBox", "SpecialValueUnChecked", QJsonObject(
+         {{"checked", false}, {"checkedValue", "SpecialCheckedValue"}, {"uncheckedValue", "SpecialUnCheckedValue"}})
+        ),
+        createWidget("CheckBox", "SpecialValueChecked", QJsonObject(
+         {{"checked", true}, {"checkedValue", "SpecialCheckedValue"}, {"uncheckedValue", "SpecialUnCheckedValue"}})
+        )
+    });
+    const QJsonObject pages = createFieldPageJsonObject(widgets);
+    const QJsonObject wizardObject = createGeneralWizard(pages);
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizardObject.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY2(factory, qPrintable(errorMessage));
+
+    Utils::Wizard *wizard = factory->runWizard(QString(), &parent, Core::Id(), QVariantMap());
+
+    QVERIFY(!findCheckBox(wizard, "Default")->isChecked());
+    QVERIFY(findCheckBox(wizard, "Checked")->isChecked());
+    QVERIFY(!findCheckBox(wizard, "UnChecked")->isChecked());
+
+    QVERIFY(!findCheckBox(wizard, "SpecialValueUnChecked")->isChecked());
+    QCOMPARE(qPrintable(wizard->field("SpecialValueUnCheckedCheckBox").toString()), "SpecialUnCheckedValue");
+
+    QVERIFY(findCheckBox(wizard, "SpecialValueChecked")->isChecked());
+    QCOMPARE(qPrintable(wizard->field("SpecialValueCheckedCheckBox").toString()), "SpecialCheckedValue");
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsLineEdit()
+{
+    QString errorMessage;
+
+    QWidget parent;
+    const QJsonArray widgets({
+         createWidget("LineEdit", "Default", QJsonObject()),
+         createWidget("LineEdit", "WithText", QJsonObject({{"trText", "some text"}}))
+    });
+    const QJsonObject pages = createFieldPageJsonObject(widgets);
+    const QJsonObject wizardObject = createGeneralWizard(pages);
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizardObject.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY2(factory, qPrintable(errorMessage));
+
+    Utils::Wizard *wizard = factory->runWizard(QString(), &parent, Core::Id(), QVariantMap());
+    QVERIFY(findLineEdit(wizard, "Default"));
+    QVERIFY(findLineEdit(wizard, "Default")->text().isEmpty());
+    QCOMPARE(qPrintable(findLineEdit(wizard, "WithText")->text()), "some text");
+
+    QVERIFY(!wizard->page(0)->isComplete());
+    findLineEdit(wizard, "Default")->setText("enable isComplete");
+    QVERIFY(wizard->page(0)->isComplete());
+}
+
+void ProjectExplorer::ProjectExplorerPlugin::testJsonWizardsComboBox()
+{
+    QString errorMessage;
+
+    QWidget parent;
+    const QJsonArray items({"abc", "cde", "fgh"});
+    QJsonObject disabledComboBoxObject = createWidget("ComboBox", "Disabled", QJsonObject({ {{"disabledIndex", 2}, {"items", items}} }));
+    disabledComboBoxObject.insert("enabled", false);
+    const QJsonArray widgets({
+        createWidget("ComboBox", "Default", QJsonObject({ {{"items", items}} })),
+        createWidget("ComboBox", "Index2", QJsonObject({ {{"index", 2}, {"items", items}} })),
+        disabledComboBoxObject
+    });
+
+    const QJsonObject pages = createFieldPageJsonObject(widgets);
+    const QJsonObject wizardObject = createGeneralWizard(pages);
+    JsonWizardFactory *factory = ProjectExplorer::JsonWizardFactory::createWizardFactory(wizardObject.toVariantMap(), QDir(), &errorMessage);
+    QVERIFY2(factory, qPrintable(errorMessage));
+    Utils::Wizard *wizard = factory->runWizard(QString(), &parent, Core::Id(), QVariantMap());
+
+    QComboBox *defaultComboBox = findComboBox(wizard, "Default");
+    QVERIFY(defaultComboBox);
+
+    defaultComboBox->setCurrentIndex(2);
+    QCOMPARE(qPrintable(defaultComboBox->currentText()), "fgh");
+
+    QComboBox *index2ComboBox = findComboBox(wizard, "Index2");
+    QVERIFY(index2ComboBox);
+    QCOMPARE(qPrintable(index2ComboBox->currentText()), "fgh");
+
+    QComboBox *disabledComboBox = findComboBox(wizard, "Disabled");
+    QVERIFY(disabledComboBox);
+    QEXPECT_FAIL("", "This is wrong, since ComboBox got condition items", Continue);
+    QCOMPARE(qPrintable(disabledComboBox->currentText()), "fgh");
+
+}

src/plugins/projectexplorer/projectexplorer.h

@@ -182,6 +182,14 @@ private:
 
 #ifdef WITH_TESTS
 private slots:
+    void testJsonWizardsEmptyWizard();
+    void testJsonWizardsEmptyPage();
+    void testJsonWizardsUnusedKeyAtFields_data();
+    void testJsonWizardsUnusedKeyAtFields();
+    void testJsonWizardsCheckBox();
+    void testJsonWizardsLineEdit();
+    void testJsonWizardsComboBox();
+
     void testAnsiFilterOutputParser_data();
     void testAnsiFilterOutputParser();