feat: constraint group registry (#15741)

Co-authored-by: Stephen Lewis (Burrows) <[email protected]>

Author: ramonvermeulen

mmv1/api/resource.go

@@ -367,6 +367,9 @@ type Resource struct {
 	ImportPath     string `yaml:"-"`
 	SourceYamlFile string `yaml:"-"`
 
+	constraintGroupRegistry     map[string]*[]string `yaml:"-"`
+	constraintGroupsInitialized bool                 `yaml:"-"`
+
 	// ====================
 	// TGC
 	// ====================
@@ -812,10 +815,44 @@ func deduplicateSliceOfStrings(slice []string) []string {
 	return result
 }
 
+func (r *Resource) initializeConstraintGroups() {
+	if r.constraintGroupsInitialized {
+		return
+	}
+	r.constraintGroupRegistry = make(map[string]*[]string)
+
+	props := r.AllNestedProperties(google.Concat(r.RootProperties(), r.UserVirtualFields()))
+	for _, prop := range props {
+		prop.ConflictsGroup = r.attachConstraintGroup("conflicts", prop.Conflicts)
+		prop.AtLeastOneOfGroup = r.attachConstraintGroup("at_least_one_of", prop.AtLeastOneOf)
+		prop.ExactlyOneOfGroup = r.attachConstraintGroup("exactly_one_of", prop.ExactlyOneOf)
+		prop.RequiredWithGroup = r.attachConstraintGroup("required_with", prop.RequiredWith)
+	}
+	r.constraintGroupsInitialized = true
+}
+
+func (r *Resource) attachConstraintGroup(groupType string, source []string) *[]string {
+	if len(source) == 0 {
+		return nil
+	}
+
+	sorted := slices.Clone(source)
+	slices.Sort(sorted)
+	key := fmt.Sprintf("%s|%s", groupType, strings.Join(sorted, ","))
+
+	if existing, ok := r.constraintGroupRegistry[key]; ok {
+		return existing
+	}
+
+	newGroup := slices.Clone(sorted)
+	r.constraintGroupRegistry[key] = &newGroup
+	return &newGroup
+}
+
 func buildWriteOnlyField(name string, versionFieldName string, originalField *Type) *Type {
 	description := fmt.Sprintf("%s Note: This property is write-only and will not be read from the API. For more info see [updating write-only attributes](/docs/providers/google/guides/using_write_only_attributes.html#updating-write-only-attributes)", originalField.Description)
 	originalFieldLineage := originalField.TerraformLineage()
-	fieldPathCurrentField := strings.ReplaceAll(originalFieldLineage, google.Underscore(originalField.Name), google.Underscore(name))
+	newFieldLineage := strings.ReplaceAll(originalFieldLineage, google.Underscore(originalField.Name), google.Underscore(name))
 	requiredWith := strings.ReplaceAll(originalFieldLineage, google.Underscore(originalField.Name), google.Underscore(versionFieldName))
 
 	apiName := originalField.ApiName
@@ -833,19 +870,28 @@ func buildWriteOnlyField(name string, versionFieldName string, originalField *Ty
 		propertyWithRequiredWith([]string{requiredWith}),
 	}
 
-	if originalField.Required {
+	if originalField.Required || len(originalField.ExactlyOneOf) > 0 {
 		originalField.Required = false
-		exactlyOneOf := append(originalField.ExactlyOneOf, originalFieldLineage, fieldPathCurrentField)
-		options = append(options, propertyWithExactlyOneOf(deduplicateSliceOfStrings(exactlyOneOf)))
-		originalField.ExactlyOneOf = deduplicateSliceOfStrings(exactlyOneOf)
+		if originalField.ExactlyOneOfGroup == nil {
+			base := []string{originalFieldLineage, newFieldLineage}
+			originalField.ExactlyOneOfGroup = &base
+		} else {
+			*originalField.ExactlyOneOfGroup = deduplicateSliceOfStrings(append(*originalField.ExactlyOneOfGroup, originalFieldLineage, newFieldLineage))
+		}
+		options = append(options, propertyWithExactlyOneOfPointer(originalField.ExactlyOneOfGroup))
 	} else {
-		conflicts := append(originalField.Conflicts, originalFieldLineage)
-		options = append(options, propertyWithConflicts(deduplicateSliceOfStrings(conflicts)))
+		if originalField.ConflictsGroup != nil {
+			*originalField.ConflictsGroup = deduplicateSliceOfStrings(append(*originalField.ConflictsGroup, newFieldLineage))
+		} else {
+			originalField.Conflicts = deduplicateSliceOfStrings(append(originalField.Conflicts, newFieldLineage))
+		}
+		newConflicts := deduplicateSliceOfStrings(append([]string{originalFieldLineage}, originalField.Conflicts...))
+		options = append(options, propertyWithConflicts(newConflicts))
 	}
 
-	if len(originalField.AtLeastOneOf) > 0 {
-		atLeastOneOf := append(originalField.AtLeastOneOf, originalFieldLineage, fieldPathCurrentField)
-		options = append(options, propertyWithAtLeastOneOf(deduplicateSliceOfStrings(atLeastOneOf)))
+	if originalField.AtLeastOneOfGroup != nil {
+		*originalField.AtLeastOneOfGroup = deduplicateSliceOfStrings(append(*originalField.AtLeastOneOfGroup, originalFieldLineage, newFieldLineage))
+		options = append(options, propertyWithAtLeastOneOfPointer(originalField.AtLeastOneOfGroup))
 	}
 
 	return NewProperty(name, originalField.ApiName, options)
@@ -883,6 +929,10 @@ func (r *Resource) addWriteOnlyFields(props []*Type, propWithWoConfigured *Type)
 // AddExtraFields processes properties and adds supplementary fields based on property types.
 // It handles write-only properties, labels, and annotations.
 func (r *Resource) AddExtraFields(props []*Type, parent *Type) []*Type {
+	if !r.constraintGroupsInitialized {
+		r.initializeConstraintGroups()
+	}
+
 	for _, p := range props {
 		if p.WriteOnly && !strings.HasSuffix(p.Name, "Wo") {
 			props = r.addWriteOnlyFields(props, p)

mmv1/api/type.go

@@ -136,6 +136,12 @@ type Type struct {
 	// A list of properties that are required to be set together.
 	RequiredWith []string `yaml:"required_with,omitempty"`
 
+	// Shared constraint group pointers (populated post-unmarshal)
+	ConflictsGroup    *([]string) `yaml:"-"`
+	AtLeastOneOfGroup *([]string) `yaml:"-"`
+	ExactlyOneOfGroup *([]string) `yaml:"-"`
+	RequiredWithGroup *([]string) `yaml:"-"`
+
 	// Can only be overridden - we should never set this ourselves.
 	NewType string `yaml:"-"`
 
@@ -703,7 +709,9 @@ func (t Type) Conflicting() []string {
 	if t.ResourceMetadata == nil {
 		return []string{}
 	}
-
+	if t.ConflictsGroup != nil {
+		return *t.ConflictsGroup
+	}
 	return t.Conflicts
 }
 
@@ -723,7 +731,9 @@ func (t Type) AtLeastOneOfList() []string {
 	if t.ResourceMetadata == nil {
 		return []string{}
 	}
-
+	if t.AtLeastOneOfGroup != nil {
+		return *t.AtLeastOneOfGroup
+	}
 	return t.AtLeastOneOf
 }
 
@@ -743,7 +753,9 @@ func (t Type) ExactlyOneOfList() []string {
 	if t.ResourceMetadata == nil {
 		return []string{}
 	}
-
+	if t.ExactlyOneOfGroup != nil {
+		return *t.ExactlyOneOfGroup
+	}
 	return t.ExactlyOneOf
 }
 
@@ -762,7 +774,9 @@ func (t Type) RequiredWithList() []string {
 	if t.ResourceMetadata == nil {
 		return []string{}
 	}
-
+	if t.RequiredWithGroup != nil {
+		return *t.RequiredWithGroup
+	}
 	return t.RequiredWith
 }
 
@@ -1227,12 +1241,6 @@ func propertyWithRequiredWith(requiredWith []string) func(*Type) {
 	}
 }
 
-func propertyWithExactlyOneOf(exactlyOneOf []string) func(*Type) {
-	return func(p *Type) {
-		p.ExactlyOneOf = exactlyOneOf
-	}
-}
-
 func propertyWithAtLeastOneOf(atLeastOneOf []string) func(*Type) {
 	return func(p *Type) {
 		p.AtLeastOneOf = atLeastOneOf
@@ -1245,6 +1253,18 @@ func propertyWithApiName(apiName string) func(*Type) {
 	}
 }
 
+func propertyWithExactlyOneOfPointer(ptr *[]string) func(*Type) {
+	return func(p *Type) {
+		p.ExactlyOneOfGroup = ptr
+	}
+}
+
+func propertyWithAtLeastOneOfPointer(ptr *[]string) func(*Type) {
+	return func(p *Type) {
+		p.AtLeastOneOfGroup = ptr
+	}
+}
+
 func (t *Type) validateLabelsField() {
 	productName := t.ResourceMetadata.ProductMetadata.Name
 	resourceName := t.ResourceMetadata.Name