Dumb ping plugin (#34)

Signed-off-by: Valentin Pichard <[email protected]>

Author: w3st3ry

README.md

@@ -428,6 +428,10 @@ Browse [builtin actions](./pkg/plugins/builtin)
 |              || `to`: receiver(s) of your email
 |              || `subject`: subject of your email
 |              || `body`: content of your email
+|**`ping`**    | Send a ping to an hostname *Warn: This plugin will keep running until the count is done*
+|              || `hostname`: ping destination
+|              || `count`: number of ping you want execute
+|              || `interval_second`: interval between two pings
 
 
 #### Loops

go.mod

@@ -48,6 +48,7 @@ require (
 	github.com/satori/go.uuid v1.2.0 // indirect
 	github.com/sirupsen/logrus v1.4.2
 	github.com/smartystreets/goconvey v0.0.0-20190731233626-505e41936337 // indirect
+	github.com/sparrc/go-ping v0.0.0-20190613174326-4e5b6552494c
 	github.com/spf13/afero v1.2.2 // indirect
 	github.com/spf13/cobra v0.0.5
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect

go.sum

@@ -227,6 +227,8 @@ github.com/smartystreets/goconvey v0.0.0-20190731233626-505e41936337 h1:WN9BUFbd
 github.com/smartystreets/goconvey v0.0.0-20190731233626-505e41936337/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
 github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
 github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
+github.com/sparrc/go-ping v0.0.0-20190613174326-4e5b6552494c h1:gqEdF4VwBu3lTKGHS9rXE9x1/pEaSwCXRLOZRF6qtlw=
+github.com/sparrc/go-ping v0.0.0-20190613174326-4e5b6552494c/go.mod h1:eMyUVp6f/5jnzM+3zahzl7q6UXLbgSc3MKg/+ow9QW0=
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
 github.com/spf13/afero v1.2.2 h1:5jhuqJyZCZf2JRofRvN/nIFgIWNzPa3/Vz8mYylgbWc=
 github.com/spf13/afero v1.2.2/go.mod h1:9ZxEEn6pIJ8Rxe320qSDBk6AsU0r9pR7Q4OcevTdifk=

pkg/plugins/builtin/builtin.go

@@ -7,6 +7,7 @@ import (
 	pluginemail "github.com/ovh/utask/pkg/plugins/builtin/email"
 	pluginhttp "github.com/ovh/utask/pkg/plugins/builtin/http"
 	pluginnotify "github.com/ovh/utask/pkg/plugins/builtin/notify"
+	pluginping "github.com/ovh/utask/pkg/plugins/builtin/ping"
 	pluginssh "github.com/ovh/utask/pkg/plugins/builtin/ssh"
 	pluginsubtask "github.com/ovh/utask/pkg/plugins/builtin/subtask"
 	"github.com/ovh/utask/pkg/plugins/taskplugin"
@@ -22,6 +23,7 @@ func Register() error {
 		pluginnotify.Plugin,
 		pluginecho.Plugin,
 		pluginemail.Plugin,
+		pluginping.Plugin,
 	} {
 		if err := step.RegisterRunner(p.PluginName(), p); err != nil {
 			return err

pkg/plugins/builtin/ping/README.md

@@ -0,0 +1,49 @@
+# `ping` plugin
+
+This plugin send a ping.
+
+*Warn: This plugin will keep running until the count is done*
+
+## Configuration
+
+An action of type `ping` requires the following kind of configuration:
+
+```yaml
+action:
+  type: ping
+  configuration:
+    # mandatory, string
+    hostname: example.org
+    # mandatory, string as uint
+    count: "2"
+    # mandatory, string as uint
+    interval_second: "1"
+```
+
+## Note
+
+The plugin returns two objects, the `Output` to fetch statistics about ping(s):
+
+```json
+{
+  "packets_received":1,
+  "packets_sent":1,
+  "packet_loss": 0.00,
+  "ip_addr":"192.168.0.1",
+  "rtts":"1s",
+  "min_rtt":"1se",
+  "max_rtt":"1s",
+  "avg_rtt":"1s",
+  "std_dev_rtt":"1s"
+}
+```
+
+The `Metadata` to reuse the parameters in a future component:
+
+```json
+{
+  "hostname":"example.org",
+  "count":"2",
+  "interval_second": "1"
+}
+```

pkg/plugins/builtin/ping/ping.go

@@ -0,0 +1,102 @@
+package ping
+
+import (
+	"errors"
+	"fmt"
+	"strconv"
+	"time"
+
+	ping "github.com/sparrc/go-ping"
+
+	"github.com/ovh/utask/pkg/plugins/taskplugin"
+)
+
+// the ping plugin send ping
+var (
+	Plugin = taskplugin.New("ping", "0.1", exec,
+		taskplugin.WithConfig(validConfig, Config{}),
+	)
+)
+
+// based on Statistics struct from github.com/sparrc/go-ping /w json tags
+type pingStats struct {
+	PacketsRecv int             `json:"packets_received"`
+	PacketsSent int             `json:"packets_sent"`
+	PacketLoss  float64         `json:"packet_loss"`
+	IPAddr      string          `json:"ip_addr"`
+	Rtts        []time.Duration `json:"rtts"`
+	MinRtt      time.Duration   `json:"min_rtt"`
+	MaxRtt      time.Duration   `json:"max_rtt"`
+	AvgRtt      time.Duration   `json:"avg_rtt"`
+	StdDevRtt   time.Duration   `json:"std_dev_rtt"`
+}
+
+// Config is the configuration needed to send a ping
+type Config struct {
+	Hostname string `json:"hostname"`
+	Count    string `json:"count,omitempty"`
+	Interval string `json:"interval_second,omitempty"`
+}
+
+func validConfig(config interface{}) error {
+	cfg := config.(*Config)
+
+	if cfg.Hostname == "" {
+		return errors.New("hostname is missing")
+	}
+
+	if cfg.Count != "" {
+		if _, err := strconv.ParseUint(cfg.Count, 10, 64); err != nil {
+			return fmt.Errorf("count is wrong %s", err.Error())
+		}
+	}
+
+	if cfg.Interval != "" {
+		if _, err := strconv.ParseUint(cfg.Interval, 10, 64); err != nil {
+			return fmt.Errorf("interval_second is wrong %s", err.Error())
+		}
+	}
+
+	return nil
+}
+
+func exec(stepName string, config interface{}, ctx interface{}) (interface{}, interface{}, error) {
+	cfg := config.(*Config)
+
+	pinger, err := ping.NewPinger(cfg.Hostname)
+	if err != nil {
+		return nil, nil, fmt.Errorf("Initiate ping failed: %s", err.Error())
+	}
+
+	pinger.Count = pingDefault(cfg.Count)
+	pinger.Interval = time.Duration(pingDefault(cfg.Interval)) * time.Second
+
+	// Run() is blocking until count is done
+	pinger.Run()
+
+	so := pinger.Statistics()
+
+	return &pingStats{
+		PacketsRecv: so.PacketsRecv,
+		PacketsSent: so.PacketsSent,
+		PacketLoss:  so.PacketLoss,
+		IPAddr:      so.IPAddr.String(),
+		Rtts:        so.Rtts,
+		MinRtt:      so.MinRtt,
+		MaxRtt:      so.MaxRtt,
+		AvgRtt:      so.AvgRtt,
+		StdDevRtt:   so.StdDevRtt,
+	}, cfg, nil
+}
+
+func pingDefault(c string) int {
+	if c == "" || c == "0" {
+		return 1
+	}
+
+	// count or interval is already checked, at validConfig() lvl
+	// values must be correct so errors are not evaluated
+	count, _ := strconv.Atoi(c)
+
+	return count
+}