mirror of
https://github.com/caronc/apprise.git
synced 2024-11-22 16:13:12 +01:00
c9f0751b61
While the namespace is physically made of modules, it has been amended to be the namespace home for the corresponding notifier classes as well. This turned out to confuse both humans and machines on various ends. While it has apparently worked for a while, it croaks on Python 3.11 now, and is not considered to have been a good idea in general.
288 lines
9.0 KiB
Python
288 lines
9.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2021 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 re
|
|
from unittest import mock
|
|
|
|
import requests
|
|
from apprise import Apprise
|
|
from apprise import AppriseAttachment
|
|
from apprise import NotifyType
|
|
from apprise.plugins.NotifyXML import NotifyXML
|
|
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 = (
|
|
('xml://:@/', {
|
|
'instance': None,
|
|
}),
|
|
('xml://', {
|
|
'instance': None,
|
|
}),
|
|
('xmls://', {
|
|
'instance': None,
|
|
}),
|
|
('xml://localhost', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost?method=invalid', {
|
|
'instance': TypeError,
|
|
}),
|
|
('xml://user:pass@localhost', {
|
|
'instance': NotifyXML,
|
|
|
|
# Our expected url(privacy=True) startswith() response:
|
|
'privacy_url': 'xml://user:****@localhost',
|
|
}),
|
|
|
|
# Test method variations
|
|
('xml://user@localhost?method=put', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost?method=get', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost?method=post', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost?method=head', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user@localhost?method=delete', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
|
|
# Continue testing other cases
|
|
('xml://localhost:8080', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user:pass@localhost:8080', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xmls://localhost', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xmls://user:pass@localhost', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
# Continue testing other cases
|
|
('xml://localhost:8080', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user:pass@localhost:8080', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://localhost', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xmls://user:pass@localhost', {
|
|
'instance': NotifyXML,
|
|
# Our expected url(privacy=True) startswith() response:
|
|
'privacy_url': 'xmls://user:****@localhost',
|
|
}),
|
|
('xml://user@localhost:8080/path/', {
|
|
'instance': NotifyXML,
|
|
'privacy_url': 'xml://user@localhost:8080/path',
|
|
}),
|
|
('xmls://localhost:8080/path/', {
|
|
'instance': NotifyXML,
|
|
# Our expected url(privacy=True) startswith() response:
|
|
'privacy_url': 'xmls://localhost:8080/path/',
|
|
}),
|
|
('xmls://user:pass@localhost:8080', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
# Test our GET params
|
|
('xml://localhost:8080/path?-ParamA=Value', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
# Test our Headers
|
|
('xml://localhost:8080/path?+HeaderKey=HeaderValue', {
|
|
'instance': NotifyXML,
|
|
}),
|
|
('xml://user:pass@localhost:8081', {
|
|
'instance': NotifyXML,
|
|
# force a failure
|
|
'response': False,
|
|
'requests_response_code': requests.codes.internal_server_error,
|
|
}),
|
|
('xml://user:pass@localhost:8082', {
|
|
'instance': NotifyXML,
|
|
# throw a bizzare code forcing us to fail to look it up
|
|
'response': False,
|
|
'requests_response_code': 999,
|
|
}),
|
|
('xml://user:pass@localhost:8083', {
|
|
'instance': NotifyXML,
|
|
# 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_custom_xml_urls():
|
|
"""
|
|
NotifyXML() Apprise URLs
|
|
|
|
"""
|
|
|
|
# Run our general tests
|
|
AppriseURLTester(tests=apprise_url_tests).run_all()
|
|
|
|
|
|
@mock.patch('requests.post')
|
|
def test_notify_xml_plugin_attachments(mock_post, no_throttling):
|
|
"""
|
|
NotifyXML() Attachments
|
|
|
|
"""
|
|
|
|
okay_response = requests.Request()
|
|
okay_response.status_code = requests.codes.ok
|
|
okay_response.content = ""
|
|
|
|
# Assign our mock object our return value
|
|
mock_post.return_value = okay_response
|
|
|
|
obj = Apprise.instantiate('xml://localhost.localdomain/')
|
|
assert isinstance(obj, NotifyXML)
|
|
|
|
# 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
|
|
|
|
# Test Valid Attachment (load 3)
|
|
path = (
|
|
os.path.join(TEST_VAR_DIR, 'apprise-test.gif'),
|
|
os.path.join(TEST_VAR_DIR, 'apprise-test.gif'),
|
|
os.path.join(TEST_VAR_DIR, 'apprise-test.gif'),
|
|
)
|
|
attach = AppriseAttachment(path)
|
|
|
|
# Return our good configuration
|
|
mock_post.side_effect = None
|
|
mock_post.return_value = okay_response
|
|
with mock.patch('builtins.open', side_effect=OSError()):
|
|
# We can't send the message we can't open the attachment for reading
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is False
|
|
|
|
# test the handling of our batch modes
|
|
obj = Apprise.instantiate('xml://no-reply@example.com/')
|
|
assert isinstance(obj, NotifyXML)
|
|
|
|
# Now send an attachment normally without issues
|
|
mock_post.reset_mock()
|
|
assert obj.notify(
|
|
body='body', title='title', notify_type=NotifyType.INFO,
|
|
attach=attach) is True
|
|
assert mock_post.call_count == 1
|
|
|
|
|
|
@mock.patch('requests.post')
|
|
@mock.patch('requests.get')
|
|
def test_plugin_custom_xml_edge_cases(mock_get, mock_post, no_throttling):
|
|
"""
|
|
NotifyXML() Edge Cases
|
|
|
|
"""
|
|
|
|
# Prepare our response
|
|
response = requests.Request()
|
|
response.status_code = requests.codes.ok
|
|
|
|
# Prepare Mock
|
|
mock_post.return_value = response
|
|
mock_get.return_value = response
|
|
|
|
results = NotifyXML.parse_url(
|
|
'xml://localhost:8080/command?:Message=test&method=GET'
|
|
'&:Key=value&:,=invalid')
|
|
|
|
assert isinstance(results, dict)
|
|
assert results['user'] is None
|
|
assert results['password'] is None
|
|
assert results['port'] == 8080
|
|
assert results['host'] == 'localhost'
|
|
assert results['fullpath'] == '/command'
|
|
assert results['path'] == '/'
|
|
assert results['query'] == 'command'
|
|
assert results['schema'] == 'xml'
|
|
assert results['url'] == 'xml://localhost:8080/command'
|
|
assert isinstance(results['qsd:'], dict) is True
|
|
assert results['qsd:']['Message'] == 'test'
|
|
assert results['qsd:']['Key'] == 'value'
|
|
assert results['qsd:'][','] == 'invalid'
|
|
|
|
instance = NotifyXML(**results)
|
|
assert isinstance(instance, NotifyXML)
|
|
|
|
response = instance.send(title='title', body='body')
|
|
assert response is True
|
|
assert mock_post.call_count == 0
|
|
assert mock_get.call_count == 1
|
|
|
|
details = mock_get.call_args_list[0]
|
|
assert details[0][0] == 'http://localhost:8080/command'
|
|
assert instance.url(privacy=False).startswith(
|
|
'xml://localhost:8080/command?')
|
|
|
|
# Generate a new URL based on our last and verify key values are the same
|
|
new_results = NotifyXML.parse_url(instance.url(safe=False))
|
|
for k in ('user', 'password', 'port', 'host', 'fullpath', 'path', 'query',
|
|
'schema', 'url', 'method'):
|
|
assert new_results[k] == results[k]
|
|
|
|
# Test our data set for our key/value pair
|
|
assert re.search(r'<Version>[1-9]+\.[0-9]+</Version>', details[1]['data'])
|
|
assert re.search('<MessageType>info</MessageType>', details[1]['data'])
|
|
assert re.search('<Subject>title</Subject>', details[1]['data'])
|
|
# Custom entry Message acts as Over-ride and kicks in here
|
|
assert re.search('<Message>test</Message>', details[1]['data'])
|
|
# Custom entry
|
|
assert re.search('<Key>value</Key>', details[1]['data'])
|