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.
243 lines
9.2 KiB
243 lines
9.2 KiB
# -*- coding: utf-8 -*- |
|
# |
|
# Copyright (C) 2019 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 six |
|
import mock |
|
import sys |
|
import types |
|
|
|
import apprise |
|
|
|
try: |
|
# Python v3.4+ |
|
from importlib import reload |
|
except ImportError: |
|
try: |
|
# Python v3.0-v3.3 |
|
from imp import reload |
|
except ImportError: |
|
# Python v2.7 |
|
pass |
|
|
|
# Disable logging for a cleaner testing output |
|
import logging |
|
logging.disable(logging.CRITICAL) |
|
|
|
|
|
def test_gnome_plugin(): |
|
""" |
|
API: NotifyGnome Plugin() |
|
|
|
""" |
|
|
|
# Our module base |
|
gi_name = 'gi' |
|
|
|
# First we do an import without the gi library available to ensure |
|
# we can handle cases when the library simply isn't available |
|
|
|
if gi_name in sys.modules: |
|
# Test cases where the gi library exists; we want to remove it |
|
# for the purpose of testing and capture the handling of the |
|
# library when it is missing |
|
del sys.modules[gi_name] |
|
reload(sys.modules['apprise.plugins.NotifyGnome']) |
|
|
|
# We need to fake our gnome environment for testing purposes since |
|
# the gi library isn't available in Travis CI |
|
gi = types.ModuleType(gi_name) |
|
gi.repository = types.ModuleType(gi_name + '.repository') |
|
gi.module = types.ModuleType(gi_name + '.module') |
|
|
|
mock_pixbuf = mock.Mock() |
|
mock_notify = mock.Mock() |
|
|
|
gi.repository.GdkPixbuf = \ |
|
types.ModuleType(gi_name + '.repository.GdkPixbuf') |
|
gi.repository.GdkPixbuf.Pixbuf = mock_pixbuf |
|
gi.repository.Notify = mock.Mock() |
|
gi.repository.Notify.init.return_value = True |
|
gi.repository.Notify.Notification = mock_notify |
|
|
|
# Emulate require_version function: |
|
gi.require_version = mock.Mock( |
|
name=gi_name + '.require_version') |
|
|
|
# Force the fake module to exist |
|
sys.modules[gi_name] = gi |
|
sys.modules[gi_name + '.repository'] = gi.repository |
|
sys.modules[gi_name + '.repository.Notify'] = gi.repository.Notify |
|
|
|
# Notify Object |
|
notify_obj = mock.Mock() |
|
notify_obj.set_urgency.return_value = True |
|
notify_obj.set_icon_from_pixbuf.return_value = True |
|
notify_obj.set_image_from_pixbuf.return_value = True |
|
notify_obj.show.return_value = True |
|
mock_notify.new.return_value = notify_obj |
|
mock_pixbuf.new_from_file.return_value = True |
|
|
|
# The following libraries need to be reloaded to prevent |
|
# TypeError: super(type, obj): obj must be an instance or subtype of type |
|
# This is better explained in this StackOverflow post: |
|
# https://stackoverflow.com/questions/31363311/\ |
|
# any-way-to-manually-fix-operation-of-\ |
|
# super-after-ipython-reload-avoiding-ty |
|
# |
|
reload(sys.modules['apprise.plugins.NotifyGnome']) |
|
reload(sys.modules['apprise.plugins']) |
|
reload(sys.modules['apprise.Apprise']) |
|
reload(sys.modules['apprise']) |
|
|
|
# Create our instance |
|
obj = apprise.Apprise.instantiate('gnome://', suppress_exceptions=False) |
|
obj.duration = 0 |
|
|
|
# Check that it found our mocked environments |
|
assert obj._enabled is True |
|
|
|
# Test url() call |
|
assert isinstance(obj.url(), six.string_types) 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( |
|
'gnome://_/?image=True', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?image=False', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
# Test Priority (alias of urgency) |
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?priority=invalid', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.urgency == 1 |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?priority=high', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.urgency == 2 |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?priority=2', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.urgency == 2 |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
# Test Urgeny |
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?urgency=invalid', suppress_exceptions=False) |
|
assert obj.urgency == 1 |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?urgency=high', suppress_exceptions=False) |
|
assert obj.urgency == 2 |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
obj = apprise.Apprise.instantiate( |
|
'gnome://_/?urgency=2', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
assert obj.urgency == 2 |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
|
|
# Test our loading of our icon exception; it will still allow the |
|
# notification to be sent |
|
mock_pixbuf.new_from_file.side_effect = AttributeError() |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is True |
|
# Undo our change |
|
mock_pixbuf.new_from_file.side_effect = None |
|
|
|
# Test our exception handling during initialization |
|
sys.modules['gi.repository.Notify']\ |
|
.Notification.new.return_value = None |
|
sys.modules['gi.repository.Notify']\ |
|
.Notification.new.side_effect = AttributeError() |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is False |
|
|
|
# Undo our change |
|
sys.modules['gi.repository.Notify']\ |
|
.Notification.new.side_effect = None |
|
|
|
# Toggle our testing for when we can't send notifications because the |
|
# package has been made unavailable to us |
|
obj._enabled = False |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is False |
|
|
|
# Test the setting of a the urgency (through priority keyword) |
|
apprise.plugins.NotifyGnome(priority=0) |
|
|
|
# Verify this all works in the event a ValueError is also thronw |
|
# out of the call to gi.require_version() |
|
|
|
# Emulate require_version function: |
|
gi.require_version.side_effect = ValueError() |
|
|
|
# The following libraries need to be reloaded to prevent |
|
# TypeError: super(type, obj): obj must be an instance or subtype of type |
|
# This is better explained in this StackOverflow post: |
|
# https://stackoverflow.com/questions/31363311/\ |
|
# any-way-to-manually-fix-operation-of-\ |
|
# super-after-ipython-reload-avoiding-ty |
|
# |
|
reload(sys.modules['apprise.plugins.NotifyGnome']) |
|
reload(sys.modules['apprise.plugins']) |
|
reload(sys.modules['apprise.Apprise']) |
|
reload(sys.modules['apprise']) |
|
|
|
# Create our instance |
|
obj = apprise.Apprise.instantiate('gnome://', suppress_exceptions=False) |
|
assert isinstance(obj, apprise.plugins.NotifyGnome) is True |
|
obj.duration = 0 |
|
|
|
# Our notifications can not work without our gi library having been |
|
# loaded. |
|
assert obj.notify(title='title', body='body', |
|
notify_type=apprise.NotifyType.INFO) is False
|
|
|