Extend NFR code with MatchStatus and introduce failFast strategy.

MatchStatus provides details about successful expressions and their results,
which are the matched host features. Additionally, a new flag controls
rule processing behavior: it can either stop at the first error or
continue processing all expressions and rules.

Signed-off-by: Marcin Franczyk <[email protected]>

Author: mfranczy

api/image-compatibility/v1alpha1/spec.go

@@ -0,0 +1,48 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import (
+	nfdv1alpha1 "sigs.k8s.io/node-feature-discovery/api/nfd/v1alpha1"
+)
+
+// ArtifactType is a type of OCI artifact that contains image compatibility metadata.
+const (
+	ArtifactType = "application/vnd.nfd.image-compatibility.v1alpha1"
+	Version      = "v1alpha1"
+)
+
+// Spec represents image compatibility metadata.
+type Spec struct {
+	// Version of the spec.
+	Version string `json:"version"`
+	// Compatibilities contains list of compatibility sets.
+	Compatibilties []Compatibility `json:"compatibilities"`
+}
+
+// Compatibility represents image compatibility metadata
+// that describe the image requirements for the host and OS.
+type Compatibility struct {
+	// Rules represents a list of Node Feature Rules.
+	Rules []nfdv1alpha1.Rule `json:"rules"`
+	// Weight indicates the priority of the compatibility set.
+	Weight int `json:"weight,omitempty"`
+	// Tag enables grouping or distinguishing between compatibility sets.
+	Tag string `json:"tag,omitempty"`
+	// Description of the compatibility set.
+	Description string `json:"description,omitempty"`
+}

api/nfd/v1alpha1/types.go

@@ -17,6 +17,8 @@ limitations under the License.
 package v1alpha1
 
 import (
+	"fmt"
+
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
@@ -298,6 +300,13 @@ type MatchExpression struct {
 	Value MatchValue `json:"value,omitempty"`
 }
 
+func (m MatchExpression) String() string {
+	if len(m.Value) < 1 {
+		return fmt.Sprintf("{op: %q}", m.Op)
+	}
+	return fmt.Sprintf("{op: %q, value: %q}", m.Op, m.Value)
+}
+
 // MatchOp is the match operator that is applied on values when evaluating a
 // MatchExpression.
 // +kubebuilder:validation:Enum="In";"NotIn";"InRegexp";"Exists";"DoesNotExist";"Gt";"Lt";"GtLt";"IsTrue";"IsFalse"

pkg/apis/nfd/nodefeaturerule/expression-api_test.go

@@ -116,7 +116,7 @@ bar: { op: Exists }
 				t.Fatal("failed to parse data of test case")
 			}
 
-			res, out, err := api.MatchGetKeys(mes, tc.input)
+			res, out, _, err := api.MatchGetKeys(mes, tc.input)
 			tc.result(t, res)
 			assert.Equal(t, tc.output, out)
 			tc.err(t, err)
@@ -183,12 +183,12 @@ baz: { op: Gt, value: ["10"] }
 				t.Fatal("failed to parse data of test case")
 			}
 
-			res, out, err := api.MatchGetValues(mes, tc.input)
+			res, out, _, err := api.MatchGetValues(mes, tc.input, true)
 			tc.result(t, res)
 			assert.Equal(t, tc.output, out)
 			tc.err(t, err)
 
-			res, err = api.MatchValues(mes, tc.input)
+			res, _, err = api.MatchValues(mes, tc.input, true)
 			tc.result(t, res)
 			tc.err(t, err)
 		})
@@ -248,12 +248,12 @@ bar: { op: Lt, value: ["10"] }
 				t.Fatal("failed to parse data of test case")
 			}
 
-			res, out, err := api.MatchGetInstances(mes, tc.input)
+			res, out, _, err := api.MatchGetInstances(mes, tc.input, true)
 			assert.Equal(t, tc.output, out)
 			tc.result(t, res)
 			tc.err(t, err)
 
-			res, err = api.MatchInstances(mes, tc.input)
+			res, err = api.MatchInstances(mes, tc.input, true)
 			tc.result(t, res)
 			tc.err(t, err)
 		})
@@ -745,7 +745,7 @@ func TestMatchMulti(t *testing.T) {
 
 	for _, tc := range tcs {
 		t.Run(tc.name, func(t *testing.T) {
-			res, out, err := api.MatchMulti(tc.mes, tc.inputKeys, tc.inputValues, tc.inputInstances)
+			res, out, _, err := api.MatchMulti(tc.mes, tc.inputKeys, tc.inputValues, tc.inputInstances, true)
 			if tc.expectErr {
 				assert.NotNil(t, err)
 			} else {