Slack Attachment + Bot Support

This commit is contained in:
Chris Caron 2019-11-14 19:41:12 -05:00
parent 002cebfaa3
commit 0175da1583
5 changed files with 656 additions and 179 deletions

View File

@ -23,21 +23,41 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE. # THE SOFTWARE.
# To use this plugin, you need to first access https://api.slack.com # There are 2 ways to use this plugin...
# Specifically https://my.slack.com/services/new/incoming-webhook/ # Method 1: Via Webhook:
# to create a new incoming webhook for your account. You'll need to # Visit https://my.slack.com/services/new/incoming-webhook/
# follow the wizard to pre-determine the channel(s) you want your # to create a new incoming webhook for your account. You'll need to
# message to broadcast to, and when you're complete, you will # follow the wizard to pre-determine the channel(s) you want your
# recieve a URL that looks something like this: # message to broadcast to, and when you're complete, you will
# https://hooks.slack.com/services/T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ # recieve a URL that looks something like this:
# ^ ^ ^ # https://hooks.slack.com/services/T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7
# | | | # ^ ^ ^
# These are important <--------------^---------^---------------^ # | | |
# These are important <--------------^---------^---------------^
# #
# Method 2: Via a Bot:
# 1. visit: https://api.slack.com/apps?new_app=1
# 2. Pick an App Name (such as Apprise) and select your workspace. Then
# press 'Create App'
# 3. You'll be able to click on 'Bots' from here where you can then choose
# to add a 'Bot User'. Give it a name and choose 'Add Bot User'.
# 4. Now you can choose 'Install App' to which you can choose 'Install App
# to Workspace'.
# 5. You will need to authorize the app which you get promopted to do.
# 6. Finally you'll get some important information providing you your
# 'OAuth Access Token' and 'Bot User OAuth Access Token' such as:
# slack://{Oauth Access Token}
# #
# ... which might look something like:
# slack://xoxp-1234-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d
# ... or:
# slack://xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d
#
import re import re
import requests import requests
from json import dumps from json import dumps
from json import loads
from time import time from time import time
from .NotifyBase import NotifyBase from .NotifyBase import NotifyBase
@ -58,6 +78,27 @@ SLACK_HTTP_ERROR_MAP = {
CHANNEL_LIST_DELIM = re.compile(r'[ \t\r\n,#\\/]+') CHANNEL_LIST_DELIM = re.compile(r'[ \t\r\n,#\\/]+')
class SlackMode(object):
"""
Tracks the mode of which we're using Slack
"""
# We're dealing with a webhook
# Our token looks like: T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7
WEBHOOK = 'webhook'
# We're dealing with a bot (using the OAuth Access Token)
# Our token looks like: xoxp-1234-1234-1234-abc124 or
# Our token looks like: xoxb-1234-1234-abc124 or
BOT = 'bot'
# Define our Slack Modes
SLACK_MODES = (
SlackMode.WEBHOOK,
SlackMode.BOT,
)
class NotifySlack(NotifyBase): class NotifySlack(NotifyBase):
""" """
A wrapper for Slack Notifications A wrapper for Slack Notifications
@ -72,27 +113,43 @@ class NotifySlack(NotifyBase):
# The default secure protocol # The default secure protocol
secure_protocol = 'slack' secure_protocol = 'slack'
# Allow 50 requests per minute (Tier 2).
# 60/50 = 0.2
request_rate_per_sec = 1.2
# A URL that takes you to the setup/help of the specific protocol # A URL that takes you to the setup/help of the specific protocol
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_slack' setup_url = 'https://github.com/caronc/apprise/wiki/Notify_slack'
# Slack uses the http protocol with JSON requests # Slack Webhook URL
notify_url = 'https://hooks.slack.com/services' webhook_url = 'https://hooks.slack.com/services'
# Slack API URL (used with Bots)
api_url = 'https://slack.com/api/{}'
# Allows the user to specify the NotifyImageSize object # Allows the user to specify the NotifyImageSize object
image_size = NotifyImageSize.XY_72 image_size = NotifyImageSize.XY_72
# The maximum allowable characters allowed in the body per message # The maximum allowable characters allowed in the body per message
body_maxlen = 1000 body_maxlen = 35000
# Default Notification Format # Default Notification Format
notify_format = NotifyFormat.MARKDOWN notify_format = NotifyFormat.MARKDOWN
# Bot's do not have default channels to notify; so #general
# becomes the default channel in BOT mode
default_notification_channel = '#general'
# Define object templates # Define object templates
templates = ( templates = (
# Webhook
'{schema}://{token_a}/{token_b}{token_c}', '{schema}://{token_a}/{token_b}{token_c}',
'{schema}://{botname}@{token_a}/{token_b}{token_c}', '{schema}://{botname}@{token_a}/{token_b}{token_c}',
'{schema}://{token_a}/{token_b}{token_c}/{targets}', '{schema}://{token_a}/{token_b}{token_c}/{targets}',
'{schema}://{botname}@{token_a}/{token_b}{token_c}/{targets}', '{schema}://{botname}@{token_a}/{token_b}{token_c}/{targets}',
# Bot
'{schema}://{access_token}/',
'{schema}://{access_token}/{targets}',
) )
# Define our template tokens # Define our template tokens
@ -102,7 +159,17 @@ class NotifySlack(NotifyBase):
'type': 'string', 'type': 'string',
'map_to': 'user', 'map_to': 'user',
}, },
# Token required as part of the API request # Bot User OAuth Access Token
# which always starts with xoxp- e.g.:
# xoxb-1234-1234-4ddbc191d40ee098cbaae6f3523ada2d
'access_token': {
'name': _('OAuth Access Token'),
'type': 'string',
'private': True,
'required': True,
'regex': (r'^xox[abp]-[A-Z0-9-]+$', 'i'),
},
# Token required as part of the Webhook request
# /AAAAAAAAA/........./........................ # /AAAAAAAAA/........./........................
'token_a': { 'token_a': {
'name': _('Token A'), 'name': _('Token A'),
@ -111,7 +178,7 @@ class NotifySlack(NotifyBase):
'required': True, 'required': True,
'regex': (r'^[A-Z0-9]{9}$', 'i'), 'regex': (r'^[A-Z0-9]{9}$', 'i'),
}, },
# Token required as part of the API request # Token required as part of the Webhook request
# /........./BBBBBBBBB/........................ # /........./BBBBBBBBB/........................
'token_b': { 'token_b': {
'name': _('Token B'), 'name': _('Token B'),
@ -120,7 +187,7 @@ class NotifySlack(NotifyBase):
'required': True, 'required': True,
'regex': (r'^[A-Z0-9]{9}$', 'i'), 'regex': (r'^[A-Z0-9]{9}$', 'i'),
}, },
# Token required as part of the API request # Token required as part of the Webhook request
# /........./........./CCCCCCCCCCCCCCCCCCCCCCCC # /........./........./CCCCCCCCCCCCCCCCCCCCCCCC
'token_c': { 'token_c': {
'name': _('Token C'), 'name': _('Token C'),
@ -161,41 +228,60 @@ class NotifySlack(NotifyBase):
'default': True, 'default': True,
'map_to': 'include_image', 'map_to': 'include_image',
}, },
'footer': {
'name': _('Include Footer'),
'type': 'bool',
'default': True,
'map_to': 'include_footer',
},
'to': { 'to': {
'alias_of': 'targets', 'alias_of': 'targets',
}, },
}) })
def __init__(self, token_a, token_b, token_c, targets, def __init__(self, access_token=None, token_a=None, token_b=None,
include_image=True, **kwargs): token_c=None, targets=None, include_image=True,
include_footer=True, **kwargs):
""" """
Initialize Slack Object Initialize Slack Object
""" """
super(NotifySlack, self).__init__(**kwargs) super(NotifySlack, self).__init__(**kwargs)
self.token_a = validate_regex( # Setup our mode
token_a, *self.template_tokens['token_a']['regex']) self.mode = SlackMode.BOT if access_token else SlackMode.WEBHOOK
if not self.token_a:
msg = 'An invalid Slack (first) Token ' \
'({}) was specified.'.format(token_a)
self.logger.warning(msg)
raise TypeError(msg)
self.token_b = validate_regex( if self.mode is SlackMode.WEBHOOK:
token_b, *self.template_tokens['token_b']['regex']) self.token_a = validate_regex(
if not self.token_b: token_a, *self.template_tokens['token_a']['regex'])
msg = 'An invalid Slack (second) Token ' \ if not self.token_a:
'({}) was specified.'.format(token_b) msg = 'An invalid Slack (first) Token ' \
self.logger.warning(msg) '({}) was specified.'.format(token_a)
raise TypeError(msg) self.logger.warning(msg)
raise TypeError(msg)
self.token_c = validate_regex( self.token_b = validate_regex(
token_c, *self.template_tokens['token_c']['regex']) token_b, *self.template_tokens['token_b']['regex'])
if not self.token_c: if not self.token_b:
msg = 'An invalid Slack (third) Token ' \ msg = 'An invalid Slack (second) Token ' \
'({}) was specified.'.format(token_c) '({}) was specified.'.format(token_b)
self.logger.warning(msg) self.logger.warning(msg)
raise TypeError(msg) raise TypeError(msg)
self.token_c = validate_regex(
token_c, *self.template_tokens['token_c']['regex'])
if not self.token_c:
msg = 'An invalid Slack (third) Token ' \
'({}) was specified.'.format(token_c)
self.logger.warning(msg)
raise TypeError(msg)
else:
self.access_token = validate_regex(
access_token, *self.template_tokens['access_token']['regex'])
if not self.access_token:
msg = 'An invalid Slack OAuth Access Token ' \
'({}) was specified.'.format(access_token)
self.logger.warning(msg)
raise TypeError(msg)
if not self.user: if not self.user:
self.logger.warning( self.logger.warning(
@ -207,7 +293,9 @@ class NotifySlack(NotifyBase):
# No problem; the webhook is smart enough to just notify the # No problem; the webhook is smart enough to just notify the
# channel it was created for; adding 'None' is just used as # channel it was created for; adding 'None' is just used as
# a flag lower to not set the channels # a flag lower to not set the channels
self.channels.append(None) self.channels.append(
None if self.mode is SlackMode.WEBHOOK
else self.default_notification_channel)
# Formatting requirements are defined here: # Formatting requirements are defined here:
# https://api.slack.com/docs/message-formatting # https://api.slack.com/docs/message-formatting
@ -229,18 +317,16 @@ class NotifySlack(NotifyBase):
# Place a thumbnail image inline with the message body # Place a thumbnail image inline with the message body
self.include_image = include_image self.include_image = include_image
# Place a footer with each post
self.include_footer = include_footer
return return
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
**kwargs):
""" """
Perform Slack Notification Perform Slack Notification
""" """
headers = {
'User-Agent': self.app_id,
'Content-Type': 'application/json',
}
# error tracking (used for function return) # error tracking (used for function return)
has_error = False has_error = False
@ -251,14 +337,8 @@ class NotifySlack(NotifyBase):
body = self._re_formatting_rules.sub( # pragma: no branch body = self._re_formatting_rules.sub( # pragma: no branch
lambda x: self._re_formatting_map[x.group()], body, lambda x: self._re_formatting_map[x.group()], body,
) )
url = '%s/%s/%s/%s' % (
self.notify_url,
self.token_a,
self.token_b,
self.token_c,
)
# prepare JSON Object # Prepare JSON Object (applicable to both WEBHOOK and BOT mode)
payload = { payload = {
'username': self.user if self.user else self.app_id, 'username': self.user if self.user else self.app_id,
# Use Markdown language # Use Markdown language
@ -269,18 +349,41 @@ class NotifySlack(NotifyBase):
'color': self.color(notify_type), 'color': self.color(notify_type),
# Time # Time
'ts': time(), 'ts': time(),
'footer': self.app_id,
}], }],
} }
# Prepare our URL (depends on mode)
if self.mode is SlackMode.WEBHOOK:
url = '{}/{}/{}/{}'.format(
self.webhook_url,
self.token_a,
self.token_b,
self.token_c,
)
else: # SlackMode.BOT
url = self.api_url.format('chat.postMessage')
if self.include_footer:
# Include the footer only if specified to do so
payload['attachments'][0]['footer'] = self.app_id
if attach and self.mode is SlackMode.WEBHOOK:
# Be friendly; let the user know why they can't send their
# attachments if using the Webhook mode
self.logger.warning(
'Slack Webhooks do not support attachments.')
# Create a copy of the channel list # Create a copy of the channel list
channels = list(self.channels) channels = list(self.channels)
attach_channel_list = []
while len(channels): while len(channels):
channel = channels.pop(0) channel = channels.pop(0)
if channel is not None: if channel is not None:
_channel = validate_regex( _channel = validate_regex(
channel, r'[+#@]?([A-Z0-9_]{1,32})') channel, r'[+#@]?(?P<value>[A-Z0-9_]{1,32})')
if not _channel: if not _channel:
# Channel over-ride was specified # Channel over-ride was specified
@ -304,70 +407,226 @@ class NotifySlack(NotifyBase):
# Prefix with channel hash tag # Prefix with channel hash tag
payload['channel'] = '#{}'.format(_channel) payload['channel'] = '#{}'.format(_channel)
# Store the valid and massaged payload that is recognizable by
# slack. This list is used for sending attachments later.
attach_channel_list.append(payload['channel'])
# Acquire our to-be footer icon if configured to do so # Acquire our to-be footer icon if configured to do so
image_url = None if not self.include_image \ image_url = None if not self.include_image \
else self.image_url(notify_type) else self.image_url(notify_type)
if image_url: if image_url:
payload['attachments'][0]['footer_icon'] = image_url
payload['icon_url'] = image_url payload['icon_url'] = image_url
self.logger.debug('Slack POST URL: %s (cert_verify=%r)' % ( if self.include_footer:
url, self.verify_certificate, payload['attachments'][0]['footer_icon'] = image_url
))
self.logger.debug('Slack Payload: %s' % str(payload))
# Always call throttle before any remote server i/o is made response = self._send(url, payload)
self.throttle() if not response:
try: # Handle any error
r = requests.post(
url,
data=dumps(payload),
headers=headers,
verify=self.verify_certificate,
)
if r.status_code != requests.codes.ok:
# We had a problem
status_str = \
NotifySlack.http_response_code_lookup(
r.status_code, SLACK_HTTP_ERROR_MAP)
self.logger.warning(
'Failed to send Slack notification{}: '
'{}{}error={}.'.format(
' to {}'.format(channel)
if channel is not None else '',
status_str,
', ' if status_str else '',
r.status_code))
self.logger.debug(
'Response Details:\r\n{}'.format(r.content))
# Mark our failure
has_error = True
continue
else:
self.logger.info(
'Sent Slack notification{}.'.format(
' to {}'.format(channel)
if channel is not None else ''))
except requests.RequestException as e:
self.logger.warning(
'A Connection error occured sending Slack '
'notification{}.'.format(
' to {}'.format(channel)
if channel is not None else ''))
self.logger.debug('Socket Exception: %s' % str(e))
# Mark our failure
has_error = True has_error = True
continue continue
self.logger.info(
'Sent Slack notification{}.'.format(
' to {}'.format(channel)
if channel is not None else ''))
if attach and self.mode is SlackMode.BOT and attach_channel_list:
# Send our attachments (can only be done in bot mode)
for attachment in attach:
self.logger.info(
'Posting Slack Attachment {}'.format(attachment.name))
# Prepare API Upload Payload
_payload = {
'filename': attachment.name,
'channels': ','.join(attach_channel_list)
}
# Our URL
_url = self.api_url.format('files.upload')
response = self._send(_url, _payload, attach=attachment)
if not (response and response.get('file') and
response['file'].get('url_private')):
# We failed to post our attachments, take an early exit
return False
return not has_error return not has_error
def _send(self, url, payload, attach=None, **kwargs):
"""
Wrapper to the requests (post) object
"""
self.logger.debug('Slack POST URL: %s (cert_verify=%r)' % (
url, self.verify_certificate,
))
self.logger.debug('Slack Payload: %s' % str(payload))
headers = {
'User-Agent': self.app_id,
}
if not attach:
headers['Content-Type'] = 'application/json; charset=utf-8'
if self.mode is SlackMode.BOT:
headers['Authorization'] = 'Bearer {}'.format(self.access_token)
# Our response object
response = None
# Always call throttle before any remote server i/o is made
self.throttle()
# Our attachment path (if specified)
files = None
try:
# Open our attachment path if required:
if attach:
files = (attach.name, open(attach.path, 'rb'))
r = requests.post(
url,
data=payload if attach else dumps(payload),
headers=headers,
files=files,
verify=self.verify_certificate,
)
if r.status_code != requests.codes.ok:
# We had a problem
status_str = \
NotifySlack.http_response_code_lookup(
r.status_code, SLACK_HTTP_ERROR_MAP)
self.logger.warning(
'Failed to send {}to Slack: '
'{}{}error={}.'.format(
attach.name if attach else '',
status_str,
', ' if status_str else '',
r.status_code))
self.logger.debug(
'Response Details:\r\n{}'.format(r.content))
return False
try:
response = loads(r.content)
except (AttributeError, ValueError):
# AttributeError means r.content was None
pass
if not (response and response.get('ok', True)):
# Bare minimum requirements not met
self.logger.warning(
'Failed to send {}to Slack: error={}.'.format(
attach.name if attach else '',
r.status_code))
self.logger.debug(
'Response Details:\r\n{}'.format(r.content))
return False
# Message Post Response looks like this:
# {
# "attachments": [
# {
# "color": "3AA3E3",
# "fallback": "test",
# "id": 1,
# "text": "my body",
# "title": "my title",
# "ts": 1573694687
# }
# ],
# "bot_id": "BAK4K23G5",
# "icons": {
# "image_48": "https://s3-us-west-2.amazonaws.com/...
# },
# "subtype": "bot_message",
# "text": "",
# "ts": "1573694689.003700",
# "type": "message",
# "username": "Apprise"
# }
# File Attachment Responses look like this
# {
# "file": {
# "channels": [],
# "comments_count": 0,
# "created": 1573617523,
# "display_as_bot": false,
# "editable": false,
# "external_type": "",
# "filetype": "png",
# "groups": [],
# "has_rich_preview": false,
# "id": "FQJJLDAHM",
# "image_exif_rotation": 1,
# "ims": [],
# "is_external": false,
# "is_public": false,
# "is_starred": false,
# "mimetype": "image/png",
# "mode": "hosted",
# "name": "apprise-test.png",
# "original_h": 640,
# "original_w": 640,
# "permalink": "https://{name}.slack.com/files/...
# "permalink_public": "https://slack-files.com/...
# "pretty_type": "PNG",
# "public_url_shared": false,
# "shares": {},
# "size": 238810,
# "thumb_160": "https://files.slack.com/files-tmb/...
# "thumb_360": "https://files.slack.com/files-tmb/...
# "thumb_360_h": 360,
# "thumb_360_w": 360,
# "thumb_480": "https://files.slack.com/files-tmb/...
# "thumb_480_h": 480,
# "thumb_480_w": 480,
# "thumb_64": "https://files.slack.com/files-tmb/...
# "thumb_80": "https://files.slack.com/files-tmb/...
# "thumb_tiny": abcd...
# "timestamp": 1573617523,
# "title": "apprise-test",
# "url_private": "https://files.slack.com/files-pri/...
# "url_private_download": "https://files.slack.com/files-...
# "user": "UADKLLMJT",
# "username": ""
# },
# "ok": true
# }
except requests.RequestException as e:
self.logger.warning(
'A Connection error occured posting {}to Slack.'.format(
attach.name if attach else ''))
self.logger.debug('Socket Exception: %s' % str(e))
return False
except (OSError, IOError) as e:
self.logger.warning(
'An I/O error occured while reading {}.'.format(
attach.name if attach else 'attachment'))
self.logger.debug('I/O Exception: %s' % str(e))
return False
finally:
# Close our file (if it's open) stored in the second element
# of our files tuple (index 1)
if files:
files[1].close()
# Return the response for processing
return response
def url(self, privacy=False, *args, **kwargs): def url(self, privacy=False, *args, **kwargs):
""" """
Returns the URL built dynamically based on specified arguments. Returns the URL built dynamically based on specified arguments.
@ -378,23 +637,35 @@ class NotifySlack(NotifyBase):
'format': self.notify_format, 'format': self.notify_format,
'overflow': self.overflow_mode, 'overflow': self.overflow_mode,
'image': 'yes' if self.include_image else 'no', 'image': 'yes' if self.include_image else 'no',
'footer': 'yes' if self.include_footer else 'no',
'verify': 'yes' if self.verify_certificate else 'no', 'verify': 'yes' if self.verify_certificate else 'no',
} }
# Determine if there is a botname present if self.mode == SlackMode.WEBHOOK:
botname = '' # Determine if there is a botname present
if self.user: botname = ''
botname = '{botname}@'.format( if self.user:
botname=NotifySlack.quote(self.user, safe=''), botname = '{botname}@'.format(
) botname=NotifySlack.quote(self.user, safe=''),
)
return '{schema}://{botname}{token_a}/{token_b}/{token_c}/{targets}/'\ return '{schema}://{botname}{token_a}/{token_b}/{token_c}/'\
'{targets}/?{args}'.format(
schema=self.secure_protocol,
botname=botname,
token_a=self.pprint(self.token_a, privacy, safe=''),
token_b=self.pprint(self.token_b, privacy, safe=''),
token_c=self.pprint(self.token_c, privacy, safe=''),
targets='/'.join(
[NotifySlack.quote(x, safe='')
for x in self.channels]),
args=NotifySlack.urlencode(args),
)
# else -> self.mode == SlackMode.BOT:
return '{schema}://{access_token}/{targets}/'\
'?{args}'.format( '?{args}'.format(
schema=self.secure_protocol, schema=self.secure_protocol,
botname=botname, access_token=self.pprint(self.access_token, privacy, safe=''),
token_a=self.pprint(self.token_a, privacy, safe=''),
token_b=self.pprint(self.token_b, privacy, safe=''),
token_c=self.pprint(self.token_c, privacy, safe=''),
targets='/'.join( targets='/'.join(
[NotifySlack.quote(x, safe='') for x in self.channels]), [NotifySlack.quote(x, safe='') for x in self.channels]),
args=NotifySlack.urlencode(args), args=NotifySlack.urlencode(args),
@ -407,32 +678,40 @@ class NotifySlack(NotifyBase):
us to substantiate this object. us to substantiate this object.
""" """
results = NotifyBase.parse_url(url) results = NotifyBase.parse_url(url, verify_host=False)
if not results: if not results:
# We're done early as we couldn't load the results # We're done early as we couldn't load the results
return results return results
# The first token is stored in the hostname
token = NotifySlack.unquote(results['host'])
# Get unquoted entries # Get unquoted entries
entries = NotifySlack.split_path(results['fullpath']) entries = NotifySlack.split_path(results['fullpath'])
# The first token is stored in the hostname # Verify if our token_a us a bot token or part of a webhook:
results['token_a'] = NotifySlack.unquote(results['host']) if token.startswith('xo'):
# We're dealing with a bot
results['access_token'] = token
# Now fetch the remaining tokens else:
try: # We're dealing with a webhook
results['token_b'] = entries.pop(0) results['token_a'] = token
except IndexError: # Now fetch the remaining tokens
# We're done try:
results['token_b'] = None results['token_b'] = entries.pop(0)
try: except IndexError:
results['token_c'] = entries.pop(0) # We're done
results['token_b'] = None
except IndexError: try:
# We're done results['token_c'] = entries.pop(0)
results['token_c'] = None
except IndexError:
# We're done
results['token_c'] = None
# assign remaining entries to the channels we wish to notify # assign remaining entries to the channels we wish to notify
results['targets'] = entries results['targets'] = entries
@ -444,10 +723,14 @@ class NotifySlack(NotifyBase):
bool, CHANNEL_LIST_DELIM.split( bool, CHANNEL_LIST_DELIM.split(
NotifySlack.unquote(results['qsd']['to'])))] NotifySlack.unquote(results['qsd']['to'])))]
# Get Image # Get Image Flag
results['include_image'] = \ results['include_image'] = \
parse_bool(results['qsd'].get('image', True)) parse_bool(results['qsd'].get('image', True))
# Get Footer Flag
results['include_footer'] = \
parse_bool(results['qsd'].get('footer', True))
return results return results
@staticmethod @staticmethod

View File

@ -23,6 +23,7 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE. # THE SOFTWARE.
import os
import six import six
import pytest import pytest
import requests import requests
@ -37,6 +38,7 @@ from apprise import NotifyType
from apprise import NotifyBase from apprise import NotifyBase
from apprise import Apprise from apprise import Apprise
from apprise import AppriseAsset from apprise import AppriseAsset
from apprise import AppriseAttachment
from apprise.common import NotifyFormat from apprise.common import NotifyFormat
from apprise.common import OverflowMode from apprise.common import OverflowMode
@ -61,6 +63,9 @@ REQUEST_EXCEPTIONS = (
0, 'requests.TooManyRedirects() not handled'), 0, 'requests.TooManyRedirects() not handled'),
) )
# Attachment Directory
TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')
TEST_URLS = ( TEST_URLS = (
################################## ##################################
# NotifyBoxcar # NotifyBoxcar
@ -2483,10 +2488,10 @@ TEST_URLS = (
# NotifySlack # NotifySlack
################################## ##################################
('slack://', { ('slack://', {
'instance': None, 'instance': TypeError,
}), }),
('slack://:@/', { ('slack://:@/', {
'instance': None, 'instance': TypeError,
}), }),
('slack://T1JJ3T3L2', { ('slack://T1JJ3T3L2', {
# Just Token 1 provided # Just Token 1 provided
@ -2503,6 +2508,10 @@ TEST_URLS = (
# There is an invalid channel that we will fail to deliver to # There is an invalid channel that we will fail to deliver to
# as a result the response type will be false # as a result the response type will be false
'response': False, 'response': False,
'requests_response_text': {
'ok': False,
'message': 'Bad Channel',
},
}), }),
('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#channel', { ('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#channel', {
# No username specified; this is still okay as we sub in # No username specified; this is still okay as we sub in
@ -2510,11 +2519,19 @@ TEST_URLS = (
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
# don't include an image by default # don't include an image by default
'include_image': False, 'include_image': False,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/+id/@id/', { ('slack://T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/+id/@id/', {
# + encoded id, # + encoded id,
# @ userid # @ userid
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/' \ ('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/' \
'?to=#nuxref', { '?to=#nuxref', {
@ -2522,23 +2539,67 @@ TEST_URLS = (
# Our expected url(privacy=True) startswith() response: # Our expected url(privacy=True) startswith() response:
'privacy_url': 'slack://username@T...2/A...D/T...Q/', 'privacy_url': 'slack://username@T...2/A...D/T...Q/',
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#nuxref', { ('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#nuxref', {
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
# Test using a bot-token (also test footer set to no flag)
('slack://username@xoxb-1234-1234-abc124/#nuxref?footer=no', {
'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
# support attachments
'file': {
'url_private': 'http://localhost/',
},
},
}),
('slack://username@xoxb-1234-1234-abc124/#nuxref', {
'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
# we'll fail to send attachments because we had no 'file' response in
# our object
'response': False,
}),
('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ', { ('slack://username@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ', {
# Missing a channel, falls back to webhook channel bindings # Missing a channel, falls back to webhook channel bindings
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
# Native URL Support, take the slack URL and still build from it # Native URL Support, take the slack URL and still build from it
('https://hooks.slack.com/services/{}/{}/{}'.format( ('https://hooks.slack.com/services/{}/{}/{}'.format(
'A' * 9, 'B' * 9, 'c' * 24), { 'A' * 9, 'B' * 9, 'c' * 24), {
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
# Native URL Support with arguments # Native URL Support with arguments
('https://hooks.slack.com/services/{}/{}/{}?format=text'.format( ('https://hooks.slack.com/services/{}/{}/{}?format=text'.format(
'A' * 9, 'B' * 9, 'c' * 24), { 'A' * 9, 'B' * 9, 'c' * 24), {
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
'requests_response_text': {
'ok': True,
'message': '',
},
}), }),
('slack://username@INVALID/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#cool', { ('slack://username@INVALID/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#cool', {
# invalid 1st Token # invalid 1st Token
@ -2557,18 +2618,30 @@ TEST_URLS = (
# force a failure # force a failure
'response': False, 'response': False,
'requests_response_code': requests.codes.internal_server_error, 'requests_response_code': requests.codes.internal_server_error,
'requests_response_text': {
'ok': False,
'message': '',
},
}), }),
('slack://respect@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#a', { ('slack://respect@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#a', {
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
# throw a bizzare code forcing us to fail to look it up # throw a bizzare code forcing us to fail to look it up
'response': False, 'response': False,
'requests_response_code': 999, 'requests_response_code': 999,
'requests_response_text': {
'ok': False,
'message': '',
},
}), }),
('slack://notify@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#b', { ('slack://notify@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7FQ/#b', {
'instance': plugins.NotifySlack, 'instance': plugins.NotifySlack,
# Throws a series of connection and transfer exceptions when this flag # Throws a series of connection and transfer exceptions when this flag
# is set and tests that we gracfully handle them # is set and tests that we gracfully handle them
'test_requests_exceptions': True, 'test_requests_exceptions': True,
'requests_response_text': {
'ok': False,
'message': '',
},
}), }),
################################## ##################################
@ -3613,6 +3686,26 @@ def test_rest_plugins(mock_post, mock_get):
notify_type=notify_type, notify_type=notify_type,
overflow=OverflowMode.SPLIT) == notify_response overflow=OverflowMode.SPLIT) == notify_response
# Test single attachment support; even if the service
# doesn't support attachments, it should still gracefully
# ignore the data
attach = os.path.join(TEST_VAR_DIR, 'apprise-test.gif')
assert obj.notify(
body=body, title=title,
notify_type=notify_type,
attach=attach) == notify_response
# Same results should apply to a list of attachments
attach = AppriseAttachment((
os.path.join(TEST_VAR_DIR, 'apprise-test.gif'),
os.path.join(TEST_VAR_DIR, 'apprise-test.png'),
os.path.join(TEST_VAR_DIR, 'apprise-test.jpeg'),
))
assert obj.notify(
body=body, title=title,
notify_type=notify_type,
attach=attach) == notify_response
else: else:
# Disable throttling # Disable throttling
obj.request_rate_per_sec = 0 obj.request_rate_per_sec = 0
@ -4780,50 +4873,6 @@ def test_notify_sendgrid_plugin(mock_post, mock_get):
cc=('abc@test.org', '!invalid')), plugins.NotifySendGrid) cc=('abc@test.org', '!invalid')), plugins.NotifySendGrid)
@mock.patch('requests.get')
@mock.patch('requests.post')
def test_notify_slack_plugin(mock_post, mock_get):
"""
API: NotifySlack() Extra Checks
"""
# Disable Throttling to speed testing
plugins.NotifyBase.request_rate_per_sec = 0
# Initialize some generic (but valid) tokens
token_a = 'A' * 9
token_b = 'B' * 9
token_c = 'c' * 24
# Support strings
channels = 'chan1,#chan2,+id,@user,,,'
obj = plugins.NotifySlack(
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels)
assert len(obj.channels) == 4
# Prepare Mock
mock_get.return_value = requests.Request()
mock_post.return_value = requests.Request()
mock_post.return_value.status_code = requests.codes.ok
mock_get.return_value.status_code = requests.codes.ok
# Missing first Token
with pytest.raises(TypeError):
plugins.NotifySlack(
token_a=None, token_b=token_b, token_c=token_c,
targets=channels)
# Test include_image
obj = plugins.NotifySlack(
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels,
include_image=True)
# This call includes an image with it's payload:
assert obj.notify(
body='body', title='title', notify_type=NotifyType.INFO) is True
@mock.patch('requests.get') @mock.patch('requests.get')
@mock.patch('requests.post') @mock.patch('requests.post')
def test_notify_pushbullet_plugin(mock_post, mock_get): def test_notify_pushbullet_plugin(mock_post, mock_get):

145
test/test_slack_plugin.py Normal file
View File

@ -0,0 +1,145 @@
# -*- coding: utf-8 -*-
#
# 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 pytest
import requests
from apprise import plugins
from apprise import NotifyType
from json import dumps
# Disable logging for a cleaner testing output
import logging
logging.disable(logging.CRITICAL)
@mock.patch('requests.post')
def test_slack_oauth_access_token(mock_post):
"""
API: NotifySlack() OAuth Access Token Tests
"""
# Disable Throttling to speed testing
plugins.NotifyBase.request_rate_per_sec = 0
# Generate an invalid bot token
token = 'xo-invalid'
request = mock.Mock()
request.content = dumps({
'ok': True,
'message': '',
})
request.status_code = requests.codes.ok
# We'll fail to validate the access_token
with pytest.raises(TypeError):
plugins.NotifySlack(access_token=token)
# Generate a (valid) bot token
token = 'xoxb-1234-1234-abc124'
# Prepare Mock
mock_post.return_value = request
# Variation Initializations
obj = plugins.NotifySlack(access_token=token, targets='#apprise')
assert isinstance(obj, plugins.NotifySlack) is True
assert isinstance(obj.url(), six.string_types) is True
# apprise room was found
assert obj.send(body="test") is True
# Slack requests pay close attention to the response to determine
# if things go well... this is not a good JSON response:
request.content = '{'
# As a result, we'll fail to send our notification
assert obj.send(body="test") is False
request.content = dumps({
'ok': False,
'message': 'We failed',
})
# A response from Slack (even with a 200 response) still
# results in a failure:
assert obj.send(body="test") is False
# Handle exceptions reading our attachment from disk (should it happen)
mock_post.side_effect = OSError("Attachment Error")
mock_post.return_value = None
# We'll fail now because of an internal exception
assert obj.send(body="test") is False
@mock.patch('requests.post')
def test_slack_webhook(mock_post):
"""
API: NotifySlack() Webhook Tests
"""
# Disable Throttling to speed testing
plugins.NotifyBase.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 = dumps({
'ok': True,
})
# Initialize some generic (but valid) tokens
token_a = 'A' * 9
token_b = 'B' * 9
token_c = 'c' * 24
# Support strings
channels = 'chan1,#chan2,+BAK4K23G5,@user,,,'
obj = plugins.NotifySlack(
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels)
assert len(obj.channels) == 4
# This call includes an image with it's payload:
assert obj.notify(
body='body', title='title', notify_type=NotifyType.INFO) is True
# Missing first Token
with pytest.raises(TypeError):
plugins.NotifySlack(
token_a=None, token_b=token_b, token_c=token_c,
targets=channels)
# Test include_image
obj = plugins.NotifySlack(
token_a=token_a, token_b=token_b, token_c=token_c, targets=channels,
include_image=True)
# This call includes an image with it's payload:
assert obj.notify(
body='body', title='title', notify_type=NotifyType.INFO) is True

BIN
test/var/apprise-test.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
test/var/apprise-test.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 233 KiB