chore: Update error message for invalid expression (#2156)

Makes the error message consistent with others by moving the compile errors to the description. Signed-off-by: Charith Ellawala <charith@cerbos.dev> --------- Signed-off-by: Charith Ellawala <charith@cerbos.dev>
cerbos · May 16, 2024 · 1a25664 · 1a25664
1 parent c7e7860
commit 1a25664
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 13 deletions.
diff --git a/internal/compile/conditions.go b/internal/compile/conditions.go
@@ -5,6 +5,7 @@ package compile
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/google/cel-go/cel"
 	exprpb "google.golang.org/genproto/googleapis/api/expr/v1alpha1"
@@ -61,7 +62,11 @@ func compileMatch(modCtx *moduleCtx, path string, match *policyv1.Match, markRef
 func compileCELExpr(modCtx *moduleCtx, path, expr string, markReferencedVariablesAsUsed bool) *exprpb.CheckedExpr {
 	celAST, issues := conditions.StdEnv.Compile(expr)
 	if issues != nil && issues.Err() != nil {
-		modCtx.addErrForProtoPath(path, newCELCompileError(expr, issues), "Invalid expression: `%s`", expr)
+		errList := make([]string, len(issues.Errors()))
+		for i, ce := range issues.Errors() {
+			errList[i] = ce.Message
+		}
+		modCtx.addErrForProtoPath(path, newCELCompileError(expr, issues), "Invalid expression `%s`: [%s]", expr, strings.Join(errList, ", "))
 		return nil
 	}
 

diff --git a/internal/compile/errors.go b/internal/compile/errors.go
@@ -165,12 +165,7 @@ func newCELCompileError(expr string, issues *cel.Issues) *CELCompileError {
 }
 
 func (cce *CELCompileError) Error() string {
-	errList := make([]string, len(cce.issues.Errors()))
-	for i, ce := range cce.issues.Errors() {
-		errList[i] = ce.Message
-	}
-
-	return fmt.Sprintf("failed to compile `%s` [%s]", cce.expr, strings.Join(errList, ", "))
+	return "invalid expression"
 }
 
 func (cce *CELCompileError) Unwrap() error {

diff --git a/internal/test/testdata/compile/bad_cel_expr.yaml b/internal/test/testdata/compile/bad_cel_expr.yaml
@@ -3,9 +3,9 @@
 wantErrors:
   - file: principal_policies/donald_duck_20210210.yaml
     error: |-
-      failed to compile `resource.attr.dev_record ^^ true` [Syntax error: token recognition error at: '^', Syntax error: token recognition error at: '^', Syntax error: extraneous input 'true' expecting <EOF>]
+      invalid expression
     description: |-
-      Invalid expression: `resource.attr.dev_record ^^ true`
+      Invalid expression `resource.attr.dev_record ^^ true`: [Syntax error: token recognition error at: '^', Syntax error: token recognition error at: '^', Syntax error: extraneous input 'true' expecting <EOF>]
     position:
       line: 12
       column: 15

diff --git a/internal/test/testdata/compile/yaml_comment_in_condition.yaml b/internal/test/testdata/compile/yaml_comment_in_condition.yaml
@@ -4,11 +4,10 @@ mainDef: "resource_policies/leave_request_20210210.yaml"
 wantErrors:
   - file: resource_policies/leave_request_20210210.yaml
     error: |-
-      failed to compile `# YAML comment
-      request.resource.attr.status == "PENDING_APPROVAL"` [Syntax error: token recognition error at: '#', Syntax error: mismatched input 'comment' expecting <EOF>]
+      invalid expression
     description: |-
-      Invalid expression: `# YAML comment
-      request.resource.attr.status == "PENDING_APPROVAL"`
+      Invalid expression `# YAML comment
+      request.resource.attr.status == "PENDING_APPROVAL"`: [Syntax error: token recognition error at: '#', Syntax error: mismatched input 'comment' expecting <EOF>]
     position:
       line: 15
       column: 11