Merge pull request #4415 from shraddhabang/tagsgeneric

Add generic tag processing system for controllers

Author: k8s-ci-robot

pkg/aga/model_build_accelerator.go

@@ -23,9 +23,9 @@ type acceleratorBuilder interface {
 }
 
 // NewAcceleratorBuilder constructs new acceleratorBuilder
-func NewAcceleratorBuilder(trackingProvider tracking.Provider, clusterName string, defaultTags map[string]string, externalManagedTags []string) acceleratorBuilder {
+func NewAcceleratorBuilder(trackingProvider tracking.Provider, clusterName string, defaultTags map[string]string, externalManagedTags []string, additionalTagsOverrideDefaultTags bool) acceleratorBuilder {
 	externalManagedTagsSet := sets.New(externalManagedTags...)
-	tagHelper := newTagHelper(externalManagedTagsSet, defaultTags)
+	tagHelper := newTagHelper(externalManagedTagsSet, defaultTags, additionalTagsOverrideDefaultTags)
 
 	return &defaultAcceleratorBuilder{
 		trackingProvider: trackingProvider,
@@ -121,7 +121,7 @@ func (b *defaultAcceleratorBuilder) buildAcceleratorIPAddressType(_ context.Cont
 
 func (b *defaultAcceleratorBuilder) buildAcceleratorTags(_ context.Context, stack core.Stack, ga *agaapi.GlobalAccelerator) (map[string]string, error) {
 	// Get tags from tag helper (includes default tags and user-specified tags)
-	tags, err := b.tagHelper.getAcceleratorTags(ga)
+	tags, err := b.tagHelper.getAcceleratorTags(*ga)
 	if err != nil {
 		return nil, err
 	}

pkg/aga/model_build_accelerator_test.go

@@ -329,7 +329,9 @@ func Test_defaultAcceleratorBuilder_buildAcceleratorTags(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			builder := NewAcceleratorBuilder(trackingProvider, tt.clusterName, tt.defaultTags, tt.externalManagedTags)
+			// Use true for "user tags override default tags" test case
+			additionalTagsOverrideDefaultTags := tt.name == "user tags override default tags"
+			builder := NewAcceleratorBuilder(trackingProvider, tt.clusterName, tt.defaultTags, tt.externalManagedTags, additionalTagsOverrideDefaultTags)
 			b := builder.(*defaultAcceleratorBuilder)
 
 			stack := core.NewDefaultStack(core.StackID{Namespace: "test", Name: "test"})
@@ -495,7 +497,7 @@ func Test_defaultAcceleratorBuilder_Build(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			builder := NewAcceleratorBuilder(trackingProvider, tt.clusterName, tt.defaultTags, tt.externalManagedTags)
+			builder := NewAcceleratorBuilder(trackingProvider, tt.clusterName, tt.defaultTags, tt.externalManagedTags, false)
 
 			got, err := builder.Build(context.Background(), stack, tt.ga)
 

pkg/aga/model_builder.go

@@ -58,7 +58,7 @@ func (b *defaultModelBuilder) Build(ctx context.Context, ga *agaapi.GlobalAccele
 	stack := core.NewDefaultStack(core.StackID(k8s.NamespacedName(ga)))
 
 	// Create fresh builder instances for each reconciliation
-	acceleratorBuilder := NewAcceleratorBuilder(b.trackingProvider, b.clusterName, b.defaultTags, b.externalManagedTags)
+	acceleratorBuilder := NewAcceleratorBuilder(b.trackingProvider, b.clusterName, b.defaultTags, b.externalManagedTags, b.featureGates.Enabled(config.EnableDefaultTagsLowPriority))
 	// TODO
 	// listenerBuilder := NewListenerBuilder()
 	// endpointGroupBuilder := NewEndpointGroupBuilder()

pkg/aga/tag_adapters.go

@@ -0,0 +1,21 @@
+package aga
+
+import (
+	agaapi "sigs.k8s.io/aws-load-balancer-controller/apis/aga/v1beta1"
+	"sigs.k8s.io/aws-load-balancer-controller/pkg/shared_utils"
+)
+
+// GlobalAcceleratorTagProvider adapts GlobalAccelerator to implement TagProvider
+type GlobalAcceleratorTagProvider struct {
+	ga agaapi.GlobalAccelerator
+}
+
+// NewGlobalAcceleratorTagProvider creates a new GlobalAcceleratorTagProvider
+func NewGlobalAcceleratorTagProvider(ga agaapi.GlobalAccelerator) shared_utils.TagProvider {
+	return &GlobalAcceleratorTagProvider{ga: ga}
+}
+
+// GetTags returns the tags from the GlobalAccelerator spec
+func (g GlobalAcceleratorTagProvider) GetTags() *map[string]string {
+	return g.ga.Spec.Tags
+}

pkg/aga/tag_helper.go

@@ -1,49 +1,31 @@
 package aga
 
 import (
-	"github.com/pkg/errors"
 	"k8s.io/apimachinery/pkg/util/sets"
 	agaapi "sigs.k8s.io/aws-load-balancer-controller/apis/aga/v1beta1"
-	"sigs.k8s.io/aws-load-balancer-controller/pkg/algorithm"
+	"sigs.k8s.io/aws-load-balancer-controller/pkg/shared_utils"
 )
 
 type tagHelper interface {
-	getAcceleratorTags(ga *agaapi.GlobalAccelerator) (map[string]string, error)
+	getAcceleratorTags(ga agaapi.GlobalAccelerator) (map[string]string, error)
 }
 
 type tagHelperImpl struct {
-	externalManagedTags sets.Set[string]
-	defaultTags         map[string]string
+	sharedHelper shared_utils.TagHelper
 }
 
-func newTagHelper(externalManagedTags sets.Set[string], defaultTags map[string]string) tagHelper {
-	return &tagHelperImpl{
-		externalManagedTags: externalManagedTags,
-		defaultTags:         defaultTags,
-	}
-}
-
-func (t *tagHelperImpl) getAcceleratorTags(ga *agaapi.GlobalAccelerator) (map[string]string, error) {
-	gaTags := make(map[string]string)
-
-	if ga.Spec.Tags != nil {
-		for k, v := range *ga.Spec.Tags {
-			gaTags[k] = v
-		}
+func newTagHelper(externalManagedTags sets.Set[string], defaultTags map[string]string, additionalTagsOverrideDefaultTags bool) tagHelper {
+	config := shared_utils.TagHelperConfig{
+		ExternalManagedTags:               externalManagedTags,
+		DefaultTags:                       defaultTags,
+		AdditionalTagsOverrideDefaultTags: additionalTagsOverrideDefaultTags,
 	}
-
-	if err := t.validateTagCollisionWithExternalManagedTags(gaTags); err != nil {
-		return nil, err
+	return &tagHelperImpl{
+		sharedHelper: shared_utils.NewTagHelper(config),
 	}
-
-	return algorithm.MergeStringMap(gaTags, t.defaultTags), nil
 }
 
-func (t *tagHelperImpl) validateTagCollisionWithExternalManagedTags(tags map[string]string) error {
-	for tagKey := range tags {
-		if t.externalManagedTags.Has(tagKey) {
-			return errors.Errorf("external managed tag key %v cannot be specified", tagKey)
-		}
-	}
-	return nil
+func (t *tagHelperImpl) getAcceleratorTags(ga agaapi.GlobalAccelerator) (map[string]string, error) {
+	provider := NewGlobalAcceleratorTagProvider(ga)
+	return t.sharedHelper.ProcessTags(provider)
 }