Use valid UUIDs for Korifi resources guids

* Do not prefix uuids for orgs, spaces and routes
* Use uuidv5 for CFProcess guids for optimistic locking. The app GUID is
  used as a UUID namespace, the process type is used as name
* Document the decision in an ADR

fixes #2330, #2177

Co-authored-by: Danail Branekov <[email protected]>

Author: georgethebeatle

api/repositories/app_repository.go

@@ -36,8 +36,6 @@ const (
 	StartedState DesiredState = "STARTED"
 	StoppedState DesiredState = "STOPPED"
 
-	Kind               string = "CFApp"
-	APIVersion         string = "korifi.cloudfoundry.org/v1alpha1"
 	CFAppGUIDLabel     string = "korifi.cloudfoundry.org/app-guid"
 	AppResourceType    string = "App"
 	AppEnvResourceType string = "App Env"
@@ -292,7 +290,7 @@ func (f *AppRepo) CreateApp(ctx context.Context, authInfo authorization.Info, ap
 
 	envSecret := &corev1.Secret{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      GenerateEnvSecretName(cfApp.Name),
+			Name:      cfApp.Spec.EnvSecretName,
 			Namespace: cfApp.Namespace,
 			Labels: map[string]string{
 				CFAppGUIDLabel: cfApp.Name,
@@ -388,16 +386,27 @@ func (f *AppRepo) ListApps(ctx context.Context, authInfo authorization.Info, mes
 }
 
 func (f *AppRepo) PatchAppEnvVars(ctx context.Context, authInfo authorization.Info, message PatchAppEnvVarsMessage) (AppEnvVarsRecord, error) {
-	secretObj := corev1.Secret{
+	userClient, err := f.userClientFactory.BuildClient(authInfo)
+	if err != nil {
+		return AppEnvVarsRecord{}, fmt.Errorf("failed to build user client: %w", err)
+	}
+
+	cfApp := &korifiv1alpha1.CFApp{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      GenerateEnvSecretName(message.AppGUID),
 			Namespace: message.SpaceGUID,
+			Name:      message.AppGUID,
 		},
 	}
-
-	userClient, err := f.userClientFactory.BuildClient(authInfo)
+	err = userClient.Get(ctx, client.ObjectKeyFromObject(cfApp), cfApp)
 	if err != nil {
-		return AppEnvVarsRecord{}, fmt.Errorf("failed to build user client: %w", err)
+		return AppEnvVarsRecord{}, apierrors.FromK8sError(err, AppEnvResourceType)
+	}
+
+	secretObj := corev1.Secret{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      cfApp.Spec.EnvSecretName,
+			Namespace: message.SpaceGUID,
+		},
 	}
 
 	err = PatchResource(ctx, userClient, &secretObj, func() {
@@ -617,23 +626,18 @@ func getAppEnv(ctx context.Context, userClient client.Client, app AppRecord) (ma
 	return appEnvMap, nil
 }
 
-func GenerateEnvSecretName(appGUID string) string {
-	return appGUID + "-env"
-}
-
 func (m *CreateAppMessage) toCFApp() korifiv1alpha1.CFApp {
-	guid := uuid.NewString()
 	return korifiv1alpha1.CFApp{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:        guid,
+			Name:        uuid.NewString(),
 			Namespace:   m.SpaceGUID,
 			Labels:      m.Labels,
 			Annotations: m.Annotations,
 		},
 		Spec: korifiv1alpha1.CFAppSpec{
 			DisplayName:   m.Name,
 			DesiredState:  korifiv1alpha1.AppState(m.State),
-			EnvSecretName: GenerateEnvSecretName(guid),
+			EnvSecretName: uuid.NewString(),
 			Lifecycle: korifiv1alpha1.Lifecycle{
 				Type: korifiv1alpha1.LifecycleType(m.Lifecycle.Type),
 				Data: korifiv1alpha1.LifecycleData{

api/repositories/app_repository_test.go

@@ -742,21 +742,18 @@ var _ = Describe("AppRepository", func() {
 		)
 
 		var (
-			envSecretName string
-			secretRecord  repositories.AppEnvVarsRecord
-			patchErr      error
+			secretRecord repositories.AppEnvVarsRecord
+			patchErr     error
 		)
 
 		BeforeEach(func() {
-			envSecretName = cfApp.Name + "-env"
-
 			envVars := map[string]string{
 				key0: "VAL0",
 				key1: "original-value",
 			}
 			secret := corev1.Secret{
 				ObjectMeta: metav1.ObjectMeta{
-					Name:      repositories.GenerateEnvSecretName(cfApp.Name),
+					Name:      cfApp.Spec.EnvSecretName,
 					Namespace: cfSpace.Name,
 				},
 				StringData: envVars,
@@ -796,13 +793,16 @@ var _ = Describe("AppRepository", func() {
 			})
 
 			It("patches the underlying secret", func() {
-				cfAppSecretLookupKey := types.NamespacedName{Name: envSecretName, Namespace: cfSpace.Name}
-
-				var updatedSecret corev1.Secret
-				err := k8sClient.Get(ctx, cfAppSecretLookupKey, &updatedSecret)
+				envSecret := corev1.Secret{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      cfApp.Spec.EnvSecretName,
+						Namespace: cfSpace.Name,
+					},
+				}
+				err := k8sClient.Get(ctx, client.ObjectKeyFromObject(&envSecret), &envSecret)
 				Expect(err).NotTo(HaveOccurred())
 
-				Expect(asMapOfStrings(updatedSecret.Data)).To(SatisfyAll(
+				Expect(asMapOfStrings(envSecret.Data)).To(SatisfyAll(
 					HaveLen(2),
 					HaveKeyWithValue(key0, "VAL0"),
 					HaveKeyWithValue(key2, "VAL2"),

api/repositories/build_repository.go

@@ -197,10 +197,9 @@ type CreateBuildMessage struct {
 }
 
 func (m CreateBuildMessage) toCFBuild() korifiv1alpha1.CFBuild {
-	guid := uuid.NewString()
 	return korifiv1alpha1.CFBuild{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:        guid,
+			Name:        uuid.NewString(),
 			Namespace:   m.SpaceGUID,
 			Labels:      m.Labels,
 			Annotations: m.Annotations,

api/repositories/build_repository_test.go

@@ -479,7 +479,7 @@ var _ = Describe("BuildRepository", func() {
 				It("returns correct build record", func() {
 					Expect(buildCreateErr).NotTo(HaveOccurred())
 
-					Expect(buildCreateRecord.GUID).NotTo(BeEmpty())
+					Expect(buildCreateRecord.GUID).To(matchers.BeValidUUID())
 					Expect(buildCreateRecord.Lifecycle.Type).To(Equal("docker"))
 					Expect(buildCreateRecord.Lifecycle.Data).To(Equal(repositories.LifecycleData{}))
 				})

api/repositories/domain_repository_test.go

@@ -122,7 +122,7 @@ var _ = Describe("DomainRepository", func() {
 				Expect(createErr).NotTo(HaveOccurred())
 
 				createdDomainGUID := createdDomain.GUID
-				Expect(createdDomainGUID).NotTo(BeEmpty())
+				Expect(createdDomainGUID).To(matchers.BeValidUUID())
 				Expect(createdDomain.Name).To(Equal("my.domain"))
 				Expect(createdDomain.Labels).To(HaveKeyWithValue("foo", "bar"))
 				Expect(createdDomain.Annotations).To(HaveKeyWithValue("bar", "baz"))

api/repositories/org_repository.go

@@ -21,7 +21,6 @@ import (
 )
 
 const (
-	OrgPrefix       = "cf-org-"
 	OrgResourceType = "Org"
 )
 
@@ -95,7 +94,7 @@ func (r *OrgRepo) CreateOrg(ctx context.Context, info authorization.Info, messag
 
 	cfOrg := &korifiv1alpha1.CFOrg{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:        OrgPrefix + uuid.NewString(),
+			Name:        uuid.NewString(),
 			Namespace:   r.rootNamespace,
 			Labels:      message.Labels,
 			Annotations: message.Annotations,

api/repositories/org_repository_test.go

@@ -109,7 +109,7 @@ var _ = Describe("OrgRepository", func() {
 				Expect(createErr).NotTo(HaveOccurred())
 
 				Expect(orgRecord.Name).To(Equal(orgGUID))
-				Expect(orgRecord.GUID).To(HavePrefix("cf-org-"))
+				Expect(orgRecord.GUID).To(matchers.BeValidUUID())
 				Expect(orgRecord.CreatedAt).To(BeTemporally("~", time.Now(), timeCheckThreshold))
 				Expect(orgRecord.UpdatedAt).To(PointTo(BeTemporally("~", time.Now(), timeCheckThreshold)))
 				Expect(orgRecord.DeletedAt).To(BeNil())

api/repositories/package_repository.go

@@ -172,14 +172,13 @@ type PackageData struct {
 }
 
 func (message CreatePackageMessage) toCFPackage() *korifiv1alpha1.CFPackage {
-	packageGUID := uuid.NewString()
 	pkg := &korifiv1alpha1.CFPackage{
 		TypeMeta: metav1.TypeMeta{
 			Kind:       kind,
 			APIVersion: korifiv1alpha1.SchemeGroupVersion.Identifier(),
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name:        packageGUID,
+			Name:        uuid.NewString(),
 			Namespace:   message.SpaceGUID,
 			Labels:      message.Metadata.Labels,
 			Annotations: message.Metadata.Annotations,

api/repositories/package_repository_test.go

@@ -152,7 +152,7 @@ var _ = Describe("PackageRepository", func() {
 					Expect(createErr).NotTo(HaveOccurred())
 
 					packageGUID := createdPackage.GUID
-					Expect(packageGUID).NotTo(BeEmpty())
+					Expect(packageGUID).To(matchers.BeValidUUID())
 					Expect(createdPackage.Type).To(Equal("bits"))
 					Expect(createdPackage.AppGUID).To(Equal(appGUID))
 					Expect(createdPackage.State).To(Equal("AWAITING_UPLOAD"))
@@ -244,7 +244,7 @@ var _ = Describe("PackageRepository", func() {
 					Expect(createErr).NotTo(HaveOccurred())
 
 					packageGUID := createdPackage.GUID
-					Expect(packageGUID).NotTo(BeEmpty())
+					Expect(packageGUID).To(matchers.BeValidUUID())
 					Expect(createdPackage.Type).To(Equal("docker"))
 					Expect(createdPackage.AppGUID).To(Equal(appGUID))
 					Expect(createdPackage.Labels).To(HaveKeyWithValue("bob", "foo"))

api/repositories/process_repository.go

@@ -217,6 +217,7 @@ func (r *ProcessRepo) CreateProcess(ctx context.Context, authInfo authorization.
 	process := &korifiv1alpha1.CFProcess{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: message.SpaceGUID,
+			Name:      tools.NamespacedUUID(message.AppGUID, message.Type),
 		},
 		Spec: korifiv1alpha1.CFProcessSpec{
 			AppRef:      corev1.LocalObjectReference{Name: message.AppGUID},
@@ -231,7 +232,6 @@ func (r *ProcessRepo) CreateProcess(ctx context.Context, authInfo authorization.
 			DiskQuotaMB:      message.DiskQuotaMB,
 		},
 	}
-	process.SetStableName(message.AppGUID)
 	err = userClient.Create(ctx, process)
 	return apierrors.FromK8sError(err, ProcessResourceType)
 }