Use rule short_failure_message as fallback for evaluation failure message #5933
+217
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
It looks like this needs a rebase, but I like the idea, and I was wondering why we didn't do it earlier. 😁
I was also going to ask about whether we should do this for violations, but that already collects messages as part of its operation, so we don't need this kind of fallback, though we could replace "Evaluation failures:" with the short failure message if we wanted.
…sage In deny-by-default rego evaluations, when no custom message is provided by the rule writer, the evaluator now falls back to the rule's short_failure_message if available, instead of always defaulting to "denied". This provides better error messages to users when rule evaluations fail, as they will see the descriptive short_failure_message from the rule definition rather than a generic "denied" message. Changes: - Added shortFailureMessage field to denyByDefaultEvaluator struct - Modified parseResult to use cmp.Or() with short_failure_message as fallback before "denied" - Created WithShortFailureMessage() Option function to pass the message to the evaluator - Updated NewRuleEvaluator to pass short_failure_message option when creating rego evaluators Fixes mindersec#4718 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Add three new test functions to thoroughly test the short_failure_message fallback behavior in deny-by-default rego evaluations: - TestDenyByDefaultWithShortFailureMessage: Tests the complete fallback chain (custom message > short_failure_message > "denied") with 4 scenarios - TestDenyByDefaultShortFailureMessageOnlyAppliedToDenyByDefault: Verifies that the option is silently ignored for constraints evaluator - TestDenyByDefaultShortFailureMessageWithEntityName: Tests that entity names are properly included in error details Also enhanced the godoc for WithShortFailureMessage() to clearly document the fallback priority, when the option applies, and its type-specific behavior. All tests pass and linting is clean.
JAORMX
force-pushed
the
feature/use-short-failure-message-4718
branch
from
fce50a2 to
ceaca8c
Compare
evankanderson
approved these changes
Oct 28, 2025
| } | ||
| return jq.NewJQEvaluator(e.GetJq(), opts...) | ||
| case rego.RegoEvalType: | ||
| // Add short_failure_message as an option if available |
There was a problem hiding this comment.
You can actually store this always, since you use cmp.Or to combine this and the "denied".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
In deny-by-default rego evaluations, when no custom message is provided by the rule writer, the evaluator now falls back to the rule's
short_failure_messageif available, instead of always defaulting to "denied".This provides better error messages to users when rule evaluations fail, as they will see the descriptive
short_failure_messagefrom the rule definition rather than a generic "denied" message.Changes
shortFailureMessagefield todenyByDefaultEvaluatorstructparseResultto usecmp.Or()withshort_failure_messageas fallback before "denied"WithShortFailureMessage()Option function to pass the message to the evaluatorNewRuleEvaluatorto passshort_failure_messageoption when creating rego evaluatorsExample
Before: Rule failures would show
"denied"After: Rule failures show the descriptive message from the rule type, e.g.:
"License file does not match the expected license type""Malicious package found""denied"only if noshort_failure_messageis definedTest Plan
Related Issues
Fixes #4718
🤖 Generated with Claude Code