Include the CSV name in compliance messages

Relates:
https://issues.redhat.com/browse/ACM-11026

Signed-off-by: mprahl <mprahl@users.noreply.github.com>

controllers/operatorpolicy_controller.go

@@ -1413,11 +1413,14 @@ func (r *OperatorPolicyReconciler) mustnothaveCSV(
 		return nil, updateStatus(policy, keptCond("ClusterServiceVersion"), relatedCSVs...), nil
 	}
 
+	csvNames := make([]string, 0, len(csvList))
+
 	for i := range csvList {
 		relatedCSVs = append(relatedCSVs, foundNotWantedObj(&csvList[i]))
+		csvNames = append(csvNames, csvList[i].GetName())
 	}
 
-	changed := updateStatus(policy, foundNotWantedCond("ClusterServiceVersion"), relatedCSVs...)
+	changed := updateStatus(policy, foundNotWantedCond("ClusterServiceVersion", csvNames...), relatedCSVs...)
 
 	if policy.Spec.RemediationAction.IsInform() {
 		return nil, changed, nil
@@ -1441,7 +1444,7 @@ func (r *OperatorPolicyReconciler) mustnothaveCSV(
 
 		err := r.Delete(ctx, &csvList[i])
 		if err != nil {
-			changed := updateStatus(policy, foundNotWantedCond("ClusterServiceVersion"), relatedCSVs...)
+			changed := updateStatus(policy, foundNotWantedCond("ClusterServiceVersion", csvNames...), relatedCSVs...)
 
 			if anyAlreadyDeleting {
 				// reset the "early" conditions to avoid flapping
@@ -1459,10 +1462,10 @@ func (r *OperatorPolicyReconciler) mustnothaveCSV(
 		// reset the "early" conditions to avoid flapping
 		earlyConds = []metav1.Condition{}
 
-		return earlyConds, updateStatus(policy, deletingCond("ClusterServiceVersion"), relatedCSVs...), nil
+		return earlyConds, updateStatus(policy, deletingCond("ClusterServiceVersion", csvNames...), relatedCSVs...), nil
 	}
 
-	updateStatus(policy, deletedCond("ClusterServiceVersion"), relatedCSVs...)
+	updateStatus(policy, deletedCond("ClusterServiceVersion", csvNames...), relatedCSVs...)
 
 	return earlyConds, true, nil
 }

controllers/operatorpolicy_status.go

@@ -428,12 +428,22 @@ func missingNotWantedCond(kind string) metav1.Condition {
 
 // foundNotWantedCond returns a NonCompliant condition with a Reason like '____Present'
 // and a Message like 'the ____ is present'
-func foundNotWantedCond(kind string) metav1.Condition {
+func foundNotWantedCond(kind string, identifiers ...string) metav1.Condition {
+	var extraInfo string
+
+	if len(identifiers) == 1 {
+		extraInfo = fmt.Sprintf(" (%s) is", identifiers[0])
+	} else if len(identifiers) > 1 {
+		extraInfo = fmt.Sprintf("s (%s) are", strings.Join(identifiers, ", "))
+	} else {
+		extraInfo = " is"
+	}
+
 	return metav1.Condition{
 		Type:    condType(kind),
 		Status:  metav1.ConditionFalse,
 		Reason:  kind + "Present",
-		Message: "the " + kind + " is present",
+		Message: "the " + kind + extraInfo + " present",
 	}
 }
 
@@ -450,23 +460,43 @@ func createdCond(kind string) metav1.Condition {
 
 // deletedCond returns a Compliant condition, with a Reason like '____Deleted',
 // and a Message like 'the ____ was deleted'
-func deletedCond(kind string) metav1.Condition {
+func deletedCond(kind string, identifiers ...string) metav1.Condition {
+	var extraInfo string
+
+	if len(identifiers) == 1 {
+		extraInfo = fmt.Sprintf(" (%s) was", identifiers[0])
+	} else if len(identifiers) > 1 {
+		extraInfo = fmt.Sprintf("s (%s) were", strings.Join(identifiers, ", "))
+	} else {
+		extraInfo = " was"
+	}
+
 	return metav1.Condition{
 		Type:    condType(kind),
 		Status:  metav1.ConditionTrue,
 		Reason:  kind + "Deleted",
-		Message: "the " + kind + " was deleted",
+		Message: "the " + kind + extraInfo + " deleted",
 	}
 }
 
 // deletingCond returns a NonCompliant condition, with a Reason like '____Deleting',
 // and a Message like 'the ____ has a deletion timestamp'
-func deletingCond(kind string) metav1.Condition {
+func deletingCond(kind string, identifiers ...string) metav1.Condition {
+	var extraInfo string
+
+	if len(identifiers) == 1 {
+		extraInfo = fmt.Sprintf(" (%s) has", identifiers[0])
+	} else if len(identifiers) > 1 {
+		extraInfo = fmt.Sprintf("s (%s) have", strings.Join(identifiers, ", "))
+	} else {
+		extraInfo = " has"
+	}
+
 	return metav1.Condition{
 		Type:    condType(kind),
 		Status:  metav1.ConditionFalse,
 		Reason:  kind + "Deleting",
-		Message: "the " + kind + " has a deletion timestamp",
+		Message: "the " + kind + extraInfo + " a deletion timestamp",
 	}
 }
 
@@ -687,7 +717,7 @@ func buildCSVCond(csv *operatorv1alpha1.ClusterServiceVersion) metav1.Condition
 		Type:    condType(csv.Kind),
 		Status:  status,
 		Reason:  string(csv.Status.Reason),
-		Message: "ClusterServiceVersion - " + csv.Status.Message,
+		Message: "ClusterServiceVersion (" + csv.Name + ") - " + csv.Status.Message,
 	}
 }
 

test/e2e/case38_install_operator_test.go

@@ -745,12 +745,15 @@ var _ = Describe("Testing OperatorPolicy", Ordered, func() {
 					Reason:    "InstallSucceeded",
 				}},
 				metav1.Condition{
-					Type:    "ClusterServiceVersionCompliant",
-					Status:  metav1.ConditionTrue,
-					Reason:  "InstallSucceeded",
-					Message: "ClusterServiceVersion - install strategy completed with no errors",
+					Type:   "ClusterServiceVersionCompliant",
+					Status: metav1.ConditionTrue,
+					Reason: "InstallSucceeded",
+					Message: "ClusterServiceVersion (quay-operator.v3.8.13) - install strategy completed with " +
+						"no errors",
 				},
-				"ClusterServiceVersion - install strategy completed with no errors",
+				regexp.QuoteMeta(
+					"ClusterServiceVersion (quay-operator.v3.8.13) - install strategy completed with no errors",
+				),
 			)
 		})
 
@@ -863,11 +866,13 @@ var _ = Describe("Testing OperatorPolicy", Ordered, func() {
 					Type:   "ClusterServiceVersionCompliant",
 					Status: metav1.ConditionFalse,
 					Reason: "UnsupportedOperatorGroup",
-					Message: "ClusterServiceVersion - AllNamespaces InstallModeType not supported," +
-						" cannot configure to watch all namespaces",
+					Message: "ClusterServiceVersion (etcdoperator.v0.9.2) - AllNamespaces InstallModeType not " +
+						"supported, cannot configure to watch all namespaces",
 				},
-				"ClusterServiceVersion - AllNamespaces InstallModeType not supported,"+
-					" cannot configure to watch all namespaces",
+				regexp.QuoteMeta(
+					"ClusterServiceVersion (etcdoperator.v0.9.2) - AllNamespaces InstallModeType not supported,"+
+						" cannot configure to watch all namespaces",
+				),
 			)
 		})
 
@@ -1808,9 +1813,9 @@ var _ = Describe("Testing OperatorPolicy", Ordered, func() {
 					Type:    "ClusterServiceVersionCompliant",
 					Status:  metav1.ConditionFalse,
 					Reason:  "ClusterServiceVersionPresent",
-					Message: "the ClusterServiceVersion is present",
+					Message: "the ClusterServiceVersion (quay-operator.v3.8.13) is present",
 				},
-				`the ClusterServiceVersion is present`,
+				regexp.QuoteMeta("the ClusterServiceVersion (quay-operator.v3.8.13) is present"),
 			)
 			check(
 				opPolName,
@@ -2142,9 +2147,9 @@ var _ = Describe("Testing OperatorPolicy", Ordered, func() {
 					Type:    "ClusterServiceVersionCompliant",
 					Status:  metav1.ConditionFalse,
 					Reason:  "ClusterServiceVersionDeleting",
-					Message: "the ClusterServiceVersion has a deletion timestamp",
+					Message: "the ClusterServiceVersion (" + csvName + ") has a deletion timestamp",
 				},
-				`the ClusterServiceVersion was deleted`,
+				regexp.QuoteMeta("the ClusterServiceVersion ("+csvName+") was deleted"),
 			)
 			desiredCRDObjects := make([]policyv1.RelatedObject, 0)
 			for _, name := range crdNames {
@@ -2275,7 +2280,7 @@ var _ = Describe("Testing OperatorPolicy", Ordered, func() {
 					Reason:  "ClusterServiceVersionNotPresent",
 					Message: "the ClusterServiceVersion is not present",
 				},
-				`the ClusterServiceVersion was deleted`,
+				regexp.QuoteMeta("the ClusterServiceVersion (quay-operator.v3.8.13) was deleted"),
 			)
 			check(
 				opPolName,