# -*- coding: utf-8 -*- # BSD 2-Clause License # # Apprise - Push Notification Library. # Copyright (c) 2024, Chris Caron # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met: # # 1. Redistributions of source code must retain the above copyright notice, # this list of conditions and the following disclaimer. # # 2. Redistributions in binary form must reproduce the above copyright notice, # this list of conditions and the following disclaimer in the documentation # and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. from unittest import mock import requests from json import loads from apprise import Apprise from apprise.plugins.bulkvs import NotifyBulkVS from helpers import AppriseURLTester from apprise import NotifyType # Disable logging for a cleaner testing output import logging logging.disable(logging.CRITICAL) # Our Testing URLs apprise_url_tests = ( ('bulkvs://', { # Instantiated but no auth, so no otification can happen 'instance': TypeError, }), ('bulkvs://:@/', { # invalid auth 'instance': TypeError, }), ('bulkvs://{}@9876543210/'.format('a' * 10), { # Just user provided (no password) 'instance': TypeError, }), ('bulkvs://{}:{}@{}'.format('u' * 10, 'p' * 10, '3' * 5), { # invalid source number provided 'instance': TypeError, }), ('bulkvs://{}:{}@{}/{}'.format('u' * 10, 'p' * 10, '1' * 10, 2 * '5'), { # invalid target number provided 'instance': NotifyBulkVS, # Expected notify() response because we have no one to notify 'notify_response': False, }), ('bulkvs://{}:{}@{}'.format('u' * 10, 'p' * 10, '2' * 10), { # default to ourselves 'instance': NotifyBulkVS, }), ('bulkvs://{}:{}@9876543210/{}/abcd/'.format( 'a' * 5, 'b' * 10, '3' * 11), { # included phone, short number (123) and garbage string (abcd) dropped 'instance': NotifyBulkVS, 'privacy_url': 'bulkvs://a...a:****@9876543210/33333333333' }), ('bulkvs://{}:{}@{}?batch=y'.format( 'b' * 5, 'c' * 10, '4' * 11), { 'instance': NotifyBulkVS, # Our expected url(privacy=True) startswith() response: 'privacy_url': 'bulkvs://b...b:****@44444444444', }), ('bulkvs://{}:{}@{}'.format('a' * 10, 'b' * 10, '5' * 11), { # using phone no with no target - we text ourselves in # this case 'instance': NotifyBulkVS, }), ('bulkvs://?user={}&password={}&from={}'.format( 'z' * 10, 'y' * 10, '5' * 11), { # use get args to acomplish the same thing 'instance': NotifyBulkVS, }), ('bulkvs://?user={}&password={}&from={}&to={}'.format( 'a' * 10, 'b' * 10, '5' * 11, '7' * 13), { # use to= 'instance': NotifyBulkVS, }), ('bulkvs://{}:{}@{}'.format('a' * 10, 'b' * 10, '5' * 11), { 'instance': NotifyBulkVS, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('bulkvs://{}:{}@{}'.format('a' * 10, 'b' * 10, '5' * 11), { 'instance': NotifyBulkVS, # 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_bulkvs_urls(): """ NotifyTemplate() Apprise URLs """ # Run our general tests AppriseURLTester(tests=apprise_url_tests).run_all() @mock.patch('requests.post') def test_plugin_bulkvs_edge_cases(mock_post): """ NotifyBulkVS() Edge Cases """ # Initialize some generic (but valid) tokens user = 'abcd' pwd = 'mypass123' source = "1 (405) 123 1234" targets = [ '+1(555) 123-1234', '1555 5555555', # A garbage entry '12', # NOw a valid one because a group was implicit '@12', ] # Prepare our response response = requests.Request() response.status_code = requests.codes.ok # Prepare Mock mock_post.return_value = response # Instantiate our object obj = Apprise.instantiate( 'bulkvs://{}:{}@{}/{}?batch=n'.format( user, pwd, source, '/'.join(targets))) assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is True # We know there are 2 targets assert len(obj) == 2 # Test our call count assert mock_post.call_count == 2 # Test details = mock_post.call_args_list[0] payload = loads(details[1]['data']) assert payload['From'] == '14051231234' assert payload['To'] == '15551231234' assert payload['Message'] == 'title\r\nbody' details = mock_post.call_args_list[1] payload = loads(details[1]['data']) assert payload['From'] == '14051231234' assert payload['To'] == '15555555555' assert payload['Message'] == 'title\r\nbody' # Verify our URL looks good assert obj.url().startswith( 'bulkvs://abcd:mypass123@14051231234/15551231234/15555555555') assert 'batch=no' in obj.url() # With our batch in place, our calculations are different obj = Apprise.instantiate( 'bulkvs://{}:{}@{}?batch=y'.format(user, pwd, '/'.join(targets))) # 2 phones are lumped together assert len(obj) == 1