Merge branch 'improve-partition-reporting' into calamares

This strips out the === from KPMCore reports so that they are
more readable when presented in the error dialog. Introduces
some code-conveniences, too, but that is all under-the-hood.

src/modules/partition/core/KPMHelpers.cpp

@@ -15,8 +15,8 @@
 
 #include "partition/PartitionIterator.h"
 #include "utils/Logger.h"
+#include "utils/String.h"
 
-// KPMcore
 #include <kpmcore/backend/corebackendmanager.h>
 #include <kpmcore/core/device.h>
 #include <kpmcore/core/partition.h>
@@ -127,4 +127,23 @@ clonePartition( Device* device, Partition* partition )
                           partition->activeFlags() );
 }
 
+Calamares::JobResult
+execute( Operation& operation, const QString& failureMessage )
+{
+    operation.setStatus( Operation::StatusRunning );
+
+    Report report( nullptr );
+    if ( operation.execute( report ) )
+    {
+        return Calamares::JobResult::ok();
+    }
+
+    // Remove the === lines from the report by trimming them to empty
+    QStringList l = report.toText().split( '\n' );
+    std::for_each( l.begin(), l.end(), []( QString& s ) { CalamaresUtils::removeLeading( s, '=' ); } );
+
+    return Calamares::JobResult::error( failureMessage, l.join( '\n' ) );
+}
+
+
 }  // namespace KPMHelpers

src/modules/partition/core/KPMHelpers.h

@@ -11,11 +11,13 @@
 #ifndef KPMHELPERS_H
 #define KPMHELPERS_H
 
-// KPMcore
+#include "Job.h"
+
 #include <kpmcore/core/partitiontable.h>
 #include <kpmcore/fs/filesystem.h>
+#include <kpmcore/ops/operation.h>
+#include <kpmcore/util/report.h>
 
-// Qt
 #include <QList>
 
 #include <functional>
@@ -72,6 +74,24 @@ Partition* createNewEncryptedPartition( PartitionNode* parent,
 
 Partition* clonePartition( Device* device, Partition* partition );
 
+/** @brief Return a result for an @p operation
+ *
+ * Executes the operation, and if successful, returns a success result.
+ * Otherwise returns an error using @p failureMessage as the primary part
+ * of the error, and details obtained from the operation.
+ */
+Calamares::JobResult execute( Operation& operation, const QString& failureMessage );
+/** @brief Return a result for an @p operation
+ *
+ * It's acceptable to use an rvalue: the operation-running is the effect
+ * you're interested in, rather than keeping the temporary around.
+ */
+static inline Calamares::JobResult
+execute( Operation&& operation, const QString& failureMessage )
+{
+    return execute( operation, failureMessage );
+}
+
 }  // namespace KPMHelpers
 
 #endif /* KPMHELPERS_H */

src/modules/partition/jobs/CreatePartitionJob.cpp

@@ -11,7 +11,9 @@
 
 #include "CreatePartitionJob.h"
 
+#include "core/KPMHelpers.h"
 #include "core/PartitionInfo.h"
+
 #include "partition/FileSystem.h"
 #include "partition/PartitionQuery.h"
 #include "utils/CalamaresUtilsSystem.h"
@@ -273,17 +275,9 @@ CreatePartitionJob::exec()
         return createZfs( m_partition, m_device );
     }
 
-    Report report( nullptr );
-    NewOperation op( *m_device, m_partition );
-    op.setStatus( Operation::StatusRunning );
-
-    QString message = tr( "The installer failed to create partition on disk '%1'." ).arg( m_device->name() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute(
+        NewOperation( *m_device, m_partition ),
+        tr( "The installer failed to create partition on disk '%1'." ).arg( m_device->name() ) );
 }
 
 void

src/modules/partition/jobs/CreatePartitionTableJob.cpp

@@ -12,9 +12,11 @@
 #include "CreatePartitionTableJob.h"
 
 #include "partition/PartitionIterator.h"
+#include "utils/CalamaresUtilsSystem.h"
 #include "utils/Logger.h"
 
-// KPMcore
+#include "core/KPMHelpers.h"
+
 #include <kpmcore/core/device.h>
 #include <kpmcore/core/partition.h>
 #include <kpmcore/core/partitiontable.h>
@@ -63,8 +65,6 @@ CreatePartitionTableJob::prettyStatusMessage() const
 Calamares::JobResult
 CreatePartitionTableJob::exec()
 {
-    Report report( nullptr );
-    QString message = tr( "The installer failed to create a partition table on %1." ).arg( m_device->name() );
 
     PartitionTable* table = m_device->partitionTable();
 
@@ -76,30 +76,16 @@ CreatePartitionTableJob::exec()
             cDebug() << Logger::SubEntry << ( ( *it ) ? ( *it )->deviceNode() : QString( "<null device>" ) );
         }
 
-        QProcess lsblk;
-        lsblk.setProgram( "lsblk" );
-        lsblk.setProcessChannelMode( QProcess::MergedChannels );
-        lsblk.start();
-        lsblk.waitForFinished();
-        cDebug() << Logger::SubEntry << "lsblk output:\n" << Logger::NoQuote << lsblk.readAllStandardOutput();
+        auto lsblkResult = CalamaresUtils::System::runCommand( { "lsblk" }, std::chrono::seconds( 30 ) );
+        cDebug() << Logger::SubEntry << "lsblk output:\n" << Logger::NoQuote << lsblkResult.getOutput();
 
-        QProcess mount;
-        mount.setProgram( "mount" );  // Debug output only, not mounting something
-        mount.setProcessChannelMode( QProcess::MergedChannels );
-        mount.start();
-        mount.waitForFinished();
-        cDebug() << Logger::SubEntry << "mount output:\n" << Logger::NoQuote << mount.readAllStandardOutput();
+        auto mountResult = CalamaresUtils::System::runCommand( { "mount" }, std::chrono::seconds( 30 ) );
+        cDebug() << Logger::SubEntry << "mount output:\n" << Logger::NoQuote << mountResult.getOutput();
     }
 
-    CreatePartitionTableOperation op( *m_device, table );
-    op.setStatus( Operation::StatusRunning );
-
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute(
+        CreatePartitionTableOperation( *m_device, table ),
+        tr( "The installer failed to create a partition table on %1." ).arg( m_device->name() ) );
 }
 
 void

src/modules/partition/jobs/CreateVolumeGroupJob.cpp

@@ -9,7 +9,8 @@
 
 #include "CreateVolumeGroupJob.h"
 
-// KPMcore
+#include "core/KPMHelpers.h"
+
 #include <kpmcore/core/lvmdevice.h>
 #include <kpmcore/core/partition.h>
 #include <kpmcore/ops/createvolumegroupoperation.h>
@@ -46,19 +47,8 @@ CreateVolumeGroupJob::prettyStatusMessage() const
 Calamares::JobResult
 CreateVolumeGroupJob::exec()
 {
-    Report report( nullptr );
-
-    CreateVolumeGroupOperation op( m_vgName, m_pvList, m_peSize );
-
-    op.setStatus( Operation::StatusRunning );
-
-    QString message = tr( "The installer failed to create a volume group named '%1'." ).arg( m_vgName );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute( CreateVolumeGroupOperation( m_vgName, m_pvList, m_peSize ),
+                                tr( "The installer failed to create a volume group named '%1'." ).arg( m_vgName ) );
 }
 
 void

src/modules/partition/jobs/DeactivateVolumeGroupJob.cpp

@@ -9,6 +9,8 @@
 
 #include "DeactivateVolumeGroupJob.h"
 
+#include "core/KPMHelpers.h"
+
 #include <kpmcore/core/lvmdevice.h>
 #include <kpmcore/ops/deactivatevolumegroupoperation.h>
 #include <kpmcore/util/report.h>
@@ -39,18 +41,12 @@ DeactivateVolumeGroupJob::prettyStatusMessage() const
 Calamares::JobResult
 DeactivateVolumeGroupJob::exec()
 {
-    Report report( nullptr );
-
     DeactivateVolumeGroupOperation op( *m_device );
-
-    op.setStatus( Operation::OperationStatus::StatusRunning );
-
-    QString message = tr( "The installer failed to deactivate a volume group named %1." ).arg( m_device->name() );
-    if ( op.execute( report ) )
+    auto r = KPMHelpers::execute(
+        op, tr( "The installer failed to deactivate a volume group named %1." ).arg( m_device->name() ) );
+    if ( r )
     {
         op.preview();
-        return Calamares::JobResult::ok();
     }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return r;
 }

src/modules/partition/jobs/DeletePartitionJob.cpp

@@ -10,9 +10,11 @@
  */
 
 #include "DeletePartitionJob.h"
+
+#include "core/KPMHelpers.h"
+
 #include "utils/CalamaresUtilsSystem.h"
 
-// KPMcore
 #include <kpmcore/core/device.h>
 #include <kpmcore/core/partition.h>
 #include <kpmcore/core/partitiontable.h>
@@ -45,7 +47,7 @@ removePartition( Partition* partition )
     auto r = CalamaresUtils::System::instance()->runCommand(
         { "sfdisk", "--delete", "--force", partition->devicePath(), QString::number( partition->number() ) },
         std::chrono::seconds( 5 ) );
-    if ( r.getExitCode() !=0 || r.getOutput().contains("failed") )
+    if ( r.getExitCode() != 0 || r.getOutput().contains( "failed" ) )
     {
         return Calamares::JobResult::error(
             QCoreApplication::translate( DeletePartitionJob::staticMetaObject.className(), "Deletion Failed" ),
@@ -96,17 +98,8 @@ DeletePartitionJob::exec()
         return removePartition( m_partition );
     }
 
-    Report report( nullptr );
-    DeleteOperation op( *m_device, m_partition );
-    op.setStatus( Operation::StatusRunning );
-
-    QString message = tr( "The installer failed to delete partition %1." ).arg( m_partition->devicePath() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute( DeleteOperation( *m_device, m_partition ),
+                                tr( "The installer failed to delete partition %1." ).arg( m_partition->devicePath() ) );
 }
 
 void

src/modules/partition/jobs/FormatPartitionJob.cpp

@@ -11,6 +11,8 @@
 
 #include "FormatPartitionJob.h"
 
+#include "core/KPMHelpers.h"
+
 #include "partition/FileSystem.h"
 #include "utils/Logger.h"
 
@@ -65,17 +67,7 @@ FormatPartitionJob::prettyStatusMessage() const
 Calamares::JobResult
 FormatPartitionJob::exec()
 {
-    Report report( nullptr );  // Root of the report tree, no parent
-    CreateFileSystemOperation op( *m_device, *m_partition, m_partition->fileSystem().type() );
-    op.setStatus( Operation::StatusRunning );
-
-    QString message = tr( "The installer failed to format partition %1 on disk '%2'." )
-                          .arg( m_partition->partitionPath(), m_device->name() );
-
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute( CreateFileSystemOperation( *m_device, *m_partition, m_partition->fileSystem().type() ),
+                                tr( "The installer failed to format partition %1 on disk '%2'." )
+                                    .arg( m_partition->partitionPath(), m_device->name() ) );
 }

src/modules/partition/jobs/RemoveVolumeGroupJob.cpp

@@ -9,6 +9,8 @@
 
 #include "RemoveVolumeGroupJob.h"
 
+#include "core/KPMHelpers.h"
+
 #include <kpmcore/core/lvmdevice.h>
 #include <kpmcore/ops/removevolumegroupoperation.h>
 #include <kpmcore/util/report.h>
@@ -39,17 +41,7 @@ RemoveVolumeGroupJob::prettyStatusMessage() const
 Calamares::JobResult
 RemoveVolumeGroupJob::exec()
 {
-    Report report( nullptr );
-
-    RemoveVolumeGroupOperation op( *m_device );
-
-    op.setStatus( Operation::OperationStatus::StatusRunning );
-
-    QString message = tr( "The installer failed to remove a volume group named '%1'." ).arg( m_device->name() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute(
+        RemoveVolumeGroupOperation( *m_device ),
+        tr( "The installer failed to remove a volume group named '%1'." ).arg( m_device->name() ) );
 }

src/modules/partition/jobs/ResizePartitionJob.cpp

@@ -11,9 +11,10 @@
 
 #include "ResizePartitionJob.h"
 
+#include "core/KPMHelpers.h"
+
 #include "utils/Units.h"
 
-// KPMcore
 #include <kpmcore/core/device.h>
 #include <kpmcore/ops/resizeoperation.h>
 #include <kpmcore/util/report.h>
@@ -66,23 +67,16 @@ ResizePartitionJob::prettyStatusMessage() const
 Calamares::JobResult
 ResizePartitionJob::exec()
 {
-    Report report( nullptr );
     // Restore partition sectors that were modified for preview
     m_partition->setFirstSector( m_oldFirstSector );
     m_partition->setLastSector( m_oldLastSector );
+
     ResizeOperation op( *m_device, *m_partition, m_newFirstSector, m_newLastSector );
-    op.setStatus( Operation::StatusRunning );
     connect( &op, &Operation::progress, this, &ResizePartitionJob::iprogress );
-
-    QString errorMessage = tr( "The installer failed to resize partition %1 on disk '%2'." )
-                               .arg( m_partition->partitionPath() )
-                               .arg( m_device->name() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( errorMessage, report.toText() );
+    return KPMHelpers::execute( op,
+                                tr( "The installer failed to resize partition %1 on disk '%2'." )
+                                    .arg( m_partition->partitionPath() )
+                                    .arg( m_device->name() ) );
 }
 
 void

src/modules/partition/jobs/ResizeVolumeGroupJob.cpp

@@ -9,7 +9,8 @@
 
 #include "ResizeVolumeGroupJob.h"
 
-// KPMcore
+#include "core/KPMHelpers.h"
+
 #include <kpmcore/core/lvmdevice.h>
 #include <kpmcore/core/partition.h>
 #include <kpmcore/ops/resizevolumegroupoperation.h>
@@ -51,19 +52,9 @@ ResizeVolumeGroupJob::prettyStatusMessage() const
 Calamares::JobResult
 ResizeVolumeGroupJob::exec()
 {
-    Report report( nullptr );
-
-    ResizeVolumeGroupOperation op( *m_device, m_partitionList );
-
-    op.setStatus( Operation::OperationStatus::StatusRunning );
-
-    QString message = tr( "The installer failed to resize a volume group named '%1'." ).arg( m_device->name() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( message, report.toText() );
+    return KPMHelpers::execute(
+        ResizeVolumeGroupOperation( *m_device, m_partitionList ),
+        tr( "The installer failed to resize a volume group named '%1'." ).arg( m_device->name() ) );
 }
 
 QString

src/modules/partition/jobs/SetPartitionFlagsJob.cpp

@@ -13,6 +13,8 @@
 
 #include "SetPartitionFlagsJob.h"
 
+#include "core/KPMHelpers.h"
+
 #include "partition/FileSystem.h"
 #include "utils/Logger.h"
 #include "utils/Units.h"
@@ -148,17 +150,8 @@ SetPartFlagsJob::exec()
     cDebug() << "Setting flags on" << m_device->deviceNode() << "partition" << partition()->deviceNode()
              << Logger::DebugList( flagsList );
 
-    Report report( nullptr );
     SetPartFlagsOperation op( *m_device, *partition(), m_flags );
-    op.setStatus( Operation::StatusRunning );
     connect( &op, &Operation::progress, this, &SetPartFlagsJob::iprogress );
-
-    QString errorMessage
-        = tr( "The installer failed to set flags on partition %1." ).arg( m_partition->partitionPath() );
-    if ( op.execute( report ) )
-    {
-        return Calamares::JobResult::ok();
-    }
-
-    return Calamares::JobResult::error( errorMessage, report.toText() );
+    return KPMHelpers::execute(
+        op, tr( "The installer failed to set flags on partition %1." ).arg( m_partition->partitionPath() ) );
 }