add better comment

Signed-off-by: Somtochi Onyekwere <[email protected]>
fluxcd · Nov 23, 2023 · 66fc699 · 66fc699
1 parent 44c0ec0
commit 66fc699
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/pkg/bootstrap/bootstrap.go b/pkg/bootstrap/bootstrap.go
@@ -185,7 +185,8 @@ type objectWithConditions interface {
 
 func objectReconciled(kube client.Client, objKey client.ObjectKey, clientObject objectWithConditions, expectRevision string) wait.ConditionWithContextFunc {
 	return func(ctx context.Context) (bool, error) {
-		// for some reason, TypeMeta gets unset after kube.Get so we want to get the kind before that
+		// for some reason, TypeMeta gets unset after kube.Get so we want to store the GVK and set it after
+		// ref https://github.com/kubernetes-sigs/controller-runtime/issues/1517#issuecomment-844703142
 		gvk := clientObject.GetObjectKind().GroupVersionKind()
 		if err := kube.Get(ctx, objKey, clientObject); err != nil {
 			return false, err

diff --git a/pkg/bootstrap/bootstrap_test.go b/pkg/bootstrap/bootstrap_test.go
@@ -162,6 +162,12 @@ func Test_objectReconciled(t *testing.T) {
 					Namespace: "flux-system",
 				},
 			},
+			statuses: []updateStatus{
+				{
+					expectedErr:  false,
+					expectedBool: false,
+				},
+			},
 		},
 		{
 			name: "suspended Kustomization",