feat: add action for plugin (#28)

cmd/vela-kubernetes/apply.go

@@ -11,6 +11,8 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+const applyAction = "apply"
+
 // Apply represents the plugin configuration for Apply config information.
 type Apply struct {
 	// enables pretending to apply the files

cmd/vela-kubernetes/apply_test.go

@@ -14,6 +14,7 @@ import (
 func TestKubernetes_Apply_Command(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "apply",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",
@@ -49,6 +50,7 @@ func TestKubernetes_Apply_Command(t *testing.T) {
 func TestKubernetes_Apply_Exec_Error(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "apply",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",

cmd/vela-kubernetes/config.go

@@ -18,20 +18,27 @@ var appFS = afero.NewOsFs()
 
 // Config represents the plugin configuration for Kubernetes information.
 type Config struct {
-	// cluster configuration file to interact with Kubernetes
+	// action to perform against Kubernetes
+	Action string
+	// configuration file for communication with Kubernetes
 	File string
-	// name of the configuration cluster to use for interactions with Kubernetes
+	// name of the configuration cluster from file
 	Cluster string
-	// name of the configuration context to use for interactions with Kubernetes
+	// name of the configuration context from file
 	Context string
-	// name of the configuration namespace to use for interactions with Kubernetes
+	// name of the configuration namespace from file
 	Namespace string
 }
 
 // Validate verifies the Config is properly configured.
 func (c *Config) Validate() error {
 	logrus.Trace("validating config configuration")
 
+	// verify action is provided
+	if len(c.Action) == 0 {
+		return fmt.Errorf("no config action provided")
+	}
+
 	// verify file is provided
 	if len(c.File) == 0 {
 		return fmt.Errorf("no config file provided")

cmd/vela-kubernetes/config_test.go

@@ -13,6 +13,23 @@ import (
 func TestKubernetes_Config_Validate(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "apply",
+		File:      "file",
+		Cluster:   "cluster",
+		Context:   "context",
+		Namespace: "namespace",
+	}
+
+	err := c.Validate()
+	if err != nil {
+		t.Errorf("Validate returned err: %v", err)
+	}
+}
+
+func TestKubernetes_Config_Validate_NoAction(t *testing.T) {
+	// setup types
+	c := &Config{
+		Action:    "apply",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",
@@ -28,6 +45,7 @@ func TestKubernetes_Config_Validate(t *testing.T) {
 func TestKubernetes_Config_Validate_NoFile(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "apply",
 		Cluster:   "cluster",
 		Context:   "context",
 		Namespace: "namespace",
@@ -45,6 +63,7 @@ func TestKubernetes_Config_Write(t *testing.T) {
 
 	// setup types
 	c := &Config{
+		Action:    "apply",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",
@@ -63,6 +82,7 @@ func TestKubernetes_Config_Write_NoFile(t *testing.T) {
 
 	// setup types
 	c := &Config{
+		Action:    "apply",
 		Cluster:   "cluster",
 		Context:   "context",
 		Namespace: "namespace",

cmd/vela-kubernetes/main.go

@@ -67,6 +67,11 @@ func main() {
 
 		// Config Flags
 
+		cli.StringFlag{
+			EnvVar: "PARAMETER_ACTION,CONFIG_ACTION,KUBE_ACTION",
+			Name:   "config.action",
+			Usage:  "action to perform against Kubernetes",
+		},
 		cli.StringFlag{
 			EnvVar: "PARAMETER_CONFIG,CONFIG_FILE,KUBE_CONFIG",
 			Name:   "config.file",
@@ -176,6 +181,7 @@ func run(c *cli.Context) error {
 		},
 		// config configuration
 		Config: &Config{
+			Action:    c.String("config.action"),
 			File:      c.String("config.file"),
 			Cluster:   c.String("config.cluster"),
 			Context:   c.String("config.context"),

cmd/vela-kubernetes/patch.go

@@ -12,6 +12,8 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+const patchAction = "patch"
+
 // cronPatch represents the pattern needed to
 // patch a Kubernetes CronJob with a new image.
 //

cmd/vela-kubernetes/patch_test.go

@@ -14,6 +14,7 @@ import (
 func TestKubernetes_Patch_Command(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "patch",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",
@@ -61,6 +62,7 @@ func TestKubernetes_Patch_Command(t *testing.T) {
 func TestKubernetes_Patch_Exec_Error(t *testing.T) {
 	// setup types
 	c := &Config{
+		Action:    "patch",
 		File:      "file",
 		Cluster:   "cluster",
 		Context:   "context",

cmd/vela-kubernetes/plugin.go

@@ -5,9 +5,18 @@
 package main
 
 import (
+	"errors"
+	"fmt"
+
 	"github.com/sirupsen/logrus"
 )
 
+var (
+	// ErrInvalidAction defines the error type when the
+	// Action provided to the Plugin is unsupported.
+	ErrInvalidAction = errors.New("invalid action provided")
+)
+
 // Plugin represents the configuration loaded for the plugin.
 type Plugin struct {
 	// apply arguments loaded for the plugin
@@ -36,28 +45,27 @@ func (p *Plugin) Exec() error {
 		return err
 	}
 
-	// check if containers were provided to patch
-	if len(p.Patch.Containers) > 0 {
-		// patch the Kubernetes resource files
-		err = p.Patch.Exec(p.Config)
-		if err != nil {
-			return err
-		}
-	} else { // default back to apply if no containers to patch
-		// apply the Kubernetes resource files
-		err = p.Apply.Exec(p.Config)
-		if err != nil {
-			return err
-		}
-	}
-
-	// watch the status for the specified resources
-	err = p.Status.Exec(p.Config)
-	if err != nil {
-		return err
+	// execute action specific configuration
+	switch p.Config.Action {
+	case applyAction:
+		// execute apply action
+		return p.Apply.Exec(p.Config)
+	case patchAction:
+		// execute patch action
+		return p.Patch.Exec(p.Config)
+	case statusAction:
+		// execute status action
+		return p.Status.Exec(p.Config)
+	default:
+		return fmt.Errorf(
+			"%s: %s (Valid actions: %s, %s, %s)",
+			ErrInvalidAction,
+			p.Config.Action,
+			applyAction,
+			patchAction,
+			statusAction,
+		)
 	}
-
-	return nil
 }
 
 // Validate verifies the plugin is properly configured.
@@ -70,26 +78,25 @@ func (p *Plugin) Validate() error {
 		return err
 	}
 
-	// check if containers were provided to patch
-	if len(p.Patch.RawContainers) > 0 {
-		// validate patch configuration
-		err = p.Patch.Validate()
-		if err != nil {
-			return err
-		}
-	} else { // default back to apply if no containers to patch
+	// validate action specific configuration
+	switch p.Config.Action {
+	case applyAction:
 		// validate apply configuration
-		err = p.Apply.Validate()
-		if err != nil {
-			return err
-		}
-	}
-
-	// validate status configuration
-	err = p.Status.Validate()
-	if err != nil {
-		return err
+		return p.Apply.Validate()
+	case patchAction:
+		// validate patch configuration
+		return p.Patch.Validate()
+	case statusAction:
+		// validate status configuration
+		return p.Status.Validate()
+	default:
+		return fmt.Errorf(
+			"%s: %s (Valid actions: %s, %s, %s)",
+			ErrInvalidAction,
+			p.Config.Action,
+			applyAction,
+			patchAction,
+			statusAction,
+		)
 	}
-
-	return nil
 }