feat(github): Improving GHA schema validation #3513
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
added 2 commits
September 15, 2022 14:58
nimrodkor
approved these changes
Sep 18, 2022
gruebel
approved these changes
Sep 19, 2022
| @@ -62,8 +62,8 @@ def force_dict(obj: Any) -> dict[str, Any] | None: | |||
| """ | |||
| if isinstance(obj, dict): | |||
| return obj | |||
| if isinstance(obj, list) and len(obj) > 0 and isinstance(obj[0], dict): | |||
| return obj[0] | |||
| if (isinstance(obj, list) or isinstance(obj, tuple)) and len(obj) > 0: | |||
There was a problem hiding this comment.
can you add this change to the doc string?
If the object is a list/tuple of length 1 or more, ...
checkov/github_actions/runner.py
Outdated
| @@ -181,13 +186,22 @@ def resolve_step_name(job_definition: dict[str, Any], start_line: int, end_line: | |||
| @staticmethod | |||
| def is_schema_valid(config: dict[str, Any] | list[dict[str, Any]]) -> bool: | |||
| valid = False | |||
| config = force_list(config) | |||
| config = force_dict(config) | |||
| dir_path = os.path.dirname(os.path.realpath(__file__)) | |||
There was a problem hiding this comment.
Suggested change
| dir_path = os.path.dirname(os.path.realpath(__file__)) | |
| dir_path = os.path.dirname(__file__) |
please never use realpath it has unwanted behaviour on Mac for example
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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Description
Improving GHA schema validation.
Schema resource is from https://www.schemastore.org/json/ - I made it "softer" to match the tests.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Should improve false negatives as previous schema wasn't detailed enough.
Note - I suppressed a bandit check on yaml.load since the loader used is inheriting from SafeLoader.
Checklist: