Add template support to evaluation details. #4532
Merged
Conversation
This file contains 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
blkt
force-pushed
the
enh/improved-vulncheck-evaluation-detail
branch
7 times, most recently
from
700b242
to
78f408b
Compare
blkt
force-pushed
the
enh/improved-vulncheck-evaluation-detail
branch
from
78f408b
to
ebf8c8a
Compare
eleftherias
previously approved these changes
Sep 19, 2024
internal/engine/errors/errors.go
Outdated
| } | ||
|
|
||
| var buf strings.Builder | ||
| w := LimitedWriter(&buf, 1<<10) |
There was a problem hiding this comment.
1<<10 could be extracted to a constant
This change extends error type available for use in evaluation engines with support for go templates. This error type supports rendering complex templates along with the usual string rendering. Despite the type itself being the same, a new constructor was added to avoid a bigger refactoring. Ideally, the old constructor should be deprecated and all places returning an `ErrEvaluationFailed` error should use the new one instead. Templates are internal to Minder and cannot be customized by the end user. Also, template engine choice was arbitrary and can be changed at any time. Fixes #4525 Fixes #4526
blkt
force-pushed
the
enh/improved-vulncheck-evaluation-detail
branch
from
ebf8c8a
to
68bd32a
Compare
eleftherias
approved these changes
Sep 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This change extends error type available for use in evaluation engines with support for go templates. This error type supports rendering complex templates along with the usual string rendering. Despite the type itself being the same, a new constructor was added to avoid a bigger refactoring. Ideally, the old constructor should be deprecated and all places returning an
ErrEvaluationFailederror should use the new one instead.Templates are internal to Minder and cannot be customized by the end user. Also, template engine choice was arbitrary and can be changed at any time.
Fixes #4525
Fixes #4526
Change Type
Testing
Unit tests.
Review Checklist: