Merge pull request #291 from cloudability/filter-cluster-name-again

 Fix Cluster Name Parameter (yet again)

Author: alexsouthard

README.md

@@ -39,7 +39,7 @@ Cloudability Metrics Agent currently does not support Rancher or On Prem cluster
 | Environment Variable                           |                                                                                             Description                                                                                              |
 |------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
 | CLOUDABILITY_API_KEY                           |                                                                                    Required: Cloudability api key                                                                                    |
-| CLOUDABILITY_CLUSTER_NAME                      |                                                            Required: The cluster name to be used for the cluster the agent is running in.                                                            |
+| CLOUDABILITY_CLUSTER_NAME                      |                                                            Required: The cluster name to be used for the cluster the agent is running in. Cannot be exclusively whitespace.                            |
 | CLOUDABILITY_POLL_INTERVAL                     |                                                                    Optional: The interval (Seconds) to poll metrics. Default: 180                                                                    |
 | CLOUDABILITY_OUTBOUND_PROXY                    |                    Optional: The URL of an outbound HTTP/HTTPS proxy for the agent to use (eg: http://x.x.x.x:8080). The URL must contain the scheme prefix (http:// or https://)                    |
 | CLOUDABILITY_OUTBOUND_PROXY_AUTH               | Optional: Basic Authentication credentials to be used with the defined outbound proxy. If your outbound proxy requires basic authentication credentials can be defined in the form username:password |

charts/metrics-agent/Chart.yaml

@@ -14,8 +14,8 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.11.38
+version: 2.11.39
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.
-appVersion: 2.11.38
+appVersion: 2.11.39

charts/metrics-agent/values.yaml

@@ -26,7 +26,7 @@ uploadRegion: "us-west-2"
 
 image:
   name: cloudability/metrics-agent
-  tag: 2.11.38
+  tag: 2.11.39
   pullPolicy: Always
 
 imagePullSecrets: []

util/util.go

@@ -80,6 +80,10 @@ func CheckRequiredSettings(requiredArgs []string) error {
 
 	}
 
+	if strings.TrimSpace(viper.GetString("cluster_name")) == "" {
+		return fmt.Errorf("Cluster name cannot only contain whitespace")
+	}
+
 	if viper.IsSet("poll_interval") && viper.GetInt("poll_interval") < 5 {
 		return fmt.Errorf(
 			"Polling interval must be 5 seconds or greater")

util/util_test.go

@@ -22,6 +22,7 @@ type testConfig struct {
 	KubeStateMetricsURL string
 	PollInterval        int
 	UseInClusterConfig  bool
+	ClusterName         string
 }
 
 func TestIsValidURL(t *testing.T) {
@@ -112,14 +113,21 @@ func TestCheckRequiredSettings(t *testing.T) {
 		600,
 		"Time, in seconds to poll the services infrastructure. Default: 600",
 	)
+	kubernetesCmd.PersistentFlags().StringVar(
+		&config.ClusterName,
+		"cluster_name",
+		"default-test",
+		"Kubernetes Cluster Name - required this must be unique to every cluster.",
+	)
 
 	_ = viper.BindPFlag("api_key", kubernetesCmd.PersistentFlags().Lookup("api_key"))
 	_ = viper.BindPFlag("poll_interval", kubernetesCmd.PersistentFlags().Lookup("poll_interval"))
+	_ = viper.BindPFlag("cluster_name", kubernetesCmd.PersistentFlags().Lookup("cluster_name"))
 
 	// nolint dupl
 	t.Run("ensure that required settings are set as cmd flags", func(t *testing.T) {
 
-		args := []string{"kubernetes", "--poll_interval", "5", "--api_key", "8675309-9035768"}
+		args := []string{"kubernetes", "--poll_interval", "5", "--api_key", "8675309-9035768", "--cluster_name", "specificTest"}
 		kubernetesCmd.SetArgs(args)
 
 		if err := kubernetesCmd.Execute(); err != nil {
@@ -130,7 +138,7 @@ func TestCheckRequiredSettings(t *testing.T) {
 	// nolint dupl
 	t.Run("ensure that missing required cmd flags is detected", func(t *testing.T) {
 
-		args := []string{"kubernetes", "--poll_interval", "5", "--api_key", "8675309-9035768"}
+		args := []string{"kubernetes", "--poll_interval", "5", "--api_key", "8675309-9035768", "--cluster_name", "specificTest"}
 		kubernetesCmd.SetArgs(args)
 
 		if err := kubernetesCmd.Execute(); err != nil {
@@ -145,6 +153,7 @@ func TestCheckRequiredSettings(t *testing.T) {
 
 		_ = os.Setenv("CLOUDABILITY_API_KEY", "8675309-9035768")
 		_ = os.Setenv("CLOUDABILITY_POLL_INTERVAL", "5")
+		_ = os.Setenv("CLOUDABILITY_CLUSTER_NAME", "test")
 
 		if err := kubernetesCmd.Execute(); err != nil {
 			t.Errorf("required settings set via environment variables but not detected: %v", err)
@@ -162,6 +171,7 @@ func TestCheckRequiredSettings(t *testing.T) {
 
 		_ = os.Setenv("CLOUDABILITY_API_KEY", "8675309-9035768")
 		_ = os.Setenv("CLOUDABILITY_POLL_INTERVAL", "5")
+		_ = os.Setenv("CLOUDABILITY_CLUSTER_NAME", "test")
 
 		if err := kubernetesCmd.Execute(); err != nil {
 			t.Errorf("incorrect settings via environment variables but condition not detected: %v", err)
@@ -178,11 +188,28 @@ func TestCheckRequiredSettings(t *testing.T) {
 		kubernetesCmd.SetArgs(envArgs)
 		_ = os.Setenv("CLOUDABILITY_API_KEY", "8675309-9035768")
 		_ = os.Setenv("CLOUDABILITY_POLL_INTERVAL", "4")
+		_ = os.Setenv("CLOUDABILITY_CLUSTER_NAME", "test")
 
 		if err := kubernetesCmd.Execute(); err != nil {
 			t.Errorf("incorrect poll interval set via environment variables but not detected: %v", err)
 		}
 	})
+
+	t.Run("ensure that invalid string value is detected", func(t *testing.T) {
+
+		viper.SetEnvPrefix("cloudability")
+		viper.AutomaticEnv()
+
+		envArgs := []string{"kubernetes"}
+		kubernetesCmd.SetArgs(envArgs)
+		_ = os.Setenv("CLOUDABILITY_API_KEY", "8675309-9035768")
+		_ = os.Setenv("CLOUDABILITY_POLL_INTERVAL", "5")
+		_ = os.Setenv("CLOUDABILITY_CLUSTER_NAME", " ")
+
+		if err := kubernetesCmd.Execute(); err != nil {
+			t.Errorf("incorrect cluster name set via environment variables but condition not detected: %v", err)
+		}
+	})
 }
 
 func TestCreateMetricSample(t *testing.T) {

version/version.go

@@ -1,4 +1,4 @@
 package version
 
 // VERSION is the current version of the agent
-var VERSION = "2.11.38"
+var VERSION = "2.11.39"