runCommand feature + integration tests

integration-tests/source/jobs/JobsIntegrationTests.cpp

@@ -33,6 +33,9 @@ static constexpr char VERIFY_PACKAGES_REMOVED_JOB_DOC[] =
     "{ \"version\": \"1.0\", \"steps\": [ { \"action\": { \"name\": \"Verify Packages Removed\", \"type\": "
     "\"runHandler\", \"input\": { \"handler\": \"verify-packages-removed.sh\", \"args\": [ \"dos2unix\" ], \"path\": "
     "\"default\" }, \"runAsUser\": \"root\" } }]}";
+static constexpr char RUN_COMMAND_PRINT_GREETING_JOB_DOC[] =
+    "{ \"version\": \"1.0\", \"steps\": [ { \"action\": { \"name\": \"Print Greeting\", \"type\": "
+    "\"runCommand\", \"input\": { \"command\": \"echo,Hello World\" }, \"runAsUser\": \"root\" } }]}";
 
 class TestJobsFixture : public ::testing::Test
 {
@@ -82,3 +85,11 @@ TEST_F(TestJobsFixture, RemovePackages)
 
     ASSERT_EQ(resourceHandler->GetJobExecutionStatusWithRetry(jobId), JobExecutionStatus::SUCCEEDED);
 }
+
+TEST_F(TestJobsFixture, PrintGreeting)
+{
+    string jobId = "Print-Greeting-" + resourceHandler->GetTimeStamp();
+    resourceHandler->CreateJob(jobId, RUN_COMMAND_PRINT_GREETING_JOB_DOC);
+
+    ASSERT_EQ(resourceHandler->GetJobExecutionStatusWithRetry(jobId), JobExecutionStatus::SUCCEEDED);
+}

sample-job-docs/run-shellcommand.json

@@ -0,0 +1,16 @@
+{
+  "_comment": "This sample JSON file can be used for creating a new directory newDir at the current filepath.",
+  "version": "1.0",
+  "steps": [
+    {
+      "action": {
+        "name": "Create New Directory",
+        "type": "runCommand",
+        "input": {
+          "command": "mkdir,newDir"
+        },
+        "runAsUser": "root"
+      }
+    }
+  ]
+}

source/jobs/JobDocument.cpp

@@ -3,17 +3,22 @@
 
 #include "JobDocument.h"
 #include "../logging/LoggerFactory.h"
+#include "../util/StringUtils.h"
 #include <aws/crt/JsonObject.h>
+#include <regex>
+#include <set>
 
 using namespace std;
 using namespace Aws::Iot::DeviceClient::Jobs;
 using namespace Aws::Iot;
 using namespace Aws::Crt;
 using namespace Aws::Iot::DeviceClient::Logging;
+using namespace Aws::Iot::DeviceClient::Util;
 
 constexpr char LoadableFromJobDocument::TAG[];
 
 constexpr char PlainJobDocument::ACTION_TYPE_RUN_HANDLER[];
+constexpr char PlainJobDocument::ACTION_TYPE_RUN_COMMAND[];
 
 constexpr char PlainJobDocument::JSON_KEY_VERSION[];
 constexpr char PlainJobDocument::JSON_KEY_INCLUDESTDOUT[];
@@ -52,16 +57,16 @@ void PlainJobDocument::LoadFromJobDocument(const JsonView &json)
         if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsString())
         {
             JobAction jobAction;
+            JobAction::ActionHandlerInput temp;
             // Save Job Action name and handler field value with operation field value
             jobAction.name = json.GetString(jsonKey).c_str();
-            jobAction.input.handler = jobAction.name;
+            temp.handler = jobAction.name;
 
             jsonKey = JSON_KEY_ARGS;
             if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsListType())
             {
-                jobAction.input.args = ParseToVectorString(json.GetJsonObject(jsonKey));
+                temp.args = Util::ParseToVectorString(json.GetJsonObject(jsonKey));
             }
-
             // Old Schema only supports runHandler type of action
             jobAction.type = ACTION_TYPE_RUN_HANDLER;
 
@@ -74,9 +79,11 @@ void PlainJobDocument::LoadFromJobDocument(const JsonView &json)
             jsonKey = JSON_KEY_PATH;
             if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsString())
             {
-                jobAction.input.path = json.GetString(jsonKey).c_str();
+                temp.path = json.GetString(jsonKey).c_str();
             }
 
+            jobAction.handlerInput = temp;
+
             steps.push_back(jobAction);
         }
     }
@@ -127,18 +134,6 @@ void PlainJobDocument::LoadFromJobDocument(const JsonView &json)
     }
 }
 
-vector<string> PlainJobDocument::ParseToVectorString(const JsonView &json)
-{
-    vector<string> plainVector;
-
-    for (const auto &i : json.AsArray())
-    {
-        // cppcheck-suppress useStlAlgorithm
-        plainVector.push_back(i.AsString().c_str());
-    }
-    return plainVector;
-}
-
 bool PlainJobDocument::Validate() const
 {
     if (version.empty())
@@ -201,7 +196,7 @@ void PlainJobDocument::JobCondition::LoadFromJobDocument(const JsonView &json)
     jsonKey = JSON_KEY_CONDITION_VALUE;
     if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsListType())
     {
-        conditionValue = ParseToVectorString(json.GetJsonObject(jsonKey));
+        conditionValue = Util::ParseToVectorString(json.GetJsonObject(jsonKey));
     }
 
     jsonKey = JSON_KEY_TYPE;
@@ -233,6 +228,9 @@ constexpr char PlainJobDocument::JobAction::JSON_KEY_INPUT[];
 constexpr char PlainJobDocument::JobAction::JSON_KEY_RUNASUSER[];
 constexpr char PlainJobDocument::JobAction::JSON_KEY_ALLOWSTDERR[];
 constexpr char PlainJobDocument::JobAction::JSON_KEY_IGNORESTEPFAILURE[];
+const static std::set<std::string> SUPPORTED_ACTION_TYPES{
+    Aws::Iot::DeviceClient::Jobs::PlainJobDocument::ACTION_TYPE_RUN_HANDLER,
+    Aws::Iot::DeviceClient::Jobs::PlainJobDocument::ACTION_TYPE_RUN_COMMAND};
 
 void PlainJobDocument::JobAction::LoadFromJobDocument(const JsonView &json)
 {
@@ -251,9 +249,18 @@ void PlainJobDocument::JobAction::LoadFromJobDocument(const JsonView &json)
     jsonKey = JSON_KEY_INPUT;
     if (json.ValueExists(jsonKey))
     {
-        ActionInput temp;
-        temp.LoadFromJobDocument(json.GetJsonObject(jsonKey));
-        input = temp;
+        if (type == PlainJobDocument::ACTION_TYPE_RUN_HANDLER)
+        {
+            ActionHandlerInput temp;
+            temp.LoadFromJobDocument(json.GetJsonObject(jsonKey));
+            handlerInput = temp;
+        }
+        else if (type == PlainJobDocument::ACTION_TYPE_RUN_COMMAND)
+        {
+            ActionCommandInput temp;
+            temp.LoadFromJobDocument(json.GetJsonObject(jsonKey));
+            commandInput = temp;
+        }
     }
 
     jsonKey = JSON_KEY_RUNASUSER;
@@ -289,29 +296,39 @@ bool PlainJobDocument::JobAction::Validate() const
         return false;
     }
 
-    if (type != ACTION_TYPE_RUN_HANDLER)
+    if (SUPPORTED_ACTION_TYPES.count(type) == 0)
     {
         LOGM_ERROR(
             TAG,
             "*** %s: Required field Action Type with invalid value: %s ***",
             DeviceClient::Jobs::DC_INVALID_JOB_DOC,
-            type.c_str());
+            Util::Sanitize(type).c_str());
         return false;
     }
 
-    if (!input.Validate())
+    if (type == PlainJobDocument::ACTION_TYPE_RUN_HANDLER)
     {
-        return false;
+        if (!handlerInput->Validate())
+        {
+            return false;
+        }
+    }
+    else if (type == PlainJobDocument::ACTION_TYPE_RUN_COMMAND)
+    {
+        if (!commandInput->Validate())
+        {
+            return false;
+        }
     }
 
     return true;
 }
 
-constexpr char PlainJobDocument::JobAction::ActionInput::JSON_KEY_HANDLER[];
-constexpr char PlainJobDocument::JobAction::ActionInput::JSON_KEY_ARGS[];
-constexpr char PlainJobDocument::JobAction::ActionInput::JSON_KEY_PATH[];
+constexpr char PlainJobDocument::JobAction::ActionHandlerInput::JSON_KEY_HANDLER[];
+constexpr char PlainJobDocument::JobAction::ActionHandlerInput::JSON_KEY_ARGS[];
+constexpr char PlainJobDocument::JobAction::ActionHandlerInput::JSON_KEY_PATH[];
 
-void PlainJobDocument::JobAction::ActionInput::LoadFromJobDocument(const JsonView &json)
+void PlainJobDocument::JobAction::ActionHandlerInput::LoadFromJobDocument(const JsonView &json)
 {
     const char *jsonKey = JSON_KEY_HANDLER;
     if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsString())
@@ -322,7 +339,7 @@ void PlainJobDocument::JobAction::ActionInput::LoadFromJobDocument(const JsonVie
     jsonKey = JSON_KEY_ARGS;
     if (json.ValueExists(jsonKey) && json.GetJsonObject(jsonKey).IsListType())
     {
-        args = ParseToVectorString(json.GetJsonObject(jsonKey));
+        args = Util::ParseToVectorString(json.GetJsonObject(jsonKey));
     }
 
     jsonKey = JSON_KEY_PATH;
@@ -332,7 +349,7 @@ void PlainJobDocument::JobAction::ActionInput::LoadFromJobDocument(const JsonVie
     }
 }
 
-bool PlainJobDocument::JobAction::ActionInput::Validate() const
+bool PlainJobDocument::JobAction::ActionHandlerInput::Validate() const
 {
     if (handler.empty())
     {
@@ -343,3 +360,49 @@ bool PlainJobDocument::JobAction::ActionInput::Validate() const
 
     return true;
 }
+
+constexpr char PlainJobDocument::JobAction::ActionCommandInput::JSON_KEY_COMMAND[];
+
+void PlainJobDocument::JobAction::ActionCommandInput::LoadFromJobDocument(const JsonView &json)
+{
+    const char *jsonKey = JSON_KEY_COMMAND;
+    if (json.ValueExists(jsonKey))
+    {
+        string commandString = json.GetString(jsonKey).c_str();
+
+        if (!commandString.empty())
+        {
+            vector<string> tokens = Util::SplitStringByComma(commandString);
+            for (auto token : tokens)
+            {
+                Util::replace_all(token, R"(\,)", ",");
+                // trim all leading and trailing space characters including tabs, newlines etc.
+                command.emplace_back(Util::TrimCopy(token, " \t\n\v\f\r"));
+            }
+        }
+    }
+}
+
+bool PlainJobDocument::JobAction::ActionCommandInput::Validate() const
+{
+    if (command.empty())
+    {
+        LOGM_ERROR(
+            TAG, "*** %s: Required field ActionInput command is missing ***", DeviceClient::Jobs::DC_INVALID_JOB_DOC);
+        return false;
+    }
+
+    auto isSpace = [](const char &c) { return isspace(static_cast<unsigned char>(c)); };
+    const auto &firstCommand = command.front();
+    if (find_if(firstCommand.cbegin(), firstCommand.cend(), isSpace) != firstCommand.cend())
+    {
+        LOGM_ERROR(
+            TAG,
+            "*** %s: Required field ActionInput command's first word contains space characters: %s ***",
+            DeviceClient::Jobs::DC_INVALID_JOB_DOC,
+            Util::Sanitize(firstCommand).c_str());
+        return false;
+    }
+
+    return true;
+}

source/jobs/JobDocument.h

@@ -35,9 +35,9 @@ namespace Aws
                 {
                     void LoadFromJobDocument(const JsonView &json) override;
                     bool Validate() const override;
-                    static std::vector<std::string> ParseToVectorString(const JsonView &json);
 
                     static constexpr char ACTION_TYPE_RUN_HANDLER[] = "runHandler";
+                    static constexpr char ACTION_TYPE_RUN_COMMAND[] = "runCommand";
 
                     static constexpr char JSON_KEY_VERSION[] = "version";
                     static constexpr char JSON_KEY_INCLUDESTDOUT[] = "includeStdOut";
@@ -87,7 +87,10 @@ namespace Aws
                         std::string name;
                         std::string type;
 
-                        struct ActionInput : public LoadableFromJobDocument
+                        /**
+                         * ActionHandlerInput - Invokes a handler script specified in a job document.
+                         */
+                        struct ActionHandlerInput : public LoadableFromJobDocument
                         {
                             void LoadFromJobDocument(const JsonView &json) override;
                             bool Validate() const override;
@@ -100,7 +103,21 @@ namespace Aws
                             Optional<std::vector<std::string>> args;
                             Optional<std::string> path;
                         };
-                        ActionInput input;
+                        Optional<ActionHandlerInput> handlerInput;
+
+                        /**
+                         * ActionCommandInput - Invokes arbitrary commands specified in a job document.
+                         */
+                        struct ActionCommandInput : public LoadableFromJobDocument
+                        {
+                            void LoadFromJobDocument(const JsonView &json) override;
+                            bool Validate() const override;
+
+                            static constexpr char JSON_KEY_COMMAND[] = "command";
+
+                            std::vector<std::string> command;
+                        };
+                        Optional<ActionCommandInput> commandInput;
                         Optional<std::string> runAsUser{""};
                         Optional<int> allowStdErr;
                         Optional<bool> ignoreStepFailure{false};