Merge pull request #160 from kmala/health

feat(healthcheck): Add support for healthcheck per proctype

Author: kmala

cmd/healthchecks.go

@@ -1,14 +1,33 @@
 package cmd
 
 import (
+	"errors"
 	"fmt"
+	"io"
+	"os"
 
 	"github.com/deis/controller-sdk-go/api"
 	"github.com/deis/controller-sdk-go/config"
 )
 
+func printHealthCheck(out io.Writer, healthcheck api.Healthchecks) {
+	fmt.Fprintln(out, "--- Liveness")
+	if livenessProbe, found := healthcheck["livenessProbe"]; found {
+		fmt.Fprintln(out, livenessProbe)
+	} else {
+		fmt.Fprintln(out, "No liveness probe configured.")
+	}
+
+	fmt.Fprintln(out, "\n--- Readiness")
+	if readinessProbe, found := healthcheck["readinessProbe"]; found {
+		fmt.Fprintln(out, readinessProbe)
+	} else {
+		fmt.Fprintln(out, "No readiness probe configured.")
+	}
+}
+
 // HealthchecksList lists an app's healthchecks.
-func HealthchecksList(appID string) error {
+func HealthchecksList(appID, procType string) error {
 	s, appID, err := load(appID)
 
 	if err != nil {
@@ -22,25 +41,25 @@ func HealthchecksList(appID string) error {
 	}
 
 	fmt.Printf("=== %s Healthchecks\n\n", appID)
-
-	fmt.Println("--- Liveness")
-	if livenessProbe, found := config.Healthcheck["livenessProbe"]; found {
-		fmt.Println(livenessProbe)
+	if procType == "" {
+		for proc, healthcheck := range config.Healthcheck {
+			fmt.Println(proc + ":")
+			printHealthCheck(os.Stdout, *healthcheck)
+		}
 	} else {
-		fmt.Println("No liveness probe configured.")
+		fmt.Println(procType + ":")
+		if healthcheck, found := config.Healthcheck[procType]; found {
+			printHealthCheck(os.Stdout, *healthcheck)
+		} else {
+			return errors.New(appID + " doesn't have proctype" + procType)
+		}
 	}
 
-	fmt.Println("\n--- Readiness")
-	if readinessProbe, found := config.Healthcheck["readinessProbe"]; found {
-		fmt.Println(readinessProbe)
-	} else {
-		fmt.Println("No readiness probe configured.")
-	}
 	return nil
 }
 
 // HealthchecksSet sets an app's healthchecks.
-func HealthchecksSet(appID, healthcheckType string, probe *api.Healthcheck) error {
+func HealthchecksSet(appID, healthcheckType, procType string, probe *api.Healthcheck) error {
 	s, appID, err := load(appID)
 
 	if err != nil {
@@ -50,10 +69,11 @@ func HealthchecksSet(appID, healthcheckType string, probe *api.Healthcheck) erro
 	fmt.Printf("Applying %s healthcheck... ", healthcheckType)
 
 	quit := progress()
-	configObj := api.Config{}
-	configObj.Healthcheck = make(map[string]*api.Healthcheck)
 
-	configObj.Healthcheck[healthcheckType] = probe
+	healthcheckMap := make(api.Healthchecks)
+	healthcheckMap[healthcheckType] = probe
+	configObj := api.Config{Healthcheck: make(map[string]*api.Healthchecks)}
+	configObj.Healthcheck[procType] = &healthcheckMap
 
 	_, err = config.Set(s.Client, appID, configObj)
 
@@ -66,11 +86,11 @@ func HealthchecksSet(appID, healthcheckType string, probe *api.Healthcheck) erro
 
 	fmt.Print("done\n\n")
 
-	return HealthchecksList(appID)
+	return HealthchecksList(appID, procType)
 }
 
 // HealthchecksUnset removes an app's healthchecks.
-func HealthchecksUnset(appID string, healthchecks []string) error {
+func HealthchecksUnset(appID, procType string, healthchecks []string) error {
 	s, appID, err := load(appID)
 
 	if err != nil {
@@ -83,13 +103,15 @@ func HealthchecksUnset(appID string, healthchecks []string) error {
 
 	configObj := api.Config{}
 
-	healthcheckMap := make(map[string]*api.Healthcheck)
+	healthchecksMap := make(map[string]*api.Healthchecks)
+	healthcheckMap := make(api.Healthchecks)
 
 	for _, healthcheck := range healthchecks {
 		healthcheckMap[healthcheck] = nil
 	}
+	healthchecksMap[procType] = &healthcheckMap
 
-	configObj.Healthcheck = healthcheckMap
+	configObj.Healthcheck = healthchecksMap
 
 	_, err = config.Set(s.Client, appID, configObj)
 
@@ -102,5 +124,5 @@ func HealthchecksUnset(appID string, healthchecks []string) error {
 
 	fmt.Print("done\n\n")
 
-	return HealthchecksList(appID)
+	return HealthchecksList(appID, procType)
 }

cmd/healthchecks_test.go

@@ -0,0 +1,21 @@
+package cmd
+
+import (
+	"bytes"
+	"testing"
+
+	"github.com/arschles/assert"
+	"github.com/deis/controller-sdk-go/api"
+)
+
+func TestPrintHealthCheck(t *testing.T) {
+	var b bytes.Buffer
+	testHealthCheck := api.Healthchecks{}
+	printHealthCheck(&b, testHealthCheck)
+	assert.Equal(t, b.String(), "--- Liveness\nNo liveness probe configured.\n\n--- Readiness\nNo readiness probe configured.\n", "healthcheck")
+	b.Reset()
+	testHealthCheck["livenessProbe"] = &api.Healthcheck{}
+	testHealthCheck["readinessProbe"] = &api.Healthcheck{}
+	printHealthCheck(&b, testHealthCheck)
+	assert.Equal(t, b.String(), "--- Liveness\nInitial Delay (seconds): 0\nTimeout (seconds): 0\nPeriod (seconds): 0\nSuccess Threshold: 0\nFailure Threshold: 0\nExec Probe: N/A\nHTTP GET Probe: N/A\nTCP Socket Probe: N/A\n\n--- Readiness\nInitial Delay (seconds): 0\nTimeout (seconds): 0\nPeriod (seconds): 0\nSuccess Threshold: 0\nFailure Threshold: 0\nExec Probe: N/A\nHTTP GET Probe: N/A\nTCP Socket Probe: N/A\n", "healthcheck")
+}

glide.lock

@@ -16,4 +16,4 @@ import:
 - package: github.com/olekukonko/tablewriter
 - package: github.com/arschles/assert
 - package: github.com/deis/controller-sdk-go
-  version: cd0f563b127736127e0e9debeddcbcb014621b04
+  version: b5c341604961fcf0ec326ca403b720e1aa6ff527

glide.yaml

@@ -11,6 +11,12 @@ import (
 	docopt "github.com/docopt/docopt-go"
 )
 
+// TODO: This is for supporting backward compatibility and should be removed
+// in future when next major version will be released.
+const (
+	defaultProcType string = "web/cmd"
+)
+
 // Healthchecks routes ealthcheck commands to their specific function
 func Healthchecks(argv []string) error {
 	usage := `
@@ -54,6 +60,8 @@ Usage: deis healthchecks:list [options]
 Options:
   -a --app=<app>
     the uniquely identifiable name of the application.
+  --type=<type>
+    the procType for which the health check needs to be listed.
 `
 
 	args, err := docopt.Parse(usage, argv, true, "", false, true)
@@ -62,7 +70,13 @@ Options:
 		return err
 	}
 
-	return cmd.HealthchecksList(safeGetValue(args, "--app"))
+	app := safeGetValue(args, "--app")
+	procType := safeGetValue(args, "--type")
+	if procType == "" {
+		procType = defaultProcType
+	}
+
+	return cmd.HealthchecksList(app, procType)
 }
 
 func healthchecksSet(argv []string) error {
@@ -111,6 +125,8 @@ Options:
     the uniquely identifiable name for the application.
   -p --path=<path>
     the relative URL path for 'httpGet' probes. [default: /]
+  --type=<type>
+    the procType for which the health check needs to be applied.
   --header=<header>...
     the HTTP headers to send for 'httpGet' probes, separated by commas.
   --initial-delay-timeout=<initial-delay-timeout>
@@ -133,6 +149,7 @@ Options:
 
 	app := safeGetValue(args, "--app")
 	path := safeGetValue(args, "--path")
+	procType := safeGetValue(args, "--type")
 	initialDelayTimeout := safeGetInt(args, "--initial-delay-timeout")
 	timeoutSeconds := safeGetInt(args, "--timeout-seconds")
 	periodSeconds := safeGetInt(args, "--period-seconds")
@@ -142,6 +159,9 @@ Options:
 	if args["--headers"] != nil {
 		headers = args["--headers"].([]string)
 	}
+	if procType == "" {
+		procType = defaultProcType
+	}
 
 	healthcheckType := args["<health-type>"].(string)
 	probeType := args["<probe-type>"].(string)
@@ -193,22 +213,24 @@ Options:
 	default:
 		return fmt.Errorf("Invalid probe type. Must be one of: \"httpGet\", \"exec\"")
 	}
-	return cmd.HealthchecksSet(app, healthcheckType, probe)
+	return cmd.HealthchecksSet(app, healthcheckType, procType, probe)
 }
 
 func healthchecksUnset(argv []string) error {
 	usage := `
 Unsets healthchecks for an application.
 
-Usage: deis healthchecks:unset [options] <type>...
+Usage: deis healthchecks:unset [options] <health-type>...
 
 Arguments:
-  <type>
+  <health-type>
     the healthcheck type, such as 'liveness' or 'readiness'.
 
 Options:
   -a --app=<app>
     the uniquely identifiable name for the application.
+  --type=<type>
+    the procType for which the health check needs to be removed.
 `
 
 	args, err := docopt.Parse(usage, argv, true, "", false, true)
@@ -218,15 +240,19 @@ Options:
 	}
 
 	app := safeGetValue(args, "--app")
-	healthchecks := args["<type>"].([]string)
+	healthchecks := args["<health-type>"].([]string)
+	procType := safeGetValue(args, "--type")
+	if procType == "" {
+		procType = defaultProcType
+	}
 
 	// NOTE(bacongobbler): k8s healthchecks use the term "livenessProbe" and "readinessProbe", so let's
 	// add that to the end of the healthcheck type so the controller sees the right probe type
 	for healthcheck := range healthchecks {
 		healthchecks[healthcheck] += "Probe"
 	}
 
-	return cmd.HealthchecksUnset(app, healthchecks)
+	return cmd.HealthchecksUnset(app, procType, healthchecks)
 }
 
 func parseHeaders(headers []string) ([]*api.KVPair, error) {