From 3b9bc575bc3bedff501382eb5c012304ba87a218 Mon Sep 17 00:00:00 2001
From: Markus Lehtonen <markus.lehtonen@intel.com>
Date: Fri, 28 Feb 2025 15:11:01 +0200
Subject: [PATCH] Change ExecuteGroupRule to return detailed result

Modify the ExecuteGroupRule() which is used for NodeFeatureGroups to
return detailed match status, similar to the Execute (used for
NodeFeatureRules). This prepares for using the simpler GroupRule type in
the image compatibility API.
---
 pkg/apis/nfd/nodefeaturerule/rule.go | 45 +++++++++++++++++-----------
 pkg/nfd-master/nfd-master.go         |  3 +-
 2 files changed, 29 insertions(+), 19 deletions(-)

diff --git a/pkg/apis/nfd/nodefeaturerule/rule.go b/pkg/apis/nfd/nodefeaturerule/rule.go
index fffb6ca16..e392a2a6f 100644
--- a/pkg/apis/nfd/nodefeaturerule/rule.go
+++ b/pkg/apis/nfd/nodefeaturerule/rule.go
@@ -149,37 +149,48 @@ func Execute(r *nfdv1alpha1.Rule, features *nfdv1alpha1.Features, failFast bool)
 
 // ExecuteGroupRule executes the GroupRule against a set of input features, and return true if the
 // rule matches.
-func ExecuteGroupRule(r *nfdv1alpha1.GroupRule, features *nfdv1alpha1.Features, failFast bool) (bool, error) {
-	matched := false
-	if len(r.MatchAny) > 0 {
+func ExecuteGroupRule(r *nfdv1alpha1.GroupRule, features *nfdv1alpha1.Features, failFast bool) (MatchStatus, error) {
+	var (
+		matchStatus MatchStatus
+		isMatch     bool
+	)
+	if n := len(r.MatchAny); n > 0 {
+		matchStatus.MatchAny = make([]*MatchFeatureStatus, 0, n)
 		// Logical OR over the matchAny matchers
 		for _, matcher := range r.MatchAny {
-			if isMatch, matches, err := evaluateMatchAnyElem(&matcher, features, failFast); err != nil {
-				return false, err
-			} else if isMatch {
-				matched = true
-				klog.V(4).InfoS("matchAny matched", "ruleName", r.Name, "matchedFeatures", utils.DelayedDumper(matches))
-				// there's no need to evaluate other matchers in MatchAny
-				// One match is enough for MatchAny
-				break
+			matched, featureStatus, err := evaluateMatchAnyElem(&matcher, features, failFast)
+			if err != nil {
+				return matchStatus, err
+			} else if matched {
+				isMatch = true
+				klog.V(4).InfoS("matchAny matched", "ruleName", r.Name, "matchedFeatures", utils.DelayedDumper(featureStatus.MatchedFeatures))
+
+				if failFast {
+					// there's no need to evaluate other matchers in MatchAny
+					break
+				}
 			}
+			matchStatus.MatchAny = append(matchStatus.MatchAny, featureStatus)
 		}
-		if !matched {
-			return false, nil
+		if !isMatch && failFast {
+			return matchStatus, nil
 		}
 	}
 
 	if len(r.MatchFeatures) > 0 {
-		if isMatch, _, err := evaluateFeatureMatcher(&r.MatchFeatures, features, failFast); err != nil {
-			return false, err
+		var err error
+		if isMatch, matchStatus.MatchFeatureStatus, err = evaluateFeatureMatcher(&r.MatchFeatures, features, failFast); err != nil {
+			return matchStatus, err
 		} else if !isMatch {
 			klog.V(2).InfoS("rule did not match", "ruleName", r.Name)
-			return false, nil
+			return matchStatus, nil
 		}
 	}
 
+	matchStatus.IsMatch = true
+
 	klog.V(2).InfoS("rule matched", "ruleName", r.Name)
-	return true, nil
+	return matchStatus, nil
 }
 
 func executeLabelsTemplate(r *nfdv1alpha1.Rule, in matchedFeatures, out map[string]string) error {
diff --git a/pkg/nfd-master/nfd-master.go b/pkg/nfd-master/nfd-master.go
index 3dd984724..51e02345d 100644
--- a/pkg/nfd-master/nfd-master.go
+++ b/pkg/nfd-master/nfd-master.go
@@ -742,8 +742,7 @@ func (m *nfdMaster) nfdAPIUpdateNodeFeatureGroup(nfdClient nfdclientset.Interfac
 				continue
 			}
 
-			if match {
-				klog.ErrorS(err, "failed to evaluate rule", "ruleName", rule.Name, "nodeName", feature.Name)
+			if match.IsMatch {
 				system := feature.Spec.Features.Attributes["system.name"]
 				nodeName := system.Elements["nodename"]
 				if _, ok := nodeGroupValidator[nodeName]; !ok {