4243 fix cf rename space (#4250)

* Add support for patching space name

* Adjust tests after review

Author: benjaminguttmann-avtq

api/handlers/fake/cfspace_repository.go

@@ -31,7 +31,7 @@ type CFSpaceRepository interface {
 	ListSpaces(context.Context, authorization.Info, repositories.ListSpacesMessage) (repositories.ListResult[repositories.SpaceRecord], error)
 	GetSpace(context.Context, authorization.Info, string) (repositories.SpaceRecord, error)
 	DeleteSpace(context.Context, authorization.Info, repositories.DeleteSpaceMessage) error
-	PatchSpaceMetadata(context.Context, authorization.Info, repositories.PatchSpaceMetadataMessage) (repositories.SpaceRecord, error)
+	PatchSpace(context.Context, authorization.Info, repositories.PatchSpaceMessage) (repositories.SpaceRecord, error)
 	GetDeletedAt(context.Context, authorization.Info, string) (*time.Time, error)
 }
 
@@ -120,7 +120,7 @@ func (h *Space) update(r *http.Request) (*routing.Response, error) {
 		return nil, apierrors.LogAndReturn(logger, err, "failed to decode payload")
 	}
 
-	space, err = h.spaceRepo.PatchSpaceMetadata(r.Context(), authInfo, payload.ToMessage(spaceGUID, space.OrganizationGUID))
+	space, err = h.spaceRepo.PatchSpace(r.Context(), authInfo, payload.ToMessage(spaceGUID, space.OrganizationGUID))
 	if err != nil {
 		return nil, apierrors.LogAndReturn(logger, err, "Failed to patch space metadata", "GUID", spaceGUID)
 	}

api/handlers/space.go

@@ -328,13 +328,15 @@ var _ = Describe("Space", func() {
 			requestMethod = http.MethodPatch
 			requestPath += "/the-space-guid"
 
-			spaceRepo.PatchSpaceMetadataReturns(repositories.SpaceRecord{
-				Name:             "the-space",
+			newSpaceName := tools.PtrTo("new-space-name")
+			spaceRepo.PatchSpaceReturns(repositories.SpaceRecord{
+				Name:             *newSpaceName,
 				GUID:             "the-space-guid",
 				OrganizationGUID: "the-org-guid",
 			}, nil)
 
 			requestValidator.DecodeAndValidateJSONPayloadStub = decodeAndValidatePayloadStub(&payloads.SpacePatch{
+				Name: newSpaceName,
 				Metadata: payloads.MetadataPatch{
 					Annotations: map[string]*string{
 						"hello":                       tools.PtrTo("there"),
@@ -353,9 +355,10 @@ var _ = Describe("Space", func() {
 			actualReq, _ := requestValidator.DecodeAndValidateJSONPayloadArgsForCall(0)
 			Expect(bodyString(actualReq)).To(Equal("the-json-body"))
 
-			Expect(spaceRepo.PatchSpaceMetadataCallCount()).To(Equal(1))
-			_, _, msg := spaceRepo.PatchSpaceMetadataArgsForCall(0)
+			Expect(spaceRepo.PatchSpaceCallCount()).To(Equal(1))
+			_, _, msg := spaceRepo.PatchSpaceArgsForCall(0)
 			Expect(msg.GUID).To(Equal("the-space-guid"))
+			Expect(msg.Name).To(PointTo(Equal("new-space-name")))
 			Expect(msg.OrgGUID).To(Equal("the-org-guid"))
 			Expect(msg.Annotations).To(HaveKeyWithValue("hello", PointTo(Equal("there"))))
 			Expect(msg.Annotations).To(HaveKeyWithValue("foo.example.com/lorem-ipsum", PointTo(Equal("Lorem ipsum."))))
@@ -366,6 +369,7 @@ var _ = Describe("Space", func() {
 			Expect(rr).To(HaveHTTPHeaderWithValue("Content-Type", "application/json"))
 
 			Expect(rr).To(HaveHTTPBody(SatisfyAll(
+				MatchJSONPath("$.name", "new-space-name"),
 				MatchJSONPath("$.guid", "the-space-guid"),
 				MatchJSONPath("$.links.self.href", "https://api.example.org/v3/spaces/the-space-guid"),
 			)))
@@ -378,7 +382,7 @@ var _ = Describe("Space", func() {
 
 			It("returns a not found error and does not try updating the space", func() {
 				expectNotFoundError(repositories.SpaceResourceType)
-				Expect(spaceRepo.PatchSpaceMetadataCallCount()).To(Equal(0))
+				Expect(spaceRepo.PatchSpaceCallCount()).To(Equal(0))
 			})
 		})
 
@@ -389,13 +393,13 @@ var _ = Describe("Space", func() {
 
 			It("returns an error and does not try updating the space", func() {
 				expectUnknownError()
-				Expect(spaceRepo.PatchSpaceMetadataCallCount()).To(Equal(0))
+				Expect(spaceRepo.PatchSpaceCallCount()).To(Equal(0))
 			})
 		})
 
 		When("patching the org errors", func() {
 			BeforeEach(func() {
-				spaceRepo.PatchSpaceMetadataReturns(repositories.SpaceRecord{}, errors.New("boom"))
+				spaceRepo.PatchSpaceReturns(repositories.SpaceRecord{}, errors.New("boom"))
 			})
 
 			It("returns an error", func() {

api/handlers/space_test.go

@@ -42,19 +42,22 @@ func (r SpaceRelationships) Validate() error {
 }
 
 type SpacePatch struct {
+	Name     *string       `json:"name"`
 	Metadata MetadataPatch `json:"metadata"`
 }
 
 func (p SpacePatch) Validate() error {
 	return jellidation.ValidateStruct(&p,
 		jellidation.Field(&p.Metadata),
+		jellidation.Field(&p.Name, jellidation.NilOrNotEmpty),
 	)
 }
 
-func (p SpacePatch) ToMessage(spaceGUID, orgGUID string) repositories.PatchSpaceMetadataMessage {
-	return repositories.PatchSpaceMetadataMessage{
+func (p SpacePatch) ToMessage(spaceGUID, orgGUID string) repositories.PatchSpaceMessage {
+	return repositories.PatchSpaceMessage{
 		GUID:    spaceGUID,
 		OrgGUID: orgGUID,
+		Name:    p.Name,
 		MetadataPatch: repositories.MetadataPatch{
 			Labels:      p.Metadata.Labels,
 			Annotations: p.Metadata.Annotations,

api/payloads/space.go

@@ -103,6 +103,7 @@ var _ = Describe("Space", func() {
 
 		BeforeEach(func() {
 			payload = payloads.SpacePatch{
+				Name: tools.PtrTo("new-space-name"),
 				Metadata: payloads.MetadataPatch{
 					Annotations: map[string]*string{
 						"foo": tools.PtrTo("bar"),
@@ -137,6 +138,18 @@ var _ = Describe("Space", func() {
 				)
 			})
 		})
+		When("the name is invalid", func() {
+			BeforeEach(func() {
+				payload.Name = tools.PtrTo("")
+			})
+
+			It("returns an unprocessable entity error", func() {
+				expectUnprocessableEntityError(
+					validatorErr,
+					"name cannot be blank",
+				)
+			})
+		})
 	})
 
 	Describe("SpaceList", func() {

api/payloads/space_test.go

@@ -56,10 +56,18 @@ type DeleteSpaceMessage struct {
 	OrganizationGUID string
 }
 
-type PatchSpaceMetadataMessage struct {
+type PatchSpaceMessage struct {
 	MetadataPatch
 	GUID    string
 	OrgGUID string
+	Name    *string
+}
+
+func (p *PatchSpaceMessage) Apply(space *korifiv1alpha1.CFSpace) {
+	if p.Name != nil {
+		space.Spec.DisplayName = *p.Name
+	}
+	p.MetadataPatch.Apply(space)
 }
 
 type SpaceRecord struct {
@@ -212,7 +220,7 @@ func (r *SpaceRepo) DeleteSpace(ctx context.Context, info authorization.Info, me
 	return apierrors.FromK8sError(err, SpaceResourceType)
 }
 
-func (r *SpaceRepo) PatchSpaceMetadata(ctx context.Context, authInfo authorization.Info, message PatchSpaceMetadataMessage) (SpaceRecord, error) {
+func (r *SpaceRepo) PatchSpace(ctx context.Context, authInfo authorization.Info, message PatchSpaceMessage) (SpaceRecord, error) {
 	cfSpace := &korifiv1alpha1.CFSpace{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: message.OrgGUID,

api/repositories/space_repository.go

@@ -15,6 +15,7 @@ import (
 	"code.cloudfoundry.org/korifi/tools"
 	"code.cloudfoundry.org/korifi/tools/k8s"
 
+	"github.com/google/uuid"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	. "github.com/onsi/gomega/gstruct"
@@ -446,9 +447,11 @@ var _ = Describe("SpaceRepository", func() {
 		})
 	})
 
-	Describe("PatchSpaceMetadata", func() {
+	Describe("PatchSpace", func() {
 		var (
 			spaceGUID                     string
+			displayName                   string
+			spaceNewName                  *string
 			orgGUID                       string
 			cfSpace                       *korifiv1alpha1.CFSpace
 			cfOrg                         *korifiv1alpha1.CFOrg
@@ -460,23 +463,26 @@ var _ = Describe("SpaceRepository", func() {
 		BeforeEach(func() {
 			cfOrg = createOrgWithCleanup(ctx, prefixedGUID("org"))
 			orgGUID = cfOrg.Name
-			cfSpace = createSpaceWithCleanup(ctx, cfOrg.Name, "the-space")
+			displayName = uuid.NewString()
+			cfSpace = createSpaceWithCleanup(ctx, cfOrg.Name, displayName)
 			spaceGUID = cfSpace.Name
 			labelsPatch = nil
 			annotationsPatch = nil
+			spaceNewName = tools.PtrTo(uuid.NewString())
 		})
 
 		JustBeforeEach(func() {
-			patchMsg := repositories.PatchSpaceMetadataMessage{
+			patchMsg := repositories.PatchSpaceMessage{
 				GUID:    spaceGUID,
 				OrgGUID: orgGUID,
+				Name:    spaceNewName,
 				MetadataPatch: repositories.MetadataPatch{
 					Annotations: annotationsPatch,
 					Labels:      labelsPatch,
 				},
 			}
 
-			spaceRecord, patchErr = spaceRepo.PatchSpaceMetadata(ctx, authInfo, patchMsg)
+			spaceRecord, patchErr = spaceRepo.PatchSpace(ctx, authInfo, patchMsg)
 		})
 
 		When("the user is authorized and the space exists", func() {
@@ -514,6 +520,7 @@ var _ = Describe("SpaceRepository", func() {
 							"key-two": "value-two",
 						},
 					))
+					Expect(spaceRecord.Name).To(Equal(*spaceNewName))
 				})
 
 				It("sets the k8s CFSpace resource", func() {
@@ -530,6 +537,7 @@ var _ = Describe("SpaceRepository", func() {
 							"key-two": "value-two",
 						},
 					))
+					Expect(updatedCFSpace.Spec.DisplayName).To(Equal(*spaceNewName))
 				})
 			})
 
@@ -576,6 +584,7 @@ var _ = Describe("SpaceRepository", func() {
 							"key-two":        "value-two",
 						},
 					))
+					Expect(spaceRecord.Name).To(Equal(*spaceNewName))
 				})
 
 				It("sets the k8s CFSpace resource", func() {
@@ -594,6 +603,7 @@ var _ = Describe("SpaceRepository", func() {
 							"key-two":        "value-two",
 						},
 					))
+					Expect(spaceRecord.Name).To(Equal(*spaceNewName))
 				})
 			})
 
@@ -632,6 +642,17 @@ var _ = Describe("SpaceRepository", func() {
 					))
 				})
 			})
+
+			When("the name is nil", func() {
+				BeforeEach(func() {
+					spaceNewName = nil
+				})
+
+				It("space display name remains unchanged", func() {
+					Expect(patchErr).NotTo(HaveOccurred())
+					Expect(spaceRecord.Name).To(Equal(displayName))
+				})
+			})
 		})
 
 		When("the user is authorized but the Space does not exist", func() {