feat: Support wait for StatefulSet

Author: s-diez

docs/resources/resource.md

@@ -68,7 +68,7 @@ resource "kustomization_resource" "p0" {
 
 # then loop through resources in ids_prio[1]
 # and set an explicit depends_on on kustomization_resource.p0
-# wait 2 minutes for any deployment or daemonset to become ready
+# wait 2 minutes for any deployment, statefulset or daemonset to become ready
 resource "kustomization_resource" "p1" {
   for_each = data.kustomization_build.test.ids_prio[1]
 
@@ -105,5 +105,5 @@ resource "kustomization_resource" "p2" {
 ## Argument Reference
 
 - `manifest` - (Required) JSON encoded Kubernetes resource manifest.
-- `wait` - Whether to wait for pods to become ready (default false). Currently only has an effect for Deployments and DaemonSets.
+- `wait` - Whether to wait for pods to become ready (default false). Currently only has an effect for Deployments, StatefulSets and DaemonSets.
 - 'timeouts' - (Optional) Overwrite `create`, `update` or `delete` timeout defaults. Defaults are 5 minutes for `create` and `update` and 10 minutes for `delete`.

kustomize/manifest.go

@@ -23,8 +23,9 @@ import (
 )
 
 var waitRefreshFunctions = map[string]waitRefreshFunction{
-	"apps/Deployment": waitDeploymentRefresh,
-	"apps/Daemonset":  waitDaemonsetRefresh,
+	"apps/Deployment":  waitDeploymentRefresh,
+	"apps/Daemonset":   waitDaemonsetRefresh,
+	"apps/StatefulSet": waitStatefulSetRefresh,
 }
 
 type kManifestId struct {
@@ -429,6 +430,38 @@ func waitDeploymentRefresh(km *kManifest) (interface{}, string, error) {
 	return nil, "in progress", nil
 }
 
+func statefulSetReady(u *k8sunstructured.Unstructured) (bool, error) {
+	var statefulSet k8sappsv1.StatefulSet
+	if err := k8sruntime.DefaultUnstructuredConverter.FromUnstructured(u.UnstructuredContent(), &statefulSet); err != nil {
+		return false, err
+	}
+	if statefulSet.Generation == statefulSet.Status.ObservedGeneration &&
+		statefulSet.Status.AvailableReplicas == *statefulSet.Spec.Replicas &&
+		statefulSet.Status.AvailableReplicas == statefulSet.Status.Replicas {
+		return true, nil
+	} else {
+		return false, nil
+	}
+}
+
+func waitStatefulSetRefresh(km *kManifest) (interface{}, string, error) {
+	resp, err := km.apiGet(k8smetav1.GetOptions{})
+	if err != nil {
+		if k8serrors.IsNotFound(err) {
+			return nil, "missing", nil
+		}
+		return nil, "error", err
+	}
+	ready, err := statefulSetReady(resp)
+	if err != nil {
+		return nil, "error", err
+	}
+	if ready {
+		return resp, "done", nil
+	}
+	return nil, "in progress", nil
+}
+
 func (km *kManifest) waitCreatedOrUpdated(t time.Duration) error {
 	gvk := km.gvk()
 	if refresh, ok := waitRefreshFunctions[fmt.Sprintf("%s/%s", gvk.Group, gvk.Kind)]; ok {

kustomize/resource_kustomization_test.go

@@ -483,24 +483,26 @@ func TestAccResourceKustomization_wait(t *testing.T) {
 		Steps: []resource.TestStep{
 			//
 			//
-			// Applying initial config with a svc and deployment in a namespace with wait
+			// Applying initial config with a deployment and statefulset in a namespace with wait
 			{
 				Config: testAccResourceKustomizationConfig_wait("test_kustomizations/wait/initial"),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					assertDurationIsShorterThan(now, 5*time.Minute),
 					testAccCheckManifestNestedString("kustomization_resource.dep1", "test", "spec", "selector", "matchLabels", "app"),
 					testAccCheckDeploymentReady("kustomization_resource.dep1", "test-wait", "test"),
+					testAccCheckStatefulSetReady("kustomization_resource.state1", "test-wait", "test-statefulset"),
 				),
 			},
 			//
 			//
-			// Applying modified config updating the deployment annotation with wait
+			// Applying modified config updating the deployment and statefulset annotation with wait
 			{
 				Config: testAccResourceKustomizationConfig_wait("test_kustomizations/wait/modified"),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					assertDurationIsShorterThan(now, 1*time.Minute),
 					testAccCheckManifestNestedString("kustomization_resource.dep1", "this will cause a redeploy", "spec", "template", "metadata", "annotations", "new"),
 					testAccCheckDeploymentReady("kustomization_resource.dep1", "test-wait", "test"),
+					testAccCheckStatefulSetReady("kustomization_resource.state1", "test-wait", "test-statefulset"),
 				),
 			},
 		},
@@ -520,6 +522,14 @@ resource "kustomization_resource" "dep1" {
 		update = "1m"
 	}
 }
+resource "kustomization_resource" "state1" {
+	manifest = data.kustomization_build.test.manifests["apps/StatefulSet/test-wait/test-statefulset"]
+	wait     = true
+	timeouts {
+		create = "1m"
+		update = "1m"
+	}
+}
 `
 }
 
@@ -548,6 +558,7 @@ func TestAccResourceKustomization_add_wait(t *testing.T) {
 					assertDurationIsShorterThan(now, 1*time.Minute),
 					testAccCheckManifestNestedString("kustomization_resource.dep1", "test", "spec", "selector", "matchLabels", "app"),
 					testAccCheckDeploymentReady("kustomization_resource.dep1", "test-wait-change", "test"),
+					testAccCheckStatefulSetReady("kustomization_resource.state1", "test-wait-change", "test-statefulset"),
 				),
 			},
 		},
@@ -562,6 +573,9 @@ resource "kustomization_resource" "ns" {
 resource "kustomization_resource" "dep1" {
 	manifest = data.kustomization_build.test.manifests["apps/Deployment/test-wait-change/test"]
 }
+resource "kustomization_resource" "state1" {
+	manifest = data.kustomization_build.test.manifests["apps/StatefulSet/test-wait-change/test-statefulset"]
+}
 `
 }
 
@@ -578,6 +592,14 @@ resource "kustomization_resource" "dep1" {
 		update = "1m"
 	}
 }
+resource "kustomization_resource" "state1" {
+	manifest = data.kustomization_build.test.manifests["apps/StatefulSet/test-wait-change/test-statefulset"]
+	wait = true
+	timeouts {
+		create = "1m"
+		update = "1m"
+	}
+}
 `
 }
 
@@ -618,32 +640,71 @@ resource "kustomization_resource" "dep1" {
 `
 }
 
-func TestAccResourceKustomization_nowait(t *testing.T) {
+func TestAccResourceKustomization_wait_failure_statefulset(t *testing.T) {
+	now := time.Now()
 
 	resource.Test(t, resource.TestCase{
 		//PreCheck:  func() { testAccPreCheck(t) },
 		Providers: testAccProviders,
 		Steps: []resource.TestStep{
 			//
 			//
-			// Applying initial config with a svc and deployment in a namespace without wait
+			// Applying initial config with a failing statefulset in a namespace with wait
+			{
+				Config: testAccResourceKustomizationConfig_wait_failure_statefulset("test_kustomizations/wait-fail-statefulset/initial"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					testAccCheckStatefulSetNotReady("kustomization_resource.state1", "test-wait-fail-statefulset", "test-statefulset"),
+					assertDurationIsLongerThan(now, 1*time.Minute),
+				),
+				ExpectError: regexp.MustCompile("timed out creating/updating StatefulSet test-wait-fail-statefulset/test-statefulset:"),
+			},
+		},
+	})
+}
+
+func testAccResourceKustomizationConfig_wait_failure_statefulset(path string) string {
+	return testAccDataSourceKustomizationConfig_basic(path) + `
+resource "kustomization_resource" "ns" {
+	manifest = data.kustomization_build.test.manifests["_/Namespace/_/test-wait-fail-statefulset"]
+}
+resource "kustomization_resource" "state1" {
+	manifest = data.kustomization_build.test.manifests["apps/StatefulSet/test-wait-fail-statefulset/test-statefulset"]
+	wait     = true
+	timeouts {
+		create = "1m"
+	}
+}
+`
+}
+
+func TestAccResourceKustomization_nowait(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		//PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			//
+			//
+			// Applying initial config with a svc and deployment and statefulset in a namespace without wait
 			// so shouldn't exist immediately after creation
 			{
 				Config: testAccResourceKustomizationConfig_nowait("test_kustomizations/nowait/initial"),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckManifestNestedString("kustomization_resource.dep1", "test", "spec", "selector", "matchLabels", "app"),
 					testAccCheckDeploymentNotReady("kustomization_resource.dep1", "test-nowait", "test"),
+					testAccCheckStatefulSetNotReady("kustomization_resource.state1", "test-nowait", "test-statefulset"),
 				),
 			},
 			//
 			//
-			// Applying modified config updating the deployment annotation without wait,
+			// Applying modified config updating the deployment and statefulset annotation without wait,
 			// so we don't immediately expect the annotation to be present
 			{
 				Config: testAccResourceKustomizationConfig_nowait("test_kustomizations/nowait/modified"),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					testAccCheckManifestNestedString("kustomization_resource.dep1", "this will cause a redeploy", "spec", "template", "metadata", "annotations", "new"),
 					testAccCheckDeploymentNotReady("kustomization_resource.dep1", "test-nowait", "test"),
+					testAccCheckManifestNestedString("kustomization_resource.state1", "this will cause statefulset to redeploy", "spec", "template", "metadata", "annotations", "new"),
+					testAccCheckStatefulSetNotReady("kustomization_resource.state1", "test-nowait", "test-statefulset"),
 				),
 			},
 		},
@@ -659,6 +720,9 @@ resource "kustomization_resource" "ns" {
 resource "kustomization_resource" "dep1" {
 	manifest = data.kustomization_build.test.manifests["apps/Deployment/test-nowait/test"]
 }
+resource "kustomization_resource" "state1" {
+	manifest = data.kustomization_build.test.manifests["apps/StatefulSet/test-nowait/test-statefulset"]
+}
 `
 }
 
@@ -1122,6 +1186,50 @@ func testAccCheckDeploymentNotReady(n string, namespace string, name string) res
 	}
 }
 
+func testAccCheckStatefulSetReady(n string, namespace string, name string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		u, err := getResourceFromTestState(s, n)
+		if err != nil {
+			return err
+		}
+
+		resp, err := getResourceFromK8sAPI(u)
+		if err != nil {
+			return err
+		}
+		ready, err := statefulSetReady(resp)
+		if err != nil {
+			return err
+		}
+		if !ready {
+			return fmt.Errorf("statefulset %s in %s not ready", name, namespace)
+		}
+		return nil
+	}
+}
+
+func testAccCheckStatefulSetNotReady(n string, namespace string, name string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		u, err := getResourceFromTestState(s, n)
+		if err != nil {
+			return err
+		}
+
+		resp, err := getResourceFromK8sAPI(u)
+		if err != nil {
+			return err
+		}
+		ready, err := statefulSetReady(resp)
+		if err != nil {
+			return err
+		}
+		if ready {
+			return fmt.Errorf("statefulset %s in %s unexpectedly ready", name, namespace)
+		}
+		return nil
+	}
+}
+
 func getResourceFromTestState(s *terraform.State, n string) (ur *k8sunstructured.Unstructured, err error) {
 	rs, ok := s.RootModule().Resources[n]
 	if !ok {

kustomize/test_kustomizations/nowait/initial/kustomization.yaml

@@ -5,4 +5,5 @@ namespace: test-nowait
 
 resources:
 - namespace.yaml
+- statefulset.yaml
 - ../../_example_app

kustomize/test_kustomizations/nowait/initial/statefulset.yaml

@@ -0,0 +1,19 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  labels:
+    app: test-statefulset
+  name: test-statefulset
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: test-statefulset
+  template:
+    metadata:
+      labels:
+        app: test-statefulset
+    spec:
+      containers:
+      - image: nginx
+        name: nginx

kustomize/test_kustomizations/nowait/modified/kustomization.yaml

@@ -13,3 +13,11 @@ patches:
         path: /spec/template/metadata/annotations
         value: 
           new: this will cause a redeploy
+  - target:
+      kind: StatefulSet
+      name: test-statefulset
+    patch: |
+      - op: add
+        path: /spec/template/metadata/annotations
+        value:
+          new: this will cause statefulset to redeploy

kustomize/test_kustomizations/wait-change/initial/kustomization.yaml

@@ -5,4 +5,5 @@ namespace: test-wait-change
 
 resources:
 - namespace.yaml
+- statefulset.yaml
 - ../../_example_app

kustomize/test_kustomizations/wait-change/initial/statefulset.yaml

@@ -0,0 +1,19 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  labels:
+    app: test-statefulset
+  name: test-statefulset
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: test-statefulset
+  template:
+    metadata:
+      labels:
+        app: test-statefulset
+    spec:
+      containers:
+      - image: nginx
+        name: nginx

kustomize/test_kustomizations/wait-fail-statefulset/initial/kustomization.yaml

@@ -0,0 +1,8 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+namespace: test-wait-fail-statefulset
+
+resources:
+- namespace.yaml
+- statefulset.yaml

kustomize/test_kustomizations/wait-fail-statefulset/initial/namespace.yaml

@@ -0,0 +1,4 @@
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: test-wait-fail-statefulset