feat(scan): include exit code and reason in JSON result #555
Conversation
WalkthroughThe recent changes enhance the system's error handling and reporting capabilities by introducing a new exit code mapping dictionary. This addition clarifies the context of exit codes and improves the reporting function by incorporating exit status and reasons into JSON outputs. Overall, these modifications bolster user feedback and make the codebase more maintainable and informative. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- safety/constants.py (1 hunks)
- safety/scan/command.py (32 hunks)
Additional context used
Ruff
safety/scan/command.py
472-472: Local variable
fixesis assigned to but never usedRemove assignment to unused variable
fixes(F841)
Additional comments not posted (6)
safety/constants.py (1)
166-178: Addition ofEXIT_CODE_REASON_MAPPINGis well-structured.The new dictionary
EXIT_CODE_REASON_MAPPINGprovides clear and descriptive messages for each exit code, enhancing the readability and maintainability of the codebase.safety/scan/command.py (5)
52-53: New parametersexit_codeandexit_reasonare added toprocess_report.The function signature now includes
exit_codeandexit_reason, which are essential for enhancing the reporting capabilities.
57-60: Inclusion ofexit_codeandexit_reasonin JSON output.The
exit_codeandexit_reasonare correctly added to the JSON output, providing more detailed information about the scan results.
437-439: Determination ofexit_reasonbased onexit_code.The
exit_reasonis correctly determined usingEXIT_CODE_REASON_MAPPING, ensuring that a descriptive reason is provided for each exit code.
439-439: Updated call toprocess_reportincludesexit_codeandexit_reason.The call to
process_reportnow correctly includes theexit_codeandexit_reason, enhancing the reporting functionality.
760-760: Updated call toprocess_reportinsystem_scanincludes default values.The call to
process_reportnow includes the default values forexit_codeandexit_reason, ensuring consistency in the reporting functionality.
safety/scan/command.py
Outdated
| fixes = process_fixes_scan(file_to_fix, | ||
|
|
||
| fixes = process_fixes_scan(file_to_fix, |
There was a problem hiding this comment.
Remove unused variable fixes.
The variable fixes is assigned but never used, which is unnecessary.
- fixes = process_fixes_scan(file_to_fix,
- specs_to_fix, update_limits, output, no_output=no_output,
- prompt=prompt)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| fixes = process_fixes_scan(file_to_fix, | |
| process_fixes_scan(file_to_fix, | |
| specs_to_fix, update_limits, output, no_output=no_output, | |
| prompt=prompt) |
Tools
Ruff
472-472: Local variable
fixesis assigned to but never usedRemove assignment to unused variable
fixes(F841)
There was a problem hiding this comment.
i agree with coderabbit's suggested change here: remove fixes =
There was a problem hiding this comment.
"""
@jeff-at-safety, thanks for confirming the change. I'll proceed to remove the assignment to the fixes variable as suggested.
If you found this review helpful, would you consider giving us a shout-out on X?
Thank you for using CodeRabbit!
|
I noticed that a datetime serialization error is thrown during testing. I don't believe this issue is directly related to the changes introduced here, but we could introduce datetime serialization logic to address it if needed. Specifically, we can add a custom serializer to handle datetime objects when generating the JSON result. Please let me know if you would like me to include this fix in the current PR! |
safety/scan/command.py
Outdated
| fixes = process_fixes_scan(file_to_fix, | ||
|
|
||
| fixes = process_fixes_scan(file_to_fix, |
There was a problem hiding this comment.
i agree with coderabbit's suggested change here: remove fixes =
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- safety/scan/command.py (32 hunks)
Files skipped from review as they are similar to previous changes (1)
- safety/scan/command.py
Description:
This PR introduces enhancements to the
scanandprocess_reportfunctions to include the exit code and corresponding reason in the JSON result. This improvement aims to provide better insights into the scan outcomes, making it easier for the platform to understand and act upon the results. This also ensures that the exit code result will be in audit logs for historical data and for customers that ingest and parse and rely on this JSON output.Changes Made:
exit_codeandexit_reasonwith default values (0and"No vulnerabilities found."respectively).EXIT_CODE_REASON_MAPPINGto map exit codes to their corresponding reasons.exit_reasonbased on the determinedexit_codeusing the mapping dictionary.exit_codeandexit_reason.Details:
EXIT_CODE_REASON_MAPPINGinsafety/constants.pyto map predefined exit codes to user-friendly reason strings. This helps in providing clear and understandable reasons for each exit code.process_reportfunction now accepts and includesexit_codeandexit_reasonin the generated JSON report. This allows for more comprehensive reporting of scan results.scanfunction to determine and setexit_reasonbased on theexit_code. Similarly, ensured thesystem_scanfunction passes default values for these parameters toprocess_report.Rationale:
Including the exit code and its corresponding reason in the JSON result enhances the clarity of scan reports. This improvement facilitates better decision-making and error handling on the platform, ultimately improving the user experience.
Summary by CodeRabbit
New Features
Bug Fixes
Style