fix(484): add a validation on taint nested object of the nodepool template

fix(review): add title to link un MD

Author: matprig

ovh/resource_cloud_project_kube_nodepool.go

@@ -1,6 +1,7 @@
 package ovh
 
 import (
+	"errors"
 	"fmt"
 	"log"
 	"strings"
@@ -203,6 +204,25 @@ func resourceCloudProjectKubeNodePool() *schema.Resource {
 										Elem: &schema.Schema{
 											Type: schema.TypeMap,
 											Set:  schema.HashString,
+											ValidateFunc: func(taintInterface interface{}, path string) (warning []string, errorList []error) {
+												taint := taintInterface.(map[string]interface{})
+
+												if taint["key"] == nil {
+													return nil, []error{errors.New(fmt.Sprintf("key attribute is mandatory for taint: %s", path))}
+												}
+
+												if taint["effect"] == nil {
+													return nil, []error{errors.New(fmt.Sprintf("effect attribute is mandatory for taint: %s", path))}
+												}
+
+												effectString := taint["effect"].(string)
+												effect := TaintEffecTypeToID[effectString]
+												if effect == NotATaint {
+													return nil, []error{fmt.Errorf("effect: %s is not a allowable taint %#v", effectString, TaintEffecTypeToID)}
+												}
+
+												return nil, nil
+											},
 										},
 									},
 								},

ovh/resource_cloud_project_kube_nodepool_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"regexp"
 	"strings"
 	"testing"
 	"time"
@@ -13,6 +14,12 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
 )
 
+var (
+	effectTaintsErrorRegex       = regexp.MustCompile("(.)*effect attribute is mandatory for taint(.)*")
+	keyTaintsErrorRegex          = regexp.MustCompile("(.)*key attribute is mandatory for taint(.)*")
+	valueNoCrashTaintsErrorRegex = regexp.MustCompile("(.)*This service does not exist(.)*")
+)
+
 func init() {
 	resource.AddTestSweepers("ovh_cloud_project_kube_nodepool", &resource.Sweeper{
 		Name: "ovh_cloud_project_kube_nodepool",
@@ -73,6 +80,105 @@ func testSweepCloudProjectKubeNodePool(region string) error {
 	return nil
 }
 
+var testAccCloudProjectKubeNodePoolConfigEffectMissingInTaint = `
+resource "ovh_cloud_project_kube_nodepool" "pool" {
+  service_name  = "xxx"
+  kube_id       = "xxx"
+  name          = "xxx"
+  flavor_name   = "b2-7"
+  desired_nodes = 1
+  min_nodes     = 0
+  max_nodes     = 1
+  template {
+    metadata {
+      annotations = {
+        a1 = "av1"
+      }
+      finalizers = ["finalizer.extensions/v1beta1"]
+      labels = {
+        l1 = "lv1"
+      }
+    }
+    spec {
+      unschedulable = false
+      taints = [
+        {
+          #effect = "PreferNoSchedule"
+          key    = "t1"
+          value  = "tv1"
+        }
+      ]
+    }
+  }
+}
+`
+
+var testAccCloudProjectKubeNodePoolConfigKeyMissingInTaint = `
+resource "ovh_cloud_project_kube_nodepool" "pool" {
+  service_name  = "xxx"
+  kube_id       = "xxx"
+  name          = "xxx"
+  flavor_name   = "b2-7"
+  desired_nodes = 1
+  min_nodes     = 0
+  max_nodes     = 1
+  template {
+    metadata {
+      annotations = {
+        a1 = "av1"
+      }
+      finalizers = ["finalizer.extensions/v1beta1"]
+      labels = {
+        l1 = "lv1"
+      }
+    }
+    spec {
+      unschedulable = false
+      taints = [
+        {
+          effect = "PreferNoSchedule"
+          #key    = "t1"
+          value  = "tv1"
+        }
+      ]
+    }
+  }
+}
+`
+
+var testAccCloudProjectKubeNodePoolConfigValueMissingInTaint = `
+resource "ovh_cloud_project_kube_nodepool" "pool" {
+  service_name  = "xxx"
+  kube_id       = "xxx"
+  name          = "xxx"
+  flavor_name   = "b2-7"
+  desired_nodes = 1
+  min_nodes     = 0
+  max_nodes     = 1
+  template {
+    metadata {
+      annotations = {
+        a1 = "av1"
+      }
+      finalizers = ["finalizer.extensions/v1beta1"]
+      labels = {
+        l1 = "lv1"
+      }
+    }
+    spec {
+      unschedulable = false
+      taints = [
+        {
+          effect = "PreferNoSchedule"
+          key    = "t1"
+          #value  = "tv1"
+        }
+      ]
+    }
+  }
+}
+`
+
 var testAccCloudProjectKubeNodePoolConfig = `
 resource "ovh_cloud_project_kube" "cluster" {
   service_name = "%s"
@@ -297,3 +403,50 @@ func TestAccCloudProjectKubeNodePool(t *testing.T) {
 		},
 	})
 }
+
+func TestAccCloudProjectKubeNodePoolTaints(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheckCloud(t)
+			testAccCheckCloudProjectExists(t)
+			testAccPreCheckKubernetes(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config:      testAccCloudProjectKubeNodePoolConfigEffectMissingInTaint,
+				ExpectError: effectTaintsErrorRegex,
+			},
+		},
+	})
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheckCloud(t)
+			testAccCheckCloudProjectExists(t)
+			testAccPreCheckKubernetes(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config:      testAccCloudProjectKubeNodePoolConfigKeyMissingInTaint,
+				ExpectError: keyTaintsErrorRegex,
+			},
+		},
+	})
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			testAccPreCheckCloud(t)
+			testAccCheckCloudProjectExists(t)
+			testAccPreCheckKubernetes(t)
+		},
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config:      testAccCloudProjectKubeNodePoolConfigValueMissingInTaint,
+				ExpectError: valueNoCrashTaintsErrorRegex,
+			},
+		},
+	})
+}

ovh/types_cloud_project_kube_nodepool.go

@@ -196,11 +196,15 @@ func loadNodelPoolTemplateFromResource(i interface{}) (*CloudProjectKubeNodePool
 					return nil, fmt.Errorf("effect: %s is not a allowable taint %#v", effectString, TaintEffecTypeToID)
 				}
 
-				template.Spec.Taints = append(template.Spec.Taints, Taint{
+				taintObject := Taint{
 					Effect: effect,
 					Key:    taint.(map[string]interface{})["key"].(string),
-					Value:  taint.(map[string]interface{})["value"].(string),
-				})
+				}
+				if taint.(map[string]interface{})["value"] != nil {
+					taintObject.Value = taint.(map[string]interface{})["value"].(string)
+				}
+
+				template.Spec.Taints = append(template.Spec.Taints, taintObject)
 			}
 
 			// spec.unschedulable

website/docs/r/cloud_project_kube_nodepool.html.markdown

@@ -80,7 +80,10 @@ The following arguments are supported:
         * `finalizers` - Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
         * `labels` - Labels to apply to each node
     * `spec` - Spec of each node in the pool
-        * `taints` - Taints to apply to each node
+        * `taints` - Taints to apply to each node [NodeSpec kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/node-v1/#NodeSpec)
+          * `effect` - mandatory possible values: NoExecute, NoSchedule, PreferNoSchedule
+          * `key` - mandatory
+          * `value` - (Optional)
         * `unschedulable` - If true, set nodes as un-schedulable
 
 ## Attributes Reference