Disallow rolling upgrades for appworkloads <= v0.7.1

Co-authored-by: Giuseppe Capizzi <gcapizzi@vmware.com>
Co-authored-by: Kieron Browne <kbrowne@vmware.com>

Author: 3 people

api/repositories/deployment_repository.go

@@ -10,6 +10,8 @@ import (
 	korifiv1alpha1 "code.cloudfoundry.org/korifi/controllers/api/v1alpha1"
 	"code.cloudfoundry.org/korifi/controllers/controllers/shared"
 	"code.cloudfoundry.org/korifi/tools/k8s"
+	"code.cloudfoundry.org/korifi/version"
+	"github.com/go-logr/logr"
 
 	"k8s.io/apimachinery/pkg/api/meta"
 	"sigs.k8s.io/controller-runtime/pkg/client"
@@ -101,6 +103,10 @@ func (r *DeploymentRepo) CreateDeployment(ctx context.Context, authInfo authoriz
 		return DeploymentRecord{}, apierrors.FromK8sError(err, DeploymentResourceType)
 	}
 
+	if err = ensureSupport(ctx, userClient, app); err != nil {
+		return DeploymentRecord{}, err
+	}
+
 	dropletGUID := app.Spec.CurrentDropletRef.Name
 	if message.DropletGUID != "" {
 		dropletGUID = message.DropletGUID
@@ -158,3 +164,35 @@ func appToDeploymentRecord(cfApp *korifiv1alpha1.CFApp) DeploymentRecord {
 
 	return deploymentRecord
 }
+
+func ensureSupport(ctx context.Context, userClient client.Client, app *korifiv1alpha1.CFApp) error {
+	log := logr.FromContextOrDiscard(ctx).WithName("repo.deployment.ensureSupport")
+
+	var appWorkloadsList korifiv1alpha1.AppWorkloadList
+	err := userClient.List(ctx, &appWorkloadsList, client.InNamespace(app.Namespace), client.MatchingLabels{
+		korifiv1alpha1.CFAppGUIDLabelKey: app.Name,
+	})
+	if err != nil {
+		return apierrors.FromK8sError(err, DeploymentResourceType)
+	}
+
+	checker := version.NewChecker("v0.7.1")
+	for i := range appWorkloadsList.Items {
+		appWorkload := appWorkloadsList.Items[i]
+		newer, err := checker.ObjectIsNewer(&appWorkload)
+		if newer {
+			continue
+		}
+
+		if err != nil {
+			log.Info("failed comparining version of appWorkload",
+				"ns", appWorkload.Namespace,
+				"name", appWorkload.Name,
+				"version", appWorkload.Annotations[version.KorifiCreationVersionKey],
+			)
+		}
+		return apierrors.NewUnprocessableEntityError(nil, "App instances created with an older version of Korifi can't use the rolling strategy. Please restart/restage/re-push app before using the rolling strategy")
+	}
+
+	return nil
+}

api/repositories/deployment_repository_test.go

@@ -9,10 +9,12 @@ import (
 	"code.cloudfoundry.org/korifi/controllers/controllers/shared"
 	"code.cloudfoundry.org/korifi/tests/matchers"
 	"code.cloudfoundry.org/korifi/tools/k8s"
+	"code.cloudfoundry.org/korifi/version"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	"github.com/google/uuid"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 )
@@ -29,6 +31,18 @@ var _ = Describe("DeploymentRepository", func() {
 		cfOrg = createOrgWithCleanup(ctx, prefixedGUID("org"))
 		cfSpace = createSpaceWithCleanup(ctx, cfOrg.Name, prefixedGUID("space1"))
 		cfApp = createApp(cfSpace.Name)
+		Expect(k8sClient.Create(ctx, &korifiv1alpha1.AppWorkload{
+			ObjectMeta: metav1.ObjectMeta{
+				Namespace: cfApp.Namespace,
+				Name:      uuid.NewString(),
+				Labels: map[string]string{
+					korifiv1alpha1.CFAppGUIDLabelKey: cfApp.Name,
+				},
+				Annotations: map[string]string{
+					version.KorifiCreationVersionKey: "0.7.2",
+				},
+			},
+		})).To(Succeed())
 
 		deploymentRepo = repositories.NewDeploymentRepo(userClientFactory, namespaceRetriever)
 	})
@@ -210,6 +224,24 @@ var _ = Describe("DeploymentRepository", func() {
 					Expect(createErr).To(matchers.WrapErrorAssignableToTypeOf(apierrors.NotFoundError{}))
 				})
 			})
+
+			When("one of the app workloads does not support rolling deployments", func() {
+				BeforeEach(func() {
+					Expect(k8sClient.Create(ctx, &korifiv1alpha1.AppWorkload{
+						ObjectMeta: metav1.ObjectMeta{
+							Namespace: cfApp.Namespace,
+							Name:      uuid.NewString(),
+							Labels: map[string]string{
+								korifiv1alpha1.CFAppGUIDLabelKey: cfApp.Name,
+							},
+						},
+					})).To(Succeed())
+				})
+
+				It("returns an error", func() {
+					Expect(createErr).To(BeAssignableToTypeOf(apierrors.UnprocessableEntityError{}))
+				})
+			})
 		})
 	})
 })

go.mod

@@ -63,7 +63,7 @@ require (
 	github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
 	github.com/Azure/go-autorest/logger v0.2.1 // indirect
 	github.com/Azure/go-autorest/tracing v0.6.0 // indirect
-	github.com/Masterminds/semver/v3 v3.2.0 // indirect
+	github.com/Masterminds/semver/v3 v3.2.0
 	github.com/PaesslerAG/gval v1.0.0 // indirect
 	github.com/aws/aws-sdk-go-v2 v1.18.0 // indirect
 	github.com/aws/aws-sdk-go-v2/credentials v1.13.24 // indirect

helm/korifi/controllers/cf_roles/cf_admin.yaml

@@ -160,6 +160,13 @@ rules:
   - patch
   - watch
 
+- apiGroups:
+  - korifi.cloudfoundry.org
+  resources:
+  - appworkloads
+  verbs:
+  - list
+
 - apiGroups:
     - korifi.cloudfoundry.org
   resources:

helm/korifi/controllers/cf_roles/cf_space_developer.yaml

@@ -46,6 +46,13 @@ rules:
   - list
   - watch
 
+- apiGroups:
+  - korifi.cloudfoundry.org
+  resources:
+  - appworkloads
+  verbs:
+  - list
+
 - apiGroups:
   - korifi.cloudfoundry.org
   resources:

version/version.go

@@ -1,7 +1,30 @@
 package version
 
+import (
+	"github.com/Masterminds/semver/v3"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
 const KorifiCreationVersionKey = "korifi.cloudfoundry.org/creation-version"
 
 // version is overwritten at compile time by passing
 // -ldflags -X code.cloudfoundry.org/korifi/version.Version=<version>
 var Version = "v9999.99.99-local.dev"
+
+type Checker struct {
+	version *semver.Version
+}
+
+func NewChecker(ver string) Checker {
+	return Checker{version: semver.MustParse(ver)}
+}
+
+func (c Checker) ObjectIsNewer(obj client.Object) (bool, error) {
+	korifiVersion := obj.GetAnnotations()[KorifiCreationVersionKey]
+	semVersion, err := semver.NewVersion(korifiVersion)
+	if err != nil {
+		return false, err
+	}
+
+	return semVersion.GreaterThan(c.version), nil
+}

version/version_suite_test.go

@@ -0,0 +1,13 @@
+package version_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestVersion(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Version Suite")
+}

version/version_test.go

@@ -0,0 +1,92 @@
+package version_test
+
+import (
+	"code.cloudfoundry.org/korifi/version"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+var _ = Describe("Version comparison", func() {
+	var (
+		objectVersion string
+		checker       version.Checker
+		obj           client.Object
+		res           bool
+		err           error
+	)
+
+	BeforeEach(func() {
+		objectVersion = ""
+	})
+
+	JustBeforeEach(func() {
+		checker = version.NewChecker("v0.7.1")
+		obj = &v1.Pod{ObjectMeta: metav1.ObjectMeta{
+			Annotations: map[string]string{
+				version.KorifiCreationVersionKey: objectVersion,
+			},
+		}}
+		res, err = checker.ObjectIsNewer(obj)
+	})
+
+	When("object version is greater", func() {
+		BeforeEach(func() {
+			objectVersion = "v1.0.0"
+		})
+
+		It("returns true", func() {
+			Expect(res).To(BeTrue())
+		})
+	})
+
+	When("object version is less", func() {
+		BeforeEach(func() {
+			objectVersion = "v0.7.0"
+		})
+
+		It("returns false", func() {
+			Expect(res).To(BeFalse())
+		})
+	})
+
+	When("object version is the same", func() {
+		BeforeEach(func() {
+			objectVersion = "v0.7.1"
+		})
+
+		It("returns false", func() {
+			Expect(res).To(BeFalse())
+		})
+	})
+
+	When("object version is incorrect", func() {
+		BeforeEach(func() {
+			objectVersion = "foo"
+		})
+
+		It("returns an error", func() {
+			Expect(err).To(HaveOccurred())
+		})
+	})
+
+	When("object version is empty", func() {
+		BeforeEach(func() {
+			objectVersion = ""
+		})
+
+		It("returns an error", func() {
+			Expect(err).To(HaveOccurred())
+		})
+	})
+})
+
+var _ = Describe("construction", func() {
+	When("checker version is incorrect", func() {
+		It("panics on construction", func() {
+			Expect(func() { version.NewChecker("blah") }).To(Panic())
+		})
+	})
+})