Introduce properties for plugins vars

apis/monitoring/v1alpha1/cluster_alert.go

@@ -102,11 +102,11 @@ func (a ClusterAlert) IsValid(kc kubernetes.Interface) error {
 	if !ok {
 		return fmt.Errorf("'%s' is not a valid cluster check command", a.Spec.Check)
 	}
-	for k := range a.Spec.Vars {
-		if _, ok := cmd.Vars[k]; !ok {
-			return fmt.Errorf("var '%s' is unsupported for check command %s", k, a.Spec.Check)
-		}
+
+	if err := validateVariables(cmd.Vars, a.Spec.Vars); err != nil {
+		return err
 	}
+
 	for _, rcv := range a.Spec.Receivers {
 		found := false
 		for _, state := range cmd.States {

apis/monitoring/v1alpha1/crds.yaml

@@ -1782,9 +1782,15 @@ spec:
                 host:
                   type: object
                 vars:
-                  items:
-                    type: string
-                  type: array
+                  properties:
+                    Item:
+                      type: object
+                    required:
+                      items:
+                        type: string
+                      type: array
+                  required:
+                  - Item
             command:
               description: Check Command
               type: string

apis/monitoring/v1alpha1/icinga.go

@@ -5,23 +5,19 @@ import (
 	"sync"
 
 	"github.com/appscode/go-notify/unified"
-	"github.com/appscode/go/log"
-	"github.com/appscode/searchlight/data"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
 )
 
 const (
-	CheckPodInfluxQuery = "influx-query"
-	CheckPodStatus      = "pod-status"
-	CheckPodVolume      = "pod-volume"
-	CheckPodExec        = "pod-exec"
+	CheckPodStatus = "pod-status"
+	CheckPodVolume = "pod-volume"
+	CheckPodExec   = "pod-exec"
 )
 
 const (
-	CheckNodeInfluxQuery = "influx-query"
-	CheckNodeVolume      = "node-volume"
-	CheckNodeStatus      = "node-status"
+	CheckNodeVolume = "node-volume"
+	CheckNodeStatus = "node-status"
 )
 
 const (
@@ -31,12 +27,6 @@ const (
 	CheckPodExists       = "pod-exists"
 	CheckEvent           = "event"
 	CheckCACert          = "ca-cert"
-	CheckHttp            = "any-http"
-	CheckEnv             = "env"
-	CheckDummy           = "dummy"
-	//CheckICMP           = "icmp"
-	//CheckDIG            = "dig"
-	//CheckDNS            = "dns"
 )
 
 // +k8s:deepcopy-gen=false
@@ -67,7 +57,7 @@ func (c *Registry) Delete(cmd string) {
 // +k8s:deepcopy-gen=false
 type IcingaCommand struct {
 	Name   string
-	Vars   map[string]data.CommandVar
+	Vars   *PluginVars
 	States []string
 }
 
@@ -77,56 +67,6 @@ var (
 	ClusterCommands = &Registry{reg: map[string]IcingaCommand{}}
 )
 
-func init() {
-	clusterChecks, err := data.LoadClusterChecks()
-	if err != nil {
-		log.Fatal(err)
-	}
-	for _, cmd := range clusterChecks.Command {
-		vars := make(map[string]data.CommandVar)
-		for _, v := range cmd.Vars {
-			vars[v.Name] = v
-		}
-		ClusterCommands.Insert(cmd.Name, IcingaCommand{
-			Name:   cmd.Name,
-			Vars:   vars,
-			States: cmd.States,
-		})
-	}
-
-	nodeChecks, err := data.LoadNodeChecks()
-	if err != nil {
-		log.Fatal(err)
-	}
-	for _, cmd := range nodeChecks.Command {
-		vars := make(map[string]data.CommandVar)
-		for _, v := range cmd.Vars {
-			vars[v.Name] = v
-		}
-		NodeCommands.Insert(cmd.Name, IcingaCommand{
-			Name:   cmd.Name,
-			Vars:   vars,
-			States: cmd.States,
-		})
-	}
-
-	podChecks, err := data.LoadPodChecks()
-	if err != nil {
-		log.Fatal(err)
-	}
-	for _, cmd := range podChecks.Command {
-		vars := make(map[string]data.CommandVar)
-		for _, v := range cmd.Vars {
-			vars[v.Name] = v
-		}
-		PodCommands.Insert(cmd.Name, IcingaCommand{
-			Name:   cmd.Name,
-			Vars:   vars,
-			States: cmd.States,
-		})
-	}
-}
-
 func checkNotifiers(kc kubernetes.Interface, alert Alert) error {
 	if alert.GetNotifierSecretName() == "" && len(alert.GetReceivers()) == 0 {
 		return nil

apis/monitoring/v1alpha1/node_alert.go

@@ -110,11 +110,11 @@ func (a NodeAlert) IsValid(kc kubernetes.Interface) error {
 	if !ok {
 		return fmt.Errorf("%s is not a valid node check command", a.Spec.Check)
 	}
-	for k := range a.Spec.Vars {
-		if _, ok := cmd.Vars[k]; !ok {
-			return fmt.Errorf("var %s is unsupported for check command %s", k, a.Spec.Check)
-		}
+
+	if err := validateVariables(cmd.Vars, a.Spec.Vars); err != nil {
+		return err
 	}
+
 	for _, rcv := range a.Spec.Receivers {
 		found := false
 		for _, state := range cmd.States {

apis/monitoring/v1alpha1/openapi_generated.go

@@ -193,14 +193,7 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 						},
 						"Vars": {
 							SchemaProps: spec.SchemaProps{
-								Type: []string{"object"},
-								AdditionalProperties: &spec.SchemaOrBool{
-									Schema: &spec.Schema{
-										SchemaProps: spec.SchemaProps{
-											Ref: ref("github.com/appscode/searchlight/data.CommandVar"),
-										},
-									},
-								},
+								Ref: ref("github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVars"),
 							},
 						},
 						"States": {
@@ -221,7 +214,7 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 				},
 			},
 			Dependencies: []string{
-				"github.com/appscode/searchlight/data.CommandVar"},
+				"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVars"},
 		},
 		"github.com/appscode/searchlight/apis/monitoring/v1alpha1.Incident": {
 			Schema: spec.Schema{
@@ -570,8 +563,13 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 					Properties: map[string]spec.Schema{
 						"vars": {
 							SchemaProps: spec.SchemaProps{
-								Type: []string{"array"},
-								Items: &spec.SchemaOrArray{
+								Ref: ref("github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVars"),
+							},
+						},
+						"host": {
+							SchemaProps: spec.SchemaProps{
+								Type: []string{"object"},
+								AdditionalProperties: &spec.SchemaOrBool{
 									Schema: &spec.Schema{
 										SchemaProps: spec.SchemaProps{
 											Type:   []string{"string"},
@@ -581,10 +579,54 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 								},
 							},
 						},
-						"host": {
+					},
+				},
+			},
+			Dependencies: []string{
+				"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVars"},
+		},
+		"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVarItem": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Properties: map[string]spec.Schema{
+						"description": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+						"type": {
+							SchemaProps: spec.SchemaProps{
+								Type:   []string{"string"},
+								Format: "",
+							},
+						},
+					},
+					Required: []string{"type"},
+				},
+			},
+			Dependencies: []string{},
+		},
+		"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVars": {
+			Schema: spec.Schema{
+				SchemaProps: spec.SchemaProps{
+					Properties: map[string]spec.Schema{
+						"Item": {
 							SchemaProps: spec.SchemaProps{
 								Type: []string{"object"},
 								AdditionalProperties: &spec.SchemaOrBool{
+									Schema: &spec.Schema{
+										SchemaProps: spec.SchemaProps{
+											Ref: ref("github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVarItem"),
+										},
+									},
+								},
+							},
+						},
+						"required": {
+							SchemaProps: spec.SchemaProps{
+								Type: []string{"array"},
+								Items: &spec.SchemaOrArray{
 									Schema: &spec.Schema{
 										SchemaProps: spec.SchemaProps{
 											Type:   []string{"string"},
@@ -595,9 +637,11 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
 							},
 						},
 					},
+					Required: []string{"Item"},
 				},
 			},
-			Dependencies: []string{},
+			Dependencies: []string{
+				"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PluginVarItem"},
 		},
 		"github.com/appscode/searchlight/apis/monitoring/v1alpha1.PodAlert": {
 			Schema: spec.Schema{

apis/monitoring/v1alpha1/plugin.go

@@ -1,6 +1,10 @@
 package v1alpha1
 
 import (
+	"fmt"
+
+	"github.com/appscode/kutil/meta"
+	"github.com/pkg/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
@@ -48,8 +52,28 @@ type WebhookServiceSpec struct {
 	Name string `json:"name"`
 }
 
+type VarType string
+
+const (
+	VarTypeInteger  VarType = "integer"
+	VarTypeNumber   VarType = "number"
+	VarTypeBoolean  VarType = "boolean"
+	VarTypeString   VarType = "string"
+	VarTypeDuration VarType = "duration"
+)
+
+type PluginVarItem struct {
+	Description string  `json:"description,omitempty"`
+	Type        VarType `json:"type"`
+}
+
+type PluginVars struct {
+	Items    map[string]PluginVarItem `json:"Item"`
+	Required []string                 `json:"required,omitempty"`
+}
+
 type PluginArguments struct {
-	Vars []string          `json:"vars,omitempty"`
+	Vars *PluginVars       `json:"vars,omitempty"`
 	Host map[string]string `json:"host,omitempty"`
 }
 
@@ -65,3 +89,48 @@ type SearchlightPluginList struct {
 	// Items is the list of SearchlightPlugin.
 	Items []SearchlightPlugin `json:"items"`
 }
+
+var (
+	validateVarValue = map[VarType]meta.ParserFunc{}
+)
+
+func registerVarValueParser(key VarType, fn meta.ParserFunc) {
+	validateVarValue[key] = fn
+}
+
+func init() {
+	registerVarValueParser(VarTypeInteger, meta.GetInt)
+	registerVarValueParser(VarTypeNumber, meta.GetFloat)
+	registerVarValueParser(VarTypeBoolean, meta.GetBool)
+	registerVarValueParser(VarTypeString, meta.GetString)
+	registerVarValueParser(VarTypeDuration, meta.GetDuration)
+}
+
+func validateVariables(pluginVars *PluginVars, vars map[string]string) error {
+	if pluginVars == nil {
+		return nil
+	}
+	// Check if any invalid variable is provided
+	var err error
+	for k := range vars {
+		p, found := pluginVars.Items[k]
+		if !found {
+			return fmt.Errorf("var '%s' is unsupported", k)
+		}
+
+		fn, found := validateVarValue[p.Type]
+		if !found {
+			return errors.Errorf(`type "%v" is not registered`, p.Type)
+		}
+		if _, err = fn(vars, k); err != nil {
+			return errors.Wrapf(err, `validation failure: variable "%s" must be of type %v`, k, p.Type)
+		}
+	}
+	for _, k := range pluginVars.Required {
+		if _, ok := vars[k]; !ok {
+			return fmt.Errorf("plugin variable '%s' is required", k)
+		}
+	}
+
+	return nil
+}

apis/monitoring/v1alpha1/pod_alert.go

@@ -119,11 +119,11 @@ func (a PodAlert) IsValid(kc kubernetes.Interface) error {
 	if !ok {
 		return fmt.Errorf("%s is not a valid pod check command", a.Spec.Check)
 	}
-	for k := range a.Spec.Vars {
-		if _, ok := cmd.Vars[k]; !ok {
-			return fmt.Errorf("var %s is unsupported for check command %s", k, a.Spec.Check)
-		}
+
+	if err := validateVariables(cmd.Vars, a.Spec.Vars); err != nil {
+		return err
 	}
+
 	for _, rcv := range a.Spec.Receivers {
 		found := false
 		for _, state := range cmd.States {