Change default validate image output to text #1893
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1893 +/- ##
==========================================
+ Coverage 80.79% 80.81% +0.01%
==========================================
Files 68 68
Lines 5050 5050
==========================================
+ Hits 4080 4081 +1
+ Misses 970 969 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
For once I think I will pay attention to the CodeCov complaint. |
The same mocked validator was used in many places with a lot of copy/pasted code, so I wanted to clean that up. Not directly related to, but done while while working on... Ref: https://issues.redhat.com/browse/EC-758
The previous default was json. There was one change in the unit tests required to make the tests pass. I'm not 100% sure why that was needed (or rather why it wasn't needed before), but my understanding is that the fs and the ctx was being reused between two test cases and it was causing problems somehow. I did look at the task definition also, but the output is specified explicitly, so should be no change needed. Ref: https://issues.redhat.com/browse/EC-758
Motivated by CodeCov complaining about one uncovered code path. I decided to test the output with and without --show-successes. It's perhaps more than was needed, but actually this is the first unit test coverage of the validate image text output, (existing coverage is all in the acceptance tests), so I think it's worthwhile. Ref: https://issues.redhat.com/browse/EC-758
Fix a little text output glitch when --show-successes is not set. Note: I realized that `or` in a go template can take more than two parameters, so that's why the nested or was removed. Drive-by fix while working on... Ref: https://issues.redhat.com/browse/EC-758
simonbaird
force-pushed
the
default-to-text-output
branch
from
7b0baa6 to
902d6ec
Compare
|
I fixed a few annoyances and added some more test coverage. Will take out of draft when it goes green. |
|
Now I'm pretty sure the CodeCov complaint is wrong. 🤔 🤷 |
simonbaird
commented
Aug 28, 2024
| @@ -166,7 +166,7 @@ func NewReport(snapshot string, components []Component, policy policy.Policy, da | |||
| // WriteAll writes the report to all the given targets. | |||
| func (r Report) WriteAll(targets []string, p format.TargetParser) (allErrors error) { | |||
| if len(targets) == 0 { | |||
| targets = append(targets, JSON) | |||
| targets = append(targets, Text) | |||
There was a problem hiding this comment.
The significant functional change.
lcarva
approved these changes
Aug 29, 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.
The previous default was json.
There was one change in the unit tests required to make the tests pass. I'm not 100% sure why that was needed (or rather why it wasn't needed before), but my understanding is that the fs and the ctx was being reused between two test cases and it was causing problems somehow.
I did look at the task definition also, but the output is specified explicitly, so should be no change needed.
Ref: https://issues.redhat.com/browse/EC-758