# -*- coding: utf-8 -*- # # Copyright (C) 2021 Chris Caron # All rights reserved. # # This code is licensed under the MIT License. # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files(the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and / or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions : # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. import mock import pytest import requests from apprise import plugins from helpers import AppriseURLTester # Disable logging for a cleaner testing output import logging logging.disable(logging.CRITICAL) # Our Testing URLs apprise_url_tests = ( ('pushed://', { 'instance': TypeError, }), # Application Key Only ('pushed://%s' % ('a' * 32), { 'instance': TypeError, }), # Invalid URL ('pushed://:@/', { 'instance': TypeError, }), # Application Key+Secret ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # Application Key+Secret + channel ('pushed://%s/%s/#channel/' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # Application Key+Secret + channel (via to=) ('pushed://%s/%s?to=channel' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # Our expected url(privacy=True) startswith() response: 'privacy_url': 'pushed://a...a/****/', }), # Application Key+Secret + dropped entry ('pushed://%s/%s/dropped_value/' % ('a' * 32, 'a' * 64), { # No entries validated is a fail 'instance': TypeError, }), # Application Key+Secret + 2 channels ('pushed://%s/%s/#channel1/#channel2' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # Application Key+Secret + User Pushed ID ('pushed://%s/%s/@ABCD/' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # Application Key+Secret + 2 devices ('pushed://%s/%s/@ABCD/@DEFG/' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # Application Key+Secret + Combo ('pushed://%s/%s/@ABCD/#channel' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, }), # , ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # force a failure 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # Throws a series of connection and transfer exceptions when this flag # is set and tests that we gracfully handle them 'test_requests_exceptions': True, }), ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # force a failure 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('pushed://%s/%s/#channel' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('pushed://%s/%s/@user' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('pushed://%s/%s' % ('a' * 32, 'a' * 64), { 'instance': plugins.NotifyPushed, # Throws a series of connection and transfer exceptions when this flag # is set and tests that we gracfully handle them 'test_requests_exceptions': True, }), ) def test_plugin_pushed_urls(): """ NotifyPushed() Apprise URLs """ # Run our general tests AppriseURLTester(tests=apprise_url_tests).run_all() @mock.patch('requests.get') @mock.patch('requests.post') def test_plugin_pushed_edge_cases(mock_post, mock_get): """ NotifyPushed() Edge Cases """ # Disable Throttling to speed testing plugins.NotifyBase.request_rate_per_sec = 0 # Chat ID recipients = '@ABCDEFG, @DEFGHIJ, #channel, #channel2' # Some required input app_key = 'ABCDEFG' app_secret = 'ABCDEFG' # Prepare Mock mock_get.return_value = requests.Request() mock_post.return_value = requests.Request() mock_post.return_value.status_code = requests.codes.ok mock_get.return_value.status_code = requests.codes.ok # No application Key specified with pytest.raises(TypeError): plugins.NotifyPushed( app_key=None, app_secret=app_secret, recipients=None, ) with pytest.raises(TypeError): plugins.NotifyPushed( app_key=" ", app_secret=app_secret, recipients=None, ) # No application Secret specified with pytest.raises(TypeError): plugins.NotifyPushed( app_key=app_key, app_secret=None, recipients=None, ) with pytest.raises(TypeError): plugins.NotifyPushed( app_key=app_key, app_secret=" ", ) # recipients list set to (None) is perfectly fine; in this case it will # notify the App obj = plugins.NotifyPushed( app_key=app_key, app_secret=app_secret, recipients=None, ) assert isinstance(obj, plugins.NotifyPushed) is True assert len(obj.channels) == 0 assert len(obj.users) == 0 obj = plugins.NotifyPushed( app_key=app_key, app_secret=app_secret, targets=recipients, ) assert isinstance(obj, plugins.NotifyPushed) is True assert len(obj.channels) == 2 assert len(obj.users) == 2 # Prepare Mock to fail mock_post.return_value.status_code = requests.codes.internal_server_error mock_get.return_value.status_code = requests.codes.internal_server_error