feat(policy): improve error messages (#2345)

Signed-off-by: Sylwester Piskozub <[email protected]>
Signed-off-by: Miguel Martinez Trivino <[email protected]>
Co-authored-by: Miguel Martinez Trivino <[email protected]>

Author: Piskoo

app/cli/cmd/policy_develop_eval.go

@@ -55,7 +55,7 @@ evaluates the policy against the provided material or attestation.`,
 
 			policyEval, err := action.NewPolicyEval(opts, actionOpts)
 			if err != nil {
-				return fmt.Errorf("failed to initialize policy evaluation: %w", err)
+				return err
 			}
 
 			result, err := policyEval.Run()

app/cli/cmd/policy_develop_lint.go

@@ -40,7 +40,7 @@ func newPolicyDevelopLintCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			a, err := action.NewPolicyLint(actionOpts)
 			if err != nil {
-				return fmt.Errorf("failed to initialize linter: %w", err)
+				return err
 			}
 
 			result, err := a.Run(cmd.Context(), &action.PolicyLintOpts{
@@ -49,7 +49,7 @@ func newPolicyDevelopLintCmd() *cobra.Command {
 				RegalConfig: regalConfig,
 			})
 			if err != nil {
-				return fmt.Errorf("linting policy: %w", err)
+				return err
 			}
 
 			if result.Valid {

app/cli/internal/action/policy_develop_eval.go

@@ -16,8 +16,6 @@
 package action
 
 import (
-	"fmt"
-
 	"github.com/chainloop-dev/chainloop/app/cli/internal/policydevel"
 )
 
@@ -62,7 +60,7 @@ func (action *PolicyEval) Run() ([]*PolicyEvalResult, error) {
 	// Evaluate policy
 	resp, err := policydevel.Evaluate(evalOpts, action.Logger)
 	if err != nil {
-		return nil, fmt.Errorf("evaluating policy: %w", err)
+		return nil, err
 	}
 
 	results := make([]*PolicyEvalResult, 0, len(resp))

app/cli/internal/action/policy_develop_lint.go

@@ -17,7 +17,6 @@ package action
 
 import (
 	"context"
-	"fmt"
 
 	"github.com/chainloop-dev/chainloop/app/cli/internal/policydevel"
 )
@@ -47,7 +46,7 @@ func (action *PolicyLint) Run(_ context.Context, opts *PolicyLintOpts) (*PolicyL
 	// Read policies
 	policy, err := policydevel.Lookup(opts.PolicyPath, opts.RegalConfig, opts.Format)
 	if err != nil {
-		return nil, fmt.Errorf("loading policy: %w", err)
+		return nil, err
 	}
 
 	// Run all validations

app/cli/internal/policydevel/lint.go

@@ -85,15 +85,15 @@ func (p *PolicyToLint) AddError(path, message string, line int) {
 func Lookup(absPath, config string, format bool) (*PolicyToLint, error) {
 	resolvedPath, err := resourceloader.GetPathForResource(absPath)
 	if err != nil {
-		return nil, fmt.Errorf("failed to resolve policy file: %w", err)
+		return nil, err
 	}
 
 	fileInfo, err := os.Stat(resolvedPath)
 	if err != nil {
 		if os.IsNotExist(err) {
 			return nil, fmt.Errorf("policy file does not exist: %s", resolvedPath)
 		}
-		return nil, fmt.Errorf("failed to stat file %q: %w", resolvedPath, err)
+		return nil, err
 	}
 	if fileInfo.IsDir() {
 		return nil, fmt.Errorf("expected a file but got a directory: %s", resolvedPath)
@@ -142,14 +142,14 @@ func (p *PolicyToLint) loadReferencedRegoFiles(baseDir string) error {
 
 				resolvedPath, err := resourceloader.GetPathForResource(regoPath)
 				if err != nil {
-					return fmt.Errorf("failed to resolve rego file %q: %w", regoPath, err)
+					return err
 				}
 				if _, ok := seen[resolvedPath]; ok {
 					continue // avoid duplicates
 				}
 				seen[resolvedPath] = struct{}{}
 				if err := p.processFile(resolvedPath); err != nil {
-					return fmt.Errorf("failed to load referenced rego file %q: %w", resolvedPath, err)
+					return err
 				}
 			}
 		}
@@ -160,7 +160,7 @@ func (p *PolicyToLint) loadReferencedRegoFiles(baseDir string) error {
 func (p *PolicyToLint) processFile(filePath string) error {
 	content, err := os.ReadFile(filePath)
 	if err != nil {
-		return fmt.Errorf("reading %s: %w", filepath.Base(filePath), err)
+		return err
 	}
 
 	ext := strings.ToLower(filepath.Ext(filePath))
@@ -197,7 +197,7 @@ func (p *PolicyToLint) Validate() {
 func (p *PolicyToLint) validateYAMLFile(file *File) {
 	var policy v1.Policy
 	if err := unmarshal.FromRaw(file.Content, unmarshal.RawFormatYAML, &policy, true); err != nil {
-		p.AddError(file.Path, fmt.Sprintf("failed to parse/validate: %v", err), 0)
+		p.AddError(file.Path, "failed to parse/validate policy", 0)
 		return
 	}
 
@@ -207,7 +207,7 @@ func (p *PolicyToLint) validateYAMLFile(file *File) {
 	if p.Format {
 		var root yaml.Node
 		if err := yaml.Unmarshal(file.Content, &root); err != nil {
-			p.AddError(file.Path, fmt.Sprintf("failed to parse YAML: %v", err), 0)
+			p.AddError(file.Path, "failed to parse YAML", 0)
 			return
 		}
 
@@ -222,13 +222,13 @@ func (p *PolicyToLint) validateYAMLFile(file *File) {
 		defer enc.Close()
 
 		if err := enc.Encode(&root); err != nil {
-			p.AddError(file.Path, fmt.Sprintf("failed to encode YAML: %v", err), 0)
+			p.AddError(file.Path, err.Error(), 0)
 			return
 		}
 
 		outYAML := buf.Bytes()
 		if err := os.WriteFile(file.Path, outYAML, 0600); err != nil {
-			p.AddError(file.Path, fmt.Sprintf("failed to write updated file: %v", err), 0)
+			p.AddError(file.Path, err.Error(), 0)
 		} else {
 			if err := os.WriteFile(file.Path, outYAML, 0600); err != nil {
 				p.AddError(file.Path, fmt.Sprintf("failed to save updated file: %v", err), 0)
@@ -260,7 +260,7 @@ func (p *PolicyToLint) validateRegoFile(file *File) {
 
 	if p.Format && formatted != original {
 		if err := os.WriteFile(file.Path, []byte(formatted), 0600); err != nil {
-			p.AddError(file.Path, fmt.Sprintf("failed to auto-format: %v", err), 0)
+			p.AddError(file.Path, err.Error(), 0)
 		} else {
 			file.Content = []byte(formatted)
 		}
@@ -286,7 +286,7 @@ func (p *PolicyToLint) validateAndFormatRego(content, path string) string {
 func (p *PolicyToLint) applyOPAFmt(content, file string) string {
 	formatted, err := format.SourceWithOpts(file, []byte(content), format.Opts{})
 	if err != nil {
-		p.AddError(file, "Auto-formatting failed", 0)
+		p.AddError(file, "auto-formatting failed", 0)
 		return content
 	}
 	return string(formatted)
@@ -352,7 +352,7 @@ func (p *PolicyToLint) runRegalLinter(filePath, content string) {
 
 	report, err := lntr.Lint(context.Background())
 	if err != nil {
-		p.AddError(filePath, fmt.Sprintf("linting failed: %v", err), 0)
+		p.AddError(filePath, err.Error(), 0)
 		return
 	}