Add a minimal status option to the report generating command #418
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
gardener-robot
added
needs/review
georgibaltiev
changed the title
gardener-robot-ci-3
added
reviewed/ok-to-test
gardener-robot-ci-1
added
reviewed/ok-to-test
gardener-robot-ci-3
added
reviewed/ok-to-test
dimityrmirchev
requested changes
Jan 9, 2025
| @@ -125,6 +125,26 @@ func (r *Report) WriteToFile(filePath string) error { | |||
| return os.WriteFile(filePath, data, 0600) | |||
| } | |||
|
|
|||
| // SetMinStatus sets minStatus of the report. It also removes all checks with status less than the specified one. | |||
| // If the new minStatus is less that the original one, nothing is changed. | |||
| func (r *Report) SetMinStatus(minStatus rule.Status) { | |||
There was a problem hiding this comment.
Can't we implement this as a report option?
There was a problem hiding this comment.
I will look into it.
There was a problem hiding this comment.
You can disregard my comment. I see that we already have this and you are making use of it.
cmd/diki/app/app.go
Outdated
| @@ -144,6 +146,7 @@ func addRunFlags(cmd *cobra.Command, opts *runOptions) { | |||
| func addReportGenerateFlags(cmd *cobra.Command, opts *generateOptions) { | |||
| cmd.PersistentFlags().Var(cliflag.NewMapStringString(&opts.distinctBy), "distinct-by", "If set generates a merged report. The keys are the IDs for the providers which the merged report will include and the values are distinct metadata attributes to be used as IDs for the different reports.") | |||
| cmd.PersistentFlags().StringVar(&opts.format, "format", "html", "Format for the output report. Format can be one of 'html' or 'json'.") | |||
| cmd.PersistentFlags().StringVar(&opts.minStatus, "min-status", "Passed", "If set specifies the minimal status that will be included in the generated report. Status can be one of 'Passed', 'Skipped', 'Accepted', 'Warning', 'Failed', 'Errored' or 'NotImplemented'") | |||
There was a problem hiding this comment.
We should mention the statuses in a sorted order stating which is the highest
dimityrmirchev
requested changes
Jan 9, 2025
pkg/report/report.go
Outdated
| @@ -125,6 +125,26 @@ func (r *Report) WriteToFile(filePath string) error { | |||
| return os.WriteFile(filePath, data, 0600) | |||
| } | |||
|
|
|||
| // SetMinStatus sets minStatus of the report. It also removes all checks with status less than the specified one. | |||
| // If the new minStatus is less that the original one, nothing is changed. | |||
There was a problem hiding this comment.
Suggested change
| // If the new minStatus is less that the original one, nothing is changed. | |
| // If the new minStatus is less than the original one, nothing is changed. |
| @@ -125,6 +125,26 @@ func (r *Report) WriteToFile(filePath string) error { | |||
| return os.WriteFile(filePath, data, 0600) | |||
| } | |||
|
|
|||
| // SetMinStatus sets minStatus of the report. It also removes all checks with status less than the specified one. | |||
| // If the new minStatus is less that the original one, nothing is changed. | |||
| func (r *Report) SetMinStatus(minStatus rule.Status) { | |||
There was a problem hiding this comment.
You can disregard my comment. I see that we already have this and you are making use of it.
gardener-robot-ci-3
added
reviewed/ok-to-test
gardener-robot
added
reviewed/lgtm
gardener-robot-ci-3
added
the
reviewed/ok-to-test
gardener-robot
added
the
status/closed
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.
What this PR does / why we need it:
This PR adds an additional flag to the diki report generate command that specifies the minimal status of the checks that should be included in the rendered report. This flag only discards check results that have a higher status when generating a regular or merged report.
Which issue(s) this PR fixes:
Fixes #378
Special notes for your reviewer:
Release note: