mirror of https://github.com/caronc/apprise
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
329 lines
11 KiB
329 lines
11 KiB
# -*- 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. |
|
from __future__ import print_function |
|
import sys |
|
from json import loads |
|
import pytest |
|
import requests |
|
import mock |
|
import apprise |
|
|
|
|
|
@mock.patch('requests.post') |
|
def test_apprise_interpret_escapes(mock_post): |
|
""" |
|
API: Apprise() interpret-escapse tests |
|
""" |
|
|
|
# Prepare Mock |
|
mock_post.return_value = requests.Request() |
|
mock_post.return_value.status_code = requests.codes.ok |
|
|
|
# Default Escapes interpretation Mode is set to disable |
|
asset = apprise.AppriseAsset() |
|
assert asset.interpret_escapes is False |
|
|
|
# Load our asset |
|
a = apprise.Apprise(asset=asset) |
|
|
|
# add a test server |
|
assert a.add("json://localhost") is True |
|
|
|
# Our servers should carry this flag |
|
a[0].asset.interpret_escapes is False |
|
|
|
# Send notification |
|
assert a.notify("ab\\ncd") is True |
|
|
|
# Test our call count |
|
assert mock_post.call_count == 1 |
|
|
|
# content is not escaped |
|
loads(mock_post.call_args_list[0][1]['data'])\ |
|
.get('message', '') == 'ab\\ncd' |
|
|
|
# Reset |
|
mock_post.reset_mock() |
|
|
|
# Send notification and provide override: |
|
assert a.notify("ab\\ncd", interpret_escapes=True) is True |
|
|
|
# Test our call count |
|
assert mock_post.call_count == 1 |
|
|
|
# content IS escaped |
|
loads(mock_post.call_args_list[0][1]['data'])\ |
|
.get('message', '') == 'ab\ncd' |
|
|
|
# Reset |
|
mock_post.reset_mock() |
|
|
|
# |
|
# Now we test the reverse setup where we set the AppriseAsset |
|
# object to True but force it off through the notify() calls |
|
# |
|
|
|
# Default Escapes interpretation Mode is set to disable |
|
asset = apprise.AppriseAsset(interpret_escapes=True) |
|
assert asset.interpret_escapes is True |
|
|
|
# Load our asset |
|
a = apprise.Apprise(asset=asset) |
|
|
|
# add a test server |
|
assert a.add("json://localhost") is True |
|
|
|
# Our servers should carry this flag |
|
a[0].asset.interpret_escapes is True |
|
|
|
# Send notification |
|
assert a.notify("ab\\ncd") is True |
|
|
|
# Test our call count |
|
assert mock_post.call_count == 1 |
|
|
|
# content IS escaped |
|
loads(mock_post.call_args_list[0][1]['data'])\ |
|
.get('message', '') == 'ab\ncd' |
|
|
|
# Reset |
|
mock_post.reset_mock() |
|
|
|
# Send notification and provide override: |
|
assert a.notify("ab\\ncd", interpret_escapes=False) is True |
|
|
|
# Test our call count |
|
assert mock_post.call_count == 1 |
|
|
|
# content is NOT escaped |
|
loads(mock_post.call_args_list[0][1]['data'])\ |
|
.get('message', '') == 'ab\\ncd' |
|
|
|
|
|
@pytest.mark.skipif(sys.version_info.major <= 2, reason="Requires Python 3.x+") |
|
@mock.patch('requests.post') |
|
def test_apprise_escaping_py3(mock_post): |
|
""" |
|
API: Apprise() Python v3.x escaping |
|
|
|
""" |
|
a = apprise.Apprise() |
|
|
|
response = mock.Mock() |
|
response.content = '' |
|
response.status_code = requests.codes.ok |
|
mock_post.return_value = response |
|
|
|
# Create ourselves a test object to work with |
|
a.add('json://localhost') |
|
|
|
# Escape our content |
|
assert a.notify( |
|
title="\\r\\ntitle\\r\\n", body="\\r\\nbody\\r\\n", |
|
interpret_escapes=True) |
|
|
|
# Verify our content was escaped correctly |
|
assert mock_post.call_count == 1 |
|
result = loads(mock_post.call_args_list[0][1]['data']) |
|
assert result['title'] == 'title' |
|
assert result['message'] == '\r\nbody' |
|
|
|
# Reset our mock object |
|
mock_post.reset_mock() |
|
|
|
# |
|
# Support Specially encoded content: |
|
# |
|
|
|
# Escape our content |
|
assert a.notify( |
|
# Google Translated to Arabic: "Let's make the world a better place." |
|
title='دعونا نجعل العالم مكانا أفضل.\\r\\t\\t\\n\\r\\n', |
|
# Google Translated to Hungarian: "One line of code at a time.' |
|
body='Egy sor kódot egyszerre.\\r\\n\\r\\r\\n', |
|
# Our Escape Flag |
|
interpret_escapes=True) |
|
|
|
# Verify our content was escaped correctly |
|
assert mock_post.call_count == 1 |
|
result = loads(mock_post.call_args_list[0][1]['data']) |
|
assert result['title'] == 'دعونا نجعل العالم مكانا أفضل.' |
|
assert result['message'] == 'Egy sor kódot egyszerre.' |
|
|
|
# Error handling |
|
# |
|
# We can't escape the content below |
|
assert a.notify( |
|
title=None, body=4, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=4, body=None, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=object(), body=False, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=False, body=object(), interpret_escapes=True) is False |
|
assert a.notify( |
|
title=b'byte title', body=b'byte body', |
|
interpret_escapes=True) is False |
|
|
|
# The body is proessed first, so the errors thrown above get tested on |
|
# the body only. Now we run similar tests but only make the title |
|
# bad and always mark the body good |
|
assert a.notify( |
|
title=None, body="valid", interpret_escapes=True) is True |
|
assert a.notify( |
|
title=4, body="valid", interpret_escapes=True) is False |
|
assert a.notify( |
|
title=object(), body="valid", interpret_escapes=True) is False |
|
assert a.notify( |
|
title=False, body="valid", interpret_escapes=True) is True |
|
assert a.notify( |
|
title=b'byte title', body="valid", interpret_escapes=True) is False |
|
|
|
|
|
@pytest.mark.skipif(sys.version_info.major >= 3, reason="Requires Python 2.x+") |
|
@mock.patch('requests.post') |
|
def test_apprise_escaping_py2(mock_post): |
|
""" |
|
API: Apprise() Python v2.x escaping |
|
|
|
""" |
|
a = apprise.Apprise() |
|
|
|
response = mock.Mock() |
|
response.content = '' |
|
response.status_code = requests.codes.ok |
|
mock_post.return_value = response |
|
|
|
# Create ourselves a test object to work with |
|
a.add('json://localhost') |
|
|
|
# Escape our content |
|
assert a.notify( |
|
title="\\r\\ntitle\\r\\n", body="\\r\\nbody\\r\\n", |
|
interpret_escapes=True) |
|
|
|
# Verify our content was escaped correctly |
|
assert mock_post.call_count == 1 |
|
result = loads(mock_post.call_args_list[0][1]['data']) |
|
assert result['title'] == 'title' |
|
assert result['message'] == '\r\nbody' |
|
|
|
# Reset our mock object |
|
mock_post.reset_mock() |
|
|
|
# |
|
# Support Specially encoded content: |
|
# |
|
|
|
# Escape our content |
|
assert a.notify( |
|
# Google Translated to Arabic: "Let's make the world a better place." |
|
title='دعونا نجعل العالم مكانا أفضل.\\r\\t\\t\\n\\r\\n', |
|
# Google Translated to Hungarian: "One line of code at a time.' |
|
body='Egy sor kódot egyszerre.\\r\\n\\r\\r\\n', |
|
# Our Escape Flag |
|
interpret_escapes=True) |
|
|
|
# Verify our content was escaped correctly |
|
assert mock_post.call_count == 1 |
|
result = loads(mock_post.call_args_list[0][1]['data']) |
|
|
|
expected = 'دعونا نجعل العالم مكانا أفضل.' |
|
assert result['title'] in ( |
|
expected, |
|
# Older versions of Python (such as 2.7.5) provide this value as |
|
# a type unicode. This specifically happens when building RPMs |
|
# for RedHat/CentOS 7. The internal RPM unit tests fail without this: |
|
expected.decode('utf-8'), |
|
) |
|
|
|
expected = 'Egy sor kódot egyszerre.' |
|
assert result['message'] in ( |
|
expected, |
|
# Older versions of Python (such as 2.7.5) provide this value as |
|
# a type unicode. This specifically happens when building RPMs |
|
# for RedHat/CentOS 7. The internal RPM unit tests fail without this: |
|
expected.decode('utf-8'), |
|
) |
|
|
|
# Reset our status |
|
mock_post.reset_mock() |
|
|
|
# Use unicode characters |
|
assert a.notify( |
|
# Google Translated to Arabic: "Let's make the world a better place." |
|
title='دعونا نجعل العالم مكانا أفضل.\\r\\t\\t\\n\\r\\n'.decode( |
|
'utf-8'), |
|
# Google Translated to Hungarian: "One line of code at a time.' |
|
body='Egy sor kódot egyszerre.\\r\\n\\r\\r\\n'.decode( |
|
'utf-8'), |
|
# Our Escape Flag |
|
interpret_escapes=True) |
|
|
|
# Verify our content was escaped correctly |
|
assert mock_post.call_count == 1 |
|
result = loads(mock_post.call_args_list[0][1]['data']) |
|
|
|
expected = 'دعونا نجعل العالم مكانا أفضل.' |
|
assert result['title'] in ( |
|
expected, |
|
# Older versions of Python (such as 2.7.5) provide this value as |
|
# a type unicode. This specifically happens when building RPMs |
|
# for RedHat/CentOS 7. The internal RPM unit tests fail without this: |
|
expected.decode('utf-8'), |
|
) |
|
|
|
expected = 'Egy sor kódot egyszerre.' |
|
assert result['message'] in ( |
|
expected, |
|
# Older versions of Python (such as 2.7.5) provide this value as |
|
# a type unicode. This specifically happens when building RPMs |
|
# for RedHat/CentOS 7. The internal RPM unit tests fail without this: |
|
expected.decode('utf-8'), |
|
) |
|
|
|
# Error handling |
|
# |
|
# We can't escape the content below |
|
assert a.notify( |
|
title=None, body=4, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=4, body=None, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=object(), body=False, interpret_escapes=True) is False |
|
assert a.notify( |
|
title=False, body=object(), interpret_escapes=True) is False |
|
|
|
# The body is proessed first, so the errors thrown above get tested on |
|
# the body only. Now we run similar tests but only make the title |
|
# bad and always mark the body good |
|
assert a.notify( |
|
title=None, body="valid", interpret_escapes=True) is True |
|
assert a.notify( |
|
title=4, body="valid", interpret_escapes=True) is False |
|
assert a.notify( |
|
title=object(), body="valid", interpret_escapes=True) is False |
|
assert a.notify( |
|
title=False, body="valid", interpret_escapes=True) is True
|
|
|