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.
Summary
This pull request enhances error handling and logging in the
tools/utils/repo.py
module. It also adds corresponding tests and updates the changelog.Changes
log
for consistency. Utilized logger's built-in formatting capabilities.ClientError
,NoCredentialsError
, andPartialCredentialsError
to improve error messaging and control flow.CHANGELOG.md
to document these improvements.tests/test_repo.py
to add tests for the logging functionality usingcaplog
.Detailed Changes
Logging Enhancements
log
for better logging practices.Error Handling Improvements
ClientError
to log specific S3-related issues.NoCredentialsError
andPartialCredentialsError
to log credential-related issues.Changelog Update
CHANGELOG.md
under the Unreleased section.Tests
tests/test_repo.py
.caplog
.Testing
get_repo_json_file_contents
function handles different exceptions correctly and logs appropriate messages.caplog
to check that logging occurs as expected during different scenarios.Additional Notes
These changes aim to improve the robustness and maintainability of the code, making it easier to debug and understand. The logging ensures that detailed information is available when issues arise, facilitating quicker resolution.
Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
Commits signed with GPG?
Yes/No
Please review Salt's Contributing Guide for best practices, including the
PR Guidelines.
See GitHub's page on GPG signing for more information about signing commits with GPG.