fix: error when receiving an AppWrapper with 0 or 1 ordered instances (#96)

* fix: error when receiving an AppWrapper with 0 or 1 ordered instances

Co-authored-by: Fiona-Waters [email protected]

* test receiving an AppWrapper with 0 or 1 ordered instances

* add: log for no orderedInstances, and tests.

Author: VanillaSpoon

controllers/appWrapper_controller_test.go

@@ -0,0 +1,107 @@
+package controllers
+
+import (
+	"github.com/onsi/gomega"
+	arbv1 "github.com/project-codeflare/multi-cluster-app-dispatcher/pkg/apis/controller/v1beta1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"testing"
+)
+
+func TestDiscoverInstanceTypes(t *testing.T) {
+	g := gomega.NewGomegaWithT(t)
+
+	tests := []struct {
+		name        string
+		input       *arbv1.AppWrapper
+		expected    map[string]int
+		expectedErr error
+	}{
+		{
+			name: "Test with multiple orderedinstance",
+			input: &arbv1.AppWrapper{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"orderedinstance": "test.instance1_test.instance2",
+					},
+				},
+				Spec: arbv1.AppWrapperSpec{
+					AggrResources: arbv1.AppWrapperResourceList{
+						GenericItems: []arbv1.AppWrapperGenericResource{
+							{
+								CustomPodResources: []arbv1.CustomPodResourceTemplate{
+									{
+										Replicas: 1,
+									},
+									{
+										Replicas: 2,
+									},
+								},
+								TypeMeta: metav1.TypeMeta{},
+							},
+						},
+					},
+				},
+			},
+			expected: map[string]int{
+				"test.instance1": 1,
+				"test.instance2": 2,
+			},
+		},
+		{
+			name: "Test with one orderedinstance",
+			input: &arbv1.AppWrapper{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"orderedinstance": "test.instance1",
+					},
+				},
+				Spec: arbv1.AppWrapperSpec{
+					AggrResources: arbv1.AppWrapperResourceList{
+						GenericItems: []arbv1.AppWrapperGenericResource{
+							{
+								CustomPodResources: []arbv1.CustomPodResourceTemplate{
+									{
+										Replicas: 1,
+									},
+								},
+								TypeMeta: metav1.TypeMeta{},
+							},
+						},
+					},
+				},
+			},
+			expected: map[string]int{
+				"test.instance1": 1,
+			},
+		},
+		{
+			name: "Test with empty orderedinstance",
+			input: &arbv1.AppWrapper{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						"orderedinstance": "",
+					},
+				},
+			},
+			expected: map[string]int{},
+		},
+		{
+			name: "Test with empty orderedinstance",
+			input: &arbv1.AppWrapper{
+				ObjectMeta: metav1.ObjectMeta{
+					Labels: map[string]string{
+						// zero instances
+					},
+				},
+			},
+			expected: map[string]int{},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			result := discoverInstanceTypes(test.input)
+			g.Expect(result).To(gomega.Equal(test.expected))
+		})
+	}
+}

controllers/appwrapper_controller.go

@@ -280,13 +280,21 @@ func discoverInstanceTypes(aw *arbv1.AppWrapper) map[string]int {
 			instanceRequired = strings.Split(v, "_")
 		}
 	}
+
+	if len(instanceRequired) < 1 {
+		klog.Infof("Found AW %s that cannot be scaled due to missing orderedinstance label", aw.ObjectMeta.Name)
+		return demandMapPerInstanceType
+	}
+
 	klog.Infof("The instanceRequired array: %v", instanceRequired)
 	for id, genericItem := range aw.Spec.AggrResources.GenericItems {
 		for idx, val := range genericItem.CustomPodResources {
-			instanceName := instanceRequired[idx+id]
-			klog.Infof("Got instance name %v", instanceName)
-			demandMapPerInstanceType[instanceName] = val.Replicas
-
+			combinedIndex := idx + id
+			if combinedIndex < len(instanceRequired) {
+				instanceName := instanceRequired[combinedIndex]
+				klog.Infof("Got instance name %v", instanceName)
+				demandMapPerInstanceType[instanceName] = val.Replicas
+			}
 		}
 	}
 	return demandMapPerInstanceType