refactor: feedback api (#511)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
kyverno · Sep 23, 2024 · d75fd96 · d75fd96
1 parent 30bb58b
commit d75fd96
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 38 deletions.
diff --git a/.crds/json.kyverno.io_validatingpolicies.yaml b/.crds/json.kyverno.io_validatingpolicies.yaml
@@ -185,10 +185,9 @@ spec:
                           value:
                             description: Value is the feedback entry value (a JMESPath
                               expression).
-                            type: string
+                            x-kubernetes-preserve-unknown-fields: true
                         required:
                         - name
-                        - value
                         type: object
                       type: array
                     identifier:

diff --git a/.schemas/json/_definitions.json b/.schemas/json/_definitions.json
@@ -17801,8 +17801,7 @@
                       "description": "Feedback contains a feedback entry.",
                       "type": "object",
                       "required": [
-                        "name",
-                        "value"
+                        "name"
                       ],
                       "properties": {
                         "compiler": {
@@ -17819,7 +17818,7 @@
                         },
                         "value": {
                           "description": "Value is the feedback entry value (a JMESPath expression).",
-                          "type": "string"
+                          "x-kubernetes-preserve-unknown-fields": true
                         }
                       }
                     }

diff --git a/.schemas/json/validatingpolicy-json-v1alpha1.json b/.schemas/json/validatingpolicy-json-v1alpha1.json
@@ -513,8 +513,7 @@
                     "null"
                   ],
                   "required": [
-                    "name",
-                    "value"
+                    "name"
                   ],
                   "properties": {
                     "compiler": {
@@ -534,7 +533,7 @@
                     },
                     "value": {
                       "description": "Value is the feedback entry value (a JMESPath expression).",
-                      "type": "string"
+                      "x-kubernetes-preserve-unknown-fields": true
                     }
                   }
                 }

diff --git a/.schemas/json/validatingpolicylist-json-v1alpha1.json b/.schemas/json/validatingpolicylist-json-v1alpha1.json
@@ -536,8 +536,7 @@
                           "null"
                         ],
                         "required": [
-                          "name",
-                          "value"
+                          "name"
                         ],
                         "properties": {
                           "compiler": {
@@ -557,7 +556,7 @@
                           },
                           "value": {
                             "description": "Value is the feedback entry value (a JMESPath expression).",
-                            "type": "string"
+                            "x-kubernetes-preserve-unknown-fields": true
                           }
                         }
                       }

diff --git a/.schemas/openapi/v2/schema.json b/.schemas/openapi/v2/schema.json
diff --git a/.schemas/openapi/v3/apis/json.kyverno.io/v1alpha1.json b/.schemas/openapi/v3/apis/json.kyverno.io/v1alpha1.json
diff --git a/charts/kyverno-json/templates/crds.yaml b/charts/kyverno-json/templates/crds.yaml
@@ -194,10 +194,9 @@ spec:
                           value:
                             description: Value is the feedback entry value (a JMESPath
                               expression).
-                            type: string
+                            x-kubernetes-preserve-unknown-fields: true
                         required:
                         - name
-                        - value
                         type: object
                       type: array
                     identifier:

diff --git a/pkg/apis/policy/v1alpha1/feedback.go b/pkg/apis/policy/v1alpha1/feedback.go
@@ -10,5 +10,6 @@ type Feedback struct {
 	Name string `json:"name"`
 
 	// Value is the feedback entry value (a JMESPath expression).
-	Value string `json:"value"`
+	// +optional
+	Value *Any `json:"value,omitempty"`
 }
diff --git a/pkg/apis/policy/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/policy/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/data/crds/json.kyverno.io_validatingpolicies.yaml b/pkg/data/crds/json.kyverno.io_validatingpolicies.yaml
@@ -185,10 +185,9 @@ spec:
                           value:
                             description: Value is the feedback entry value (a JMESPath
                               expression).
-                            type: string
+                            x-kubernetes-preserve-unknown-fields: true
                         required:
                         - name
-                        - value
                         type: object
                       type: array
                     identifier:

diff --git a/pkg/json-engine/engine.go b/pkg/json-engine/engine.go
@@ -159,24 +159,24 @@ func New() engine.Engine[Request, Response] {
 			}
 			var feedback map[string]Feedback
 			for _, f := range r.rule.Feedback {
-				// TODO
-				// defaultCompiler := defaultCompiler
-				// if f.Engine != nil {
-				// 	defaultCompiler = string(*f.Engine)
-				// }
-				result, err := compilers.Execute(f.Value, r.resource, bindings, compiler.Jp)
-				if feedback == nil {
-					feedback = map[string]Feedback{}
-				}
-				if err != nil {
-					feedback[f.Name] = Feedback{
-						Error: err,
+				entry := Feedback{}
+				if f.Value != nil {
+					defaultCompiler := defaultCompiler
+					if f.Compiler != nil {
+						defaultCompiler = string(*f.Compiler)
 					}
-				} else {
-					feedback[f.Name] = Feedback{
-						Value: result,
+					if handler, err := f.Value.Compile(compiler.CompileProjection, defaultCompiler); err != nil {
+						entry.Error = err
+					} else if projected, err := handler(r.resource, bindings); err != nil {
+						entry.Error = err
+					} else {
+						entry.Value = projected
 					}
 				}
+				if feedback == nil {
+					feedback = map[string]Feedback{}
+				}
+				feedback[f.Name] = entry
 			}
 			violations, err := matching.Assert(nil, r.rule.Assert, r.resource, bindings, compiler, defaultCompiler)
 			if err != nil {

diff --git a/test/commands/scan/cel/policy.yaml b/test/commands/scan/cel/policy.yaml
@@ -3,20 +3,18 @@ kind: ValidatingPolicy
 metadata:
   name: test
 spec:
+  compiler: cel
   rules:
     - name: foo-bar-4
       context:
       - name: celFoo
-        compiler: cel
         variable: (4)
       - name: jpFoo
         compiler: jp
         variable: ($celFoo)
       - name: celFoo
-        compiler: cel
         variable: (bindings.resolve('jpFoo'))
       assert:
         all:
-        - compiler: cel
-          check:
+        - check:
             (object.foo.bar): (bindings.resolve('celFoo'))
diff --git a/website/docs/apis/kyverno-json.v1alpha1.md b/website/docs/apis/kyverno-json.v1alpha1.md
@@ -46,6 +46,7 @@ auto_generated: true
 **Appears in:**
 
 - [ContextEntry](#json-kyverno-io-v1alpha1-ContextEntry)
+- [Feedback](#json-kyverno-io-v1alpha1-Feedback)
 
 <p>Any can be any type.</p>
 
@@ -141,7 +142,7 @@ auto_generated: true
 |---|---|---|---|---|
 | `compiler` | [`Compiler`](#json-kyverno-io-v1alpha1-Compiler) |  |  | <p>Compiler defines the default compiler to use when evaluating expressions.</p> |
 | `name` | `string` | :white_check_mark: |  | <p>Name is the feedback entry name.</p> |
-| `value` | `string` | :white_check_mark: |  | <p>Value is the feedback entry value (a JMESPath expression).</p> |
+| `value` | [`Any`](#json-kyverno-io-v1alpha1-Any) |  |  | <p>Value is the feedback entry value (a JMESPath expression).</p> |
 
 ## `Match`     {#json-kyverno-io-v1alpha1-Match}