feat(general): Allow skipping multiple checks in a single line #6622
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
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
esterKoren
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
esterKoren
had a problem deploying
to
scan-security
GitHub Actions
Failure
|
|
||
| def test(self) -> None: | ||
| # given | ||
| test_files_dir = Path(__file__).parent / "a example skip" |
There was a problem hiding this comment.
Suggested change
| test_files_dir = Path(__file__).parent / "a example skip" | |
| test_files_dir = Path(__file__).parent / "a_example_skip" |
Please use one word in the file names.
| report = Runner().run(root_folder=str(test_files_dir), runner_filter=RunnerFilter(checks=[])) | ||
|
|
||
| # then | ||
| summary = report.get_summary() |
There was a problem hiding this comment.
Please assert the skipped part in the reports by resource -
We want to be sure default and skip_invalid are with one skip, and skip_more_than_one is with 2 skips.
| location = "azurerm_resource_group.example.location" | ||
| account_tier = "Standard" | ||
| account_replication_type = "GRS" | ||
| } |
There was a problem hiding this comment.
It would be great if you could create another resource that we are skipping multiple checks (maybe all the checks that the resource should fail on).
lirshindalman
approved these changes
Jul 30, 2024
|
Another point - And do every change by condition if |
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
| """ | ||
| should_allow_multi_checks_skip = bool(os.getenv('CHECKOV_ALLOW_SKIP_MULTIPLE_ONE_LINE', 'False')) |
There was a problem hiding this comment.
Suggested change
| should_allow_multi_checks_skip = bool(os.getenv('CHECKOV_ALLOW_SKIP_MULTIPLE_ONE_LINE', 'False')) | |
| should_allow_multi_checks_skip = strtobool(os.getenv('CHECKOV_ALLOW_SKIP_MULTIPLE_ONE_LINE', 'False')) |
bool('False') equal to True.
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
esterKoren
temporarily deployed
to
scan-security
GitHub Actions
Inactive
shoshiGit
had a problem deploying
to
scan-security
GitHub Actions
Failure
|
Hey @shoshiGit, |
shoshiGit
requested a deployment
to
scan-security
GitHub Actions
Waiting
|
Hey @shoshiGit, |
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.
User description
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Description
This pull request enhances Checkov to support skipping multiple checks in a single line for Terraform configurations. Currently, individual skip comments are required for each check, which can be cumbersome. This enhancement allows specifying multiple checks to skip in a single line.
Fixes # #5381
Changes made:
Added functionality to parse multiple checks in the
checkov:skipcomment.Updated documentation to reflect the new capability.
Checklist:
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Enhances Checkov to support skipping multiple checks in a single line for Terraform configurations. Modifies the comment parsing logic in
checkov/common/comment/enum.pyandcheckov/terraform/context_parsers/base_parser.pyto allow multiple check IDs in a single skip comment. Adds new test cases intests/terraform/checks/a_example_skip/main.tfandtests/terraform/checks/test_multiple_skips.pyto verify the new functionality.Modified files (2)
Latest Contributors(0)
Modified files (2)
Latest Contributors(2)