add support for setting the persistent volume claimRef (#1020)

* add support for setting the persistent volume claimRef

* Adapt to recent test framework changes

Co-authored-by: Alex Somesan <[email protected]>

Author: dvulpe

kubernetes/resource_kubernetes_persistent_volume.go

@@ -114,6 +114,28 @@ func resourceKubernetesPersistentVolume() *schema.Resource {
 								"Retain",
 							}, false),
 						},
+						"claim_ref": {
+							Type:        schema.TypeList,
+							Description: "A reference to the persistent volume claim details for statically managed PVs. More Info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding",
+							Optional:    true,
+							MaxItems:    1,
+							Elem: &schema.Resource{
+								Schema: map[string]*schema.Schema{
+									"namespace": {
+										Type:        schema.TypeString,
+										Description: "The namespace of the PersistentVolumeClaim",
+										Elem:        schema.TypeString,
+										Required:    true,
+									},
+									"name": {
+										Type:        schema.TypeString,
+										Description: "The name of the PersistentVolumeClaim",
+										Elem:        schema.TypeString,
+										Required:    true,
+									},
+								},
+							},
+						},
 						"persistent_volume_source": {
 							Type:        schema.TypeList,
 							Description: "The specification of a persistent volume.",

kubernetes/resource_kubernetes_persistent_volume_claim_test.go

@@ -716,6 +716,11 @@ resource "kubernetes_persistent_volume" "test" {
       }
     }
   }
+  lifecycle {
+    ignore_changes = [
+      spec[0].claim_ref,
+    ]
+  }
 }
 resource "kubernetes_persistent_volume_claim" "test" {
   wait_until_bound = true

kubernetes/resource_kubernetes_persistent_volume_test.go

@@ -879,6 +879,50 @@ func TestAccKubernetesPersistentVolume_regression(t *testing.T) {
 	})
 }
 
+func TestAccKubernetesPersistentVolume_hostPath_claimRef(t *testing.T) {
+	var conf api.PersistentVolume
+	randString := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum)
+	name := fmt.Sprintf("tf-acc-test-%s", randString)
+	claimNamespace := "default"
+	claimName := "expected-claim-name"
+
+	const resourceName = "kubernetes_persistent_volume.test"
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		IDRefreshName:     resourceName,
+		ProviderFactories: testAccProviderFactories,
+		CheckDestroy:      testAccCheckKubernetesPersistentVolumeDestroy,
+		Steps: []resource.TestStep{
+			// create a volume without a claimRef
+			{
+				Config: testAccKubernetesPersistentVolumeConfig_hostPath_basic(name),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckKubernetesPersistentVolumeExists(resourceName, &conf),
+					resource.TestCheckResourceAttr(resourceName, "spec.0.claim_ref.#", "0"),
+				),
+			},
+			// set the claimRef and assert it's present
+			{
+				Config: testAccKubernetesPersistentVolumeConfig_hostPath_claimRef(name, claimNamespace, claimName),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckKubernetesPersistentVolumeExists(resourceName, &conf),
+					resource.TestCheckResourceAttr(resourceName, "spec.0.claim_ref.#", "1"),
+					resource.TestCheckResourceAttr(resourceName, "spec.0.claim_ref.0.namespace", claimNamespace),
+					resource.TestCheckResourceAttr(resourceName, "spec.0.claim_ref.0.name", claimName),
+				),
+			},
+			// unset the claimRef and assert it's absent
+			{
+				Config: testAccKubernetesPersistentVolumeConfig_hostPath_basic(name),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckKubernetesPersistentVolumeExists(resourceName, &conf),
+					resource.TestCheckResourceAttr(resourceName, "spec.0.claim_ref.#", "0"),
+				),
+			},
+		},
+	})
+}
+
 func testAccCheckKubernetesPersistentVolumeForceNew(old, new *api.PersistentVolume, wantNew bool) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		if wantNew {
@@ -1718,6 +1762,52 @@ func testAccKubernetesPersistentVolumeConfig_hostPath_mountOptions(name string)
 }`, name)
 }
 
+func testAccKubernetesPersistentVolumeConfig_hostPath_basic(name string) string {
+	return fmt.Sprintf(`resource "kubernetes_persistent_volume" "test" {
+  metadata {
+    name = "%s"
+  }
+  spec {
+    capacity = {
+      storage = "1Gi"
+    }
+    access_modes = ["ReadWriteMany"]
+    mount_options = ["foo"]
+
+    persistent_volume_source {
+      host_path {
+        path = "/mnt/local-volume"
+      }
+    }
+  }
+}`, name)
+}
+
+func testAccKubernetesPersistentVolumeConfig_hostPath_claimRef(name string, claimNamespace string, claimName string) string {
+	return fmt.Sprintf(`resource "kubernetes_persistent_volume" "test" {
+  metadata {
+    name = "%s"
+  }
+  spec {
+    capacity = {
+      storage = "1Gi"
+    }
+    access_modes = ["ReadWriteMany"]
+    mount_options = ["foo"]
+    claim_ref {
+       name = "%s"
+       namespace = "%s"
+    }
+
+    persistent_volume_source {
+      host_path {
+        path = "/mnt/local-volume"
+      }
+    }
+  }
+}`, name, claimName, claimNamespace)
+}
+
 func testAccKubernetesPersistentVolume_regression(provider, name, path, typ string) string {
 	return fmt.Sprintf(`resource "kubernetes_persistent_volume" "test" {
   provider = %s

kubernetes/structure_persistent_volume_spec.go

@@ -394,6 +394,9 @@ func flattenPersistentVolumeSpec(in v1.PersistentVolumeSpec) []interface{} {
 	if in.VolumeMode != nil {
 		att["volume_mode"] = in.VolumeMode
 	}
+	if in.ClaimRef != nil {
+		att["claim_ref"] = flattenObjectRef(in.ClaimRef)
+	}
 	return []interface{}{att}
 }
 
@@ -1010,9 +1013,23 @@ func expandPersistentVolumeSpec(l []interface{}) (*v1.PersistentVolumeSpec, erro
 		volumeMode := v1.PersistentVolumeMode(v)
 		obj.VolumeMode = &volumeMode
 	}
+	if v, ok := in["claim_ref"].([]interface{}); ok && len(v) > 0 {
+		obj.ClaimRef = expandClaimRef(v)
+	}
 	return obj, nil
 }
 
+func expandClaimRef(v []interface{}) *v1.ObjectReference {
+	if len(v) == 0 || v[0] == nil {
+		return nil
+	}
+	o := v[0].(map[string]interface{})
+	return &v1.ObjectReference{
+		Name:      o["name"].(string),
+		Namespace: o["namespace"].(string),
+	}
+}
+
 func expandPhotonPersistentDiskVolumeSource(l []interface{}) *v1.PhotonPersistentDiskVolumeSource {
 	if len(l) == 0 || l[0] == nil {
 		return &v1.PhotonPersistentDiskVolumeSource{}
@@ -1222,7 +1239,13 @@ func patchPersistentVolumeSpec(pathPrefix, prefix string, d *schema.ResourceData
 			Value: expandPersistentVolumeAccessModes(v.List()),
 		})
 	}
-
+	if d.HasChange(prefix + "claim_ref") {
+		v := d.Get(prefix + "claim_ref").([]interface{})
+		ops = append(ops, &ReplaceOperation{
+			Path:  pathPrefix + "/claimRef",
+			Value: expandClaimRef(v),
+		})
+	}
 	return ops, nil
 }
 

kubernetes/structures_container.go

@@ -1028,3 +1028,14 @@ func expandContainerResourceRequirements(l []interface{}) (*v1.ResourceRequireme
 
 	return obj, nil
 }
+
+func flattenObjectRef(in *v1.ObjectReference) []interface{} {
+	att := make(map[string]interface{})
+	if in.Name != "" {
+		att["name"] = in.Name
+	}
+	if in.Namespace != "" {
+		att["namespace"] = in.Namespace
+	}
+	return []interface{}{att}
+}

kubernetes/structures_container_test.go

@@ -212,3 +212,35 @@ func TestExpandConfigMapKeyRef(t *testing.T) {
 		}
 	}
 }
+
+func TestFlattenObjectRef(t *testing.T) {
+	cases := []struct {
+		Input          *v1.ObjectReference
+		ExpectedOutput []interface{}
+	}{
+		{
+			&v1.ObjectReference{
+				Name:      "demo",
+				Namespace: "default",
+			},
+			[]interface{}{
+				map[string]interface{}{
+					"name":      "demo",
+					"namespace": "default",
+				},
+			},
+		},
+		{
+			&v1.ObjectReference{},
+			[]interface{}{map[string]interface{}{}},
+		},
+	}
+
+	for _, tc := range cases {
+		output := flattenObjectRef(tc.Input)
+		if !reflect.DeepEqual(output, tc.ExpectedOutput) {
+			t.Fatalf("Unexpected output from flattener.\nExpected: %#v\nGiven:    %#v",
+				tc.ExpectedOutput, output)
+		}
+	}
+}