feat(k8s): add warning if cluster type is not prefixed by kapsule or multicloud (#2309)

pablo-ruth · Pablo RUTH · web-flow · commit 8a2118e540c0 · 2023-12-18T12:28:38.000Z
* feat(k8s): add warning if cluster type is not prefixed by kapsule or multicloud

* add attributepath to diag

* remove usage of slices package

---------

Co-authored-by: Pablo RUTH &lt;pruth@scaleway.com&gt;
diff --git a/scaleway/resource_k8s_cluster.go b/scaleway/resource_k8s_cluster.go
@@ -276,9 +276,6 @@ func resourceScalewayK8SCluster() *schema.Resource {
 						if err != nil {
 							return err
 						}
-
-					default:
-						return fmt.Errorf("unknown cluster type %q", clusterType)
 					}
 				}
 				return nil
@@ -325,6 +322,8 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 	// Create cluster
 	////
 
+	var diags diag.Diagnostics
+
 	description, ok := d.GetOk("description")
 	if !ok {
 		description = ""
@@ -335,6 +334,15 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 		clusterType = ""
 	}
 
+	if !strings.HasPrefix(d.Get("type").(string), "kapsule") && !strings.HasPrefix(d.Get("type").(string), "multicloud") {
+		diags = append(diags, diag.Diagnostic{
+			Severity:      diag.Warning,
+			Summary:       "Unexpected cluster type",
+			Detail:        fmt.Sprintf("The expected cluster type is one of %v, but got %s", []string{"kapsule", "multicloud", "kapsule-dedicated-*", "multicloud-dedicated-*"}, clusterType.(string)),
+			AttributePath: cty.GetAttrPath("type"),
+		})
+	}
+
 	req := &k8s.CreateClusterRequest{
 		Region:            region,
 		ProjectID:         expandStringPtr(d.Get("project_id")),
@@ -441,7 +449,7 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 		// if one auto upgrade attribute is set, they all must be set.
 		// if none is set, auto upgrade attributes will be computed.
 		if !(okAutoUpgradeDay && okAutoUpgradeStartHour) {
-			return diag.FromErr(fmt.Errorf("all field or zero field of auto_upgrade must be set"))
+			return append(diag.FromErr(fmt.Errorf("all field or zero field of auto_upgrade must be set")), diags...)
 		}
 	}
 
@@ -464,13 +472,13 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 	versionIsOnlyMinor := len(strings.Split(version, ".")) == 2
 
 	if versionIsOnlyMinor != clusterAutoUpgradeEnabled {
-		return diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrade enabled"))
+		return append(diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrade enabled")), diags...)
 	}
 
 	if versionIsOnlyMinor {
 		version, err = k8sGetLatestVersionFromMinor(ctx, k8sAPI, region, version)
 		if err != nil {
-			return diag.FromErr(err)
+			return append(diag.FromErr(err), diags...)
 		}
 	}
 
@@ -486,7 +494,7 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 
 	res, err := k8sAPI.CreateCluster(req, scw.WithContext(ctx))
 	if err != nil {
-		return diag.FromErr(err)
+		return append(diag.FromErr(err), diags...)
 	}
 
 	d.SetId(newRegionalIDString(region, res.ID))
@@ -498,10 +506,10 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat
 		_, err = waitK8SClusterPool(ctx, k8sAPI, region, res.ID, d.Timeout(schema.TimeoutCreate))
 	}
 	if err != nil {
-		return diag.FromErr(err)
+		return append(diag.FromErr(err), diags...)
 	}
 
-	return resourceScalewayK8SClusterRead(ctx, d, meta)
+	return append(resourceScalewayK8SClusterRead(ctx, d, meta), diags...)
 }
 
 func resourceScalewayK8SClusterRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
@@ -617,6 +625,17 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 		}
 	}
 
+	var diags diag.Diagnostics
+
+	if !strings.HasPrefix(d.Get("type").(string), "kapsule") && !strings.HasPrefix(d.Get("type").(string), "multicloud") {
+		diags = append(diags, diag.Diagnostic{
+			Severity:      diag.Warning,
+			Summary:       "Unexpected cluster type",
+			Detail:        fmt.Sprintf("The expected cluster type is one of %v, but got %s", []string{"kapsule", "multicloud", "kapsule-dedicated-*", "multicloud-dedicated-*"}, d.Get("type").(string)),
+			AttributePath: cty.GetAttrPath("type"),
+		})
+	}
+
 	canUpgrade := false
 
 	////
@@ -674,13 +693,13 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 	versionIsOnlyMinor := len(strings.Split(version, ".")) == 2
 
 	if versionIsOnlyMinor != autoupgradeEnabled {
-		return diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrades enabled"))
+		return append(diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrades enabled")), diags...)
 	}
 
 	if versionIsOnlyMinor {
 		version, err = k8sGetLatestVersionFromMinor(ctx, k8sAPI, region, version)
 		if err != nil {
-			return diag.FromErr(err)
+			return append(diag.FromErr(err), diags...)
 		}
 	}
 
@@ -693,7 +712,7 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 			Region:    region,
 		}, scw.WithContext(ctx))
 		if err != nil {
-			return diag.FromErr(err)
+			return append(diag.FromErr(err), diags...)
 		}
 
 		if clusterResp.Version == version {
@@ -794,12 +813,12 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 		actual, planned := d.GetChange("private_network_id")
 		if planned == "" && actual != "" {
 			// It's not possible to remove the private network anymore
-			return diag.FromErr(fmt.Errorf("it is only possible to change the private network attached to the cluster, but not to remove it"))
+			return append(diag.FromErr(fmt.Errorf("it is only possible to change the private network attached to the cluster, but not to remove it")), diags...)
 		}
 		if actual == "" {
 			err = migrateToPrivateNetworkCluster(ctx, d, meta)
 			if err != nil {
-				return diag.FromErr(err)
+				return append(diag.FromErr(err), diags...)
 			}
 		}
 	}
@@ -809,12 +828,12 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 	////
 	_, err = k8sAPI.UpdateCluster(updateRequest, scw.WithContext(ctx))
 	if err != nil {
-		return diag.FromErr(err)
+		return append(diag.FromErr(err), diags...)
 	}
 
 	_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, d.Timeout(schema.TimeoutUpdate))
 	if err != nil {
-		return diag.FromErr(err)
+		return append(diag.FromErr(err), diags...)
 	}
 
 	////
@@ -829,16 +848,16 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat
 		}
 		_, err = k8sAPI.UpgradeCluster(upgradeRequest)
 		if err != nil {
-			return diag.FromErr(err)
+			return append(diag.FromErr(err), diags...)
 		}
 
 		_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, d.Timeout(schema.TimeoutUpdate))
 		if err != nil {
-			return diag.FromErr(err)
+			return append(diag.FromErr(err), diags...)
 		}
 	}
 
-	return resourceScalewayK8SClusterRead(ctx, d, meta)
+	return append(resourceScalewayK8SClusterRead(ctx, d, meta), diags...)
 }
 
 func resourceScalewayK8SClusterDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {

Original file line number	Diff line number	Diff line change
`@@ -276,9 +276,6 @@ func resourceScalewayK8SCluster() *schema.Resource {`
`276`	`276`	`if err != nil {`
`277`	`277`	`return err`
`278`	`278`	`}`
`279`		`-`
`280`		`- default:`
`281`		`- return fmt.Errorf("unknown cluster type %q", clusterType)`
`282`	`279`	`}`
`283`	`280`	`}`
`284`	`281`	`return nil`
`@@ -325,6 +322,8 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`325`	`322`	`// Create cluster`
`326`	`323`	`////`
`327`	`324`
	`325`	`+ var diags diag.Diagnostics`
	`326`	`+`
`328`	`327`	`description, ok := d.GetOk("description")`
`329`	`328`	`if !ok {`
`330`	`329`	`description = ""`
`@@ -335,6 +334,15 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`335`	`334`	`clusterType = ""`
`336`	`335`	`}`
`337`	`336`
	`337`	`+ if !strings.HasPrefix(d.Get("type").(string), "kapsule") && !strings.HasPrefix(d.Get("type").(string), "multicloud") {`
	`338`	`+ diags = append(diags, diag.Diagnostic{`
	`339`	`+ Severity: diag.Warning,`
	`340`	`+ Summary: "Unexpected cluster type",`
	`341`	`+ Detail: fmt.Sprintf("The expected cluster type is one of %v, but got %s", []string{"kapsule", "multicloud", "kapsule-dedicated-", "multicloud-dedicated-"}, clusterType.(string)),`
	`342`	`+ AttributePath: cty.GetAttrPath("type"),`
	`343`	`+ })`
	`344`	`+ }`
	`345`	`+`
`338`	`346`	`req := &k8s.CreateClusterRequest{`
`339`	`347`	`Region: region,`
`340`	`348`	`ProjectID: expandStringPtr(d.Get("project_id")),`
`@@ -441,7 +449,7 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`441`	`449`	`// if one auto upgrade attribute is set, they all must be set.`
`442`	`450`	`// if none is set, auto upgrade attributes will be computed.`
`443`	`451`	`if !(okAutoUpgradeDay && okAutoUpgradeStartHour) {`
`444`		`- return diag.FromErr(fmt.Errorf("all field or zero field of auto_upgrade must be set"))`
	`452`	`+ return append(diag.FromErr(fmt.Errorf("all field or zero field of auto_upgrade must be set")), diags...)`
`445`	`453`	`}`
`446`	`454`	`}`
`447`	`455`
`@@ -464,13 +472,13 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`464`	`472`	`versionIsOnlyMinor := len(strings.Split(version, ".")) == 2`
`465`	`473`
`466`	`474`	`if versionIsOnlyMinor != clusterAutoUpgradeEnabled {`
`467`		`- return diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrade enabled"))`
	`475`	`+ return append(diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrade enabled")), diags...)`
`468`	`476`	`}`
`469`	`477`
`470`	`478`	`if versionIsOnlyMinor {`
`471`	`479`	`version, err = k8sGetLatestVersionFromMinor(ctx, k8sAPI, region, version)`
`472`	`480`	`if err != nil {`
`473`		`- return diag.FromErr(err)`
	`481`	`+ return append(diag.FromErr(err), diags...)`
`474`	`482`	`}`
`475`	`483`	`}`
`476`	`484`
`@@ -486,7 +494,7 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`486`	`494`
`487`	`495`	`res, err := k8sAPI.CreateCluster(req, scw.WithContext(ctx))`
`488`	`496`	`if err != nil {`
`489`		`- return diag.FromErr(err)`
	`497`	`+ return append(diag.FromErr(err), diags...)`
`490`	`498`	`}`
`491`	`499`
`492`	`500`	`d.SetId(newRegionalIDString(region, res.ID))`
`@@ -498,10 +506,10 @@ func resourceScalewayK8SClusterCreate(ctx context.Context, d *schema.ResourceDat`
`498`	`506`	`_, err = waitK8SClusterPool(ctx, k8sAPI, region, res.ID, d.Timeout(schema.TimeoutCreate))`
`499`	`507`	`}`
`500`	`508`	`if err != nil {`
`501`		`- return diag.FromErr(err)`
	`509`	`+ return append(diag.FromErr(err), diags...)`
`502`	`510`	`}`
`503`	`511`
`504`		`- return resourceScalewayK8SClusterRead(ctx, d, meta)`
	`512`	`+ return append(resourceScalewayK8SClusterRead(ctx, d, meta), diags...)`
`505`	`513`	`}`
`506`	`514`
`507`	`515`	`func resourceScalewayK8SClusterRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {`
`@@ -617,6 +625,17 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`617`	`625`	`}`
`618`	`626`	`}`
`619`	`627`
	`628`	`+ var diags diag.Diagnostics`
	`629`	`+`
	`630`	`+ if !strings.HasPrefix(d.Get("type").(string), "kapsule") && !strings.HasPrefix(d.Get("type").(string), "multicloud") {`
	`631`	`+ diags = append(diags, diag.Diagnostic{`
	`632`	`+ Severity: diag.Warning,`
	`633`	`+ Summary: "Unexpected cluster type",`
	`634`	`+ Detail: fmt.Sprintf("The expected cluster type is one of %v, but got %s", []string{"kapsule", "multicloud", "kapsule-dedicated-", "multicloud-dedicated-"}, d.Get("type").(string)),`
	`635`	`+ AttributePath: cty.GetAttrPath("type"),`
	`636`	`+ })`
	`637`	`+ }`
	`638`	`+`
`620`	`639`	`canUpgrade := false`
`621`	`640`
`622`	`641`	`////`
`@@ -674,13 +693,13 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`674`	`693`	`versionIsOnlyMinor := len(strings.Split(version, ".")) == 2`
`675`	`694`
`676`	`695`	`if versionIsOnlyMinor != autoupgradeEnabled {`
`677`		`- return diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrades enabled"))`
	`696`	`+ return append(diag.FromErr(fmt.Errorf("minor version x.y must be used with auto upgrades enabled")), diags...)`
`678`	`697`	`}`
`679`	`698`
`680`	`699`	`if versionIsOnlyMinor {`
`681`	`700`	`version, err = k8sGetLatestVersionFromMinor(ctx, k8sAPI, region, version)`
`682`	`701`	`if err != nil {`
`683`		`- return diag.FromErr(err)`
	`702`	`+ return append(diag.FromErr(err), diags...)`
`684`	`703`	`}`
`685`	`704`	`}`
`686`	`705`
`@@ -693,7 +712,7 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`693`	`712`	`Region: region,`
`694`	`713`	`}, scw.WithContext(ctx))`
`695`	`714`	`if err != nil {`
`696`		`- return diag.FromErr(err)`
	`715`	`+ return append(diag.FromErr(err), diags...)`
`697`	`716`	`}`
`698`	`717`
`699`	`718`	`if clusterResp.Version == version {`
`@@ -794,12 +813,12 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`794`	`813`	`actual, planned := d.GetChange("private_network_id")`
`795`	`814`	`if planned == "" && actual != "" {`
`796`	`815`	`// It's not possible to remove the private network anymore`
`797`		`- return diag.FromErr(fmt.Errorf("it is only possible to change the private network attached to the cluster, but not to remove it"))`
	`816`	`+ return append(diag.FromErr(fmt.Errorf("it is only possible to change the private network attached to the cluster, but not to remove it")), diags...)`
`798`	`817`	`}`
`799`	`818`	`if actual == "" {`
`800`	`819`	`err = migrateToPrivateNetworkCluster(ctx, d, meta)`
`801`	`820`	`if err != nil {`
`802`		`- return diag.FromErr(err)`
	`821`	`+ return append(diag.FromErr(err), diags...)`
`803`	`822`	`}`
`804`	`823`	`}`
`805`	`824`	`}`
`@@ -809,12 +828,12 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`809`	`828`	`////`
`810`	`829`	`_, err = k8sAPI.UpdateCluster(updateRequest, scw.WithContext(ctx))`
`811`	`830`	`if err != nil {`
`812`		`- return diag.FromErr(err)`
	`831`	`+ return append(diag.FromErr(err), diags...)`
`813`	`832`	`}`
`814`	`833`
`815`	`834`	`_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, d.Timeout(schema.TimeoutUpdate))`
`816`	`835`	`if err != nil {`
`817`		`- return diag.FromErr(err)`
	`836`	`+ return append(diag.FromErr(err), diags...)`
`818`	`837`	`}`
`819`	`838`
`820`	`839`	`////`
`@@ -829,16 +848,16 @@ func resourceScalewayK8SClusterUpdate(ctx context.Context, d *schema.ResourceDat`
`829`	`848`	`}`
`830`	`849`	`_, err = k8sAPI.UpgradeCluster(upgradeRequest)`
`831`	`850`	`if err != nil {`
`832`		`- return diag.FromErr(err)`
	`851`	`+ return append(diag.FromErr(err), diags...)`
`833`	`852`	`}`
`834`	`853`
`835`	`854`	`_, err = waitK8SCluster(ctx, k8sAPI, region, clusterID, d.Timeout(schema.TimeoutUpdate))`
`836`	`855`	`if err != nil {`
`837`		`- return diag.FromErr(err)`
	`856`	`+ return append(diag.FromErr(err), diags...)`
`838`	`857`	`}`
`839`	`858`	`}`
`840`	`859`
`841`		`- return resourceScalewayK8SClusterRead(ctx, d, meta)`
	`860`	`+ return append(resourceScalewayK8SClusterRead(ctx, d, meta), diags...)`
`842`	`861`	`}`
`843`	`862`
`844`	`863`	`func resourceScalewayK8SClusterDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {`