1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
|
# -*- coding: utf-8 -*-
# BSD 2-Clause License
#
# Apprise - Push Notification Library.
# Copyright (c) 2025, Chris Caron <lead2gold@gmail.com>
#
# 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 pytest
import requests
from json import dumps
from apprise.plugins.burstsms import NotifyBurstSMS
from helpers import AppriseURLTester
# Disable logging for a cleaner testing output
import logging
logging.disable(logging.CRITICAL)
# Our Testing URLs
apprise_url_tests = (
('burstsms://', {
# No API Key specified
'instance': TypeError,
}),
('burstsms://:@/', {
# invalid Auth key
'instance': TypeError,
}),
('burstsms://{}@12345678'.format('a' * 8), {
# Just a key provided
'instance': TypeError,
}),
('burstsms://{}:{}@%20'.format('d' * 8, 'e' * 16), {
# Invalid source number
'instance': TypeError,
}),
('burstsms://{}:{}@{}/123/{}/abcd/'.format(
'f' * 8, 'g' * 16, '3' * 11, '9' * 15), {
# valid everything but target numbers
'instance': NotifyBurstSMS,
# Expected notify() response because not all targets are valid
'notify_response': False,
# Our expected url(privacy=True) startswith() response:
'privacy_url': 'burstsms://f...f:****@',
}),
('burstsms://{}:{}@{}'.format('h' * 8, 'i' * 16, '5' * 11), {
'instance': NotifyBurstSMS,
# Expected notify() response because no targets are defined
'notify_response': False,
}),
('burstsms://_?key={}&secret={}&from={}&to={}'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
# use get args to acomplish the same thing
'instance': NotifyBurstSMS,
}),
('burstsms://_?key={}&secret={}&from={}&to={}&batch=y'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
# batch flag set
'instance': NotifyBurstSMS,
}),
# Test our country
('burstsms://_?key={}&secret={}&source={}&to={}&country=us'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
'instance': NotifyBurstSMS,
}),
# Test an invalid country
('burstsms://_?key={}&secret={}&source={}&to={}&country=invalid'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
'instance': TypeError,
}),
# Test our validity
('burstsms://_?key={}&secret={}&source={}&to={}&validity=10'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
'instance': NotifyBurstSMS,
}),
# Test an invalid country
('burstsms://_?key={}&secret={}&source={}&to={}&validity=invalid'.format(
'a' * 8, 'b' * 16, '5' * 11, '6' * 11), {
'instance': TypeError,
}),
('burstsms://_?key={}&secret={}&from={}&to={}'.format(
'a' * 8, 'b' * 16, '5' * 11, '7' * 11), {
# use to=
'instance': NotifyBurstSMS,
}),
('burstsms://{}:{}@{}/{}'.format('a' * 8, 'b' * 16, '6' * 11, '7' * 11), {
'instance': NotifyBurstSMS,
# throw a bizzare code forcing us to fail to look it up
'response': False,
'requests_response_code': 999,
}),
('burstsms://{}:{}@{}/{}'.format('a' * 8, 'b' * 16, '6' * 11, '7' * 11), {
'instance': NotifyBurstSMS,
# 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_burstsms_urls():
"""
NotifyBurstSMS() Apprise URLs
"""
# Run our general tests
AppriseURLTester(tests=apprise_url_tests).run_all()
@mock.patch('requests.post')
def test_plugin_burstsms_edge_cases(mock_post):
"""
NotifyBurstSMS() Edge Cases
"""
# Prepare our response
response = requests.Request()
response.status_code = requests.codes.ok
# Prepare Mock
mock_post.return_value = response
# Initialize some generic (but valid) tokens
apikey = '{}'.format('b' * 8)
secret = '{}'.format('b' * 16)
source = '+1 (555) 123-3456'
# No apikey specified
with pytest.raises(TypeError):
NotifyBurstSMS(apikey=None, secret=secret, source=source)
with pytest.raises(TypeError):
NotifyBurstSMS(apikey=" ", secret=secret, source=source)
# No secret specified
with pytest.raises(TypeError):
NotifyBurstSMS(apikey=apikey, secret=None, source=source)
with pytest.raises(TypeError):
NotifyBurstSMS(apikey=apikey, secret=" ", source=source)
# a error response
response.status_code = 400
response.content = dumps({
"error": {
"code": "FIELD_INVALID",
"description":
"Sender ID must be one of the numbers that are currently leased.",
},
})
mock_post.return_value = response
# Initialize our object
obj = NotifyBurstSMS(apikey=apikey, secret=secret, source=source)
# We will fail with the above error code
assert obj.notify('title', 'body', 'info') is False
|