Immutable fields warning

Add a warning condition if an immutable
field is modified.

This commit allows one to specify immutable
fields in generator.yaml.

Author: nmvk

pkg/generate/config/field.go

@@ -155,6 +155,9 @@ type FieldConfig struct {
 	// IsSecret instructs the code generator that this field should be a
 	// SecretKeyReference.
 	IsSecret bool `json:"is_secret"`
+	// IsImmutable instructs the code generator to add warning conditions
+	// if user modifies the spec field after resource was created.
+	IsImmutable bool `json:"is_immutable"`
 	// From instructs the code generator that the value of the field should
 	// be retrieved from the specified operation and member path
 	From *SourceFieldConfig `json:"from,omitempty"`

pkg/model/crd.go

@@ -303,6 +303,20 @@ func (r *CRD) IsSecretField(path string) bool {
 	return false
 }
 
+// GetImmutableFields returns list of immutable fields present in CRD
+func (r *CRD) GetImmutableFields() []string {
+	fConfigs := r.cfg.ResourceFields(r.Names.Original)
+	var immutableFields []string
+
+	for field,fieldConfig := range fConfigs {
+		if fieldConfig.IsImmutable {
+			immutableFields = append(immutableFields, field)
+		}
+	}
+
+	return immutableFields
+}
+
 // SetOutputCustomMethodName returns custom set output operation as *string for
 // given operation on custom resource, if specified in generator config
 func (r *CRD) SetOutputCustomMethodName(

templates/pkg/resource/sdk.go.tpl

@@ -273,3 +273,55 @@ func (rm *resourceManager) terminalAWSError(err error) bool {
 	return false
 {{- end }}
 }
+
+{{- if .CRD.GetImmutableFields }}
+// validateImmutableFields validates the immutable fields and set appropriate condition
+func (rm *resourceManager) validateImmutableFields(ko *svcapitypes.{{ .CRD.Names.Camel }},
+	delta *ackcompare.Delta,) {
+	var fields []string;
+
+	for _, diff := range delta.Differences {
+		if diff.Path.Contains("Spec") {
+		{{- range $immutableField := .CRD.GetImmutableFields }}
+			if diff.Path.Contains("{{$immutableField}}") {
+				fields = append(fields,"{{$immutableField}}")
+			}
+		{{- end }}
+		}
+	}
+
+	// Warning condition
+	var warningCondition *ackv1alpha1.Condition = nil
+	for _, condition := range ko.Status.Conditions {
+		if condition.Type == ackv1alpha1.ConditionTypeWarning {
+			warningCondition = condition
+			break
+		}
+	}
+
+	// Remove the warning condition if warning is no longer present
+	if len(fields) == 0 && warningCondition != nil{
+		var newConditions []*ackv1alpha1.Condition
+		for _, condition := range ko.Status.Conditions {
+			if condition.Type != ackv1alpha1.ConditionTypeWarning {
+				newConditions = append(newConditions,condition)
+			}
+		}
+		ko.Status.Conditions = newConditions
+	}
+
+	if len(fields) > 0 {
+		// Add warning condition
+		if warningCondition == nil {
+			warningCondition = &ackv1alpha1.Condition{
+				Type: ackv1alpha1.ConditionTypeWarning,
+			}
+			ko.Status.Conditions = append(ko.Status.Conditions, warningCondition)
+		}
+
+		warningCondition.Status = corev1.ConditionTrue
+		message := "Immutable Spec fields have been modified : " + strings.Join(fields, ",")
+		warningCondition.Message = &message
+	}
+}
+{{- end }}

templates/pkg/resource/sdk_update.go.tpl

@@ -38,6 +38,9 @@ func (rm *resourceManager) sdkUpdate(
 {{- if $hookCode := Hook .CRD "sdk_update_pre_set_output" }}
 {{ $hookCode }}
 {{- end }}
+{{- if .CRD.GetImmutableFields }}
+    rm.validateImmutableFields(ko, delta)
+{{- end }}
 {{ $setCode }}
 	rm.setStatusDefaults(ko)
 {{ if $setOutputCustomMethodName := .CRD.SetOutputCustomMethodName .CRD.Ops.Update }}