feat: rlp conflicted reason

api/v1beta2/authpolicy_types.go

@@ -315,6 +315,10 @@ func (ap *AuthPolicy) GetRulesHostnames() (ruleHosts []string) {
 	return
 }
 
+func (ap *AuthPolicy) Kind() string {
+	return ap.TypeMeta.Kind
+}
+
 //+kubebuilder:object:root=true
 
 // AuthPolicyList contains a list of AuthPolicy

api/v1beta2/ratelimitpolicy_types.go

@@ -250,6 +250,10 @@ func (r *RateLimitPolicy) GetRulesHostnames() (ruleHosts []string) {
 	return
 }
 
+func (r *RateLimitPolicy) Kind() string {
+	return r.TypeMeta.Kind
+}
+
 func init() {
 	SchemeBuilder.Register(&RateLimitPolicy{}, &RateLimitPolicyList{})
 }

controllers/authpolicy_controller.go

@@ -186,8 +186,8 @@ func (r *AuthPolicyReconciler) deleteResources(ctx context.Context, ap *api.Auth
 }
 
 // Ensures only one RLP targets the network resource
-func (r *AuthPolicyReconciler) reconcileNetworkResourceDirectBackReference(ctx context.Context, ap *api.AuthPolicy, targetNetworkObject client.Object) error {
-	return r.ReconcileTargetBackReference(ctx, client.ObjectKeyFromObject(ap), targetNetworkObject, common.AuthPolicyBackRefAnnotation)
+func (r *AuthPolicyReconciler) reconcileNetworkResourceDirectBackReference(ctx context.Context, ap common.KuadrantPolicy, targetNetworkObject client.Object) error {
+	return r.ReconcileTargetBackReference(ctx, ap, targetNetworkObject, common.AuthPolicyBackRefAnnotation)
 }
 
 func (r *AuthPolicyReconciler) deleteNetworkResourceDirectBackReference(ctx context.Context, targetNetworkObject client.Object) error {

controllers/limitador_cluster_envoyfilter_controller_test.go

@@ -105,7 +105,7 @@ var _ = Describe("Limitador Cluster EnvoyFilter controller", func() {
 			Expect(err).ToNot(HaveOccurred())
 			// Check RLP status is available
 			rlpKey := client.ObjectKey{Name: rlpName, Namespace: testNamespace}
-			Eventually(testRLPIsAvailable(rlpKey), time.Minute, 5*time.Second).Should(BeTrue())
+			Eventually(testRLPIsAccepted(rlpKey), time.Minute, 5*time.Second).Should(BeTrue())
 
 			// Check envoy filter
 			Eventually(func() bool {

controllers/ratelimitpolicy_controller.go

@@ -93,7 +93,7 @@ func (r *RateLimitPolicyReconciler) Reconcile(eventCtx context.Context, req ctrl
 				if delResErr == nil {
 					delResErr = err
 				}
-				return r.reconcileStatus(ctx, rlp, common.ErrTargetNotFound{Kind: rlp.Kind, TargetRef: rlp.GetTargetRef()})
+				return r.reconcileStatus(ctx, rlp, common.ErrTargetNotFound{Kind: rlp.Kind(), TargetRef: rlp.GetTargetRef()})
 			}
 			return ctrl.Result{}, err
 		}
@@ -154,12 +154,12 @@ func (r *RateLimitPolicyReconciler) reconcileResources(ctx context.Context, rlp
 	// TODO - Validation Error
 	err := rlp.Validate()
 	if err != nil {
-		return common.ErrInvalid{Kind: rlp.Kind, Err: err}
+		return common.ErrInvalid{Kind: rlp.Kind(), Err: err}
 	}
 
 	err = common.ValidateHierarchicalRules(rlp, targetNetworkObject)
 	if err != nil {
-		return common.ErrInvalid{Kind: rlp.Kind, Err: err}
+		return common.ErrInvalid{Kind: rlp.Kind(), Err: err}
 	}
 
 	// reconcile based on gateway diffs
@@ -213,7 +213,7 @@ func (r *RateLimitPolicyReconciler) deleteResources(ctx context.Context, rlp *ku
 
 // Ensures only one RLP targets the network resource
 func (r *RateLimitPolicyReconciler) reconcileNetworkResourceDirectBackReference(ctx context.Context, policy common.KuadrantPolicy, targetNetworkObject client.Object) error {
-	return r.ReconcileTargetBackReference(ctx, client.ObjectKeyFromObject(policy), targetNetworkObject, common.RateLimitPolicyBackRefAnnotation)
+	return r.ReconcileTargetBackReference(ctx, policy, targetNetworkObject, common.RateLimitPolicyBackRefAnnotation)
 }
 
 func (r *RateLimitPolicyReconciler) deleteNetworkResourceDirectBackReference(ctx context.Context, targetNetworkObject client.Object) error {

controllers/ratelimitpolicy_status.go

@@ -68,7 +68,6 @@ func (r *RateLimitPolicyReconciler) calculateStatus(_ context.Context, rlp *kuad
 	return newStatus
 }
 
-// TODO - Accepted Condition
 func (r *RateLimitPolicyReconciler) acceptedCondition(specErr error) *metav1.Condition {
 	// Accepted
 	cond := &metav1.Condition{
@@ -89,12 +88,13 @@ func (r *RateLimitPolicyReconciler) acceptedCondition(specErr error) *metav1.Con
 		// Invalid
 		case errors.As(specErr, &common.ErrInvalid{}):
 			cond.Reason = string(gatewayapiv1alpha2.PolicyReasonInvalid)
+		// Conflicted
+		case errors.As(specErr, &common.ErrConflict{}):
+			cond.Reason = string(gatewayapiv1alpha2.PolicyReasonConflicted)
 		default:
 			cond.Reason = "ReconciliationError"
 		}
 	}
 
-	// TODO - Conflicted Reason
-
 	return cond
 }

pkg/common/apimachinery_status_conditions.go

@@ -2,32 +2,12 @@ package common
 
 import (
 	"encoding/json"
-	"fmt"
 	"sort"
 
 	"golang.org/x/exp/slices"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	gatewayapiv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
-type ErrTargetNotFound struct {
-	Kind      string
-	TargetRef gatewayapiv1alpha2.PolicyTargetReference
-}
-
-func (e ErrTargetNotFound) Error() string {
-	return fmt.Sprintf("%s target %s was not found", e.Kind, e.TargetRef.Name)
-}
-
-type ErrInvalid struct {
-	Kind string
-	Err  error
-}
-
-func (e ErrInvalid) Error() string {
-	return fmt.Sprintf("%s target is invalid: %s", e.Kind, e.Err.Error())
-}
-
 // ConditionMarshal marshals the set of conditions as a JSON array, sorted by condition type.
 func ConditionMarshal(conditions []metav1.Condition) ([]byte, error) {
 	condCopy := slices.Clone(conditions)

pkg/common/common.go

@@ -43,6 +43,7 @@ type KuadrantPolicy interface {
 	GetTargetRef() gatewayapiv1alpha2.PolicyTargetReference
 	GetWrappedNamespace() gatewayapiv1.Namespace
 	GetRulesHostnames() []string
+	Kind() string
 }
 
 type KuadrantPolicyList interface {

pkg/common/errors.go

@@ -0,0 +1,35 @@
+package common
+
+import (
+	"fmt"
+
+	gatewayapiv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
+)
+
+type ErrTargetNotFound struct {
+	Kind      string
+	TargetRef gatewayapiv1alpha2.PolicyTargetReference
+}
+
+func (e ErrTargetNotFound) Error() string {
+	return fmt.Sprintf("%s target %s was not found", e.Kind, e.TargetRef.Name)
+}
+
+type ErrInvalid struct {
+	Kind string
+	Err  error
+}
+
+func (e ErrInvalid) Error() string {
+	return fmt.Sprintf("%s target is invalid: %s", e.Kind, e.Err.Error())
+}
+
+type ErrConflict struct {
+	Kind          string
+	NameNamespace string
+	Err           error
+}
+
+func (e ErrConflict) Error() string {
+	return fmt.Sprintf("%s is conflicted by %s: %s", e.Kind, e.NameNamespace, e.Err.Error())
+}

pkg/common/gatewayapi_utils_test.go

@@ -1320,6 +1320,10 @@ func (p *FakePolicy) GetRulesHostnames() []string {
 	return p.Hosts
 }
 
+func (p *FakePolicy) Kind() string {
+	return "FakePolicy"
+}
+
 func TestValidateHierarchicalRules(t *testing.T) {
 	hostname := gatewayapiv1.Hostname("*.example.com")
 	gateway := &gatewayapiv1.Gateway{

pkg/reconcilers/targetref_reconciler.go

@@ -154,9 +154,10 @@ func (r *TargetRefReconciler) TargetedGatewayKeys(_ context.Context, targetNetwo
 }
 
 // ReconcileTargetBackReference adds policy key in annotations of the target object
-func (r *TargetRefReconciler) ReconcileTargetBackReference(ctx context.Context, policyKey client.ObjectKey, targetNetworkObject client.Object, annotationName string) error {
+func (r *TargetRefReconciler) ReconcileTargetBackReference(ctx context.Context, policy common.KuadrantPolicy, targetNetworkObject client.Object, annotationName string) error {
 	logger, _ := logr.FromContext(ctx)
 
+	policyKey := client.ObjectKeyFromObject(policy)
 	targetNetworkObjectKey := client.ObjectKeyFromObject(targetNetworkObject)
 	targetNetworkObjectKind := targetNetworkObject.GetObjectKind().GroupVersionKind()
 
@@ -165,7 +166,7 @@ func (r *TargetRefReconciler) ReconcileTargetBackReference(ctx context.Context,
 
 	if val, ok := objAnnotations[annotationName]; ok {
 		if val != policyKey.String() {
-			return fmt.Errorf("the %s target %s is already referenced by policy %s", targetNetworkObjectKind, targetNetworkObjectKey, policyKey.String())
+			return common.ErrConflict{Kind: policy.Kind(), NameNamespace: val, Err: fmt.Errorf("the %s target %s is already referenced by policy %s", targetNetworkObjectKind, targetNetworkObjectKey, val)}
 		}
 	} else {
 		objAnnotations[annotationName] = policyKey.String()

pkg/reconcilers/targetref_reconciler_test.go

@@ -24,6 +24,7 @@ import (
 	"testing"
 
 	"github.com/go-logr/logr"
+	"github.com/kuadrant/kuadrant-operator/api/v1beta2"
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -302,6 +303,7 @@ func TestReconcileTargetBackReference(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	policy := &v1beta2.RateLimitPolicy{ObjectMeta: metav1.ObjectMeta{Name: "someName", Namespace: "someNamespace"}}
 	policyKey := client.ObjectKey{Name: "someName", Namespace: "someNamespace"}
 
 	existingRoute := &gatewayapiv1.HTTPRoute{
@@ -354,7 +356,7 @@ func TestReconcileTargetBackReference(t *testing.T) {
 		BaseReconciler: baseReconciler,
 	}
 
-	err = targetRefReconciler.ReconcileTargetBackReference(ctx, policyKey, existingRoute, annotationName)
+	err = targetRefReconciler.ReconcileTargetBackReference(ctx, policy, existingRoute, annotationName)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -378,7 +380,7 @@ func TestReconcileTargetBackReference(t *testing.T) {
 		t.Fatal("expected annotation not found")
 	}
 
-	if val != policyKey.String() {
+	if val != client.ObjectKeyFromObject(policy).String() {
 		t.Fatalf("annotation value (%s) does not match expected (%s)", val, policyKey.String())
 	}
 }