From af8f6dc039a96c05f4906300d63239d13f14f374 Mon Sep 17 00:00:00 2001
From: Jarek Kobus <jaroslaw.kobus@qt.io>
Date: Tue, 31 May 2022 18:03:05 +0200
Subject: [PATCH] LinuxDeviceTester: Test if required commands are available

Change-Id: Iaad3ec8667c4134ead86ca9e3239e810554b8f43
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
---
 src/plugins/remotelinux/linuxdevicetester.cpp | 99 ++++++++++++++++++-
 src/plugins/remotelinux/linuxdevicetester.h   |  4 +
 2 files changed, 101 insertions(+), 2 deletions(-)

diff --git a/src/plugins/remotelinux/linuxdevicetester.cpp b/src/plugins/remotelinux/linuxdevicetester.cpp
index 869ac90b3e8..796b9c87d4e 100644
--- a/src/plugins/remotelinux/linuxdevicetester.cpp
+++ b/src/plugins/remotelinux/linuxdevicetester.cpp
@@ -42,7 +42,13 @@ namespace RemoteLinux {
 namespace Internal {
 namespace {
 
-enum State { Inactive, TestingEcho, TestingUname, TestingPorts, TestingSftp, TestingRsync };
+enum State { Inactive,
+             TestingEcho,
+             TestingUname,
+             TestingPorts,
+             TestingSftp,
+             TestingRsync,
+             TestingCommands };
 
 } // anonymous namespace
 
@@ -56,8 +62,43 @@ public:
     FileTransfer fileTransfer;
     State state = Inactive;
     bool sftpWorks = false;
+    int currentCommandIndex = 0;
+    bool commandFailed = false;
+    QtcProcess commandsProcess;
 };
 
+const QStringList s_commandsToTest = {"base64",
+                                      "cat",
+                                      "chmod",
+                                      "cp",
+                                      "cut",
+                                      "dd",
+                                      "df",
+                                      "echo",
+                                      "eval",
+                                      "exit",
+                                      "kill",
+                                      "ls",
+                                      "mkdir",
+                                      "mkfifo",
+                                      "mktemp",
+                                      "mv",
+                                      "printf",
+                                      "read",
+                                      "readlink",
+                                      "rm",
+                                      "sed",
+                                      "sh",
+                                      "shift",
+                                      "stat",
+                                      "tail",
+                                      "test",
+                                      "trap",
+                                      "touch",
+                                      "which"};
+// other possible commands (checked for qnx):
+// "awk", "grep", "netstat", "print", "pidin", "sleep", "uname"
+
 } // namespace Internal
 
 using namespace Internal;
@@ -75,6 +116,8 @@ GenericLinuxDeviceTester::GenericLinuxDeviceTester(QObject *parent)
             this, &GenericLinuxDeviceTester::handlePortsGathererDone);
     connect(&d->fileTransfer, &FileTransfer::done,
             this, &GenericLinuxDeviceTester::handleFileTransferDone);
+    connect(&d->commandsProcess, &QtcProcess::done,
+            this, &GenericLinuxDeviceTester::handleCommandDone);
 }
 
 GenericLinuxDeviceTester::~GenericLinuxDeviceTester() = default;
@@ -106,6 +149,9 @@ void GenericLinuxDeviceTester::stopTest()
     case TestingRsync:
         d->fileTransfer.stop();
         break;
+    case TestingCommands:
+        d->commandsProcess.close();
+        break;
     case Inactive:
         break;
     }
@@ -254,10 +300,59 @@ void GenericLinuxDeviceTester::handleFileTransferDone(const ProcessResultData &r
             }
         }
         d->device->setExtraData(Constants::SupportsRSync, succeeded);
-        setFinished(d->sftpWorks || succeeded ? TestSuccess : TestFailure);
+        if (d->sftpWorks || succeeded)
+            testCommands();
+        else
+            setFinished(TestFailure);
     }
 }
 
+void GenericLinuxDeviceTester::testCommands()
+{
+    d->state = TestingCommands;
+    emit progressMessage(tr("Checking if required commands are available..."));
+
+    d->currentCommandIndex = 0;
+    d->commandFailed = false;
+    testNextCommand();
+}
+
+void GenericLinuxDeviceTester::testNextCommand()
+{
+    d->commandsProcess.close();
+    if (s_commandsToTest.size() == d->currentCommandIndex) {
+        setFinished(d->commandFailed ? TestFailure : TestSuccess);
+        return;
+    }
+
+    const QString commandName = s_commandsToTest[d->currentCommandIndex];
+    emit progressMessage(tr("%1...").arg(commandName));
+    CommandLine command{d->device->filePath("/bin/sh"), {"-c"}};
+    command.addArgs(QLatin1String("\"command -v %1\"").arg(commandName), CommandLine::Raw);
+    d->commandsProcess.setCommand(command);
+    d->commandsProcess.start();
+}
+
+void GenericLinuxDeviceTester::handleCommandDone()
+{
+    QTC_ASSERT(d->state == TestingCommands, return);
+
+    const QString command = s_commandsToTest[d->currentCommandIndex];
+    if (d->commandsProcess.result() == ProcessResult::FinishedWithSuccess) {
+        emit progressMessage(tr("%1 found.").arg(command));
+    } else {
+        d->commandFailed = true;
+        const QString message = d->commandsProcess.result() == ProcessResult::StartFailed
+                ? tr("An error occurred while checking for %1.").arg(command)
+                  + '\n' + d->commandsProcess.errorString()
+                : tr("%1 not found.").arg(command);
+        emit errorMessage(message);
+    }
+
+    ++d->currentCommandIndex;
+    testNextCommand();
+}
+
 void GenericLinuxDeviceTester::setFinished(TestResult result)
 {
     d->state = Inactive;
diff --git a/src/plugins/remotelinux/linuxdevicetester.h b/src/plugins/remotelinux/linuxdevicetester.h
index 890484a8705..67c392771a6 100644
--- a/src/plugins/remotelinux/linuxdevicetester.h
+++ b/src/plugins/remotelinux/linuxdevicetester.h
@@ -61,6 +61,10 @@ private:
     void testFileTransfer(ProjectExplorer::FileTransferMethod method);
     void handleFileTransferDone(const Utils::ProcessResultData &resultData);
 
+    void testCommands();
+    void testNextCommand();
+    void handleCommandDone();
+
     void setFinished(ProjectExplorer::DeviceTester::TestResult result);
 
     std::unique_ptr<Internal::GenericLinuxDeviceTesterPrivate> d;