mirror of
https://github.com/caronc/apprise.git
synced 2025-03-10 04:49:37 +01:00
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.
171 lines
6.0 KiB
Python
171 lines
6.0 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
|
|
from unittest import mock
|
|
|
|
from helpers import reload_plugin
|
|
|
|
import apprise
|
|
|
|
# Disable logging for a cleaner testing output
|
|
import logging
|
|
logging.disable(logging.CRITICAL)
|
|
|
|
|
|
@mock.patch('subprocess.Popen')
|
|
@mock.patch('platform.system')
|
|
@mock.patch('platform.mac_ver')
|
|
def test_plugin_macosx_general(mock_macver, mock_system, mock_popen, tmpdir):
|
|
"""
|
|
NotifyMacOSX() General Checks
|
|
|
|
"""
|
|
|
|
# Create a temporary binary file we can reference
|
|
script = tmpdir.join("terminal-notifier")
|
|
script.write('')
|
|
# Give execute bit
|
|
os.chmod(str(script), 0o755)
|
|
mock_cmd_response = mock.Mock()
|
|
|
|
# Set a successful response
|
|
mock_cmd_response.returncode = 0
|
|
|
|
# Simulate a Mac Environment
|
|
mock_system.return_value = 'Darwin'
|
|
mock_macver.return_value = ('10.8', ('', '', ''), '')
|
|
mock_popen.return_value = mock_cmd_response
|
|
|
|
# Ensure our environment is loaded with this configuration
|
|
reload_plugin('NotifyMacOSX')
|
|
from apprise.plugins.NotifyMacOSX import NotifyMacOSX
|
|
|
|
# Point our object to our new temporary existing file
|
|
NotifyMacOSX.notify_paths = (str(script), )
|
|
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?image=True', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMacOSX) is True
|
|
|
|
# Test url() call
|
|
assert isinstance(obj.url(), str) is True
|
|
|
|
# test notifications
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is True
|
|
|
|
# test notification without a title
|
|
assert obj.notify(title='', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is True
|
|
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?image=True', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMacOSX) is True
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is True
|
|
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?image=False', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMacOSX) is True
|
|
assert isinstance(obj.url(), str) is True
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is True
|
|
|
|
# Test Sound
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?sound=default', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMacOSX) is True
|
|
assert obj.sound == 'default'
|
|
assert isinstance(obj.url(), str) is True
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is True
|
|
|
|
# If our binary is inacccessible (or not executable), we can
|
|
# no longer send our notifications
|
|
os.chmod(str(script), 0o644)
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is False
|
|
|
|
# Restore permission
|
|
os.chmod(str(script), 0o755)
|
|
|
|
# But now let's disrupt the path location
|
|
obj.notify_path = 'invalid_missing-file'
|
|
assert not os.path.isfile(obj.notify_path)
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is False
|
|
|
|
# Test cases where the script just flat out fails
|
|
mock_cmd_response.returncode = 1
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://', suppress_exceptions=False)
|
|
assert isinstance(obj, NotifyMacOSX) is True
|
|
assert obj.notify(title='title', body='body',
|
|
notify_type=apprise.NotifyType.INFO) is False
|
|
|
|
# Restore script return value
|
|
mock_cmd_response.returncode = 0
|
|
|
|
# Test case where we simply aren't on a mac
|
|
mock_system.return_value = 'Linux'
|
|
reload_plugin('NotifyMacOSX')
|
|
|
|
# Point our object to our new temporary existing file
|
|
NotifyMacOSX.notify_paths = (str(script), )
|
|
|
|
# Our object is disabled
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?sound=default', suppress_exceptions=False)
|
|
assert obj is None
|
|
|
|
# Restore mac environment
|
|
mock_system.return_value = 'Darwin'
|
|
|
|
# Now we must be Mac OS v10.8 or higher...
|
|
mock_macver.return_value = ('10.7', ('', '', ''), '')
|
|
reload_plugin('NotifyMacOSX')
|
|
|
|
# Point our object to our new temporary existing file
|
|
NotifyMacOSX.notify_paths = (str(script), )
|
|
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?sound=default', suppress_exceptions=False)
|
|
assert obj is None
|
|
|
|
# A newer environment to test edge case where this is tested
|
|
mock_macver.return_value = ('9.12', ('', '', ''), '')
|
|
reload_plugin('NotifyMacOSX')
|
|
|
|
# Point our object to our new temporary existing file
|
|
NotifyMacOSX.notify_paths = (str(script), )
|
|
|
|
# This is just to test that the the minor (in this case .12)
|
|
# is only weighed with respect to the major number as wel
|
|
# with respect to the versioning
|
|
obj = apprise.Apprise.instantiate(
|
|
'macosx://_/?sound=default', suppress_exceptions=False)
|
|
assert obj is None
|