Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(secrets): Don't show stack trace in failures when uploading secrets to verify #4734

Merged
merged 5 commits into from
Mar 26, 2023

Conversation

Eliran-Turgeman
Copy link
Contributor

@Eliran-Turgeman Eliran-Turgeman commented Mar 23, 2023

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Description

When failing to upload due to access denied, we printed the entire stack trace.
This PR suppresses that behavior, and prints only the log messages.

2023-03-23 15:16:19,607 [ThreadPoolEx] [WARNI]  Got access denied, retrying as s3 role changes should be propagated
2023-03-23 15:16:23,982 [ThreadPoolEx] [ERROR]  failed to persist object into S3 bucket bc-scanner-results-619572639823-elt2
2023-03-23 15:16:23,982 [ThreadPoolEx] [ERROR]  Getting access denied consistently, skipping secrets verification, please try again

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.

Fixes # (issue)

New/Edited policies (Delete if not relevant)

Description

Include a description of what makes it a violation and any relevant external links.

Fix

How does someone fix the issue in code and/or in runtime?

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my feature, policy, or fix is effective and works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@@ -42,6 +42,17 @@ def _put_json_object(s3_client: BaseClient, json_obj: Any, bucket: str, object_p
raise


def _put_json_object_quiet(s3_client: BaseClient, json_obj: Any, bucket: str, object_path: str) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about using the original function and add default parameter add_stack_trace: bool = True and pass it to exc_info= 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my first try, but something didn't work, now it seems fine the second time 😄

Copy link
Contributor

@gruebel gruebel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🍪

@Eliran-Turgeman Eliran-Turgeman merged commit 082beb4 into main Mar 26, 2023
@Eliran-Turgeman Eliran-Turgeman deleted the add_retry_to_secrets_upload branch March 26, 2023 09:45
Teko012 pushed a commit to Teko012/checkov_fork_bridgecrewio that referenced this pull request Mar 26, 2023
…ts to verify (bridgecrewio#4734)

* don't show stack trace on errors to upload secrets

* client error

* lint

* review

---------

Co-authored-by: Eliran Turgeman <elturgeman@paloaltonetworks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants