Merge AbstractPackaginsStep with TarPackageCreationStep

Change-Id: I754d46df144fa4cc4d9715a22b85b12e38828ff6
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>

src/plugins/remotelinux/CMakeLists.txt

@@ -2,7 +2,6 @@ add_qtc_plugin(RemoteLinux
   DEPENDS QmlDebug
   PLUGIN_DEPENDS Core Debugger ProjectExplorer
   SOURCES
-    abstractpackagingstep.cpp abstractpackagingstep.h
     abstractremotelinuxdeployservice.cpp abstractremotelinuxdeployservice.h
     abstractremotelinuxdeploystep.cpp abstractremotelinuxdeploystep.h
     checkforfreediskspacestep.cpp checkforfreediskspacestep.h

src/plugins/remotelinux/abstractpackagingstep.cpp

@@ -1,148 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2016 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 "abstractpackagingstep.h"
-
-#include <projectexplorer/buildconfiguration.h>
-#include <projectexplorer/deploymentdata.h>
-#include <projectexplorer/projectexplorerconstants.h>
-#include <projectexplorer/target.h>
-#include <projectexplorer/task.h>
-
-#include <QDateTime>
-
-using namespace ProjectExplorer;
-using namespace Utils;
-
-namespace RemoteLinux {
-namespace Internal {
-
-class AbstractPackagingStepPrivate
-{
-public:
-    FilePath cachedPackageFilePath;
-    FilePath cachedPackageDirectory;
-    bool deploymentDataModified = false;
-};
-
-} // namespace Internal
-
-AbstractPackagingStep::AbstractPackagingStep(BuildStepList *bsl, Utils::Id id)
-    : BuildStep(bsl, id)
-{
-    d = new Internal::AbstractPackagingStepPrivate;
-
-    connect(target(), &Target::deploymentDataChanged,
-            this, &AbstractPackagingStep::setDeploymentDataModified);
-    setDeploymentDataModified();
-
-    connect(this, &AbstractPackagingStep::unmodifyDeploymentData,
-            this, &AbstractPackagingStep::setDeploymentDataUnmodified);
-}
-
-AbstractPackagingStep::~AbstractPackagingStep()
-{
-    delete d;
-}
-
-FilePath AbstractPackagingStep::cachedPackageFilePath() const
-{
-    return d->cachedPackageFilePath;
-}
-
-FilePath AbstractPackagingStep::packageFilePath() const
-{
-    if (packageDirectory().isEmpty())
-        return {};
-    return packageDirectory().pathAppended(packageFileName());
-}
-
-FilePath AbstractPackagingStep::cachedPackageDirectory() const
-{
-    return d->cachedPackageDirectory;
-}
-
-FilePath AbstractPackagingStep::packageDirectory() const
-{
-    return buildDirectory();
-}
-
-bool AbstractPackagingStep::isPackagingNeeded() const
-{
-    const FilePath packagePath = packageFilePath();
-    if (!packagePath.exists() || d->deploymentDataModified)
-        return true;
-
-    const DeploymentData &dd = target()->deploymentData();
-    for (int i = 0; i < dd.fileCount(); ++i) {
-        if (dd.fileAt(i).localFilePath().isNewerThan(packagePath.lastModified()))
-            return true;
-    }
-
-    return false;
-}
-
-bool AbstractPackagingStep::init()
-{
-    d->cachedPackageDirectory = packageDirectory();
-    d->cachedPackageFilePath = packageFilePath();
-    return true;
-}
-
-void AbstractPackagingStep::setPackagingStarted()
-{
-}
-
-// called in ::run thread
-void AbstractPackagingStep::setPackagingFinished(bool success)
-{
-    if (success)
-        emit unmodifyDeploymentData();
-}
-
-// called in gui thread
-void AbstractPackagingStep::setDeploymentDataUnmodified()
-{
-    d->deploymentDataModified = false;
-}
-
-void AbstractPackagingStep::setDeploymentDataModified()
-{
-    d->deploymentDataModified = true;
-}
-
-void AbstractPackagingStep::raiseError(const QString &errorMessage)
-{
-    emit addTask(DeploymentTask(Task::Error, errorMessage));
-    emit addOutput(errorMessage, BuildStep::OutputFormat::Stderr);
-}
-
-void AbstractPackagingStep::raiseWarning(const QString &warningMessage)
-{
-    emit addTask(DeploymentTask(Task::Warning, warningMessage));
-    emit addOutput(warningMessage, OutputFormat::ErrorMessage);
-}
-
-} // namespace RemoteLinux

src/plugins/remotelinux/abstractpackagingstep.h

@@ -1,71 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2016 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.
-**
-****************************************************************************/
-
-#pragma once
-
-#include "remotelinux_export.h"
-
-#include <projectexplorer/buildstep.h>
-
-namespace RemoteLinux {
-
-namespace Internal { class AbstractPackagingStepPrivate; }
-
-class REMOTELINUX_EXPORT AbstractPackagingStep : public ProjectExplorer::BuildStep
-{
-    Q_OBJECT
-
-public:
-    explicit AbstractPackagingStep(ProjectExplorer::BuildStepList *bsl, Utils::Id id);
-    ~AbstractPackagingStep() override;
-
-    Utils::FilePath packageFilePath() const;
-    Utils::FilePath cachedPackageFilePath() const;
-    bool init() override;
-
-signals:
-    void unmodifyDeploymentData();
-
-protected:
-    void setPackagingStarted();
-    void setPackagingFinished(bool success);
-
-    void raiseError(const QString &errorMessage);
-    void raiseWarning(const QString &warningMessage);
-    Utils::FilePath cachedPackageDirectory() const;
-    Utils::FilePath packageDirectory() const;
-
-    virtual bool isPackagingNeeded() const;
-
-private:
-    void setDeploymentDataUnmodified();
-    void setDeploymentDataModified();
-
-    virtual QString packageFileName() const = 0;
-
-    Internal::AbstractPackagingStepPrivate *d;
-};
-
-} // namespace RemoteLinux

src/plugins/remotelinux/remotelinux.qbs

@@ -13,8 +13,6 @@ Project {
         Depends { name: "ProjectExplorer" }
 
         files: [
-            "abstractpackagingstep.cpp",
-            "abstractpackagingstep.h",
             "abstractremotelinuxdeployservice.cpp",
             "abstractremotelinuxdeployservice.h",
             "abstractremotelinuxdeploystep.cpp",

src/plugins/remotelinux/tarpackagecreationstep.cpp

@@ -25,6 +25,7 @@
 
 #include "tarpackagecreationstep.h"
 
+#include "deploymenttimeinfo.h"
 #include "remotelinux_constants.h"
 
 #include <projectexplorer/buildmanager.h>
@@ -43,7 +44,7 @@ using namespace ProjectExplorer;
 using namespace Utils;
 
 namespace RemoteLinux {
-namespace {
+
 const char IgnoreMissingFilesKey[] = "RemoteLinux.TarPackageCreationStep.IgnoreMissingFiles";
 const char IncrementalDeploymentKey[] = "RemoteLinux.TarPackageCreationStep.IncrementalDeployment";
 
@@ -68,20 +69,40 @@ struct TarFileHeader {
     char padding[12];
 };
 
-} // Anonymous namespace.
+namespace Internal {
 
-TarPackageCreationStep::TarPackageCreationStep(BuildStepList *bsl, Utils::Id id)
+class TarPackageCreationStepPrivate
-    : AbstractPackagingStep(bsl, id)
 {
-    m_ignoreMissingFilesAspect = addAspect<BoolAspect>();
+public:
-    m_ignoreMissingFilesAspect->setLabel(tr("Ignore missing files"),
+    FilePath m_cachedPackageFilePath;
-                                         BoolAspect::LabelPlacement::AtCheckBox);
+    bool m_deploymentDataModified = false;
-    m_ignoreMissingFilesAspect->setSettingsKey(IgnoreMissingFilesKey);
+    DeploymentTimeInfo m_deployTimes;
+    BoolAspect *m_incrementalDeploymentAspect = nullptr;
+    BoolAspect *m_ignoreMissingFilesAspect = nullptr;
+    bool m_packagingNeeded = false;
+    QList<DeployableFile> m_files;
+};
 
-    m_incrementalDeploymentAspect = addAspect<BoolAspect>();
+} // namespace Internal
-    m_incrementalDeploymentAspect->setLabel(tr("Package modified files only"),
+
+TarPackageCreationStep::TarPackageCreationStep(BuildStepList *bsl, Id id)
+    : BuildStep(bsl, id)
+    , d(new Internal::TarPackageCreationStepPrivate)
+{
+    connect(target(), &Target::deploymentDataChanged, this, [this] {
+        d->m_deploymentDataModified = true;
+    });
+    d->m_deploymentDataModified = true;
+
+    d->m_ignoreMissingFilesAspect = addAspect<BoolAspect>();
+    d->m_ignoreMissingFilesAspect->setLabel(tr("Ignore missing files"),
                                          BoolAspect::LabelPlacement::AtCheckBox);
-    m_incrementalDeploymentAspect->setSettingsKey(IncrementalDeploymentKey);
+    d->m_ignoreMissingFilesAspect->setSettingsKey(IgnoreMissingFilesKey);
+
+    d->m_incrementalDeploymentAspect = addAspect<BoolAspect>();
+    d->m_incrementalDeploymentAspect->setLabel(tr("Package modified files only"),
+                                            BoolAspect::LabelPlacement::AtCheckBox);
+    d->m_incrementalDeploymentAspect->setSettingsKey(IncrementalDeploymentKey);
 
     setSummaryUpdater([this] {
         FilePath path = packageFilePath();
@@ -92,13 +113,30 @@ TarPackageCreationStep::TarPackageCreationStep(BuildStepList *bsl, Utils::Id id)
     });
 }
 
+TarPackageCreationStep::~TarPackageCreationStep() = default;
+
+Utils::Id TarPackageCreationStep::stepId()
+{
+    return Constants::TarPackageCreationStepId;
+}
+
+QString TarPackageCreationStep::displayName()
+{
+    return tr("Create tarball");
+}
+
+FilePath TarPackageCreationStep::packageFilePath() const
+{
+    if (buildDirectory().isEmpty())
+        return {};
+    const QString packageFileName = project()->displayName() + QLatin1String(".tar");
+    return buildDirectory().pathAppended(packageFileName);
+}
+
 bool TarPackageCreationStep::init()
 {
-    if (!AbstractPackagingStep::init())
+    d->m_cachedPackageFilePath = packageFilePath();
-        return false;
+    d->m_packagingNeeded = isPackagingNeeded();
-
-    m_packagingNeeded = isPackagingNeeded();
-
     return true;
 }
 
@@ -107,14 +145,76 @@ void TarPackageCreationStep::doRun()
     runInThread([this] { return runImpl(); });
 }
 
+bool TarPackageCreationStep::fromMap(const QVariantMap &map)
+{
+    if (!BuildStep::fromMap(map))
+        return false;
+    d->m_deployTimes.importDeployTimes(map);
+    return true;
+}
+
+QVariantMap TarPackageCreationStep::toMap() const
+{
+    QVariantMap map = BuildStep::toMap();
+#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
+    map.insert(d->m_deployTimes.exportDeployTimes());
+#else
+    map.unite(d->m_deployTimes.exportDeployTimes());
+#endif
+    return map;
+}
+
+void TarPackageCreationStep::raiseError(const QString &errorMessage)
+{
+    emit addTask(DeploymentTask(Task::Error, errorMessage));
+    emit addOutput(errorMessage, BuildStep::OutputFormat::Stderr);
+}
+
+void TarPackageCreationStep::raiseWarning(const QString &warningMessage)
+{
+    emit addTask(DeploymentTask(Task::Warning, warningMessage));
+    emit addOutput(warningMessage, OutputFormat::ErrorMessage);
+}
+
+bool TarPackageCreationStep::isPackagingNeeded() const
+{
+    const FilePath packagePath = packageFilePath();
+    if (!packagePath.exists() || d->m_deploymentDataModified)
+        return true;
+
+    const DeploymentData &dd = target()->deploymentData();
+    for (int i = 0; i < dd.fileCount(); ++i) {
+        if (dd.fileAt(i).localFilePath().isNewerThan(packagePath.lastModified()))
+            return true;
+    }
+
+    return false;
+}
+
+void TarPackageCreationStep::deployFinished(bool success)
+{
+    disconnect(BuildManager::instance(), &BuildManager::buildQueueFinished,
+               this, &TarPackageCreationStep::deployFinished);
+
+    if (!success)
+        return;
+
+    const Kit *kit = target()->kit();
+
+    // Store files that have been tar'd and successfully deployed
+    const auto files = d->m_files;
+    for (const DeployableFile &file : files)
+        d->m_deployTimes.saveDeploymentTimeStamp(file, kit, QDateTime());
+}
+
 void TarPackageCreationStep::addNeededDeploymentFiles(
         const ProjectExplorer::DeployableFile &deployable,
         const ProjectExplorer::Kit *kit)
 {
     const QFileInfo fileInfo = deployable.localFilePath().toFileInfo();
     if (!fileInfo.isDir()) {
-        if (m_deployTimes.hasLocalFileChanged(deployable, kit))
+        if (d->m_deployTimes.hasLocalFileChanged(deployable, kit))
-            m_files << deployable;
+            d->m_files << deployable;
         return;
     }
 
@@ -122,7 +222,7 @@ void TarPackageCreationStep::addNeededDeploymentFiles(
             .entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot);
 
     if (files.isEmpty()) {
-        m_files << deployable;
+        d->m_files << deployable;
         return;
     }
 
@@ -136,16 +236,43 @@ void TarPackageCreationStep::addNeededDeploymentFiles(
     }
 }
 
+bool TarPackageCreationStep::runImpl()
+{
+    const QList<DeployableFile> &files = target()->deploymentData().allFiles();
+
+    if (d->m_incrementalDeploymentAspect->value()) {
+        d->m_files.clear();
+        for (const DeployableFile &file : files)
+            addNeededDeploymentFiles(file, kit());
+    } else {
+        d->m_files = files;
+    }
+
+    const bool success = doPackage();
+
+    if (success) {
+        d->m_deploymentDataModified = false;
+        emit addOutput(tr("Packaging finished successfully."), OutputFormat::NormalMessage);
+    } else {
+        emit addOutput(tr("Packaging failed."), OutputFormat::ErrorMessage);
+    }
+
+    connect(BuildManager::instance(), &BuildManager::buildQueueFinished,
+            this, &TarPackageCreationStep::deployFinished);
+
+    return success;
+}
+
 bool TarPackageCreationStep::doPackage()
 {
     emit addOutput(tr("Creating tarball..."), OutputFormat::NormalMessage);
-    if (!m_packagingNeeded) {
+    if (!d->m_packagingNeeded) {
         emit addOutput(tr("Tarball up to date, skipping packaging."), OutputFormat::NormalMessage);
         return true;
     }
 
     // TODO: Optimization: Only package changed files
-    const FilePath tarFilePath = cachedPackageFilePath();
+    const FilePath tarFilePath = d->m_cachedPackageFilePath;
     QFile tarFile(tarFilePath.toString());
 
     if (!tarFile.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
@@ -154,7 +281,7 @@ bool TarPackageCreationStep::doPackage()
         return false;
     }
 
-    foreach (const DeployableFile &d, m_files) {
+    for (const DeployableFile &d : qAsConst(d->m_files)) {
         if (d.remoteDirectory().isEmpty()) {
             emit addOutput(tr("No remote path specified for file \"%1\", skipping.")
                 .arg(d.localFilePath().toUserOutput()), OutputFormat::ErrorMessage);
@@ -177,66 +304,6 @@ bool TarPackageCreationStep::doPackage()
     return true;
 }
 
-bool TarPackageCreationStep::appendFile(QFile &tarFile, const QFileInfo &fileInfo,
-    const QString &remoteFilePath)
-{
-    if (!writeHeader(tarFile, fileInfo, remoteFilePath))
-        return false;
-    if (fileInfo.isDir()) {
-        QDir dir(fileInfo.absoluteFilePath());
-        foreach (const QString &fileName,
-                 dir.entryList(QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot)) {
-            const QString thisLocalFilePath = dir.path() + QLatin1Char('/') + fileName;
-            const QString thisRemoteFilePath  = remoteFilePath + QLatin1Char('/') + fileName;
-            if (!appendFile(tarFile, QFileInfo(thisLocalFilePath), thisRemoteFilePath))
-                return false;
-        }
-        return true;
-    }
-
-    const QString nativePath = QDir::toNativeSeparators(fileInfo.filePath());
-    QFile file(fileInfo.filePath());
-    if (!file.open(QIODevice::ReadOnly)) {
-        const QString message = tr("Error reading file \"%1\": %2.")
-                                .arg(nativePath, file.errorString());
-        if (m_ignoreMissingFilesAspect->value()) {
-            raiseWarning(message);
-            return true;
-        } else {
-            raiseError(message);
-            return false;
-        }
-    }
-
-    const int chunkSize = 1024*1024;
-
-    emit addOutput(tr("Adding file \"%1\" to tarball...").arg(nativePath),
-                   OutputFormat::NormalMessage);
-
-    // TODO: Wasteful. Work with fixed-size buffer.
-    while (!file.atEnd() && file.error() == QFile::NoError && tarFile.error() == QFile::NoError) {
-        const QByteArray data = file.read(chunkSize);
-        tarFile.write(data);
-        if (isCanceled())
-            return false;
-    }
-    if (file.error() != QFile::NoError) {
-        raiseError(tr("Error reading file \"%1\": %2.").arg(nativePath, file.errorString()));
-        return false;
-    }
-
-    const int blockModulo = file.size() % TarBlockSize;
-    if (blockModulo != 0)
-        tarFile.write(QByteArray(TarBlockSize - blockModulo, 0));
-
-    if (tarFile.error() != QFile::NoError) {
-        raiseError(tr("Error writing tar file \"%1\": %2.")
-            .arg(QDir::toNativeSeparators(tarFile.fileName()), tarFile.errorString()));
-        return false;
-    }
-    return true;
-}
-
 static bool setFilePath(TarFileHeader &header, const QByteArray &filePath)
 {
     if (filePath.length() <= int(sizeof header.fileName)) {
@@ -257,13 +324,14 @@ static bool setFilePath(TarFileHeader &header, const QByteArray &filePath)
     return false;
 }
 
-bool TarPackageCreationStep::writeHeader(QFile &tarFile, const QFileInfo &fileInfo,
+static bool writeHeader(QFile &tarFile, const QFileInfo &fileInfo, const QString &remoteFilePath,
-    const QString &remoteFilePath)
+                        const QString &cachedPackageFilePath, QString *errorMessage)
 {
     TarFileHeader header;
     std::memset(&header, '\0', sizeof header);
     if (!setFilePath(header, remoteFilePath.toUtf8())) {
-        raiseError(tr("Cannot add file \"%1\" to tar-archive: path too long.").arg(remoteFilePath));
+        *errorMessage = QCoreApplication::translate("RemoteLinux::TarPackageCreationStep",
+            "Cannot add file \"%1\" to tar-archive: path too long.").arg(remoteFilePath);
         return false;
     }
     int permissions = (0400 * fileInfo.permission(QFile::ReadOwner))
@@ -308,89 +376,75 @@ bool TarPackageCreationStep::writeHeader(QFile &tarFile, const QFileInfo &fileIn
     std::memcpy(&header.chksum, checksumString.data(), checksumString.length());
     header.chksum[sizeof header.chksum-1] = 0;
     if (!tarFile.write(reinterpret_cast<char *>(&header), sizeof header)) {
-        raiseError(tr("Error writing tar file \"%1\": %2")
+        *errorMessage = QCoreApplication::translate("RemoteLinux::TarPackageCreationStep",
-           .arg(cachedPackageFilePath().toUserOutput(), tarFile.errorString()));
+            "Error writing tar file \"%1\": %2").arg(cachedPackageFilePath, tarFile.errorString());
         return false;
     }
     return true;
 }
 
-void TarPackageCreationStep::deployFinished(bool success)
+bool TarPackageCreationStep::appendFile(QFile &tarFile, const QFileInfo &fileInfo,
+    const QString &remoteFilePath)
 {
-    disconnect(BuildManager::instance(), &BuildManager::buildQueueFinished,
+    QString errorMessage;
-               this, &TarPackageCreationStep::deployFinished);
+    if (!writeHeader(tarFile, fileInfo, remoteFilePath, d->m_cachedPackageFilePath.toUserOutput(),
+                     &errorMessage)) {
+        raiseError(errorMessage);
+        return false;
+    }
+    if (fileInfo.isDir()) {
+        QDir dir(fileInfo.absoluteFilePath());
+        foreach (const QString &fileName,
+                 dir.entryList(QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot)) {
+            const QString thisLocalFilePath = dir.path() + QLatin1Char('/') + fileName;
+            const QString thisRemoteFilePath  = remoteFilePath + QLatin1Char('/') + fileName;
+            if (!appendFile(tarFile, QFileInfo(thisLocalFilePath), thisRemoteFilePath))
+                return false;
+        }
+        return true;
+    }
 
-    if (!success)
+    const QString nativePath = QDir::toNativeSeparators(fileInfo.filePath());
-        return;
+    QFile file(fileInfo.filePath());
-
+    if (!file.open(QIODevice::ReadOnly)) {
-    const Kit *kit = target()->kit();
+        const QString message = tr("Error reading file \"%1\": %2.")
-
+                                .arg(nativePath, file.errorString());
-    // Store files that have been tar'd and successfully deployed
+        if (d->m_ignoreMissingFilesAspect->value()) {
-    const auto files = m_files;
+            raiseWarning(message);
-    for (const DeployableFile &file : files)
+            return true;
-        m_deployTimes.saveDeploymentTimeStamp(file, kit, QDateTime());
-}
-
-QString TarPackageCreationStep::packageFileName() const
-{
-    return project()->displayName() + QLatin1String(".tar");
-}
-
-bool TarPackageCreationStep::runImpl()
-{
-    setPackagingStarted();
-
-    const QList<DeployableFile> &files = target()->deploymentData().allFiles();
-
-    if (m_incrementalDeploymentAspect->value()) {
-        m_files.clear();
-        for (const DeployableFile &file : files)
-            addNeededDeploymentFiles(file, kit());
         } else {
-        m_files = files;
+            raiseError(message);
+            return false;
+        }
     }
 
-    const bool success = doPackage();
+    const int chunkSize = 1024*1024;
 
-    setPackagingFinished(success);
+    emit addOutput(tr("Adding file \"%1\" to tarball...").arg(nativePath),
-    if (success)
+                   OutputFormat::NormalMessage);
-        emit addOutput(tr("Packaging finished successfully."), OutputFormat::NormalMessage);
-    else
-        emit addOutput(tr("Packaging failed."), OutputFormat::ErrorMessage);
 
-    connect(BuildManager::instance(), &BuildManager::buildQueueFinished,
+    // TODO: Wasteful. Work with fixed-size buffer.
-            this, &TarPackageCreationStep::deployFinished);
+    while (!file.atEnd() && file.error() == QFile::NoError && tarFile.error() == QFile::NoError) {
-
+        const QByteArray data = file.read(chunkSize);
-    return success;
+        tarFile.write(data);
-}
+        if (isCanceled())
-
-bool TarPackageCreationStep::fromMap(const QVariantMap &map)
-{
-    if (!AbstractPackagingStep::fromMap(map))
             return false;
-    m_deployTimes.importDeployTimes(map);
+    }
+    if (file.error() != QFile::NoError) {
+        raiseError(tr("Error reading file \"%1\": %2.").arg(nativePath, file.errorString()));
+        return false;
+    }
+
+    const int blockModulo = file.size() % TarBlockSize;
+    if (blockModulo != 0)
+        tarFile.write(QByteArray(TarBlockSize - blockModulo, 0));
+
+    if (tarFile.error() != QFile::NoError) {
+        raiseError(tr("Error writing tar file \"%1\": %2.")
+            .arg(QDir::toNativeSeparators(tarFile.fileName()), tarFile.errorString()));
+        return false;
+    }
     return true;
 }
 
-QVariantMap TarPackageCreationStep::toMap() const
-{
-    QVariantMap map = AbstractPackagingStep::toMap();
-#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
-    map.insert(m_deployTimes.exportDeployTimes());
-#else
-    map.unite(m_deployTimes.exportDeployTimes());
-#endif
-    return map;
-}
-
-Utils::Id TarPackageCreationStep::stepId()
-{
-    return Constants::TarPackageCreationStepId;
-}
-
-QString TarPackageCreationStep::displayName()
-{
-    return tr("Create tarball");
-}
-
 } // namespace RemoteLinux

src/plugins/remotelinux/tarpackagecreationstep.h

@@ -27,60 +27,49 @@
 
 #include "remotelinux_export.h"
 
-#include "abstractpackagingstep.h"
+#include <projectexplorer/buildstep.h>
-#include "deploymenttimeinfo.h"
-
-#include <projectexplorer/deployablefile.h>
 
 QT_BEGIN_NAMESPACE
 class QFile;
 class QFileInfo;
 QT_END_NAMESPACE
 
+namespace ProjectExplorer { class DeployableFile; }
+
 namespace RemoteLinux {
 
-class REMOTELINUX_EXPORT TarPackageCreationStep : public AbstractPackagingStep
+namespace Internal { class TarPackageCreationStepPrivate; }
+
+class REMOTELINUX_EXPORT TarPackageCreationStep : public ProjectExplorer::BuildStep
 {
     Q_OBJECT
+
 public:
-    TarPackageCreationStep(ProjectExplorer::BuildStepList *bsl, Utils::Id id);
+    explicit TarPackageCreationStep(ProjectExplorer::BuildStepList *bsl, Utils::Id id);
+    ~TarPackageCreationStep() override;
 
     static Utils::Id stepId();
     static QString displayName();
 
-    void setIgnoreMissingFiles(bool ignoreMissingFiles);
+    Utils::FilePath packageFilePath() const;
-    bool ignoreMissingFiles() const;
-
-    void setIncrementalDeployment(bool incrementalDeployment);
-    bool isIncrementalDeployment() const;
 
 private:
     bool init() override;
     void doRun() override;
-
-    void deployFinished(bool success);
-
-    void addNeededDeploymentFiles(const ProjectExplorer::DeployableFile &deployable,
-                                  const ProjectExplorer::Kit *kit);
-
     bool fromMap(const QVariantMap &map) override;
     QVariantMap toMap() const override;
 
-    QString packageFileName() const override;
+    void raiseError(const QString &errorMessage);
-
+    void raiseWarning(const QString &warningMessage);
+    bool isPackagingNeeded() const;
+    void deployFinished(bool success);
+    void addNeededDeploymentFiles(const ProjectExplorer::DeployableFile &deployable,
+                                  const ProjectExplorer::Kit *kit);
     bool runImpl();
     bool doPackage();
-    bool appendFile(QFile &tarFile, const QFileInfo &fileInfo,
+    bool appendFile(QFile &tarFile, const QFileInfo &fileInfo, const QString &remoteFilePath);
-        const QString &remoteFilePath);
-    bool writeHeader(QFile &tarFile, const QFileInfo &fileInfo,
-        const QString &remoteFilePath);
 
-    DeploymentTimeInfo m_deployTimes;
+    std::unique_ptr<Internal::TarPackageCreationStepPrivate> d;
-
-    Utils::BoolAspect *m_incrementalDeploymentAspect = nullptr;
-    Utils::BoolAspect *m_ignoreMissingFilesAspect = nullptr;
-    bool m_packagingNeeded = false;
-    QList<ProjectExplorer::DeployableFile> m_files;
 };
 
 } // namespace RemoteLinux