README.md

Script Executor

An executor that runs custom shell scripts on a Unix-like system.

How It Works

To be correctly processed by this executor, an Action should provide two entries in its payload: the path to a script on the local filesystem of the executor process, and all the arguments to be passed to the script itself.

The script path is identified by the payload key script. It is important to verify that the executor has both read and execute rights at that path.

The script arguments are identified by the payload key args; if present, they are passed as command line arguments when the script is executed.

An example of a valid Action is:

{
    "id": "script",
    "payload" : {
        "script": "./usr/script/my_script.sh",
        "args": [
            "tornado",
            "rust"
        ] 
    }
}

In this case the executor will launch the script my_script.sh with the arguments "tornado" and "rust". Consequently, the resulting command will be:

./usr/script/my_script.sh tornado rust

Other Ways of Passing Arguments

There are different ways to pass the arguments for a script:

• Passing arguments as a String:

  {
    "id": "script",
    "payload" : {
        "script": "./usr/script/my_script.sh",
        "args": "arg_one arg_two -a --something else"
    }
  }

  If args is a String, the entire String is appended as a single argument to the script. In this case the resulting command will be:

  ./usr/script/my_script.sh "arg_one arg_two -a --something else" 

• Passing arguments in an array:

  {
    "id": "script",
    "payload" : {
        "script": "./usr/script/my_script.sh",
        "args": [
            "--arg_one tornado",
            "arg_two",
            true,
            100
        ] 
    }
  }

  Here the argument's array elements are passed as four arguments to the script in the exact order they are declared. In this case the resulting command will be:

  ./usr/script/my_script.sh "--arg_one tornado" arg_two true 100 

• Passing arguments in a map:

  {
    "id": "script",
    "payload" : {
        "script": "./usr/script/my_script.sh",
        "args": {
          "arg_one": "tornado",
          "arg_two": "rust"
      }
    }
  }

  When arguments are passed in a map, each entry in the map is considered to be a (option key, option value) pair. Each pair is passed to the script using the default style to pass options to a Unix executable which is --key followed by the value. Consequently, the resulting command will be:

  ./usr/script/my_script.sh --arg_one tornado --arg_two rust

  Please note that ordering is not guaranteed to be preserved in this case, so the resulting command line could also be:

  ./usr/script/my_script.sh --arg_two rust --arg_one tornado

  Thus if the order of the arguments matters, you should pass them using either the string- or the array-based approach.

• Passing no arguments:

  {
    "id": "script",
    "payload" : {
        "script": "./usr/script/my_script.sh"
    }
  }

  Since arguments are not mandatory, they can be omitted. In this case the resulting command will simply be:

  ./usr/script/my_script.sh