Fix nil pointer when fetching snowmachineconfig that does not exist (#3795)

Author: jiayiwang7

pkg/cluster/snow.go

@@ -70,6 +70,9 @@ func snowEntry() *ConfigManagerEntry {
 				}
 				return nil
 			},
+			func(c *Config) error {
+				return ValidateSnowMachineRefExists(c)
+			},
 		},
 	}
 }
@@ -192,3 +195,14 @@ func SetSnowDatacenterIndentityRefDefault(s *anywherev1.SnowDatacenterConfig) {
 		}
 	}
 }
+
+// ValidateSnowMachineRefExists checks the cluster spec machine refs and makes sure
+// the snowmachineconfig object exists for each ref with kind == snowmachineconfig.
+func ValidateSnowMachineRefExists(c *Config) error {
+	for _, machineRef := range c.Cluster.MachineConfigRefs() {
+		if machineRef.Kind == anywherev1.SnowMachineConfigKind && c.SnowMachineConfig(machineRef.Name) == nil {
+			return fmt.Errorf("unable to find SnowMachineConfig %s", machineRef.Name)
+		}
+	}
+	return nil
+}

pkg/cluster/snow_test.go

@@ -311,3 +311,39 @@ func TestSetSnowDatacenterIndentityRefDefault(t *testing.T) {
 		})
 	}
 }
+
+func TestValidateSnowMachineRefExistsError(t *testing.T) {
+	g := NewWithT(t)
+	c := &cluster.Config{
+		Cluster: &anywherev1.Cluster{
+			TypeMeta: metav1.TypeMeta{
+				Kind:       anywherev1.ClusterKind,
+				APIVersion: anywherev1.SchemeBuilder.GroupVersion.String(),
+			},
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "eksa-unit-test",
+				Namespace: "ns-1",
+			},
+			Spec: anywherev1.ClusterSpec{
+				WorkerNodeGroupConfigurations: []anywherev1.WorkerNodeGroupConfiguration{
+					{
+						MachineGroupRef: &anywherev1.Ref{
+							Name: "worker-not-exists",
+							Kind: "SnowMachineConfig",
+						},
+					},
+				},
+			},
+		},
+		SnowMachineConfigs: map[string]*anywherev1.SnowMachineConfig{
+			"worker-1": {
+				ObjectMeta: metav1.ObjectMeta{
+					Name: "worker-1",
+				},
+			},
+		},
+	}
+	g.Expect(cluster.ValidateConfig(c)).To(
+		MatchError(ContainSubstring("unable to find SnowMachineConfig worker-not-exists")),
+	)
+}

pkg/providers/snow/reconciler/reconciler.go

@@ -72,6 +72,13 @@ func (r *Reconciler) ValidateMachineConfigs(ctx context.Context, log logr.Logger
 		}
 	}
 
+	if err := cluster.ValidateSnowMachineRefExists(clusterSpec.Config); err != nil {
+		log.Error(err, "Invalid SnowMachineConfig")
+		failureMessage := err.Error()
+		clusterSpec.Cluster.Status.FailureMessage = &failureMessage
+		return controller.Result{}, err
+	}
+
 	return controller.Result{}, nil
 }
 

pkg/providers/snow/reconciler/reconciler_test.go

@@ -87,6 +87,20 @@ func TestReconcilerValidateMachineConfigsInvalidControlPlaneMachineConfig(t *tes
 	tt.Expect(*tt.cluster.Status.FailureMessage).To(ContainSubstring("Something wrong"))
 }
 
+func TestReconcilerValidateMachineConfigsSnowMachineRefNotExists(t *testing.T) {
+	tt := newReconcilerTest(t)
+	tt.withFakeClient()
+
+	spec := tt.buildSpec()
+	spec.Cluster.Spec.ControlPlaneConfiguration.MachineGroupRef.Name = "cp-machine-not-exists"
+
+	_, err := tt.reconciler().ValidateMachineConfigs(tt.ctx, test.NewNullLogger(), spec)
+
+	tt.Expect(err).To(MatchError(ContainSubstring("unable to find SnowMachineConfig cp-machine-not-exists")))
+	tt.Expect(tt.cluster.Status.FailureMessage).ToNot(BeZero())
+	tt.Expect(*tt.cluster.Status.FailureMessage).To(ContainSubstring("unable to find SnowMachineConfig cp-machine-not-exists"))
+}
+
 func TestReconcilerReconcileWorkers(t *testing.T) {
 	tt := newReconcilerTest(t)
 	tt.createAllObjs()