use acktypes.AWSResource in method signature instead of concerete 'resource' for lateInitialization.

Author: vijtrip2

pkg/generate/ack/controller.go

@@ -121,8 +121,8 @@ var (
 		"GoCodeFindLateInitializedFieldNames": func(r *ackmodel.CRD, resVarName string, indentLevel int) string {
 			return code.FindLateInitializedFieldNames(r.Config(), r, resVarName, indentLevel)
 		},
-		"GoCodeLateInitializeFromReadOne": func(r *ackmodel.CRD, koSourceVarName string, koTargetVarName string, indentLevel int) string {
-			return code.LateInitializeFromReadOne(r.Config(), r, koSourceVarName, koTargetVarName, indentLevel)
+		"GoCodeLateInitializeFromReadOne": func(r *ackmodel.CRD, sourceResVarName string, targetResVarName string, indentLevel int) string {
+			return code.LateInitializeFromReadOne(r.Config(), r, sourceResVarName, targetResVarName, indentLevel)
 		},
 		"GoCodeIncompleteLateInitialization": func(r *ackmodel.CRD, resVarName string, indentLevel int) string {
 			return code.IncompleteLateInitialization(r.Config(), r, resVarName, indentLevel)

pkg/generate/code/late_initialize.go

@@ -98,8 +98,8 @@ func getSortedLateInitFieldsAndConfig(
 //          min_backoff_seconds: 20
 //
 // Sample output:
-//	observedKo := observed.ko
-//	latestKo := latest.ko
+//	observedKo := rm.concreteResource(observed).ko
+//	latestKo := rm.concreteResource(latest).ko
 //	if observedKo.Spec.ImageScanningConfiguration != nil && latestKo.Spec.ImageScanningConfiguration != nil {
 //		if observedKo.Spec.ImageScanningConfiguration.ScanOnPush != nil && latestKo.Spec.ImageScanningConfiguration.ScanOnPush == nil {
 //			latestKo.Spec.ImageScanningConfiguration.ScanOnPush = observedKo.Spec.ImageScanningConfiguration.ScanOnPush
@@ -151,8 +151,8 @@ func LateInitializeFromReadOne(
 	if len(lateInitializedFieldNames) == 0 {
 		return fmt.Sprintf("%sreturn %s", indent, targetResVarName)
 	}
-	out += fmt.Sprintf("%sobservedKo := %s.ko\n", indent, sourceResVarName)
-	out += fmt.Sprintf("%slatestKo := %s.ko\n", indent, targetResVarName)
+	out += fmt.Sprintf("%sobservedKo := rm.concreteResource(%s).ko\n", indent, sourceResVarName)
+	out += fmt.Sprintf("%slatestKo := rm.concreteResource(%s).ko\n", indent, targetResVarName)
 	// TODO(vijat@): Add validation for correct field path in lateInitializedFieldNames
 	for _, fName := range lateInitializedFieldNames {
 		// split the field name by period
@@ -235,7 +235,7 @@ func LateInitializeFromReadOne(
 //
 //
 // Sample Output:
-//	ko := latestWithDefaults.ko
+//	ko := rm.concreteResource(latest).ko
 //	if ko.Spec.ImageScanningConfiguration != nil {
 //		if ko.Spec.ImageScanningConfiguration.ScanOnPush == nil {
 //			return true
@@ -288,7 +288,7 @@ func IncompleteLateInitialization(
 		out += fmt.Sprintf("%sreturn false", indent)
 		return out
 	}
-	out += fmt.Sprintf("%sko := %s.ko\n", indent, resVarName)
+	out += fmt.Sprintf("%sko := rm.concreteResource(%s).ko\n", indent, resVarName)
 	for _, fName := range sortedLateInitFieldNames {
 		// split the field name by period
 		// each substring represents a field.

pkg/generate/code/late_initialize_test.go

@@ -100,8 +100,8 @@ func Test_LateInitializeFromReadOne_NonNestedPath(t *testing.T) {
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["Name"].LateInitialize)
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["ImageTagMutability"].LateInitialize)
 	expected :=
-		`	observedKo := observed.ko
-	latestKo := latest.ko
+		`	observedKo := rm.concreteResource(observed).ko
+	latestKo := rm.concreteResource(latest).ko
 	if observedKo.Spec.ImageTagMutability != nil && latestKo.Spec.ImageTagMutability == nil {
 		latestKo.Spec.ImageTagMutability = observedKo.Spec.ImageTagMutability
 	}
@@ -125,8 +125,8 @@ func Test_LateInitializeFromReadOne_NestedPath(t *testing.T) {
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["Name"].LateInitialize)
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["ImageScanningConfiguration.ScanOnPush"].LateInitialize)
 	expected :=
-		`	observedKo := observed.ko
-	latestKo := latest.ko
+		`	observedKo := rm.concreteResource(observed).ko
+	latestKo := rm.concreteResource(latest).ko
 	if observedKo.Spec.ImageScanningConfiguration != nil && latestKo.Spec.ImageScanningConfiguration != nil {
 		if observedKo.Spec.ImageScanningConfiguration.ScanOnPush != nil && latestKo.Spec.ImageScanningConfiguration.ScanOnPush == nil {
 			latestKo.Spec.ImageScanningConfiguration.ScanOnPush = observedKo.Spec.ImageScanningConfiguration.ScanOnPush
@@ -193,7 +193,7 @@ func Test_IncompleteLateInitialization(t *testing.T) {
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["Name"].LateInitialize)
 	assert.NotNil(crd.Config().ResourceFields(crd.Names.Original)["ImageScanningConfiguration.ScanOnPush"].LateInitialize)
 	expected :=
-		`	ko := latestWithDefaults.ko
+		`	ko := rm.concreteResource(latest).ko
 	if ko.Spec.ImageScanningConfiguration != nil {
 		if ko.Spec.ImageScanningConfiguration.ScanOnPush == nil {
 			return true
@@ -231,5 +231,5 @@ func Test_IncompleteLateInitialization(t *testing.T) {
 		}
 	}
 	return false`
-	assert.Equal(expected, code.IncompleteLateInitialization(crd.Config(), crd, "latestWithDefaults", 1))
+	assert.Equal(expected, code.IncompleteLateInitialization(crd.Config(), crd, "latest", 1))
 }

templates/pkg/resource/manager.go.tpl

@@ -169,10 +169,9 @@ func (rm *resourceManager) ARNFromName(name string) string {
 // object passed in the parameter.
 func (rm *resourceManager) LateInitialize(
 	ctx context.Context,
-	resLatest acktypes.AWSResource,
+	latest acktypes.AWSResource,
 ) (acktypes.AWSResource, error) {
 	rlog := ackrtlog.FromContext(ctx)
-	latest := rm.concreteResource(resLatest)
 	// If there are no fields to late initialize, do nothing
 	if len(lateInitializeFieldNames) == 0 {
 		rlog.Debug("no late initialization required.")
@@ -183,7 +182,7 @@ func (rm *resourceManager) LateInitialize(
 {{- if $hookCode := Hook .CRD "late_initialize_pre_read_one" }}
 {{ $hookCode }}
 {{- end }}
-	observedRes, err := rm.ReadOne(ctx, latest)
+	observed, err := rm.ReadOne(ctx, latest)
 	if err != nil {
 		lateInitConditionMessage = "Unable to complete Read operation required for late initialization"
 		lateInitConditionReason = "Late Initialization Failure"
@@ -193,7 +192,6 @@ func (rm *resourceManager) LateInitialize(
 {{- if $hookCode := Hook .CRD "late_initialize_post_read_one" }}
 {{ $hookCode }}
 {{- end }}
-	observed := rm.concreteResource(observedRes)
 	latest = rm.lateInitializeFromReadOneOutput(observed, latest)
 	incompleteInitialization := rm.incompleteLateInitialization(latest)
 	if incompleteInitialization {
@@ -213,17 +211,17 @@ func (rm *resourceManager) LateInitialize(
 // incompleteLateInitialization return true if there are fields which were supposed to be
 // late initialized but are not. If all the fields are late initialized, false is returned
 func (rm *resourceManager) incompleteLateInitialization(
-	latest *resource,
+	latest acktypes.AWSResource,
 ) bool {
 {{ GoCodeIncompleteLateInitialization .CRD "latest" 1 }}
 }
 
 // lateInitializeFromReadOneOutput late initializes the 'latest' resource from the 'observed'
 // resource and returns 'latest' resource
 func (rm *resourceManager) lateInitializeFromReadOneOutput(
-	observed *resource,
-	latest *resource,
-) *resource {
+	observed acktypes.AWSResource,
+	latest acktypes.AWSResource,
+) acktypes.AWSResource {
 {{ GoCodeLateInitializeFromReadOne .CRD "observed" "latest" 1 }}
 }