Handle nil pointer for HMAC options.

Prevents nil pointer exception when checking length of secrets. The
`hmac` field in the RPC provider options is an optional field, if it is
not defined, it will result in nil pointer exeption.

- Added nil pointer check for `rpc.hmac` for machine and task in
  `doReconcile` step.
- Added unit tests for this situation.

Author: MrFlynn

controller/machine.go

@@ -98,7 +98,7 @@ func (r *MachineReconciler) doReconcile(ctx context.Context, bm *v1alpha1.Machin
 	}
 	if bm.Spec.Connection.ProviderOptions != nil && bm.Spec.Connection.ProviderOptions.RPC != nil {
 		opts.ProviderOptions = bm.Spec.Connection.ProviderOptions
-		if len(bm.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets) > 0 {
+		if bm.Spec.Connection.ProviderOptions.RPC.HMAC != nil && len(bm.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets) > 0 {
 			se, err := retrieveHMACSecrets(ctx, r.client, bm.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets)
 			if err != nil {
 				return ctrl.Result{}, fmt.Errorf("unable to get hmac secrets: %w", err)

controller/machine_test.go

@@ -38,6 +38,12 @@ func TestMachineReconcile(t *testing.T) {
 			machine:  createMachineWithRPC(createHMACSecret()),
 		},
 
+		"success power on with RPC provider w/o secrets": {
+			provider: &testProvider{Powerstate: "on", Proto: "rpc"},
+			secret:   createSecret(),
+			machine:  createMachineWithRPC(nil),
+		},
+
 		"fail to find secret with RPC provider": {
 			provider:  &testProvider{Powerstate: "on", Proto: "rpc"},
 			secret:    createHMACSecret(),
@@ -149,7 +155,7 @@ func TestMachineReconcile(t *testing.T) {
 }
 
 func createMachineWithRPC(secret *corev1.Secret) *v1alpha1.Machine {
-	return &v1alpha1.Machine{
+	machine := &v1alpha1.Machine{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      "test-bm",
 			Namespace: "test-namespace",
@@ -161,21 +167,26 @@ func createMachineWithRPC(secret *corev1.Secret) *v1alpha1.Machine {
 				ProviderOptions: &v1alpha1.ProviderOptions{
 					RPC: &v1alpha1.RPCOptions{
 						ConsumerURL: "http://127.0.0.1:7777",
-						HMAC: &v1alpha1.HMACOpts{
-							Secrets: v1alpha1.HMACSecrets{
-								"sha256": []corev1.SecretReference{
-									{
-										Name:      secret.Name,
-										Namespace: secret.Namespace,
-									},
-								},
-							},
-						},
 					},
 				},
 			},
 		},
 	}
+
+	if secret != nil {
+		machine.Spec.Connection.ProviderOptions.RPC.HMAC = &v1alpha1.HMACOpts{
+			Secrets: v1alpha1.HMACSecrets{
+				"sha256": []corev1.SecretReference{
+					{
+						Name:      secret.Name,
+						Namespace: secret.Namespace,
+					},
+				},
+			},
+		}
+	}
+
+	return machine
 }
 
 func createMachine() *v1alpha1.Machine {

controller/task.go

@@ -93,7 +93,7 @@ func (r *TaskReconciler) doReconcile(ctx context.Context, task *v1alpha1.Task, t
 	}
 	if task.Spec.Connection.ProviderOptions != nil && task.Spec.Connection.ProviderOptions.RPC != nil {
 		opts.ProviderOptions = task.Spec.Connection.ProviderOptions
-		if len(task.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets) > 0 {
+		if task.Spec.Connection.ProviderOptions.RPC.HMAC != nil && len(task.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets) > 0 {
 			se, err := retrieveHMACSecrets(ctx, r.client, task.Spec.Connection.ProviderOptions.RPC.HMAC.Secrets)
 			if err != nil {
 				return ctrl.Result{}, fmt.Errorf("unable to get hmac secrets: %w", err)

controller/task_test.go

@@ -81,6 +81,12 @@ func TestTaskReconcile(t *testing.T) {
 			task:     createTaskWithRPC("PowerOn", getAction("PowerOn"), createHMACSecret()),
 		},
 
+		"success power on with RPC provider w/o secrets": {
+			taskName: "PowerOn",
+			action:   getAction("PowerOn"),
+			provider: &testProvider{Powerstate: "on", PowerSetOK: true, Proto: "rpc"},
+		},
+
 		"failure on bmc open": {
 			taskName: "PowerOn", action: getAction("PowerOn"),
 			provider:  &testProvider{ErrOpen: errors.New("failed to open")},
@@ -259,7 +265,7 @@ func createTask(name string, action v1alpha1.Action, secret *corev1.Secret) *v1a
 }
 
 func createTaskWithRPC(name string, action v1alpha1.Action, secret *corev1.Secret) *v1alpha1.Task {
-	return &v1alpha1.Task{
+	machine := &v1alpha1.Task{
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      name,
 			Namespace: "default",
@@ -276,19 +282,24 @@ func createTaskWithRPC(name string, action v1alpha1.Action, secret *corev1.Secre
 				ProviderOptions: &v1alpha1.ProviderOptions{
 					RPC: &v1alpha1.RPCOptions{
 						ConsumerURL: "http://127.0.0.1:7777",
-						HMAC: &v1alpha1.HMACOpts{
-							Secrets: v1alpha1.HMACSecrets{
-								"sha256": []corev1.SecretReference{
-									{
-										Name:      secret.Name,
-										Namespace: secret.Namespace,
-									},
-								},
-							},
-						},
 					},
 				},
 			},
 		},
 	}
+
+	if secret != nil {
+		machine.Spec.Connection.ProviderOptions.RPC.HMAC = &v1alpha1.HMACOpts{
+			Secrets: v1alpha1.HMACSecrets{
+				"sha256": []corev1.SecretReference{
+					{
+						Name:      secret.Name,
+						Namespace: secret.Namespace,
+					},
+				},
+			},
+		}
+	}
+
+	return machine
 }