integrate health checks for a lb service

Author: sgsullivan

cmd/networkLoadBalancerCreate.go

@@ -22,7 +22,9 @@ import (
 
 	"github.com/spf13/cast"
 	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v2"
 
+	"github.com/liquidweb/liquidweb-cli/instance"
 	"github.com/liquidweb/liquidweb-cli/types/api"
 	"github.com/liquidweb/liquidweb-cli/types/cmd"
 	"github.com/liquidweb/liquidweb-cli/validate"
@@ -40,7 +42,9 @@ var networkLoadBalancerCreateCmd = &cobra.Command{
 A Load Balancer allows you to distribute traffic to multiple endpoints.
 
 %s
-`, networkLoadBalancerServicesHealthChecksHelp),
+
+%s
+`, networkLoadBalancerServicesHealthChecksHelp, networkLoadBalancerServicesHealthCheckFileHelp),
 	Run: func(cmd *cobra.Command, args []string) {
 		nameFlag, _ := cmd.Flags().GetString("name")
 		strategyFlag, _ := cmd.Flags().GetString("strategy")
@@ -52,6 +56,7 @@ A Load Balancer allows you to distribute traffic to multiple endpoints.
 		enableSslIncludesFlag, _ := cmd.Flags().GetBool("enable-ssl-includes")
 		disableSslIncludesFlag, _ := cmd.Flags().GetBool("disable-ssl-includes")
 		regionFlag, _ := cmd.Flags().GetInt("region")
+		healthCheckFileFlag, _ := cmd.Flags().GetString("health-check-file")
 
 		if enableSslTerminationFlag && disableSslTerminationFlag {
 			lwCliInst.Die(fmt.Errorf("can't both enable and disable ssl termination"))
@@ -69,6 +74,9 @@ A Load Balancer allows you to distribute traffic to multiple endpoints.
 				lwCliInst.Die(fmt.Errorf("when using --ssl-certificate or --ssl-private-key --enable-ssl-termination must be passed"))
 			}
 		}
+		if len(healthChecksMapCreate) > 0 && healthCheckFileFlag != "" {
+			lwCliInst.Die(fmt.Errorf("cannot pass conflicting flags --health-check and --health-check-file"))
+		}
 
 		validateFields := map[interface{}]interface{}{
 			strategyFlag: "LoadBalancerStrategy",
@@ -150,9 +158,39 @@ A Load Balancer allows you to distribute traffic to multiple endpoints.
 		// slice of maps with keys src_port, dest_port, with a value of its network port number.
 		var servicesToBalance []map[string]interface{}
 		// a service is permitted to have one health check
-		healthChecks, err := cmdTypes.LoadBalancerHealthCheck{HealthCheck: healthChecksMapCreate}.Transform()
-		if err != nil {
-			lwCliInst.Die(err)
+
+		var healthChecks map[string]map[string]interface{}
+
+		// health check, command line flags.
+		if len(healthChecksMapCreate) > 0 {
+			healthChecksFromCmdLine, err := cmdTypes.LoadBalancerHealthCheckCmdLine{HealthCheck: healthChecksMapCreate}.Transform()
+			if err != nil {
+				lwCliInst.Die(err)
+			}
+			healthChecks = healthChecksFromCmdLine
+		} else if healthCheckFileFlag != "" {
+			// health check, yaml file
+			contents, err := ioutil.ReadFile(healthCheckFileFlag)
+			if err != nil {
+				lwCliInst.Die(fmt.Errorf("error reading given --health-check-file [%s]: %s", healthCheckFileFlag, err))
+			}
+			if err = yaml.Unmarshal(contents, &healthChecks); err != nil {
+				lwCliInst.Die(fmt.Errorf("error yaml decoding [%s] (see help for an example of the file); %s", healthCheckFileFlag, err))
+			}
+		}
+
+		// validate
+		for _, healthCheck := range healthChecks {
+			var obj apiTypes.NetworkLoadBalancerDetailsServiceHealthCheck
+
+			if err := instance.CastFieldTypes(healthCheck, &obj); err != nil {
+				lwCliInst.Die(fmt.Errorf(
+					"failed casting --health-check-file [%s] to expected structure (see help for an example of the file): %s",
+					healthCheckFileFlag, err))
+			}
+			if err := obj.Validate(); err != nil {
+				lwCliInst.Die(err)
+			}
 		}
 
 		for _, pair := range networkLoadBalancerCreateServicesCmd {
@@ -216,7 +254,9 @@ func init() {
 		[]string{}, "source/destination port pairs (such as 80:80) separated by ',' to balance via the Load Balancer")
 
 	networkLoadBalancerCreateCmd.Flags().StringToStringVar(&healthChecksMapCreate, "health-check", nil,
-		"Health check defintions for the service matching src_port")
+		"Health check defintions for the service matching src_port. Should not be combined with --health-check.")
+	networkLoadBalancerCreateCmd.Flags().String("health-check-file", "",
+		"A file containing valid yaml describing the LoadBalancer health checks to add for the service(s). Should not be combined with --health-check.")
 
 	networkLoadBalancerCreateCmd.MarkFlagRequired("name")
 	networkLoadBalancerCreateCmd.MarkFlagRequired("services")

cmd/networkLoadBalancerUpdate.go

@@ -22,7 +22,9 @@ import (
 
 	"github.com/spf13/cast"
 	"github.com/spf13/cobra"
+	"gopkg.in/yaml.v2"
 
+	"github.com/liquidweb/liquidweb-cli/instance"
 	"github.com/liquidweb/liquidweb-cli/types/api"
 	"github.com/liquidweb/liquidweb-cli/types/cmd"
 	"github.com/liquidweb/liquidweb-cli/validate"
@@ -50,10 +52,33 @@ such as '80:80,443:443'.
 
 For example, to set these values for the service with source port 443, the flag could look like this:
 
-  --health-check 443_failure_threshold=12,443_http_body_match=hello,443_http_path=/status,443_http_response_codes=200:201:202,443_http_use_tls=true,443_interval=10,443_protocol=tcp,443_timeout=99
+  --health-check 443_failure_threshold=12,443_http_body_match=hello,443_http_path=/status,443_http_response_codes=200:201:202,443_http_use_tls=true,443_interval=10,443_protocol=http,443_timeout=99
 
 Notice the leading '443_' before the parameter name. To create a health check for service 80 as well, follow the same pattern, but
 replacing '443_' with '80_'.`
+var networkLoadBalancerServicesHealthCheckFileHelp = `--health-check-file value should be the path to a yaml file containing the health check(s) to apply for each service(s). Here is
+an example of how that file should look:
+
+443:
+  protocol: http
+  timeout: 5
+  interval: 10
+  http_use_tls: true
+  http_response_codes: 200-202,404
+  http_path: /status-443
+  http_body_match:
+  failure_threshold: 3
+80:
+  protocol: http
+  timeout: 10
+  interval: 20
+  http_use_tls: false
+  http_response_codes: 200-202,404
+  http_path: /status-80
+  http_body_match:
+  failure_threshold: 3
+
+It is an error to provide both --health-check and --health-check-file flags.`
 
 var networkLoadBalancerUpdateCmd = &cobra.Command{
 	Use:   "update",
@@ -64,11 +89,15 @@ A Load Balancer allows you to distribute traffic to multiple endpoints.
 
 %s
 
+%s
+
 To remove a health check from a service, simply call update for the service(s) omitting their --health-check entries. For example,
 this would remove any set health checks for services 443:443,80:80 (as well as remove any other services entirely):
 
 network load-balancer update --uniq_id ABC123 --services 443:443,80:80
-`, networkLoadBalancerServicesHealthChecksHelp),
+
+Similarly to remove a health check when using --health-check-file, simply remove the health check from the file.
+`, networkLoadBalancerServicesHealthChecksHelp, networkLoadBalancerServicesHealthCheckFileHelp),
 	Run: func(cmd *cobra.Command, args []string) {
 		uniqIdFlag, _ := cmd.Flags().GetString("uniq_id")
 		nameFlag, _ := cmd.Flags().GetString("name")
@@ -80,6 +109,7 @@ network load-balancer update --uniq_id ABC123 --services 443:443,80:80
 		sslIntermediateCertFlag, _ := cmd.Flags().GetString("ssl-intermediate-certificate")
 		enableSslIncludesFlag, _ := cmd.Flags().GetBool("enable-ssl-includes")
 		disableSslIncludesFlag, _ := cmd.Flags().GetBool("disable-ssl-includes")
+		healthCheckFileFlag, _ := cmd.Flags().GetString("health-check-file")
 
 		if enableSslTerminationFlag && disableSslTerminationFlag {
 			lwCliInst.Die(fmt.Errorf("can't both enable and disable ssl termination"))
@@ -97,6 +127,9 @@ network load-balancer update --uniq_id ABC123 --services 443:443,80:80
 				lwCliInst.Die(fmt.Errorf("when using --ssl-certificate or --ssl-private-key --enable-ssl-termination must be passed"))
 			}
 		}
+		if len(healthChecksMapUpdate) > 0 && healthCheckFileFlag != "" {
+			lwCliInst.Die(fmt.Errorf("cannot pass conflicting flags --health-check and --health-check-file"))
+		}
 
 		validateFields := map[interface{}]interface{}{
 			uniqIdFlag: "UniqId",
@@ -178,12 +211,42 @@ network load-balancer update --uniq_id ABC123 --services 443:443,80:80
 		// services
 		if len(networkLoadBalancerUpdateServicesCmd) > 0 {
 			var servicesToBalance []map[string]interface{}
-			// a service is permitted to have one health check
-			healthChecks, err := cmdTypes.LoadBalancerHealthCheck{HealthCheck: healthChecksMapUpdate}.Transform()
-			if err != nil {
-				lwCliInst.Die(err)
+			// a service is permitted to have one health check.
+
+			var healthChecks map[string]map[string]interface{}
+
+			// health check, command line flags.
+			if len(healthChecksMapUpdate) > 0 {
+				healthChecksFromCmdLine, err := cmdTypes.LoadBalancerHealthCheckCmdLine{HealthCheck: healthChecksMapUpdate}.Transform()
+				if err != nil {
+					lwCliInst.Die(err)
+				}
+				healthChecks = healthChecksFromCmdLine
+			} else if healthCheckFileFlag != "" {
+				// health check, yaml file
+				contents, err := ioutil.ReadFile(healthCheckFileFlag)
+				if err != nil {
+					lwCliInst.Die(fmt.Errorf("error reading given --health-check-file [%s]: %s", healthCheckFileFlag, err))
+				}
+				if err = yaml.Unmarshal(contents, &healthChecks); err != nil {
+					lwCliInst.Die(fmt.Errorf("error yaml decoding [%s] (see help for an example of the file); %s", healthCheckFileFlag, err))
+				}
+			}
+
+			// validate
+			for _, healthCheck := range healthChecks {
+				var obj apiTypes.NetworkLoadBalancerDetailsServiceHealthCheck
+				if err := instance.CastFieldTypes(healthCheck, &obj); err != nil {
+					lwCliInst.Die(fmt.Errorf(
+						"failed casting --health-check-file [%s] to expected structure (see help for an example of the file): %s",
+						healthCheckFileFlag, err))
+				}
+				if err := obj.Validate(); err != nil {
+					lwCliInst.Die(err)
+				}
 			}
 
+			// build services api argument
 			for _, pair := range networkLoadBalancerUpdateServicesCmd {
 				err := validate.Validate(map[interface{}]interface{}{pair: "NetworkPortPair"})
 				if err != nil {
@@ -206,7 +269,6 @@ network load-balancer update --uniq_id ABC123 --services 443:443,80:80
 
 				servicesToBalance = append(servicesToBalance, serviceToBalance)
 			}
-
 			apiArgs["services"] = servicesToBalance
 		}
 
@@ -250,7 +312,10 @@ func init() {
 		[]string{}, "source/destination port pairs (such as 80:80) separated by ',' to balance via the Load Balancer")
 
 	networkLoadBalancerUpdateCmd.Flags().StringToStringVar(&healthChecksMapUpdate, "health-check", nil,
-		"Health check defintions for the service matching source port")
+		"Health check defintions for the service matching source port. Should not be combined with --health-check.")
+
+	networkLoadBalancerUpdateCmd.Flags().String("health-check-file", "",
+		"A file containing valid yaml describing the LoadBalancer health checks to add for the service(s). Should not be combined with --health-check.")
 
 	networkLoadBalancerUpdateCmd.MarkFlagRequired("uniq_id")
 }

go.mod

@@ -17,5 +17,5 @@ require (
 	golang.org/x/sys v0.0.0-20200124204421-9fbb57f87de9 // indirect
 	golang.org/x/text v0.3.2 // indirect
 	gopkg.in/ini.v1 v1.51.1 // indirect
-	gopkg.in/yaml.v2 v2.2.8 // indirect
+	gopkg.in/yaml.v2 v2.2.8
 )

types/api/network.go

@@ -16,8 +16,11 @@ limitations under the License.
 package apiTypes
 
 import (
+	"errors"
 	"fmt"
 	"strings"
+
+	"github.com/liquidweb/liquidweb-cli/validate"
 )
 
 type NetworkIpPoolListEntry struct {
@@ -129,14 +132,61 @@ type NetworkLoadBalancerDetailsService struct {
 }
 
 type NetworkLoadBalancerDetailsServiceHealthCheck struct {
-	FailureThreshold  int64  `json:"failure_threshold" mapstructure:"failure_threshold"`
-	HttpBodyMatch     string `json:"http_body_match" mapstructure:"http_body_match"`
-	HttpPath          string `json:"http_path" mapstructure:"http_path"`
-	HttpResponseCodes string `json:"http_response_codes" mapstructure:"http_response_codes"`
-	HttpUseTls        bool   `json:"http_use_tls" mapstructure:"http_use_tls"`
-	Interval          int64  `json:"interval" mapstructure:"interval"`
-	Protocol          string `json:"protocol" mapstructure:"protocol"`
-	Timeout           int64  `json:"timeout" mapstructure:"timeout"`
+	FailureThreshold  int64  `json:"failure_threshold" mapstructure:"failure_threshold" yaml:"failure_threshold"`
+	HttpBodyMatch     string `json:"http_body_match" mapstructure:"http_body_match" yaml:"http_body_match"`
+	HttpPath          string `json:"http_path" mapstructure:"http_path" yaml:"http_path"`
+	HttpResponseCodes string `json:"http_response_codes" mapstructure:"http_response_codes" yaml:"http_response_codes"`
+	HttpUseTls        bool   `json:"http_use_tls" mapstructure:"http_use_tls" yaml:"http_use_tls"`
+	Interval          int64  `json:"interval" mapstructure:"interval" yaml:"interval"`
+	Protocol          string `json:"protocol" mapstructure:"protocol" yaml:"protocol"`
+	Timeout           int64  `json:"timeout" mapstructure:"timeout" yaml:"timeout"`
+}
+
+func (x NetworkLoadBalancerDetailsServiceHealthCheck) Validate() error {
+	// protocol is required
+	if x.Protocol == "" {
+		return errors.New("protocol is required and was not given")
+	}
+
+	// place defaults for http_path, http_use_tls, http_response_codes if protocol == "http" if unset.
+	if x.Protocol != "http" {
+		// when protocol isn't http, these shouldn't be set.
+		if x.HttpPath != "" {
+			return errors.New("http_path cannot be set when protocol isn't http")
+		}
+		if x.HttpResponseCodes != "" {
+			return errors.New("http_response_codes cannot be set when protocol isn't http")
+		}
+		if x.HttpUseTls {
+			return errors.New("http_use_tls cannot be set when protocol isn't http")
+		}
+		if x.HttpBodyMatch != "" {
+			return errors.New("http_body_match cannot be set when protocol isn't http")
+		}
+	}
+
+	validateFields := map[interface{}]interface{}{
+		x.Protocol: "LoadBalancerHealthCheckProtocol",
+	}
+
+	if x.HttpResponseCodes != "" {
+		validateFields[x.HttpResponseCodes] = "LoadBalancerHttpCodeRange"
+	}
+	if x.Timeout != 0 {
+		validateFields[x.Timeout] = "PositiveInt64"
+	}
+	if x.Interval != 0 {
+		validateFields[x.Interval] = "PositiveInt64"
+	}
+	if x.FailureThreshold != 0 {
+		validateFields[x.FailureThreshold] = "PositiveInt64"
+	}
+
+	if validateErr := validate.Validate(validateFields); validateErr != nil {
+		return fmt.Errorf("healthCheck validation failed: %s", validateErr)
+	}
+
+	return nil
 }
 
 func (x NetworkLoadBalancerDetails) String() string {

types/cmd/cmdTypes.go

@@ -18,12 +18,9 @@ package cmdTypes
 import (
 	"fmt"
 	"regexp"
-	"strconv"
 	"strings"
 
 	"github.com/spf13/cast"
-
-	"github.com/liquidweb/liquidweb-cli/validate"
 )
 
 type AuthContext struct {
@@ -36,11 +33,11 @@ type AuthContext struct {
 	Timeout        int    `json:"timeout" mapstructure:"timeout"`
 }
 
-type LoadBalancerHealthCheck struct {
+type LoadBalancerHealthCheckCmdLine struct {
 	HealthCheck map[string]string `json:"health_check" mapstructure:"health_check"`
 }
 
-func (x LoadBalancerHealthCheck) Transform() (bySrcPort map[string]map[string]interface{}, err error) {
+func (x LoadBalancerHealthCheckCmdLine) Transform() (bySrcPort map[string]map[string]interface{}, err error) {
 	// this is a bit of a hack. I couldn't find any supported way in cobra/viper/pflag to
 	// get flags to go into a slice of maps. So its reading from flags into a single map,
 	// and then doing this logic here to transform that into one suitable to aid later
@@ -154,40 +151,6 @@ func (x LoadBalancerHealthCheck) Transform() (bySrcPort map[string]map[string]in
 				return
 			}
 		}
-
-		validateFields := map[interface{}]interface{}{
-			healthCheck["protocol"]: "LoadBalancerHealthCheckProtocol",
-		}
-
-		if val, exists := healthCheck["http_response_codes"]; exists {
-			validateFields[val] = "LoadBalancerHttpCodeRange"
-		}
-		if val, exists := healthCheck["timeout"]; exists {
-			if _, convErr := strconv.Atoi(cast.ToString(val)); convErr != nil {
-				err = fmt.Errorf("timeout value [%+v] doesn't look numeric", val)
-				return
-			}
-			validateFields[cast.ToInt(val)] = "PositiveInt"
-		}
-		if val, exists := healthCheck["interval"]; exists {
-			if _, convErr := strconv.Atoi(cast.ToString(val)); convErr != nil {
-				err = fmt.Errorf("interval value [%+v] doesn't look numeric", val)
-				return
-			}
-			validateFields[cast.ToInt(val)] = "PositiveInt"
-		}
-		if val, exists := healthCheck["failure_threshold"]; exists {
-			if _, convErr := strconv.Atoi(cast.ToString(val)); convErr != nil {
-				err = fmt.Errorf("failure_threshold value [%+v] doesn't look numeric", val)
-				return
-			}
-			validateFields[cast.ToInt(val)] = "PositiveInt"
-		}
-
-		if validateErr := validate.Validate(validateFields); validateErr != nil {
-			err = fmt.Errorf("healthCheck validation failed for service with source port [%+v]: %s", sourcePort, validateErr)
-			return
-		}
 	}
 
 	return