[FEATURE] Add action to manually validate a processing model

Allows users to run a validation over their model, listing any issues found with the model
qgis · Apr 14, 2020 · fd98158 · fd98158
1 parent acc6844
commit fd98158
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 0 deletions.
diff --git a/src/gui/processing/models/qgsmodeldesignerdialog.cpp b/src/gui/processing/models/qgsmodeldesignerdialog.cpp
@@ -28,6 +28,8 @@
 #include "qgsmodelgraphicsscene.h"
 #include "qgsmodelcomponentgraphicitem.h"
 #include "processing/models/qgsprocessingmodelgroupbox.h"
+#include "qgsmessageviewer.h"
+#include "qgsmessagebaritem.h"
 
 #include <QShortcut>
 #include <QDesktopWidget>
@@ -39,6 +41,7 @@
 #include <QCloseEvent>
 #include <QMessageBox>
 #include <QUndoView>
+#include <QPushButton>
 
 ///@cond NOT_STABLE
 
@@ -134,6 +137,7 @@ QgsModelDesignerDialog::QgsModelDesignerDialog( QWidget *parent, Qt::WindowFlags
   connect( mActionSaveAs, &QAction::triggered, this, [ = ] { saveModel( true ); } );
   connect( mActionDeleteComponents, &QAction::triggered, this, &QgsModelDesignerDialog::deleteSelected );
   connect( mActionSnapSelected, &QAction::triggered, mView, &QgsModelGraphicsView::snapSelected );
+  connect( mActionValidate, &QAction::triggered, this, &QgsModelDesignerDialog::validate );
 
   mActionSnappingEnabled->setChecked( settings.value( QStringLiteral( "/Processing/Modeler/enableSnapToGrid" ), false ).toBool() );
   connect( mActionSnappingEnabled, &QAction::toggled, this, [ = ]( bool enabled )
@@ -777,6 +781,38 @@ void QgsModelDesignerDialog::populateZoomToMenu()
   }
 }
 
+void QgsModelDesignerDialog::validate()
+{
+  QStringList issues;
+  if ( model()->validate( issues ) )
+  {
+    mMessageBar->pushSuccess( QString(), tr( "Model is valid!" ) );
+  }
+  else
+  {
+    QgsMessageBarItem *messageWidget = mMessageBar->createMessage( QString(), tr( "Model is invalid!" ) );
+    QPushButton *detailsButton = new QPushButton( tr( "Details" ) );
+    connect( detailsButton, &QPushButton::clicked, detailsButton, [ = ]
+    {
+      QgsMessageViewer *dialog = new QgsMessageViewer( detailsButton );
+      dialog->setTitle( tr( "Model is Invalid" ) );
+
+      QString longMessage = tr( "<p>This model is not valid:</p>" ) + QStringLiteral( "<ul>" );
+      for ( const QString &issue : issues )
+      {
+        longMessage += QStringLiteral( "<li>%1</li>" ).arg( issue );
+      }
+      longMessage += QStringLiteral( "</ul>" );
+
+      dialog->setMessage( longMessage, QgsMessageOutput::MessageHtml );
+      dialog->showMessage();
+    } );
+    messageWidget->layout()->addWidget( detailsButton );
+    mMessageBar->clearWidgets();
+    mMessageBar->pushWidget( messageWidget, Qgis::Warning, 0 );
+  }
+}
+
 bool QgsModelDesignerDialog::isDirty() const
 {
   return mHasChanged && mUndoStack->index() != -1;

diff --git a/src/gui/processing/models/qgsmodeldesignerdialog.h b/src/gui/processing/models/qgsmodeldesignerdialog.h
@@ -143,6 +143,7 @@ class GUI_EXPORT QgsModelDesignerDialog : public QMainWindow, public Ui::QgsMode
     void updateWindowTitle();
     void deleteSelected();
     void populateZoomToMenu();
+    void validate();
 
   private:
 

diff --git a/src/ui/processing/qgsmodeldesignerdialogbase.ui b/src/ui/processing/qgsmodeldesignerdialogbase.ui
@@ -58,6 +58,7 @@
      <addaction name="separator"/>
      <addaction name="mActionExportPython"/>
     </widget>
+    <addaction name="mActionValidate"/>
     <addaction name="mActionRun"/>
     <addaction name="separator"/>
     <addaction name="mActionOpen"/>
@@ -647,6 +648,15 @@
     <string>Add Group Box</string>
    </property>
   </action>
+  <action name="mActionValidate">
+   <property name="icon">
+    <iconset resource="../../../images/images.qrc">
+     <normaloff>:/images/themes/default/mIconSuccess.svg</normaloff>:/images/themes/default/mIconSuccess.svg</iconset>
+   </property>
+   <property name="text">
+    <string>Validate Model</string>
+   </property>
+  </action>
  </widget>
  <customwidgets>
   <customwidget>