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

Add Pushover Notification Support and Unit Tests #286

Merged
merged 17 commits into from
Feb 11, 2025

Conversation

john-pierre
Copy link
Contributor

@john-pierre john-pierre commented Jan 29, 2025

This PR introduces support for Pushover notifications in the icloud-docker project. The following enhancements have been made:

Added Pushover Integration:
Implemented Pushover notifications in notify.py to allow sending alerts via the Pushover API.
Updated config_parser.py to include Pushover-related configuration fields (user_key and api_token).

Extended Unit Tests:
Added test cases in test_notify.py to validate Pushover notifications.
Updated test_config_parser.py to ensure correct parsing of Pushover settings.

Updated Documentation:
Enhanced README.md with details about configuring Pushover notifications.
These improvements provide an additional notification channel, making icloud-docker more versatile for different user preferences.

Looking forward to feedback and suggestions!

Summary by Sourcery

Add Pushover support for notifications.

New Features:

  • Implement Pushover notifications as a new notification channel.

Tests:

  • Add unit tests for the new Pushover notification functionality.

@mandarons
Copy link
Owner

@sourcery-ai review

Copy link

sourcery-ai bot commented Feb 10, 2025

Reviewer's Guide by Sourcery

This pull request adds support for Pushover notifications in the icloud-docker project. The changes include new functions to send notifications via Pushover, configuration parsing enhancements to support Pushover settings, extended unit tests to validate the new functionality, and updates to documentation and configuration files. The implementation involves adding new modules in the notification and configuration code, integrating Pushover API calls, and testing multiple scenarios including success, failure, throttling, and dry-run modes.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Implemented Pushover notification functionality.
  • Added notify_pushover function in the notification module to handle Pushover alerts based on configuration and conditions.
  • Introduced post_message_to_pushover to wrap the HTTP call to the Pushover API.
  • Integrated the Pushover notification into the general send method.
src/notify.py
Enhanced configuration parsing to support Pushover settings.
  • Added get_pushover_user_key and get_pushover_api_token functions to extract Pushover configuration.
  • Updated relevant sections to warn when configuration is missing.
src/config_parser.py
Extended unit tests to cover Pushover functionality.
  • Created multiple test cases in test_notify.py to assess successful notifications, failure responses, throttling behavior, dry run mode, and missing configuration scenarios for Pushover.
  • Added tests in test_config_parser.py to validate correct parsing of Pushover keys from the configuration.
tests/test_notify.py
tests/test_config_parser.py
Updated documentation and configuration samples for Pushover support.
  • Expanded README.md to include instructions for configuring Pushover notifications.
  • Modified config.yaml and test configuration files to include Pushover configuration comments.
README.md
config.yaml
tests/data/test_config.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @john-pierre - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a helper function to reduce the duplication in test_post_message_to_pushover and test_post_message_to_pushover_fail.
  • The throttling test in test_notify.py could be improved by asserting that the last_send time is updated when a message is sent.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mandarons mandarons merged commit 5dca527 into mandarons:main Feb 11, 2025
2 checks passed
@mandarons
Copy link
Owner

@john-pierre : Thank you for very well-written PR! It was a pleasure to merge it in the project. 🥇

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.

2 participants