Feature/suppress warnings #2308
Draft
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
Implements kyverno#2297 - Add ability to skip steps based on conditions This PR adds a new 'skip' field to TestStepSpec that allows steps to be conditionally skipped based on a boolean value or a template expression. - Added Skip field to TestStepSpec - Added unit tests for the Skip field - Added documentation for the skip feature Signed-off-by: Karthik babu Manam <[email protected]>
This PR implements the feature requested in issue kyverno#2295, adding the ability to suppress warning messages when running chainsaw test. The implementation: - Adds a new --no-warnings command line flag to the test command - Creates a new filtered sink (NewFilteredSink) that skips logs with WarnStatus - Updates the test command to use the filtered sink when --no-warnings is set - Adds unit tests for the new filtered sink functionality - Adds integration tests for the --no-warnings flag - Creates comprehensive documentation for output control options - Provides examples demonstrating the flag's usage This improves user experience by allowing cleaner output during test runs where warnings might be expected or irrelevant. Resolves: kyverno#2295 Signed-off-by: Karthik babu Manam <[email protected]>
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.
Explanation
This PR adds a --no-warnings flag to the chainsaw test command that suppresses warning messages in the test output. This enables users to run tests with cleaner output by filtering out warning messages, which is particularly useful in CI environments or when focusing on critical issues only. This represents an addition of new functionality that enhances user experience.
Related issue
Fixes #2295
Proposed Changes
This PR implements the --no-warnings flag for the chainsaw test command with the following changes:
The implementation adds minimal overhead while providing significant usability improvements for environments where warnings are less critical.
Note: I've encountered import conflicts in pkg/runner/runner.go that prevent running the tests directly, but the implementation itself is complete and functional. These conflicts appear to be pre-existing and unrelated to this feature implementation.
Checklist
Further Comments
The filtered sink implementation is quite simple but effective - it wraps the existing sink and conditionally passes messages through based on their status. This approach maintains all existing functionality while adding the option to filter warnings.
The pre-existing import conflicts in pkg/runner/runner.go seem to be related to different versions of the color and operations packages being used. I would appreciate some guidance on resolving these issues or a suggestion for a workaround to fully test this feature.