Improve error messages for StatefulSet (#673)

pulumi · Aug 1, 2019 · c0b4e12 · c0b4e12
1 parent 67eac9f
commit c0b4e12
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 - v1.14.x
 - v1.13.x
 
+### Improvements
+
+-   Improve error messages for StatefulSet. (https://github.com/pulumi/pulumi-kubernetes/pull/673)
+
 ### Bug fixes
 
 -   Properly reference override values in Python Helm SDK (https://github.com/pulumi/pulumi-kubernetes/pull/676).

diff --git a/pkg/await/apps_statefulset.go b/pkg/await/apps_statefulset.go
@@ -110,6 +110,8 @@ type statefulsetInitAwaiter struct {
 	pods            map[string]*unstructured.Unstructured
 	currentReplicas int64
 	targetReplicas  int64
+	currentRevision string
+	targetRevision  string
 }
 
 func makeStatefulSetInitAwaiter(c updateAwaitConfig) *statefulsetInitAwaiter {
@@ -329,6 +331,7 @@ func (sia *statefulsetInitAwaiter) processStatefulSetEvent(event watch.Event) {
 		updateRevision = rawUpdateRevision.(string)
 	}
 	sia.revisionReady = (currentRevision != "") && (currentRevision == updateRevision)
+	sia.currentRevision, sia.targetRevision = currentRevision, updateRevision
 
 	// Check if all expected replicas are ready.
 	var replicas, statusReplicas, statusReadyReplicas, statusCurrentReplicas, statusUpdatedReplicas int64
@@ -419,11 +422,13 @@ func (sia *statefulsetInitAwaiter) errorMessages() []string {
 
 	if !sia.replicasReady {
 		messages = append(messages,
-			"Failed to observe the expected number of ready replicas")
+			fmt.Sprintf(
+				"%v out of %v replicas succeeded readiness checks", sia.currentReplicas, sia.targetReplicas))
 	}
 	if !sia.revisionReady {
 		messages = append(messages,
-			".status.currentRevision does not match .status.updateRevision")
+			fmt.Sprintf("StatefulSet controller failed to advance from revision %q to revision %q",
+				sia.currentRevision, sia.targetRevision))
 	}
 
 	errorMessages := sia.aggregatePodErrors()

diff --git a/pkg/await/apps_statefulset_test.go b/pkg/await/apps_statefulset_test.go
@@ -70,7 +70,7 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetCreating(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
+					"0 out of 2 replicas succeeded readiness checks",
 				}},
 		},
 		{
@@ -88,10 +88,8 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetUpdating(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					// TODO: update error message
-					// x of y replicas succeeded readiness checks
-					"Failed to observe the expected number of ready replicas",
-					".status.currentRevision does not match .status.updateRevision",
+					"0 out of 2 replicas succeeded readiness checks",
+					"StatefulSet controller failed to advance from revision \"foo-7b5cf87b78\" to revision \"foo-789c4b994f\"",
 				}},
 		},
 		{
@@ -114,7 +112,7 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetProgressing(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
+					"1 out of 2 replicas succeeded readiness checks",
 				}},
 		},
 		{
@@ -137,8 +135,8 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetUpdating(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
-					".status.currentRevision does not match .status.updateRevision",
+					"0 out of 2 replicas succeeded readiness checks",
+					"StatefulSet controller failed to advance from revision \"foo-7b5cf87b78\" to revision \"foo-789c4b994f\"",
 				}},
 		},
 		{
@@ -161,7 +159,7 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetProgressing(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
+					"1 out of 2 replicas succeeded readiness checks",
 					"containers with unready status: [nginx] -- [ErrImagePull] manifest for nginx:busted not found",
 				}},
 		},
@@ -185,8 +183,8 @@ func Test_Apps_StatefulSet(t *testing.T) {
 			expectedError: &timeoutError{
 				object: statefulsetUpdating(inputNamespace, inputName, targetService),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
-					".status.currentRevision does not match .status.updateRevision",
+					"0 out of 2 replicas succeeded readiness checks",
+					"StatefulSet controller failed to advance from revision \"foo-7b5cf87b78\" to revision \"foo-789c4b994f\"",
 					"containers with unready status: [nginx] -- [ErrImagePull] manifest for nginx:busted not found",
 				}},
 		},
@@ -236,7 +234,7 @@ func Test_Apps_StatefulSet_MultipleUpdates(t *testing.T) {
 			firstExpectedError: &timeoutError{
 				object: statefulsetFailed(),
 				subErrors: []string{
-					"Failed to observe the expected number of ready replicas",
+					"0 out of 2 replicas succeeded readiness checks",
 				}},
 			secondUpdate: func(statefulset, pods chan watch.Event, timeout chan time.Time) {
 				statefulset <- watchAddedEvent(statefulsetUpdatedAfterFailed())
@@ -295,15 +293,15 @@ func Test_Apps_StatefulSetRead(t *testing.T) {
 			description: "Read should fail if StatefulSet status empty",
 			statefulset: statefulsetAdded,
 			expectedSubErrors: []string{
-				"Failed to observe the expected number of ready replicas",
-				".status.currentRevision does not match .status.updateRevision",
+				"0 out of 2 replicas succeeded readiness checks",
+				"StatefulSet controller failed to advance from revision \"\" to revision \"\"",
 			},
 		},
 		{
 			description: "Read should fail if StatefulSet is progressing",
 			statefulset: statefulsetProgressing,
 			expectedSubErrors: []string{
-				"Failed to observe the expected number of ready replicas",
+				"1 out of 2 replicas succeeded readiness checks",
 			},
 		},
 		{