add lookup tag

pkg/dump/dump.go

@@ -28,6 +28,10 @@ type Config struct {
 	// tags.
 	SelectorTags []string
 
+	// LookUpSelectorTagsConsumers can be used to lookup entities using other
+	// tags.
+	LookUpSelectorTagsConsumers []string
+
 	// KonnectControlPlane
 	KonnectControlPlane string
 
@@ -93,6 +97,25 @@ func getConsumerConfiguration(ctx context.Context, group *errgroup.Group,
 		if err != nil {
 			return fmt.Errorf("consumers: %w", err)
 		}
+		if config.LookUpSelectorTagsConsumers != nil {
+			globalConsumers, err := GetAllConsumers(ctx, client, config.LookUpSelectorTagsConsumers)
+			if err != nil {
+				return fmt.Errorf("error retrieving global consumers: %w", err)
+			}
+			// if globalConsumers are not present, add them.
+			for _, globalConsumer := range globalConsumers {
+				found := false
+				for _, consumer := range consumers {
+					if *globalConsumer.ID == *consumer.ID {
+						found = true
+						break
+					}
+				}
+				if !found {
+					consumers = append(consumers, globalConsumer)
+				}
+			}
+		}
 		state.Consumers = consumers
 		return nil
 	})

pkg/file/builder.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"reflect"
+	"sort"
 
 	"github.com/blang/semver/v4"
 	"github.com/kong/go-database-reconciler/pkg/konnect"
@@ -22,9 +24,10 @@ type stateBuilder struct {
 	defaulter       *utils.Defaulter
 	kongVersion     semver.Version
 
-	selectTags   []string
-	skipCACerts  bool
-	intermediate *state.KongState
+	selectTags          []string
+	lookupTagsConsumers []string
+	skipCACerts         bool
+	intermediate        *state.KongState
 
 	client *kong.Client
 	ctx    context.Context
@@ -321,7 +324,22 @@ func (b *stateBuilder) consumers() {
 				c.ID = kong.String(*consumer.ID)
 			}
 		}
-		utils.MustMergeTags(&c.Consumer, b.selectTags)
+
+		stringTags := make([]string, len(c.Tags))
+		for i, tag := range c.Tags {
+			if tag != nil {
+				stringTags[i] = *tag
+			}
+		}
+		sort.Strings(stringTags)
+		sort.Strings(b.lookupTagsConsumers)
+		// if the consumer tags and the lookup tags are the same, it means
+		// that the consumer is a global consumer retrieved from upstream,
+		// therefore we don't want to merge its tags with the selected tags.
+		if !reflect.DeepEqual(stringTags, b.lookupTagsConsumers) {
+			utils.MustMergeTags(&c.Consumer, b.selectTags)
+		}
+
 		if consumer != nil {
 			c.Consumer.CreatedAt = consumer.CreatedAt
 		}

pkg/file/kong_json_schema.json

@@ -1217,6 +1217,10 @@
           "$schema": "http://json-schema.org/draft-04/schema#",
           "$ref": "#/definitions/KongDefaults"
         },
+        "default_lookup_tags": {
+          "$schema": "http://json-schema.org/draft-04/schema#",
+          "$ref": "#/definitions/LookUpSelectorTags"
+        },
         "select_tags": {
           "items": {
             "type": "string"
@@ -1338,6 +1342,18 @@
       "additionalProperties": false,
       "type": "object"
     },
+    "LookUpSelectorTags": {
+      "properties": {
+        "consumers": {
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object"
+    },
     "MTLSAuth": {
       "required": [
         "id",

pkg/file/reader.go

@@ -84,6 +84,10 @@ func Get(ctx context.Context, fileContent *Content, opt RenderConfig, dumpConfig
 		builder.selectTags = dumpConfig.SelectorTags
 	}
 
+	if len(dumpConfig.LookUpSelectorTagsConsumers) > 0 {
+		builder.lookupTagsConsumers = dumpConfig.LookUpSelectorTagsConsumers
+	}
+
 	if fileContent.Transform != nil && !*fileContent.Transform {
 		return nil, ErrorTransformFalseNotSupported
 	}

pkg/file/types.go

@@ -597,8 +597,16 @@ type KongDefaults struct {
 // Info contains meta-data of the file.
 // +k8s:deepcopy-gen=true
 type Info struct {
-	SelectorTags []string     `json:"select_tags,omitempty" yaml:"select_tags,omitempty"`
-	Defaults     KongDefaults `json:"defaults,omitempty" yaml:"defaults,omitempty"`
+	SelectorTags       []string            `json:"select_tags,omitempty" yaml:"select_tags,omitempty"`
+	LookUpSelectorTags *LookUpSelectorTags `json:"default_lookup_tags,omitempty" yaml:"default_lookup_tags,omitempty"`
+	Defaults           KongDefaults        `json:"defaults,omitempty" yaml:"defaults,omitempty"`
+}
+
+// LookUpSelectorTags contains tags to lookup
+// for corresponding entities already in Kong.
+// +k8s:deepcopy-gen=true
+type LookUpSelectorTags struct {
+	Consumers []string `json:"consumers,omitempty" yaml:"consumers,omitempty"`
 }
 
 // Konnect contains configuration specific to Konnect.