feat: check for incompatible flavors

tsuru · Jan 23, 2024 · adf9edb · adf9edb
1 parent 9a8bfee
commit adf9edb
Show file tree

Hide file tree

Showing 3 changed files with 115 additions and 3 deletions.
diff --git a/api/v1alpha1/rpaasflavor_types.go b/api/v1alpha1/rpaasflavor_types.go
@@ -27,6 +27,10 @@ type RpaasFlavorSpec struct {
 	// CreationOnly defines if the flavor could be used only in the moment of creation of instance
 	// +optional
 	CreationOnly bool `json:"creationOnly,omitempty"`
+
+	// IncompatibleFlavors defines which other flavors cannot be used with this flavor
+	// +optional
+	IncompatibleFlavors []string `json:"incompatibleFlavors,omitempty"`
 }
 
 // +kubebuilder:object:root=true

diff --git a/internal/pkg/rpaas/k8s.go b/internal/pkg/rpaas/k8s.go
@@ -1289,6 +1289,11 @@ func (m *k8sRpaasManager) validateFlavors(ctx context.Context, instance *v1alpha
 		if flavorObj.Spec.CreationOnly && !isCreation {
 			return &ValidationError{Msg: fmt.Sprintf("flavor %q can used only in the creation of instance", f)}
 		}
+
+		incompatibleFlavor := checkIncompatibleFlavors(flavorObj.Spec.IncompatibleFlavors, flavors)
+		if incompatibleFlavor != "" {
+			return &ValidationError{Msg: fmt.Sprintf("flavor %q is incompatible with %q flavor", f, incompatibleFlavor)}
+		}
 	}
 
 	for _, f := range removed {
@@ -1321,6 +1326,18 @@ func diffFlavors(existing, updated []string) (added, removed []string) {
 	return
 }
 
+func checkIncompatibleFlavors(incompatibleFlavors, allFlavors []string) string {
+	if len(incompatibleFlavors) > 0 {
+		for _, incompatibleFlavor := range incompatibleFlavors {
+			if contains(allFlavors, incompatibleFlavor) {
+				return incompatibleFlavor
+			}
+		}
+	}
+
+	return ""
+}
+
 func isBlockTypeAllowed(bt v1alpha1.BlockType) bool {
 	allowedBlockTypes := map[v1alpha1.BlockType]bool{
 		v1alpha1.BlockTypeRoot:      true,

diff --git a/internal/pkg/rpaas/k8s_test.go b/internal/pkg/rpaas/k8s_test.go
@@ -2573,6 +2573,26 @@ func Test_k8sRpaasManager_CreateInstance(t *testing.T) {
 				Description:  "aaaaa",
 			},
 		},
+		&v1alpha1.RpaasFlavor{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "vanilla",
+				Namespace: getServiceName(),
+			},
+			Spec: v1alpha1.RpaasFlavorSpec{
+				Description:         "aaaaa",
+				IncompatibleFlavors: []string{"strawberry", "chocolate"},
+			},
+		},
+		&v1alpha1.RpaasFlavor{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "chocolate",
+				Namespace: getServiceName(),
+			},
+			Spec: v1alpha1.RpaasFlavorSpec{
+				Description:         "aaaaa",
+				IncompatibleFlavors: []string{"mint-chocolate", "pecan"},
+			},
+		},
 	}
 	one := int32(1)
 	tests := []struct {
@@ -2618,6 +2638,11 @@ func Test_k8sRpaasManager_CreateInstance(t *testing.T) {
 			args:          CreateArgs{Name: "r1", Team: "t1", Parameters: map[string]interface{}{"flavors": map[string]interface{}{"0": "strawberry", "1": "strawberry"}}},
 			expectedError: `flavor "strawberry" only can be set once`,
 		},
+		{
+			name:          "incompatible flavors",
+			args:          CreateArgs{Name: "r1", Team: "t1", Parameters: map[string]interface{}{"flavors": map[string]interface{}{"0": "strawberry", "1": "vanilla"}}},
+			expectedError: `flavor "vanilla" is incompatible with "strawberry" flavor`,
+		},
 		{
 			name:          "instance already exists",
 			args:          CreateArgs{Name: "r0", Team: "t2"},
@@ -2951,7 +2976,7 @@ func Test_k8sRpaasManager_CreateInstance(t *testing.T) {
 		},
 		{
 			name: "with flavor",
-			args: CreateArgs{Name: "r1", Team: "t1", Parameters: map[string]interface{}{"flavors": map[string]interface{}{"0": "strawberry"}}},
+			args: CreateArgs{Name: "r1", Team: "t1", Parameters: map[string]interface{}{"flavors": map[string]interface{}{"0": "strawberry", "1": "chocolate"}}},
 			expected: v1alpha1.RpaasInstance{
 				TypeMeta: metav1.TypeMeta{
 					Kind:       "RpaasInstance",
@@ -2977,7 +3002,7 @@ func Test_k8sRpaasManager_CreateInstance(t *testing.T) {
 				Spec: v1alpha1.RpaasInstanceSpec{
 					Replicas: &one,
 					PlanName: "plan1",
-					Flavors:  []string{"strawberry"},
+					Flavors:  []string{"strawberry", "chocolate"},
 					Service: &nginxv1alpha1.NginxService{
 						Labels: map[string]string{
 							"rpaas.extensions.tsuru.io/service-name":  "rpaasv2",
@@ -3334,7 +3359,39 @@ func Test_k8sRpaasManager_UpdateInstance(t *testing.T) {
 		},
 	}
 
-	resources := []runtime.Object{instance1, instance2, plan1, plan2, creationOnlyFlavor}
+	flavor1 := &v1alpha1.RpaasFlavor{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "flavor1",
+			Namespace: getServiceName(),
+		},
+		Spec: v1alpha1.RpaasFlavorSpec{
+			Description: "aaaaa",
+		},
+	}
+
+	flavor2 := &v1alpha1.RpaasFlavor{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "flavor2",
+			Namespace: getServiceName(),
+		},
+		Spec: v1alpha1.RpaasFlavorSpec{
+			Description:         "aaaaa",
+			IncompatibleFlavors: []string{"flavor1", "flavor3"},
+		},
+	}
+
+	flavor3 := &v1alpha1.RpaasFlavor{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "flavor3",
+			Namespace: getServiceName(),
+		},
+		Spec: v1alpha1.RpaasFlavorSpec{
+			Description:         "aaaaa",
+			IncompatibleFlavors: []string{"flavor2", "flavor-non-existant"},
+		},
+	}
+
+	resources := []runtime.Object{instance1, instance2, plan1, plan2, creationOnlyFlavor, flavor1, flavor2, flavor3}
 
 	tests := []struct {
 		name      string
@@ -3387,6 +3444,39 @@ func Test_k8sRpaasManager_UpdateInstance(t *testing.T) {
 				assert.Equal(t, `cannot unset flavor "feature-create-only" as it is a creation only flavor`, err.Error())
 			},
 		},
+		{
+			name:     "when added flavors are compatible",
+			instance: "instance1",
+			args: UpdateInstanceArgs{
+				Description: "Another description",
+				Plan:        "plan1",
+				Team:        "team-one",
+				Parameters: map[string]interface{}{
+					"lb-name": "my-instance.example",
+					"flavors": "flavor1,flavor3",
+				},
+			},
+			assertion: func(t *testing.T, err error, instance *v1alpha1.RpaasInstance) {
+				require.NoError(t, err)
+			},
+		},
+		{
+			name:     "when tries to add incompatible flavors",
+			instance: "instance1",
+			args: UpdateInstanceArgs{
+				Description: "Another description",
+				Plan:        "plan1",
+				Team:        "team-one",
+				Parameters: map[string]interface{}{
+					"lb-name": "my-instance.example",
+					"flavors": "flavor1,flavor2",
+				},
+			},
+			assertion: func(t *testing.T, err error, instance *v1alpha1.RpaasInstance) {
+				require.Error(t, err)
+				assert.Equal(t, `flavor "flavor2" is incompatible with "flavor1" flavor`, err.Error())
+			},
+		},
 		{
 			name:     "when tries to set an invalid annotation format",
 			instance: "instance1",
@@ -3415,6 +3505,7 @@ func Test_k8sRpaasManager_UpdateInstance(t *testing.T) {
 				Parameters: map[string]interface{}{
 					"lb-name":     "my-instance.example",
 					"annotations": "{\"my-custom-annotation\": \"my-value\"}",
+					"flavors":     "flavor3",
 				},
 			},
 			assertion: func(t *testing.T, err error, instance *v1alpha1.RpaasInstance) {