/* This file is part of KDDockWidgets. SPDX-FileCopyrightText: 2019-2022 Klarälvdalens Datakonsult AB, a KDAB Group company Author: Sérgio Martins SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only Contact KDAB at for commercial licensing options. */ // We don't care about performance related checks in the tests // clazy:excludeall=ctor-missing-parent-argument,missing-qobject-macro,range-loop,missing-typeinfo,detaching-member,function-args-by-ref,non-pod-global-static,reserve-candidates,qstring-allocations #include "Operations.h" #include "DockRegistry.h" #include "DockWidget.h" #include "DockWidget_p.h" #include "FloatingWindow_p.h" #include "Frame_p.h" #include "Fuzzer.h" #include using namespace KDDockWidgets; using namespace KDDockWidgets::Testing; using namespace KDDockWidgets::Testing::Operations; static QString operationTypeStr(OperationType optype) { return QMetaEnum::fromType().valueToKey(optype); } OperationBase::OperationBase(KDDockWidgets::Testing::Operations::OperationType type, Fuzzer *fuzzer) : m_operationType(type) , m_fuzzer(fuzzer) { } OperationBase::~OperationBase() { } void OperationBase::execute() { if (!hasParams()) generateRandomParams(); if (hasParams()) { // Check again, as generateRandomParams() is not guaranteed updateDescription(); execute_impl(); if (m_sleepMS > 0) QTest::qWait(m_sleepMS); } } QVariantMap OperationBase::toVariantMap() const { const QVariantMap params = paramsToVariantMap(); if (!hasParams()) return {}; QVariantMap map; map["type"] = m_operationType; map["params"] = params; map["comment"] = description(); return map; } OperationBase::Ptr OperationBase::fromVariantMap(Fuzzer *fuzzer, const QVariantMap &map) { if (!map.contains("type") || !map.contains("params")) { qDebug() << Q_FUNC_INFO << "Invalid map"; return {}; } auto operationType = OperationType(map["type"].toInt()); OperationBase::Ptr ptr = OperationBase::newOperation(fuzzer, operationType); if (ptr) { const QVariantMap params = map["params"].toMap(); if (params.isEmpty()) { qDebug() << Q_FUNC_INFO << "Invalid params"; } else { ptr->fillParamsFromVariantMap(params); } if (map.contains("pause")) ptr->m_sleepMS = map["pause"].toInt(); } else { qDebug() << Q_FUNC_INFO << "Failed to fill params"; } return ptr; } OperationBase::Ptr OperationBase::newOperation(Fuzzer *fuzzer, OperationType type) { OperationBase::Ptr ptr; switch (type) { case OperationType_Count: case OperationType_None: qDebug() << Q_FUNC_INFO << "Invalid type"; break; case OperationType_CloseViaDockWidgetAPI: ptr = OperationBase::Ptr(new CloseViaDockWidgetAPI(fuzzer)); break; case OperationType_HideViaDockWidgetAPI: ptr = OperationBase::Ptr(new HideViaDockWidgetAPI(fuzzer)); break; case OperationType_ShowViaDockWidgetAPI: ptr = OperationBase::Ptr(new ShowViaDockWidgetAPI(fuzzer)); break; case OperationType_AddDockWidget: ptr = OperationBase::Ptr(new AddDockWidget(fuzzer)); break; case OperationType_AddDockWidgetAsTab: ptr = OperationBase::Ptr(new AddDockWidgetAsTab(fuzzer)); break; case OperationType_SaveLayout: ptr = OperationBase::Ptr(new SaveLayout(fuzzer)); break; case OperationType_RestoreLayout: ptr = OperationBase::Ptr(new RestoreLayout(fuzzer)); break; } return ptr; } QString OperationBase::toString() { if (m_description.isEmpty()) updateDescription(); return QStringLiteral("type=%1;description=%2").arg(operationTypeStr(m_operationType), m_description); } Controllers::DockWidget *OperationBase::dockByName(const QString &name) const { return DockRegistry::self()->dockByName(name); } MainWindowBase *OperationBase::mainWindowByName(const QString &name) const { return DockRegistry::self()->mainWindowByName(name); } QString OperationBase::dockStr(const QString &name) const { if (auto dw = dockByName(name)) { if (dw->isVisible()) return name; return QStringLiteral("%1-[hidden]").arg(name); } else { return QStringLiteral("null"); } } CloseViaDockWidgetAPI::CloseViaDockWidgetAPI(Fuzzer *fuzzer) : OperationBase(OperationType_CloseViaDockWidgetAPI, fuzzer) { } void CloseViaDockWidgetAPI::generateRandomParams() { if (Controllers::DockWidget *dw = m_fuzzer->getRandomDockWidget()) if (dw->isVisible()) m_dockWidgetName = dw->uniqueName(); } bool CloseViaDockWidgetAPI::hasParams() const { return !m_dockWidgetName.isEmpty(); } void CloseViaDockWidgetAPI::updateDescription() { m_description = QStringLiteral("Closing %1").arg(dockStr(m_dockWidgetName)); } void CloseViaDockWidgetAPI::execute_impl() { Controllers::DockWidget *dw = dockByName(m_dockWidgetName); auto fw = dw->floatingWindow(); dw->close(); if (fw && fw->beingDeleted()) Testing::waitForDeleted(fw); } QVariantMap CloseViaDockWidgetAPI::paramsToVariantMap() const { QVariantMap map; if (!m_dockWidgetName.isEmpty()) map["dockWidgetName"] = m_dockWidgetName; return map; } void CloseViaDockWidgetAPI::fillParamsFromVariantMap(const QVariantMap &map) { m_dockWidgetName = map["dockWidgetName"].toString(); } HideViaDockWidgetAPI::HideViaDockWidgetAPI(Fuzzer *fuzzer) : OperationBase(OperationType_HideViaDockWidgetAPI, fuzzer) { } void HideViaDockWidgetAPI::generateRandomParams() { if (Controllers::DockWidget *dw = m_fuzzer->getRandomDockWidget()) if (dw->isVisible()) m_dockWidgetName = dw->uniqueName(); } bool HideViaDockWidgetAPI::hasParams() const { return !m_dockWidgetName.isEmpty(); } void HideViaDockWidgetAPI::updateDescription() { m_description = QStringLiteral("Hiding %1").arg(dockStr(m_dockWidgetName)); } void HideViaDockWidgetAPI::execute_impl() { Controllers::DockWidget *dw = dockByName(m_dockWidgetName); if (!dw) { qDebug() << Q_FUNC_INFO << "not found" << m_dockWidgetName; Q_ASSERT(false); } auto fw = dw->floatingWindow(); dw->close(); if (fw && fw->beingDeleted()) Testing::waitForDeleted(fw); } QVariantMap HideViaDockWidgetAPI::paramsToVariantMap() const { QVariantMap map; if (!m_dockWidgetName.isEmpty()) map["dockWidgetName"] = m_dockWidgetName; return map; } void HideViaDockWidgetAPI::fillParamsFromVariantMap(const QVariantMap &map) { m_dockWidgetName = map["dockWidgetName"].toString(); } ShowViaDockWidgetAPI::ShowViaDockWidgetAPI(Fuzzer *fuzzer) : OperationBase(OperationType_ShowViaDockWidgetAPI, fuzzer) { } void ShowViaDockWidgetAPI::generateRandomParams() { if (Controllers::DockWidget *dw = m_fuzzer->getRandomDockWidget()) if (!dw->isVisible()) m_dockWidgetName = dw->uniqueName(); } bool ShowViaDockWidgetAPI::hasParams() const { return !m_dockWidgetName.isEmpty(); } void ShowViaDockWidgetAPI::updateDescription() { m_description = QStringLiteral("Showing %1").arg(dockStr(m_dockWidgetName)); } void ShowViaDockWidgetAPI::execute_impl() { Controllers::DockWidget *dw = dockByName(m_dockWidgetName); dw->show(); } QVariantMap ShowViaDockWidgetAPI::paramsToVariantMap() const { QVariantMap map; if (!m_dockWidgetName.isEmpty()) map["dockWidgetName"] = m_dockWidgetName; return map; } void ShowViaDockWidgetAPI::fillParamsFromVariantMap(const QVariantMap &map) { m_dockWidgetName = map["dockWidgetName"].toString(); } AddDockWidget::AddDockWidget(Fuzzer *fuzzer) : OperationBase(OperationType_AddDockWidget, fuzzer) { } void AddDockWidget::generateRandomParams() { m_params = m_fuzzer->getRandomAddDockWidgetParams(); } bool AddDockWidget::hasParams() const { return !m_params.isNull(); } void AddDockWidget::updateDescription() { if (m_params.relativeToName.isEmpty()) m_description = QStringLiteral("AddDockWidget %1 to %2").arg(dockStr(m_params.dockWidgetName), KDDockWidgets::locationStr(m_params.location)); else m_description = QStringLiteral("AddDockWidget %1 to %2, relative to %3").arg(dockStr(m_params.dockWidgetName), KDDockWidgets::locationStr(m_params.location), dockStr(m_params.relativeToName)); } void AddDockWidget::execute_impl() { auto fw = m_params.dockWidget()->floatingWindow(); m_params.mainWindow()->addDockWidget(m_params.dockWidget(), m_params.location, m_params.relativeTo(), m_params.addingOption); if (fw && fw->beingDeleted()) Testing::waitForDeleted(fw); } QVariantMap AddDockWidget::paramsToVariantMap() const { return m_params.isNull() ? QVariantMap() : m_params.toVariantMap(); } void AddDockWidget::fillParamsFromVariantMap(const QVariantMap &map) { m_params = AddDockWidgetParams::fillFromVariantMap(map); } AddDockWidgetAsTab::AddDockWidgetAsTab(Fuzzer *fuzzer) : OperationBase(OperationType_AddDockWidgetAsTab, fuzzer) { } void AddDockWidgetAsTab::generateRandomParams() { Controllers::DockWidget *dw = m_fuzzer->getRandomDockWidget(); if (!dw) return; Controllers::DockWidget *dw2 = nullptr; if (auto group = dw->d->group()) { auto toExclude = group->dockWidgets(); for (auto dockWidget : DockRegistry::self()->dockwidgets()) { if (dockWidget->window() == dw->window()) toExclude.push_back(dockWidget); } dw2 = m_fuzzer->getRandomDockWidget(toExclude); } if (!dw2) return; m_dockWidgetName = dw->uniqueName(); m_dockWidgetToAddName = dw2->uniqueName(); } bool AddDockWidgetAsTab::hasParams() const { return !m_dockWidgetName.isEmpty() && !m_dockWidgetToAddName.isEmpty(); } void AddDockWidgetAsTab::updateDescription() { m_description = QStringLiteral("AddDockWidgetAsTab %1 onto %2").arg(dockStr(m_dockWidgetToAddName), dockStr(m_dockWidgetName)); } void AddDockWidgetAsTab::execute_impl() { Controllers::DockWidget *dw = dockByName(m_dockWidgetName); Controllers::DockWidget *dw2 = dockByName(m_dockWidgetToAddName); auto fw = dw2->floatingWindow(); dw->addDockWidgetAsTab(dw2); if (fw && fw->beingDeleted()) Testing::waitForDeleted(fw); } QVariantMap AddDockWidgetAsTab::paramsToVariantMap() const { QVariantMap map; if (hasParams()) { map["dockWidgetName"] = m_dockWidgetName; map["dockWidgetToAddName"] = m_dockWidgetToAddName; } return map; } void AddDockWidgetAsTab::fillParamsFromVariantMap(const QVariantMap &map) { m_dockWidgetName = map["dockWidgetName"].toString(); m_dockWidgetToAddName = map["dockWidgetToAddName"].toString(); } SaveLayout::SaveLayout(Fuzzer *fuzzer) : OperationBase(OperationType_SaveLayout, fuzzer) { } bool SaveLayout::hasParams() const { return true; } void SaveLayout::updateDescription() { m_description = QStringLiteral("SaveLayout"); } void SaveLayout::execute_impl() { LayoutSaver saver; m_fuzzer->setLastSavedLayout(saver.serializeLayout()); qDebug() << m_fuzzer << m_fuzzer->lastSavedLayout().isEmpty(); } void SaveLayout::generateRandomParams() { } QVariantMap SaveLayout::paramsToVariantMap() const { return {}; } void SaveLayout::fillParamsFromVariantMap(const QVariantMap &) { } RestoreLayout::RestoreLayout(Fuzzer *fuzzer) : OperationBase(OperationType_RestoreLayout, fuzzer) { } bool RestoreLayout::hasParams() const { return true; } void RestoreLayout::updateDescription() { m_description = QStringLiteral("RestoreLayout"); } void RestoreLayout::execute_impl() { QByteArray serialized = m_fuzzer->lastSavedLayout(); if (serialized.isEmpty()) { qDebug() << "Skipping, nothing to restore"; return; } LayoutSaver saver; saver.restoreLayout(serialized); } void RestoreLayout::generateRandomParams() { } QVariantMap RestoreLayout::paramsToVariantMap() const { return {}; } void RestoreLayout::fillParamsFromVariantMap(const QVariantMap &) { }