feat: PAAL-123 move probe equality check to equality.go and reduce complexity

Author: qa-jil-kamerling

internal/controller/agent_controller.go

@@ -767,40 +767,7 @@ func (r *AgentReconciler) servicePortsEqual(existing, desired []corev1.ServicePo
 
 // probesEqual compares two readiness probes for equality
 func (r *AgentReconciler) probesEqual(existing, desired *corev1.Probe) bool {
-	// Both nil - equal
-	if existing == nil && desired == nil {
-		return true
-	}
-
-	// One nil, one not - not equal
-	if existing == nil || desired == nil {
-		return false
-	}
-
-	// Compare probe settings
-	if existing.InitialDelaySeconds != desired.InitialDelaySeconds ||
-		existing.PeriodSeconds != desired.PeriodSeconds ||
-		existing.TimeoutSeconds != desired.TimeoutSeconds ||
-		existing.SuccessThreshold != desired.SuccessThreshold ||
-		existing.FailureThreshold != desired.FailureThreshold {
-		return false
-	}
-
-	// Compare HTTP Get actions
-	if existing.HTTPGet != nil && desired.HTTPGet != nil {
-		return existing.HTTPGet.Path == desired.HTTPGet.Path &&
-			existing.HTTPGet.Port == desired.HTTPGet.Port &&
-			existing.HTTPGet.Scheme == desired.HTTPGet.Scheme
-	}
-
-	// Compare TCP Socket actions
-	if existing.TCPSocket != nil && desired.TCPSocket != nil {
-		return existing.TCPSocket.Port == desired.TCPSocket.Port
-	}
-
-	// Different probe handler types or one nil - not equal
-	return (existing.HTTPGet == nil && desired.HTTPGet == nil) &&
-		(existing.TCPSocket == nil && desired.TCPSocket == nil)
+	return equality.ProbesEqual(existing, desired)
 }
 
 // sanitizeAgentName sanitizes the agent name to meet environment variable naming requirements.

internal/equality/equality.go

@@ -36,3 +36,9 @@ func getEnvFromSourceKey(s corev1.EnvFromSource) string {
 	}
 	return ""
 }
+
+// ProbesEqual compares two Kubernetes readiness probes for equality.
+// This function handles nil cases and uses deep comparison for comprehensive equality checking.
+func ProbesEqual(existing, desired *corev1.Probe) bool {
+	return cmp.Equal(existing, desired)
+}

internal/equality/equality_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/agentic-layer/agent-runtime-operator/internal/equality"
 	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/util/intstr"
 )
 
 // A helper function to easily get a pointer to a bool, as required by the 'Optional' field.
@@ -220,3 +221,151 @@ func TestEnvFromEqual(t *testing.T) {
 		})
 	}
 }
+
+func TestProbesEqual(t *testing.T) {
+	testCases := []struct {
+		name string
+		a    *corev1.Probe
+		b    *corev1.Probe
+		want bool
+	}{
+		{
+			name: "should be equal for both nil",
+			a:    nil,
+			b:    nil,
+			want: true,
+		},
+		{
+			name: "should not be equal for one nil",
+			a:    nil,
+			b:    &corev1.Probe{InitialDelaySeconds: 10},
+			want: false,
+		},
+		{
+			name: "should not be equal for other nil",
+			a:    &corev1.Probe{InitialDelaySeconds: 10},
+			b:    nil,
+			want: false,
+		},
+		{
+			name: "should be equal for identical HTTP probes",
+			a: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					HTTPGet: &corev1.HTTPGetAction{
+						Path: "/health",
+						Port: intstr.FromInt(8000),
+					},
+				},
+				InitialDelaySeconds: 10,
+				PeriodSeconds:       5,
+			},
+			b: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					HTTPGet: &corev1.HTTPGetAction{
+						Path: "/health",
+						Port: intstr.FromInt(8000),
+					},
+				},
+				InitialDelaySeconds: 10,
+				PeriodSeconds:       5,
+			},
+			want: true,
+		},
+		{
+			name: "should be equal for identical TCP probes",
+			a: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					TCPSocket: &corev1.TCPSocketAction{
+						Port: intstr.FromInt(8000),
+					},
+				},
+				InitialDelaySeconds: 10,
+			},
+			b: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					TCPSocket: &corev1.TCPSocketAction{
+						Port: intstr.FromInt(8000),
+					},
+				},
+				InitialDelaySeconds: 10,
+			},
+			want: true,
+		},
+		{
+			name: "should not be equal for different HTTP paths",
+			a: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					HTTPGet: &corev1.HTTPGetAction{
+						Path: "/health",
+						Port: intstr.FromInt(8000),
+					},
+				},
+			},
+			b: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					HTTPGet: &corev1.HTTPGetAction{
+						Path: "/readiness",
+						Port: intstr.FromInt(8000),
+					},
+				},
+			},
+			want: false,
+		},
+		{
+			name: "should not be equal for different ports",
+			a: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					TCPSocket: &corev1.TCPSocketAction{
+						Port: intstr.FromInt(8000),
+					},
+				},
+			},
+			b: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					TCPSocket: &corev1.TCPSocketAction{
+						Port: intstr.FromInt(3000),
+					},
+				},
+			},
+			want: false,
+		},
+		{
+			name: "should not be equal for different probe types",
+			a: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					HTTPGet: &corev1.HTTPGetAction{
+						Path: "/health",
+						Port: intstr.FromInt(8000),
+					},
+				},
+			},
+			b: &corev1.Probe{
+				ProbeHandler: corev1.ProbeHandler{
+					TCPSocket: &corev1.TCPSocketAction{
+						Port: intstr.FromInt(8000),
+					},
+				},
+			},
+			want: false,
+		},
+		{
+			name: "should not be equal for different timing settings",
+			a: &corev1.Probe{
+				InitialDelaySeconds: 10,
+			},
+			b: &corev1.Probe{
+				InitialDelaySeconds: 15,
+			},
+			want: false,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			got := equality.ProbesEqual(tc.a, tc.b)
+			if got != tc.want {
+				t.Errorf("ProbesEqual() = %v, want %v", got, tc.want)
+			}
+		})
+	}
+}