runshellscript

README

Execute a shell script

This activity provides your Flogo application with the ability to execute shell or bash scripts.

Installation

flogo install github.com/iainharfield/flogo/activity/runshellscript

Schema

Inputs and Outputs:

{
  "inputs":[
    {
      "name": "cmd",
      "type": "string",
      "required": true
    }
  ],
  "outputs": [
    {
      "name": "result",
      "type": "string"
    }
  ]
}

Inputs: Schema of cmd parameter:

The activity expects the name of the script to execute and the script parameters be put into a JSON schema. The schema contains the fully qualifies path and script name to execute, which is a mandatory field, and the parameters to be passed in in a single string. The activity is limited to 20 parameters.

JSON schma example, execute test01.sh in local directory and passes in 3 parameters. See simple example script below.

{
  "cmd":"./test01.sh",
  "params":"aaa bbb ccc"
}

Note that the params field is a single string of space separated values and not an array or params.

{"cmd":"./test01.sh","params":"aaa bbb ccc"}

Output from the Activity:

The output is the text string returned from the launched script. See very simple example below.

Configuration Example

{
    "id": "runScript_1",
    "name": "Execute a shell script",
    "description": "Run a script",
    "activity": {
    "ref": "github.com/iainharfield/flogo/activity/runshellscript",
    "mappings": {
    "input": [
        {
            "type": "assign",
            "value": "$flow.command",
            "mapTo": "cmd"
        }
     ]
}

Example bash script (test01.sh)

#!/bin/bash
printf "test01 output: $1 $2 $3"

Notes

This activity has only been tested on Linux/MacOS only. No testing on Windows.

If you are using the example flow, it is triggered from an http event. To generate the trigger I am using chrome/safari browser with the following syntax:

From MacBook:

http://localhost:9121/qos/speed?cmd=/Users/iain/Downloads/test01.sh&params=xxx yyy

or, from linux (ubuntu) server using Chrome:

http://localhost:9121/qos/speed?cmd=/home/iain/Downloads/test01.sh&params=xxx yyy

Note also the path to the script as $PATH was not set up. Relative paths like ./test01.sh can be used.

Documentation

Index

• func NewActivity(metadata *activity.Metadata) activity.Activity
• func WordCount(s string) map[string]int
• type MyActivity
  • func (a *MyActivity) Eval(context activity.Context) (done bool, err error)
  • func (a *MyActivity) Metadata() *activity.Metadata

Functions

func NewActivity

func NewActivity(metadata *activity.Metadata) activity.Activity

NewActivity creates a new activity

func WordCount

func WordCount(s string) map[string]int

Types

type MyActivity

type MyActivity struct {
	// contains filtered or unexported fields
}

MyActivity is a stub for your Activity implementation

func (*MyActivity) Eval

func (a *MyActivity) Eval(context activity.Context) (done bool, err error)

Eval implements activity.Activity.Eval

func (*MyActivity) Metadata

func (a *MyActivity) Metadata() *activity.Metadata

Metadata implements activity.Activity.Metadata