mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Ansible Module for Sending Rocket Chat Notifications (#2222)
This commit is contained in:
Deepakkothandan
Matt Clay
parent
8e4e0dab63
commit
20ea765fdd
1 changed files with 247 additions and 0 deletions
247
lib/ansible/modules/extras/notification/rocketchat.py
Normal file
247
lib/ansible/modules/extras/notification/rocketchat.py
Normal file
|
|
@ -0,0 +1,247 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2016, Deepak Kothandan <deepak.kothandan@outlook.com>
|
||||
# (c) 2015, Stefan Berggren <nsg@nsg.cc>
|
||||
# (c) 2014, Ramon de la Fuente <ramon@delafuente.nl>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
DOCUMENTATION = """
|
||||
module: rocketchat
|
||||
short_description: Send notifications to Rocket Chat
|
||||
description:
|
||||
- The M(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration
|
||||
version_added: "2.2"
|
||||
author: "Ramon de la Fuente (@ramondelafuente)"
|
||||
options:
|
||||
domain:
|
||||
description:
|
||||
- The domain for your environment without protocol. (i.e.
|
||||
C(subdomain.domain.com or chat.domain.tld))
|
||||
required: true
|
||||
default: None
|
||||
token:
|
||||
description:
|
||||
- Rocket Chat Incoming Webhook integration token. This provides
|
||||
authentication to Rocket Chat's Incoming webhook for posting
|
||||
messages.
|
||||
required: true
|
||||
protocol:
|
||||
description:
|
||||
- Specify the protocol used to send notification messages before the webhook url. (i.e. http or https)
|
||||
required: false
|
||||
default: https
|
||||
choices:
|
||||
- 'http'
|
||||
- 'https'
|
||||
msg:
|
||||
description:
|
||||
- Message to be sent.
|
||||
required: false
|
||||
default: None
|
||||
channel:
|
||||
description:
|
||||
- Channel to send the message to. If absent, the message goes to the channel selected for the I(token)
|
||||
specifed during the creation of webhook.
|
||||
required: false
|
||||
default: None
|
||||
username:
|
||||
description:
|
||||
- This is the sender of the message.
|
||||
required: false
|
||||
default: "Ansible"
|
||||
icon_url:
|
||||
description:
|
||||
- URL for the message sender's icon (default C(http://www.ansible.com/favicon.ico))
|
||||
required: false
|
||||
icon_emoji:
|
||||
description:
|
||||
- Emoji for the message sender. The representation for the available emojis can be
|
||||
got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used)
|
||||
required: false
|
||||
default: None
|
||||
link_names:
|
||||
description:
|
||||
- Automatically create links for channels and usernames in I(msg).
|
||||
required: false
|
||||
default: 1
|
||||
choices:
|
||||
- 1
|
||||
- 0
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
default: 'yes'
|
||||
choices:
|
||||
- 'yes'
|
||||
- 'no'
|
||||
color:
|
||||
description:
|
||||
- Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message
|
||||
required: false
|
||||
default: 'normal'
|
||||
choices:
|
||||
- 'normal'
|
||||
- 'good'
|
||||
- 'warning'
|
||||
- 'danger'
|
||||
attachments:
|
||||
description:
|
||||
- Define a list of attachments.
|
||||
required: false
|
||||
default: None
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Send notification message via Rocket Chat
|
||||
local_action:
|
||||
module: rocketchat
|
||||
token: thetoken/generatedby/rocketchat
|
||||
msg: "{{ inventory_hostname }} completed"
|
||||
|
||||
- name: Send notification message via Rocket Chat all options
|
||||
local_action:
|
||||
module: rocketchat
|
||||
token: thetoken/generatedby/rocketchat
|
||||
msg: "{{ inventory_hostname }} completed"
|
||||
channel: "#ansible"
|
||||
username: "Ansible on {{ inventory_hostname }}"
|
||||
icon_url: "http://www.example.com/some-image-file.png"
|
||||
link_names: 0
|
||||
|
||||
- name: insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in rocketchat
|
||||
rocketchat:
|
||||
token: thetoken/generatedby/rocketchat
|
||||
msg: "{{ inventory_hostname }} is alive!"
|
||||
color: good
|
||||
username: ""
|
||||
icon_url: ""
|
||||
|
||||
- name: Use the attachments API
|
||||
rocketchat:
|
||||
token: thetoken/generatedby/rocketchat
|
||||
attachments:
|
||||
- text: "Display my system load on host A and B"
|
||||
color: "#ff00dd"
|
||||
title: "System load"
|
||||
fields:
|
||||
- title: "System A"
|
||||
value: "load average: 0,74, 0,66, 0,63"
|
||||
short: "true"
|
||||
- title: "System B"
|
||||
value: "load average: 5,16, 4,64, 2,43"
|
||||
short: "true"
|
||||
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
changed:
|
||||
description: A flag indicating if any change was made or not.
|
||||
returned: success
|
||||
type: boolean
|
||||
sample: false
|
||||
"""
|
||||
|
||||
ROCKETCHAT_INCOMING_WEBHOOK = '%s://%s/hooks/%s'
|
||||
|
||||
def build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments):
|
||||
payload = {}
|
||||
if color == "normal" and text is not None:
|
||||
payload = dict(text=text)
|
||||
elif text is not None:
|
||||
payload = dict(attachments=[dict(text=text, color=color)])
|
||||
if channel is not None:
|
||||
if (channel[0] == '#') or (channel[0] == '@'):
|
||||
payload['channel'] = channel
|
||||
else:
|
||||
payload['channel'] = '#' + channel
|
||||
if username is not None:
|
||||
payload['username'] = username
|
||||
if icon_emoji is not None:
|
||||
payload['icon_emoji'] = icon_emoji
|
||||
else:
|
||||
payload['icon_url'] = icon_url
|
||||
if link_names is not None:
|
||||
payload['link_names'] = link_names
|
||||
|
||||
if attachments is not None:
|
||||
if 'attachments' not in payload:
|
||||
payload['attachments'] = []
|
||||
|
||||
if attachments is not None:
|
||||
for attachment in attachments:
|
||||
if 'fallback' not in attachment:
|
||||
attachment['fallback'] = attachment['text']
|
||||
payload['attachments'].append(attachment)
|
||||
|
||||
payload="payload=" + module.jsonify(payload)
|
||||
return payload
|
||||
|
||||
def do_notify_rocketchat(module, domain, token, protocol, payload):
|
||||
|
||||
if token.count('/') < 1:
|
||||
module.fail_json(msg="Invalid Token specified, provide a valid token")
|
||||
|
||||
rocketchat_incoming_webhook = ROCKETCHAT_INCOMING_WEBHOOK % (protocol, domain, token)
|
||||
|
||||
response, info = fetch_url(module, rocketchat_incoming_webhook, data=payload)
|
||||
if info['status'] != 200:
|
||||
module.fail_json(msg="failed to send message, return status=%s" % str(info['status']))
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec = dict(
|
||||
domain = dict(type='str', required=False, default=None),
|
||||
token = dict(type='str', required=True, no_log=True),
|
||||
protocol = dict(type='str', default='https', choices=['http', 'https']),
|
||||
msg = dict(type='str', required=False, default=None),
|
||||
channel = dict(type='str', default=None),
|
||||
username = dict(type='str', default='Ansible'),
|
||||
icon_url = dict(type='str', default='http://www.ansible.com/favicon.ico'),
|
||||
icon_emoji = dict(type='str', default=None),
|
||||
link_names = dict(type='int', default=1, choices=[0,1]),
|
||||
validate_certs = dict(default='yes', type='bool'),
|
||||
color = dict(type='str', default='normal', choices=['normal', 'good', 'warning', 'danger']),
|
||||
attachments = dict(type='list', required=False, default=None)
|
||||
)
|
||||
)
|
||||
|
||||
domain = module.params['domain']
|
||||
token = module.params['token']
|
||||
protocol = module.params['protocol']
|
||||
text = module.params['msg']
|
||||
channel = module.params['channel']
|
||||
username = module.params['username']
|
||||
icon_url = module.params['icon_url']
|
||||
icon_emoji = module.params['icon_emoji']
|
||||
link_names = module.params['link_names']
|
||||
color = module.params['color']
|
||||
attachments = module.params['attachments']
|
||||
|
||||
payload = build_payload_for_rocketchat(module, text, channel, username, icon_url, icon_emoji, link_names, color, attachments)
|
||||
do_notify_rocketchat(module, domain, token, protocol, payload)
|
||||
|
||||
module.exit_json(msg="OK")
|
||||
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.urls import *
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue