def test_apprise_details():
"""
API: Apprise() Details
"""
# Caling load matix a second time which is an internal function causes it
# to skip over content already loaded into our matrix and thefore accesses
# other if/else parts of the code that aren't otherwise called
__load_matrix()
a = Apprise()
# Details object
details = a.details()
# Dictionary response
assert isinstance(details, dict)
# Apprise version
assert 'version' in details
assert details.get('version') == __version__
# Defined schemas identify each plugin
assert 'schemas' in details
assert isinstance(details.get('schemas'), list)
# We have an entry per defined plugin
assert 'asset' in details
assert isinstance(details.get('asset'), dict)
assert 'app_id' in details['asset']
assert 'app_desc' in details['asset']
assert 'default_extension' in details['asset']
assert 'theme' in details['asset']
assert 'image_path_mask' in details['asset']
assert 'image_url_mask' in details['asset']
assert 'image_url_logo' in details['asset']
# All plugins must have a name defined; the below generates
# a list of entrys that do not have a string defined.
assert (not len([
x['service_name'] for x in details['schemas']
if not compat_is_basestring(x['service_name'])
]))
def test_apprise_notify_formats(tmpdir):
"""
API: Apprise() TextFormat tests
"""
# Caling load matix a second time which is an internal function causes it
# to skip over content already loaded into our matrix and thefore accesses
# other if/else parts of the code that aren't otherwise called
__load_matrix()
a = Apprise()
# no items
assert (len(a) == 0)
class TextNotification(NotifyBase):
def __init__(self, **kwargs):
super(TextNotification,
self).__init__(notify_format=NotifyFormat.TEXT)
def notify(self, **kwargs):
# Pretend everything is okay
return True
class HtmlNotification(NotifyBase):
def __init__(self, **kwargs):
super(HtmlNotification,
self).__init__(notify_format=NotifyFormat.HTML)
def notify(self, **kwargs):
# Pretend everything is okay
return True
class MarkDownNotification(NotifyBase):
def __init__(self, **kwargs):
super(MarkDownNotification,
self).__init__(notify_format=NotifyFormat.MARKDOWN)
def notify(self, **kwargs):
# Pretend everything is okay
return True
# Store our notifications into our schema map
SCHEMA_MAP['text'] = TextNotification
SCHEMA_MAP['html'] = HtmlNotification
SCHEMA_MAP['markdown'] = MarkDownNotification
# Test Markdown; the above calls the markdown because our good://
# defined plugin above was defined to default to HTML which triggers
# a markdown to take place if the body_format specified on the notify
# call
assert (a.add('html://localhost') is True)
assert (a.add('html://another.server') is True)
assert (a.add('html://and.another') is True)
assert (a.add('text://localhost') is True)
assert (a.add('text://another.server') is True)
assert (a.add('text://and.another') is True)
assert (a.add('markdown://localhost') is True)
assert (a.add('markdown://another.server') is True)
assert (a.add('markdown://and.another') is True)
assert (len(a) == 9)
assert (a.notify(title="markdown",
body="## Testing Markdown",
body_format=NotifyFormat.MARKDOWN) is True)
assert (a.notify(title="text",
body="Testing Text",
body_format=NotifyFormat.TEXT) is True)
assert (a.notify(title="html",
body="<b>HTML</b>",
body_format=NotifyFormat.HTML) is True)
def test_apprise():
"""
API: Apprise() object
"""
# Caling load matix a second time which is an internal function causes it
# to skip over content already loaded into our matrix and thefore accesses
# other if/else parts of the code that aren't otherwise called
__load_matrix()
a = Apprise()
# no items
assert (len(a) == 0)
# Create an Asset object
asset = AppriseAsset(theme='default')
# We can load the device using our asset
a = Apprise(asset=asset)
# We can load our servers up front as well
servers = [
'faast://abcdefghijklmnop-abcdefg',
'kodi://kodi.server.local',
'palot://1f418df7577e32b89ac6511f2eb9aa68',
]
a = Apprise(servers=servers)
# 3 servers loaded
assert (len(a) == 3)
# We can add another server
assert (a.add('mmosts://mattermost.server.local/'
'3ccdd113474722377935511fc85d3dd4') is True)
assert (len(a) == 4)
# We can empty our set
a.clear()
assert (len(a) == 0)
# An invalid schema
assert (a.add('this is not a parseable url at all') is False)
assert (len(a) == 0)
# An unsupported schema
assert (a.add('invalid://we.just.do.not.support.this.plugin.type') is
False)
assert (len(a) == 0)
# A poorly formatted URL
assert (a.add('json://user:@@@:bad?no.good') is False)
assert (len(a) == 0)
# Add a server with our asset we created earlier
assert (a.add(
'mmosts://mattermost.server.local/'
'3ccdd113474722377935511fc85d3dd4',
asset=asset) is True)
# Clear our server listings again
a.clear()
# No servers to notify
assert (a.notify(title="my title", body="my body") is False)
class BadNotification(NotifyBase):
def __init__(self, **kwargs):
super(BadNotification, self).__init__()
# We fail whenever we're initialized
raise TypeError()
class GoodNotification(NotifyBase):
def __init__(self, **kwargs):
super(GoodNotification,
self).__init__(notify_format=NotifyFormat.HTML)
def notify(self, **kwargs):
# Pretend everything is okay
return True
# Store our bad notification in our schema map
SCHEMA_MAP['bad'] = BadNotification
# Store our good notification in our schema map
SCHEMA_MAP['good'] = GoodNotification
# Just to explain what is happening here, we would have parsed the
# url properly but failed when we went to go and create an instance
# of it.
assert (a.add('bad://localhost') is False)
assert (len(a) == 0)
assert (a.add('good://localhost') is True)
assert (len(a) == 1)
# Bad Notification Type is still allowed as it is presumed the user
# know's what their doing
assert (a.notify(title="my title", body="my body", notify_type='bad') is
True)
# No Title/Body combo's
assert (a.notify(title=None, body=None) is False)
assert (a.notify(title='', body=None) is False)
assert (a.notify(title=None, body='') is False)
# As long as one is present, we're good
assert (a.notify(title=None, body='present') is True)
assert (a.notify(title='present', body=None) is True)
assert (a.notify(title="present", body="present") is True)
# Clear our server listings again
a.clear()
class ThrowNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
raise TypeError()
class RuntimeNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
raise RuntimeError()
class FailNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
return False
# Store our bad notification in our schema map
SCHEMA_MAP['throw'] = ThrowNotification
# Store our good notification in our schema map
SCHEMA_MAP['fail'] = FailNotification
# Store our good notification in our schema map
SCHEMA_MAP['runtime'] = RuntimeNotification
assert (a.add('runtime://localhost') is True)
assert (a.add('throw://localhost') is True)
assert (a.add('fail://localhost') is True)
assert (len(a) == 3)
# Test when our notify both throws an exception and or just
# simply returns False
assert (a.notify(title="present", body="present") is False)
# Create a Notification that throws an unexected exception
class ThrowInstantiateNotification(NotifyBase):
def __init__(self, **kwargs):
# Pretend everything is okay
raise TypeError()
SCHEMA_MAP['throw'] = ThrowInstantiateNotification
# Reset our object
a.clear()
assert (len(a) == 0)
# Instantiate a good object
plugin = a.instantiate('good://localhost')
assert (isinstance(plugin, NotifyBase))
# We an add already substatiated instances into our Apprise object
a.add(plugin)
assert (len(a) == 1)
# Reset our object again
a.clear()
try:
a.instantiate('throw://localhost', suppress_exceptions=False)
assert (False)
except TypeError:
assert (True)
assert (len(a) == 0)
assert (a.instantiate('throw://localhost', suppress_exceptions=True) is
None)
assert (len(a) == 0)
def test_apprise():
"""
API: Apprise() object
"""
# Caling load matix a second time which is an internal function causes it
# to skip over content already loaded into our matrix and thefore accesses
# other if/else parts of the code that aren't otherwise called
__load_matrix()
a = Apprise()
# no items
assert (len(a) == 0)
# Create an Asset object
asset = AppriseAsset(theme='default')
# We can load the device using our asset
a = Apprise(asset=asset)
# We can load our servers up front as well
servers = [
'faast://abcdefghijklmnop-abcdefg',
'kodi://kodi.server.local',
]
a = Apprise(servers=servers)
# 2 servers loaded
assert (len(a) == 2)
# We can retrieve our URLs this way:
assert (len(a.urls()) == 2)
# We can add another server
assert (a.add('mmosts://mattermost.server.local/'
'3ccdd113474722377935511fc85d3dd4') is True)
assert (len(a) == 3)
# We can pop an object off of our stack by it's indexed value:
obj = a.pop(0)
assert (isinstance(obj, NotifyBase) is True)
assert (len(a) == 2)
# We can retrieve elements from our list too by reference:
assert (compat_is_basestring(a[0].url()) is True)
# We can iterate over our list too:
count = 0
for o in a:
assert (compat_is_basestring(o.url()) is True)
count += 1
# verify that we did indeed iterate over each element
assert (len(a) == count)
# We can empty our set
a.clear()
assert (len(a) == 0)
# An invalid schema
assert (a.add('this is not a parseable url at all') is False)
assert (len(a) == 0)
# An unsupported schema
assert (a.add('invalid://we.just.do.not.support.this.plugin.type') is
False)
assert (len(a) == 0)
# A poorly formatted URL
assert (a.add('json://user:@@@:bad?no.good') is False)
assert (len(a) == 0)
# Add a server with our asset we created earlier
assert (a.add(
'mmosts://mattermost.server.local/'
'3ccdd113474722377935511fc85d3dd4',
asset=asset) is True)
# Clear our server listings again
a.clear()
# No servers to notify
assert (a.notify(title="my title", body="my body") is False)
class BadNotification(NotifyBase):
def __init__(self, **kwargs):
super(BadNotification, self).__init__(**kwargs)
# We fail whenever we're initialized
raise TypeError()
class GoodNotification(NotifyBase):
def __init__(self, **kwargs):
super(GoodNotification,
self).__init__(notify_format=NotifyFormat.HTML, **kwargs)
def notify(self, **kwargs):
# Pretend everything is okay
return True
# Store our bad notification in our schema map
SCHEMA_MAP['bad'] = BadNotification
# Store our good notification in our schema map
SCHEMA_MAP['good'] = GoodNotification
# Just to explain what is happening here, we would have parsed the
# url properly but failed when we went to go and create an instance
# of it.
assert (a.add('bad://localhost') is False)
assert (len(a) == 0)
assert (a.add('good://localhost') is True)
assert (len(a) == 1)
# Bad Notification Type is still allowed as it is presumed the user
# know's what their doing
assert (a.notify(title="my title", body="my body", notify_type='bad') is
True)
# No Title/Body combo's
assert (a.notify(title=None, body=None) is False)
assert (a.notify(title='', body=None) is False)
assert (a.notify(title=None, body='') is False)
# As long as one is present, we're good
assert (a.notify(title=None, body='present') is True)
assert (a.notify(title='present', body=None) is True)
assert (a.notify(title="present", body="present") is True)
# Clear our server listings again
a.clear()
class ThrowNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
raise TypeError()
class RuntimeNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
raise RuntimeError()
class FailNotification(NotifyBase):
def notify(self, **kwargs):
# Pretend everything is okay
return False
# Store our bad notification in our schema map
SCHEMA_MAP['throw'] = ThrowNotification
# Store our good notification in our schema map
SCHEMA_MAP['fail'] = FailNotification
# Store our good notification in our schema map
SCHEMA_MAP['runtime'] = RuntimeNotification
assert (a.add('runtime://localhost') is True)
assert (a.add('throw://localhost') is True)
assert (a.add('fail://localhost') is True)
assert (len(a) == 3)
# Test when our notify both throws an exception and or just
# simply returns False
assert (a.notify(title="present", body="present") is False)
# Create a Notification that throws an unexected exception
class ThrowInstantiateNotification(NotifyBase):
def __init__(self, **kwargs):
# Pretend everything is okay
raise TypeError()
SCHEMA_MAP['throw'] = ThrowInstantiateNotification
# Reset our object
a.clear()
assert (len(a) == 0)
# Instantiate a good object
plugin = a.instantiate('good://localhost', tag="good")
assert (isinstance(plugin, NotifyBase))
# Test simple tagging inside of the object
assert ("good" in plugin)
assert ("bad" not in plugin)
# the in (__contains__ override) is based on or'ed content; so although
# 'bad' isn't tagged as being in the plugin, 'good' is, so the return
# value of this is True
assert (["bad", "good"] in plugin)
assert (set(["bad", "good"]) in plugin)
assert (("bad", "good") in plugin)
# We an add already substatiated instances into our Apprise object
a.add(plugin)
assert (len(a) == 1)
# Reset our object again
a.clear()
try:
a.instantiate('throw://localhost', suppress_exceptions=False)
assert (False)
except TypeError:
assert (True)
assert (len(a) == 0)
assert (a.instantiate('throw://localhost', suppress_exceptions=True) is
None)
assert (len(a) == 0)
