# -*- coding: utf-8 -*- # # Copyright (C) 2020 Chris Caron # 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 six import sys import pytest import mock import requests from json import dumps from json import loads from apprise import Apprise from apprise import AppriseAttachment from apprise import AppriseAsset from apprise import NotifyType from apprise import NotifyFormat from apprise import plugins 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 = ( ################################## # NotifyTelegram ################################## ('tgram://', { 'instance': None, }), # Simple Message ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, }), # Simple Message (no images) ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # don't include an image by default 'include_image': False, }), # Simple Message with multiple chat names ('tgram://123456789:abcdefg_hijklmnop/id1/id2/', { 'instance': plugins.NotifyTelegram, }), # Simple Message with multiple chat names ('tgram://123456789:abcdefg_hijklmnop/?to=id1,id2', { 'instance': plugins.NotifyTelegram, }), # Simple Message with an invalid chat ID ('tgram://123456789:abcdefg_hijklmnop/%$/', { 'instance': plugins.NotifyTelegram, # Notify will fail 'response': False, }), # Simple Message with multiple chat ids ('tgram://123456789:abcdefg_hijklmnop/id1/id2/23423/-30/', { 'instance': plugins.NotifyTelegram, }), # Simple Message with multiple chat ids (no images) ('tgram://123456789:abcdefg_hijklmnop/id1/id2/23423/-30/', { 'instance': plugins.NotifyTelegram, # don't include an image by default 'include_image': False, }), # Support bot keyword prefix ('tgram://bottest@123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, }), # Testing image ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?image=Yes', { 'instance': plugins.NotifyTelegram, }), # Testing invalid format (fall's back to html) ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?format=invalid', { 'instance': plugins.NotifyTelegram, }), # Testing empty format (falls back to html) ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?format=', { 'instance': plugins.NotifyTelegram, }), # Testing valid formats ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?format=markdown', { 'instance': plugins.NotifyTelegram, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?format=html', { 'instance': plugins.NotifyTelegram, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?format=text', { 'instance': plugins.NotifyTelegram, }), # Test Silent Settings ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?silent=yes', { 'instance': plugins.NotifyTelegram, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?silent=no', { 'instance': plugins.NotifyTelegram, }), # Test Web Page Preview Settings ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?preview=yes', { 'instance': plugins.NotifyTelegram, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?preview=no', { 'instance': plugins.NotifyTelegram, }), # Simple Message without image ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # don't include an image by default 'include_image': False, }), # Invalid Bot Token ('tgram://alpha:abcdefg_hijklmnop/lead2gold/', { 'instance': None, }), # AuthToken + bad url ('tgram://:@/', { 'instance': None, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # force a failure 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?image=Yes', { 'instance': plugins.NotifyTelegram, # force a failure without an image specified 'include_image': False, 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('tgram://123456789:abcdefg_hijklmnop/id1/id2/', { 'instance': plugins.NotifyTelegram, # force a failure with multiple chat_ids 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('tgram://123456789:abcdefg_hijklmnop/id1/id2/', { 'instance': plugins.NotifyTelegram, # force a failure without an image specified 'include_image': False, 'response': False, 'requests_response_code': requests.codes.internal_server_error, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # throw a bizzare code forcing us to fail to look it up 'response': False, 'requests_response_code': 999, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # throw a bizzare code forcing us to fail to look it up without # having an image included 'include_image': False, 'response': False, 'requests_response_code': 999, }), # Test with image set ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?image=Yes', { 'instance': plugins.NotifyTelegram, # throw a bizzare code forcing us to fail to look it up without # having an image included 'include_image': True, 'response': False, 'requests_response_code': 999, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/', { 'instance': plugins.NotifyTelegram, # Throws a series of connection and transfer exceptions when this flag # is set and tests that we gracfully handle them 'test_requests_exceptions': True, }), ('tgram://123456789:abcdefg_hijklmnop/lead2gold/?image=Yes', { 'instance': plugins.NotifyTelegram, # Throws a series of connection and transfer exceptions when this flag # is set and tests that we gracfully handle them without images set 'include_image': True, 'test_requests_exceptions': True, }), ) def test_plugin_telegram_urls(): """ NotifyTelegram() Apprise URLs """ # Disable Throttling to speed testing plugins.NotifyTelegram.request_rate_per_sec = 0 # Run our general tests AppriseURLTester(tests=apprise_url_tests).run_all() @mock.patch('requests.post') def test_plugin_telegram_general(mock_post): """ NotifyTelegram() General Tests """ # Disable Throttling to speed testing plugins.NotifyTelegram.request_rate_per_sec = 0 # Bot Token bot_token = '123456789:abcdefg_hijklmnop' invalid_bot_token = 'abcd:123' # Chat ID chat_ids = 'l2g, lead2gold' # Prepare Mock mock_post.return_value = requests.Request() mock_post.return_value.status_code = requests.codes.ok mock_post.return_value.content = '{}' # Exception should be thrown about the fact no bot token was specified with pytest.raises(TypeError): plugins.NotifyTelegram(bot_token=None, targets=chat_ids) # Invalid JSON while trying to detect bot owner mock_post.return_value.content = '}' obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) obj.notify(title='hello', body='world') # Invalid JSON while trying to detect bot owner + 400 error mock_post.return_value.status_code = requests.codes.internal_server_error obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) obj.notify(title='hello', body='world') # Return status back to how they were mock_post.return_value.status_code = requests.codes.ok # Exception should be thrown about the fact an invalid bot token was # specifed with pytest.raises(TypeError): plugins.NotifyTelegram(bot_token=invalid_bot_token, targets=chat_ids) obj = plugins.NotifyTelegram( bot_token=bot_token, targets=chat_ids, include_image=True) assert isinstance(obj, plugins.NotifyTelegram) is True assert len(obj.targets) == 2 # Test Image Sending Exceptions mock_post.side_effect = IOError() assert not obj.send_media(obj.targets[0], NotifyType.INFO) # Test our other objects mock_post.side_effect = requests.HTTPError assert not obj.send_media(obj.targets[0], NotifyType.INFO) # Restore their entries mock_post.side_effect = None mock_post.return_value.content = '{}' # test url call assert isinstance(obj.url(), six.string_types) is True # test privacy version of url assert isinstance(obj.url(privacy=True), six.string_types) is True assert obj.url(privacy=True).startswith('tgram://1...p/') is True # Test that we can load the string we generate back: obj = plugins.NotifyTelegram(**plugins.NotifyTelegram.parse_url(obj.url())) assert isinstance(obj, plugins.NotifyTelegram) is True # Prepare Mock to fail response = mock.Mock() response.status_code = requests.codes.internal_server_error # a error response response.content = dumps({ 'description': 'test', }) mock_post.return_value = response # No image asset nimg_obj = plugins.NotifyTelegram(bot_token=bot_token, targets=chat_ids) nimg_obj.asset = AppriseAsset(image_path_mask=False, image_url_mask=False) # Test that our default settings over-ride base settings since they are # not the same as the one specified in the base; this check merely # ensures our plugin inheritance is working properly assert obj.body_maxlen == plugins.NotifyTelegram.body_maxlen # This tests erroneous messages involving multiple chat ids assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False assert nimg_obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False # This tests erroneous messages involving a single chat id obj = plugins.NotifyTelegram(bot_token=bot_token, targets='l2g') nimg_obj = plugins.NotifyTelegram(bot_token=bot_token, targets='l2g') nimg_obj.asset = AppriseAsset(image_path_mask=False, image_url_mask=False) assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False assert nimg_obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False # Bot Token Detection # Just to make it clear to people reading this code and trying to learn # what is going on. Apprise tries to detect the bot owner if you don't # specify a user to message. The idea is to just default to messaging # the bot owner himself (it makes it easier for people). So we're testing # the creating of a Telegram Notification without providing a chat ID. # We're testing the error handling of this bot detection section of the # code mock_post.return_value.content = dumps({ "ok": True, "result": [{ "update_id": 645421319, # Entry without `message` in it }, { # Entry without `from` in `message` "update_id": 645421320, "message": { "message_id": 2, "chat": { "id": 532389719, "first_name": "Chris", "type": "private" }, "date": 1519694394, "text": "/start", "entities": [{ "offset": 0, "length": 6, "type": "bot_command", }], } }, { "update_id": 645421321, "message": { "message_id": 2, "from": { "id": 532389719, "is_bot": False, "first_name": "Chris", "language_code": "en-US" }, "chat": { "id": 532389719, "first_name": "Chris", "type": "private" }, "date": 1519694394, "text": "/start", "entities": [{ "offset": 0, "length": 6, "type": "bot_command", }], }}, ], }) mock_post.return_value.status_code = requests.codes.ok obj = plugins.NotifyTelegram(bot_token=bot_token, targets='12345') assert len(obj.targets) == 1 assert obj.targets[0] == '12345' # Test the escaping of characters since Telegram escapes stuff for us to # which we need to consider mock_post.reset_mock() body = "

\'\"This can't\t\r\nfail us\"\'

" assert obj.notify( body=body, title='special characters', notify_type=NotifyType.INFO) is True assert mock_post.call_count == 1 payload = loads(mock_post.call_args_list[0][1]['data']) # Test our payload assert payload['text'] == \ 'special characters\r\n\'"This can\'t\t\r\nfail us"\'\r\n' # Test sending attachments attach = AppriseAttachment(os.path.join(TEST_VAR_DIR, 'apprise-test.gif')) assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO, attach=attach) is True # An invalid attachment will cause a failure path = os.path.join(TEST_VAR_DIR, '/invalid/path/to/an/invalid/file.jpg') attach = AppriseAttachment(path) assert obj.notify( body='body', title='title', notify_type=NotifyType.INFO, attach=path) is False obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) # No user detected; this happens after our firsst notification assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is True assert len(obj.targets) == 1 assert obj.targets[0] == '532389719' # Do the test again, but without the expected (parsed response) mock_post.return_value.content = dumps({ "ok": True, "result": [], }) # No user will be detected now obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) # No user detected; this happens after our firsst notification assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Do the test again, but with ok not set to True mock_post.return_value.content = dumps({ "ok": False, "result": [{ "update_id": 645421321, "message": { "message_id": 2, "from": { "id": 532389719, "is_bot": False, "first_name": "Chris", "language_code": "en-US" }, "chat": { "id": 532389719, "first_name": "Chris", "type": "private" }, "date": 1519694394, "text": "/start", "entities": [{ "offset": 0, "length": 6, "type": "bot_command", }], }}, ], }) # No user will be detected now obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) # No user detected; this happens after our firsst notification assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # An edge case where no results were provided; this will probably never # happen, but it helps with test coverage completeness mock_post.return_value.content = dumps({ "ok": True, }) # No user will be detected now obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) # No user detected; this happens after our firsst notification assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Detect the bot with a bad response mock_post.return_value.content = dumps({}) obj.detect_bot_owner() # Test our bot detection with a internal server error mock_post.return_value.status_code = requests.codes.internal_server_error # internal server error prevents notification from being sent obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Test our bot detection with an unmappable html error mock_post.return_value.status_code = 999 plugins.NotifyTelegram(bot_token=bot_token, targets=None) assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Do it again but this time provide a failure message mock_post.return_value.content = dumps({'description': 'Failure Message'}) plugins.NotifyTelegram(bot_token=bot_token, targets=None) assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Do it again but this time provide a failure message and perform a # notification without a bot detection by providing at least 1 chat id obj = plugins.NotifyTelegram(bot_token=bot_token, targets=['@abcd']) assert nimg_obj.notify( body='body', title='title', notify_type=NotifyType.INFO) is False # iterate over our exceptions and test them mock_post.side_effect = requests.HTTPError # No chat_ids specified obj = plugins.NotifyTelegram(bot_token=bot_token, targets=None) assert len(obj.targets) == 0 assert obj.notify(title='hello', body='world') is False assert len(obj.targets) == 0 # Test Telegram Group obj = Apprise.instantiate( 'tgram://123456789:ABCdefghijkl123456789opqyz/-123456789525') assert isinstance(obj, plugins.NotifyTelegram) assert len(obj.targets) == 1 assert '-123456789525' in obj.targets @pytest.mark.skipif(sys.version_info.major <= 2, reason="Requires Python 3.x+") @mock.patch('requests.post') def test_plugin_telegram_formating_py3(mock_post): """ NotifyTelegram() Python v3+ Formatting Tests """ # Disable Throttling to speed testing plugins.NotifyTelegram.request_rate_per_sec = 0 # Prepare Mock mock_post.return_value = requests.Request() mock_post.return_value.status_code = requests.codes.ok mock_post.return_value.content = '{}' # Simple success response mock_post.return_value.content = dumps({ "ok": True, "result": [{ "update_id": 645421321, "message": { "message_id": 2, "from": { "id": 532389719, "is_bot": False, "first_name": "Chris", "language_code": "en-US" }, "chat": { "id": 532389719, "first_name": "Chris", "type": "private" }, "date": 1519694394, "text": "/start", "entities": [{ "offset": 0, "length": 6, "type": "bot_command", }], }}, ], }) mock_post.return_value.status_code = requests.codes.ok results = plugins.NotifyTelegram.parse_url( 'tgram://123456789:abcdefg_hijklmnop/') instance = plugins.NotifyTelegram(**results) assert isinstance(instance, plugins.NotifyTelegram) response = instance.send(title='title', body='body') assert response is True # 1 call to look up bot owner, and second for notification assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' # Reset our values mock_post.reset_mock() # Now test our HTML Conversion as TEXT) aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/') assert len(aobj) == 1 title = '馃毃 Change detected for Apprise Test Title' body = 'Apprise Body Title' \ ' had a change' assert aobj.notify(title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a TEXT mode assert payload['text'] == \ '馃毃 Change detected for <i>Apprise Test Title</i>' \ '\r\n<a href="http://localhost"><i>' \ 'Apprise Body Title</i></a> had <' \ 'a href="http://127.0.0.1">a change</a>' # Reset our values mock_post.reset_mock() # Now test our HTML Conversion as TEXT) aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=html') assert len(aobj) == 1 assert aobj.notify(title=title, body=body, body_format=NotifyFormat.HTML) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '馃毃 Change detected for Apprise Test Title\r\n' \ 'Apprise Body Title had ' \ 'a change' # Reset our values mock_post.reset_mock() # Now test our MARKDOWN Handling title = '# 馃毃 Change detected for _Apprise Test Title_' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.1)' aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '# 馃毃 Change detected for _Apprise Test Title_\r\n' \ '_[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.1)' # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=html') assert len(aobj) == 1 # Now test our MARKDOWN Handling title = '# 馃毃 Another Change detected for _Apprise Test Title_' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.2)' # HTML forced by the command line, but MARKDOWN specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '\r\n馃毃 Another Change detected for ' \ 'Apprise Test Title\r\n\r\n' \ 'Apprise Body Title' \ ' had a change\r\n' # Now we'll test an edge case where a title was defined, but after # processing it, it was determiend there really wasn't anything there # at all at the end of the day. # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 # Now test our MARKDOWN Handling (no title defined... not really anyway) title = '# ' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.2)' # MARKDOWN forced by the command line, but TEXT specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '_[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.2)' # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 # Set an actual title this time title = '# A Great Title' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.2)' # MARKDOWN forced by the command line, but TEXT specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '# A Great Title\r\n_[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.2)' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped # title = 'Test Message Title' body = 'Test Message Body
ok
' aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ '\r\n' \ 'Test Message Body\r\n' \ 'ok\r\n' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped as it would have been via the # CLI mode where the body_format is TEXT # aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ 'Test Message Body <br/> ok</br>' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped if fed as HTML # aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.HTML) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ 'Test Message Body\r\n' \ 'ok\r\n' @pytest.mark.skipif(sys.version_info.major >= 3, reason="Requires Python 2.x+") @mock.patch('requests.post') def test_plugin_telegram_formating_py2(mock_post): """ NotifyTelegram() Python v2 Formatting Tests """ # Disable Throttling to speed testing plugins.NotifyTelegram.request_rate_per_sec = 0 # Prepare Mock mock_post.return_value = requests.Request() mock_post.return_value.status_code = requests.codes.ok mock_post.return_value.content = '{}' # Simple success response mock_post.return_value.content = dumps({ "ok": True, "result": [{ "update_id": 645421321, "message": { "message_id": 2, "from": { "id": 532389719, "is_bot": False, "first_name": "Chris", "language_code": "en-US" }, "chat": { "id": 532389719, "first_name": "Chris", "type": "private" }, "date": 1519694394, "text": "/start", "entities": [{ "offset": 0, "length": 6, "type": "bot_command", }], }}, ], }) mock_post.return_value.status_code = requests.codes.ok results = plugins.NotifyTelegram.parse_url( 'tgram://123456789:abcdefg_hijklmnop/') instance = plugins.NotifyTelegram(**results) assert isinstance(instance, plugins.NotifyTelegram) response = instance.send(title='title', body='body') assert response is True # 1 call to look up bot owner, and second for notification assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' # Reset our values mock_post.reset_mock() # Now test our HTML Conversion as TEXT) aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/') assert len(aobj) == 1 title = '馃毃 Change detected for Apprise Test Title' body = 'Apprise Body Title' \ ' had a change' assert aobj.notify(title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a TEXT mode assert payload['text'].encode('utf-8') == \ '\xf0\x9f\x9a\xa8 Change detected for <i>' \ 'Apprise Test Title</i>\r\n<' \ 'a href="http://localhost"><i>Apprise Body Title' \ '</i></a> had <a href="http://127.0.0.1"' \ '>a change</a>' # Reset our values mock_post.reset_mock() # Now test our HTML Conversion as TEXT) aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=html') assert len(aobj) == 1 assert aobj.notify(title=title, body=body, body_format=NotifyFormat.HTML) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'].encode('utf-8') == \ '\xf0\x9f\x9a\xa8 Change detected for Apprise Test Title' \ '\r\nApprise Body Title ' \ 'had a change' # Reset our values mock_post.reset_mock() # Now test our MARKDOWN Handling title = '# 馃毃 Change detected for _Apprise Test Title_' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.1)' aobj = Apprise() aobj.add('tgram://123456789:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'].encode('utf-8') == \ '# \xf0\x9f\x9a\xa8 Change detected for _Apprise Test Title_\r\n_' \ '[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.1)' # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=html') assert len(aobj) == 1 # HTML forced by the command line, but MARKDOWN specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'].encode('utf-8') == \ '\r\n\xf0\x9f\x9a\xa8 Change detected for ' \ 'Apprise Test Title\r\n\r\n' \ 'Apprise Body Title' \ ' had a change\r\n' # Reset our values mock_post.reset_mock() # Now test hebrew types (outside of default utf-8) # 讻讜转专转 谞驻诇讗讛 translates to 'A wonderful title' # 讝讜 讛讜讚注讛 translates to 'This is a notification' title = '讻讜转专转 谞驻诇讗讛' \ .decode('utf-8').encode('ISO-8859-8') body = '[_[讝讜 讛讜讚注讛](http://localhost)_' \ .decode('utf-8').encode('ISO-8859-8') asset = AppriseAsset(encoding='utf-8') # Now test default entries aobj = Apprise(asset=asset) aobj.add('tgram://123456789:abcdefg_hijklmnop/') assert len(aobj) == 1 # Our notification will fail because we'll have an encoding error assert not aobj.notify(title=title, body=body) # Nothing was even attempted to be notified assert mock_post.call_count == 0 # Let's use the expected input asset = AppriseAsset(encoding='ISO-8859-8') # Now test default entries aobj = Apprise(asset=asset) aobj.add('tgram://123456789:abcdefg_hijklmnop/') assert len(aobj) == 1 # Our notification will work now assert aobj.notify(title=title, body=body) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot123456789:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'].encode('utf-8') == \ '\xd7\x9b\xd7\x95\xd7\xaa\xd7\xa8\xd7\xaa '\ '\xd7\xa0\xd7\xa4\xd7\x9c\xd7\x90\xd7\x94\r\n[_[\xd7\x96\xd7\x95 '\ '\xd7\x94\xd7\x95\xd7\x93\xd7\xa2\xd7\x94](http://localhost)_' # Now we'll test an edge case where a title was defined, but after # processing it, it was determiend there really wasn't anything there # at all at the end of the day. # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 # Now test our MARKDOWN Handling (no title defined... not really anyway) title = '# ' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.2)' # MARKDOWN forced by the command line, but TEXT specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '_[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.2)' # Reset our values mock_post.reset_mock() # Upstream to use HTML but input specified as Markdown aobj = Apprise() aobj.add('tgram://987654321:abcdefg_hijklmnop/?format=markdown') assert len(aobj) == 1 # Set an actual title this time title = '# A Great Title' body = '_[Apprise Body Title](http://localhost)_' \ ' had [a change](http://127.0.0.2)' # MARKDOWN forced by the command line, but TEXT specified as # upstream mode assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 2 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/getUpdates' assert mock_post.call_args_list[1][0][0] == \ 'https://api.telegram.org/bot987654321:abcdefg_hijklmnop/sendMessage' payload = loads(mock_post.call_args_list[1][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ '# A Great Title\r\n_[Apprise Body Title](http://localhost)_ had ' \ '[a change](http://127.0.0.2)' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped # title = 'Test Message Title' body = 'Test Message Body
ok
' aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.MARKDOWN) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ '\r\n' \ 'Test Message Body\r\n' \ 'ok\r\n' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped as it would have been via the # CLI mode where the body_format is TEXT # aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.TEXT) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ 'Test Message Body <br/> ok</br>' # Reset our values mock_post.reset_mock() # # Now test that
is correctly escaped if fed as HTML # aobj = Apprise() aobj.add('tgram://1234:aaaaaaaaa/-1123456245134') assert len(aobj) == 1 assert aobj.notify( title=title, body=body, body_format=NotifyFormat.HTML) # Test our calls assert mock_post.call_count == 1 assert mock_post.call_args_list[0][0][0] == \ 'https://api.telegram.org/bot1234:aaaaaaaaa/sendMessage' payload = loads(mock_post.call_args_list[0][1]['data']) # Test that everything is escaped properly in a HTML mode assert payload['text'] == \ 'Test Message Title\r\n' \ 'Test Message Body\r\n' \ 'ok\r\n' @mock.patch('requests.post') def test_plugin_telegram_html_formatting(mock_post): """ NotifyTelegram() HTML Formatting """ # on't send anything other than , , , and 

    # Disable Throttling to speed testing
    plugins.NotifyTelegram.request_rate_per_sec = 0

    # Prepare Mock
    mock_post.return_value = requests.Request()
    mock_post.return_value.status_code = requests.codes.ok
    mock_post.return_value.content = '{}'

    # Simple success response
    mock_post.return_value.content = dumps({
        "ok": True,
        "result": [{
            "update_id": 645421321,
            "message": {
                "message_id": 2,
                "from": {
                    "id": 532389719,
                    "is_bot": False,
                    "first_name": "Chris",
                    "language_code": "en-US"
                },
                "chat": {
                    "id": 532389719,
                    "first_name": "Chris",
                    "type": "private"
                },
                "date": 1519694394,
                "text": "/start",
                "entities": [{
                    "offset": 0,
                    "length": 6,
                    "type": "bot_command",
                }],
            }},
        ],
    })
    mock_post.return_value.status_code = requests.codes.ok

    aobj = Apprise()
    aobj.add('tgram://123456789:abcdefg_hijklmnop/')

    assert len(aobj) == 1

    assert isinstance(aobj[0], plugins.NotifyTelegram)

    # Test our HTML Conversion
    title = ''information&apos'
    body = '"This is in Italic"
' \
           '
 &emspHeadings are dropped and' \
           ' converted to bold
'

    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.HTML)

    # 1 call to look up bot owner, and second for notification
    assert mock_post.call_count == 2

    payload = loads(mock_post.call_args_list[1][1]['data'])

    # Test that everything is escaped properly in a HTML mode
    assert payload['text'] == \
        '\r\n\'information\'\r\n\r\n"This is in Italic"' \
        '\r\n      Headings are dropped and converted to bold\r\n'

    mock_post.reset_mock()

    assert aobj.notify(title=title, body=body, body_format=NotifyFormat.TEXT)

    # owner has already been looked up, so only one call is made
    assert mock_post.call_count == 1

    payload = loads(mock_post.call_args_list[0][1]['data'])

    assert payload['text'] == \
        '<title>&apos;information&apos</title>' \
        '\r\n<em>&quot;This is in Italic&quot</em><' \
        'br/><h5>&emsp;&emspHeadings&nbsp;are ' \
        'dropped and&nbspconverted to bold</h5>'

    # Lest test more complex HTML examples now
    mock_post.reset_mock()

    test_file_01 = os.path.join(
        TEST_VAR_DIR, '01_test_example.html')
    with open(test_file_01) as html_file:
        assert aobj.notify(
            body=html_file.read(), body_format=NotifyFormat.HTML)

    # owner has already been looked up, so only one call is made
    assert mock_post.call_count == 1

    payload = loads(mock_post.call_args_list[0][1]['data'])
    assert payload['text'] == \
        '\r\nBootstrap 101 Template\r\nMy Title\r\n' \
        'Heading 1\r\n-Bullet 1\r\n-Bullet 2\r\n-Bullet 3\r\n' \
        '-Bullet 1\r\n-Bullet 2\r\n-Bullet 3\r\nHeading 2\r\n' \
        'A div entry\r\nA div entry\r\nA pre entry\r\n' \
        'Heading 3\r\nHeading 4\r\nHeading 5\r\n' \
        'Heading 6\r\nA set of text\r\n' \
        'Another line after the set of text\r\nMore text\r\nlabel'