Merge pull request #1851 from deads2k/apply-16-add-generate-name-for-…

…mutation API-1835: add generateName for mutation: came up on CSRs
openshift · Oct 23, 2024 · e59f1b6 · e59f1b6
2 parents abb8c75 + 698f089
commit e59f1b6
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 15 deletions.
diff --git a/pkg/manifestclient/mutation_directory_reader.go b/pkg/manifestclient/mutation_directory_reader.go
@@ -159,10 +159,11 @@ func serializedRequestFromFile(action Action, actionFS fs.FS, bodyFilename strin
 				Version:  versionName,
 				Resource: resourceName,
 			},
-			KindType:  retObj.(*unstructured.Unstructured).GroupVersionKind(),
-			Namespace: retObj.(*unstructured.Unstructured).GetNamespace(),
-			Name:      metadataName,
-			Body:      bodyContent,
+			KindType:     retObj.(*unstructured.Unstructured).GroupVersionKind(),
+			Namespace:    retObj.(*unstructured.Unstructured).GetNamespace(),
+			Name:         metadataName,
+			GenerateName: retObj.(*unstructured.Unstructured).GetGenerateName(),
+			Body:         bodyContent,
 		},
 	}
 	if optionsExist {

diff --git a/pkg/manifestclient/mutation_tracker.go b/pkg/manifestclient/mutation_tracker.go
@@ -35,10 +35,11 @@ type AllActionsTracker[T SerializedRequestish] struct {
 }
 
 type ActionMetadata struct {
-	Action    Action
-	GVR       schema.GroupVersionResource
-	Namespace string
-	Name      string
+	Action       Action
+	GVR          schema.GroupVersionResource
+	Namespace    string
+	Name         string
+	GenerateName string
 }
 
 type actionTracker[T SerializedRequestish] struct {

diff --git a/pkg/manifestclient/serialized_request.go b/pkg/manifestclient/serialized_request.go
@@ -34,6 +34,7 @@ type SerializedRequest struct {
 	KindType     schema.GroupVersionKind
 	Namespace    string
 	Name         string
+	GenerateName string
 
 	Options []byte
 	Body    []byte
@@ -206,6 +207,9 @@ func CompareSerializedRequest(lhs, rhs *SerializedRequest) int {
 	if cmp := strings.Compare(lhs.Name, rhs.Name); cmp != 0 {
 		return cmp
 	}
+	if cmp := strings.Compare(lhs.GenerateName, rhs.GenerateName); cmp != 0 {
+		return cmp
+	}
 
 	if cmp := bytes.Compare(lhs.Body, rhs.Body); cmp != 0 {
 		return cmp
@@ -262,7 +266,7 @@ func suggestedFilenames(a SerializedRequest, uniqueNumber int) (string, string)
 			scopingString,
 			groupName,
 			a.ResourceType.Resource,
-			fmt.Sprintf("%03d-body-%s.yaml", uniqueNumber, a.Name),
+			fmt.Sprintf("%03d-body-%s%s.yaml", uniqueNumber, a.Name, a.GenerateName),
 		),
 	)
 	optionsFilename := ""
@@ -273,7 +277,7 @@ func suggestedFilenames(a SerializedRequest, uniqueNumber int) (string, string)
 				scopingString,
 				groupName,
 				a.ResourceType.Resource,
-				fmt.Sprintf("%03d-options-%s.yaml", uniqueNumber, a.Name),
+				fmt.Sprintf("%03d-options-%s%s.yaml", uniqueNumber, a.Name, a.GenerateName),
 			),
 		)
 	}
@@ -302,20 +306,22 @@ func (a SerializedRequest) DeepCopy() SerializedRequestish {
 		KindType:     a.KindType,
 		Namespace:    a.Namespace,
 		Name:         a.Name,
+		GenerateName: a.GenerateName,
 		Options:      bytes.Clone(a.Options),
 		Body:         bytes.Clone(a.Body),
 	}
 }
 
 func (a SerializedRequest) StringID() string {
-	return fmt.Sprintf("%s-%s.%s.%s/%s[%s]", a.Action, a.KindType.Kind, a.KindType.Version, a.KindType.Group, a.Name, a.Namespace)
+	return fmt.Sprintf("%s-%s.%s.%s/%s%s[%s]", a.Action, a.KindType.Kind, a.KindType.Version, a.KindType.Group, a.Name, a.GenerateName, a.Namespace)
 }
 
 func (a SerializedRequest) GetLookupMetadata() ActionMetadata {
 	return ActionMetadata{
-		Action:    a.Action,
-		GVR:       a.ResourceType,
-		Namespace: a.Namespace,
-		Name:      a.Name,
+		Action:       a.Action,
+		GVR:          a.ResourceType,
+		Namespace:    a.Namespace,
+		Name:         a.Name,
+		GenerateName: a.GenerateName,
 	}
 }
diff --git a/pkg/manifestclient/serialized_request_test.go b/pkg/manifestclient/serialized_request_test.go
@@ -84,6 +84,88 @@ func TestDifferenceOfSerializedRequests(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "diff in generateName",
+			args: args{
+				lhs: []FileOriginatedSerializedRequest{
+					{
+						BodyFilename:    "foo.yaml",
+						OptionsFilename: "foo-options.yaml",
+						SerializedRequest: SerializedRequest{
+							Namespace:    "foo-ns",
+							GenerateName: "bar-",
+							Options:      nil,
+							Body:         []byte("content"),
+						},
+					},
+				},
+				rhs: []TrackedSerializedRequest{
+					{
+						RequestNumber: 6,
+						SerializedRequest: SerializedRequest{
+							Namespace: "foo-ns",
+							Name:      "bar",
+							Options:   nil,
+							Body:      []byte("content"),
+						},
+					},
+				},
+			},
+			want: []FileOriginatedSerializedRequest{
+				{
+					BodyFilename:    "foo.yaml",
+					OptionsFilename: "foo-options.yaml",
+					SerializedRequest: SerializedRequest{
+						Namespace:    "foo-ns",
+						GenerateName: "bar-",
+						Options:      nil,
+						Body:         []byte("content"),
+					},
+				},
+			},
+		},
+		{
+			name: "diff in generateName with same name",
+			args: args{
+				lhs: []FileOriginatedSerializedRequest{
+					{
+						BodyFilename:    "foo.yaml",
+						OptionsFilename: "foo-options.yaml",
+						SerializedRequest: SerializedRequest{
+							Namespace:    "foo-ns",
+							Name:         "bar-2", // this happens on updates for instance
+							GenerateName: "bar-",
+							Options:      nil,
+							Body:         []byte("content"),
+						},
+					},
+				},
+				rhs: []TrackedSerializedRequest{
+					{
+						RequestNumber: 6,
+						SerializedRequest: SerializedRequest{
+							Namespace: "foo-ns",
+							Name:      "bar-2",
+							Options:   nil,
+							Body:      []byte("content"),
+						},
+					},
+				},
+			},
+			want: []FileOriginatedSerializedRequest{
+				{
+					BodyFilename:    "foo.yaml",
+					OptionsFilename: "foo-options.yaml",
+					SerializedRequest: SerializedRequest{
+						Namespace:    "foo-ns",
+						Name:         "bar-2", // this happens on updates for instance
+						GenerateName: "bar-",
+						Options:      nil,
+						Body:         []byte("content"),
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

diff --git a/pkg/manifestclient/write_roundtripper.go b/pkg/manifestclient/write_roundtripper.go
@@ -168,6 +168,7 @@ func (mrt *writeTrackingRoundTripper) roundTrip(req *http.Request) ([]byte, erro
 		KindType:     bodyObj.GetObjectKind().GroupVersionKind(),
 		Namespace:    requestInfo.Namespace,
 		Name:         metadataName,
+		GenerateName: bodyObj.(*unstructured.Unstructured).GetGenerateName(),
 		Options:      optionsBytes,
 		Body:         bodyYAMLBytes,
 	}