mirror of
https://github.com/caronc/apprise.git
synced 2024-12-02 04:54:05 +01:00
c81d2465e4
Instead of needing to individually disable throttling on a per-plugin basis, this fixture takes care of all notifiers in `NOTIFY_MODULE_MAP` automatically. With `autouse=True`, there is no need to activate it manually.
406 lines
14 KiB
Python
406 lines
14 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2020 Chris Caron <lead2gold@gmail.com>
|
|
# 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 os
|
|
import pytest
|
|
from unittest import mock
|
|
|
|
import requests
|
|
from json import dumps
|
|
from apprise import Apprise
|
|
from apprise import AppriseAttachment
|
|
from apprise import NotifyType
|
|
from apprise.plugins.NotifySparkPost import NotifySparkPost
|
|
from helpers import AppriseURLTester
|
|
|
|
# Disable logging for a cleaner testing output
|
|
import logging
|
|
logging.disable(logging.CRITICAL)
|
|
|
|
# Attachment Directory
|
|
TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')
|
|
|
|
# Our Testing URLs
|
|
apprise_url_tests = (
|
|
('sparkpost://', {
|
|
'instance': TypeError,
|
|
}),
|
|
('sparkpost://:@/', {
|
|
'instance': TypeError,
|
|
}),
|
|
# No Token specified
|
|
('sparkpost://user@localhost.localdomain', {
|
|
'instance': TypeError,
|
|
}),
|
|
# Token is valid, but no user name specified
|
|
('sparkpost://localhost.localdomain/{}'.format('a' * 32), {
|
|
'instance': TypeError,
|
|
}),
|
|
# Invalid from email address
|
|
('sparkpost://"@localhost.localdomain/{}'.format('b' * 32), {
|
|
'instance': TypeError,
|
|
}),
|
|
# No To email address, but everything else is valid
|
|
('sparkpost://user@localhost.localdomain/{}'.format('c' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}?format=markdown'
|
|
.format('d' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}?format=html'
|
|
.format('d' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}?format=text'
|
|
.format('d' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# valid url with region specified (case insensitve)
|
|
('sparkpost://user@localhost.localdomain/{}?region=uS'.format('d' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# valid url with region specified (case insensitve)
|
|
('sparkpost://user@localhost.localdomain/{}?region=EU'.format('e' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# headers
|
|
('sparkpost://user@localhost.localdomain/{}'
|
|
'?+X-Customer-Campaign-ID=Apprise'.format('f' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# template tokens
|
|
('sparkpost://user@localhost.localdomain/{}'
|
|
'?:name=Chris&:status=admin'.format('g' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# bcc and cc
|
|
('sparkpost://user@localhost.localdomain/{}'
|
|
'?bcc=user@example.com&cc=user2@example.com'.format('h' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# invalid url with region specified (case insensitve)
|
|
('sparkpost://user@localhost.localdomain/{}?region=invalid'.format(
|
|
'a' * 32), {
|
|
'instance': TypeError,
|
|
}),
|
|
# One 'To' Email address
|
|
('sparkpost://user@localhost.localdomain/{}/test@example.com'.format(
|
|
'a' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# Invalid 'To' Email address
|
|
('sparkpost://user@localhost.localdomain/{}/invalid'.format(
|
|
'i' * 32), {
|
|
'instance': NotifySparkPost,
|
|
# Expected notify() response
|
|
'notify_response': False,
|
|
}),
|
|
# Multiple 'To', 'Cc', and 'Bcc' addresses (with invalid ones)
|
|
('sparkpost://user@example.com/{}/{}?bcc={}&cc={}'.format(
|
|
'j' * 32,
|
|
'/'.join(('user1@example.com', 'invalid', 'User2:user2@example.com')),
|
|
','.join(('user3@example.com', 'i@v', 'User1:user1@example.com')),
|
|
','.join(('user4@example.com', 'g@r@b', 'Da:user5@example.com'))), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/'
|
|
'{}?to=test@example.com'.format('k' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# One To Email address, a from name specified too
|
|
('sparkpost://user@localhost.localdomain/{}/'
|
|
'test@example.com?name="Frodo"'.format('l' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': {
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
},
|
|
}),
|
|
# Test invalid JSON response
|
|
('sparkpost://user@localhost.localdomain/{}'.format('m' * 32), {
|
|
'instance': NotifySparkPost,
|
|
'requests_response_text': "{",
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}'.format('n' * 32), {
|
|
'instance': NotifySparkPost,
|
|
# force a failure
|
|
'response': False,
|
|
'requests_response_code': requests.codes.internal_server_error,
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}'.format('o' * 32), {
|
|
'instance': NotifySparkPost,
|
|
# throw a bizzare code forcing us to fail to look it up
|
|
'response': False,
|
|
'requests_response_code': 999,
|
|
}),
|
|
('sparkpost://user@localhost.localdomain/{}'.format('p' * 32), {
|
|
'instance': NotifySparkPost,
|
|
# 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_sparkpost_urls():
|
|
"""
|
|
NotifySparkPost() Apprise URLs
|
|
|
|
"""
|
|
|
|
# Run our general tests
|
|
AppriseURLTester(tests=apprise_url_tests).run_all()
|
|
|
|
|
|
@mock.patch('requests.post')
|
|
def test_plugin_sparkpost_throttling(mock_post):
|
|
"""
|
|
NotifySparkPost() Throttling
|
|
|
|
"""
|
|
|
|
NotifySparkPost.sparkpost_retry_wait_sec = 0.1
|
|
NotifySparkPost.sparkpost_retry_attempts = 3
|
|
|
|
# API Key
|
|
apikey = 'abc123'
|
|
user = 'user'
|
|
host = 'example.com'
|
|
targets = '{}@{}'.format(user, host)
|
|
|
|
# Exception should be thrown about the fact no user was specified
|
|
with pytest.raises(TypeError):
|
|
NotifySparkPost(
|
|
apikey=apikey, targets=targets, host=host)
|
|
|
|
# Exception should be thrown about the fact no private key was specified
|
|
with pytest.raises(TypeError):
|
|
NotifySparkPost(
|
|
apikey=None, targets=targets, user=user, host=host)
|
|
|
|
okay_response = requests.Request()
|
|
okay_response.status_code = requests.codes.ok
|
|
okay_response.content = dumps({
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
})
|
|
|
|
retry_response = requests.Request()
|
|
retry_response.status_code = requests.codes.too_many_requests
|
|
retry_response.content = dumps({
|
|
"errors": [
|
|
{
|
|
"description":
|
|
"Unconfigured or unverified sending domain.",
|
|
"code": "7001",
|
|
"message": "Invalid domain"
|
|
}
|
|
]
|
|
})
|
|
|
|
# Prepare Mock (force 2 retry responses and then one okay)
|
|
mock_post.side_effect = \
|
|
(retry_response, retry_response, okay_response)
|
|
|
|
obj = Apprise.instantiate(
|
|
'sparkpost://user@localhost.localdomain/{}'.format(apikey))
|
|
assert isinstance(obj, NotifySparkPost)
|
|
|
|
# We'll successfully perform the notification as we're within
|
|
# our retry limit
|
|
assert obj.notify('test') is True
|
|
|
|
mock_post.reset_mock()
|
|
mock_post.side_effect = \
|
|
(retry_response, retry_response, retry_response)
|
|
|
|
# Now we are less than our expected limit check so we will fail
|
|
assert obj.notify('test') is False
|
|
|
|
|
|
@mock.patch('requests.post')
|
|
def test_plugin_sparkpost_attachments(mock_post):
|
|
"""
|
|
NotifySparkPost() Attachments
|
|
|
|
"""
|
|
NotifySparkPost.sparkpost_retry_wait_sec = 0.1
|
|
NotifySparkPost.sparkpost_retry_attempts = 3
|
|
|
|
okay_response = requests.Request()
|
|
okay_response.status_code = requests.codes.ok
|
|
okay_response.content = dumps({
|
|
"results": {
|
|
"total_rejected_recipients": 0,
|
|
"total_accepted_recipients": 1,
|
|
"id": "11668787484950529"
|
|
}
|
|
})
|
|
|
|
# Assign our mock object our return value
|
|
mock_post.return_value = okay_response
|
|
|
|
# API Key
|
|
apikey = 'abc123'
|
|
|
|
obj = Apprise.instantiate(
|
|
'sparkpost://user@localhost.localdomain/{}'.format(apikey))
|
|
assert isinstance(obj, NotifySparkPost)
|
|
|
|
# Test Valid Attachment
|
|
path = os.path.join(TEST_VAR_DIR, 'apprise-test.gif')
|
|
attach = AppriseAttachment(path)
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is True
|
|
|
|
# Test invalid attachment
|
|
path = os.path.join(TEST_VAR_DIR, '/invalid/path/to/an/invalid/file.jpg')
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=path) is False
|
|
|
|
with mock.patch('base64.b64encode', side_effect=OSError()):
|
|
# We can't send the message if we fail to parse the data
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is False
|
|
|
|
obj = Apprise.instantiate(
|
|
'sparkpost://no-reply@example.com/{}/'
|
|
'user1@example.com/user2@example.com?batch=yes'.format(apikey))
|
|
assert isinstance(obj, NotifySparkPost)
|
|
|
|
# Force our batch to break into separate messages
|
|
obj.default_batch_size = 1
|
|
# We'll send 2 messages
|
|
mock_post.reset_mock()
|
|
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is True
|
|
assert mock_post.call_count == 2
|
|
|
|
# single batch
|
|
mock_post.reset_mock()
|
|
# We'll send 1 message
|
|
obj.default_batch_size = 2
|
|
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is True
|
|
assert mock_post.call_count == 1
|