mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add matrix notification module (#45823)
* Add matrix notification module * try to make ansibot happy * docs * fix typo in encoding * is ansibot happy now? * change matrix python lib requirement description * Example formatting & no_log Thanks for this PR. Few minor things that are easier for me to just fix, than explain and get you to fix. * We suggest using `- name:` for examples, as Ansible best practice is to name your tasks * To prevent secrets being leaked out use `no_log` in argspec * use `requirements:` in `DOCUMENTATION` * Clean up argument requirements * Remove requirements duplicate * not sure on syntax with these, were adapted from an example elsewhere
This commit is contained in:
parent
0fb0ea2ab3
commit
01bee0c2d9
1 changed files with 135 additions and 0 deletions
135
lib/ansible/modules/notification/matrix.py
Normal file
135
lib/ansible/modules/notification/matrix.py
Normal file
|
@ -0,0 +1,135 @@
|
|||
#!/usr/bin/python
|
||||
# coding: utf-8
|
||||
|
||||
# (c) 2018, Jan Christian Grünhage <jan.christian@gruenhage.xyz>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
author: "Jan Christian Grünhage (@jcgruenhage)"
|
||||
module: matrix
|
||||
short_description: Send notifications to matrix
|
||||
description:
|
||||
- This module sends html formatted notifications to matrix rooms.
|
||||
version_added: "2.8"
|
||||
options:
|
||||
msg_plain:
|
||||
description:
|
||||
- Plain text form of the message to send to matrix, usually markdown
|
||||
required: true
|
||||
msg_html:
|
||||
description:
|
||||
- HTML form of the message to send to matrix
|
||||
required: true
|
||||
room_id:
|
||||
description:
|
||||
- ID of the room to send the notification to
|
||||
required: true
|
||||
hs_url:
|
||||
description:
|
||||
- URL of the homeserver, where the CS-API is reachable
|
||||
required: true
|
||||
token:
|
||||
description:
|
||||
- Authentication token for the API call. If provided, user_id and password are not required
|
||||
user_id:
|
||||
description:
|
||||
- The user id of the user
|
||||
password:
|
||||
description:
|
||||
- The password to log in with
|
||||
requirements:
|
||||
- matrix-client (Python library)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Send matrix notification with token
|
||||
matrix:
|
||||
msg_plain: "**hello world**"
|
||||
msg_html: "<b>hello world</b>"
|
||||
room_id: "!12345678:server.tld"
|
||||
hs_url: "https://matrix.org"
|
||||
token: "{{ matrix_auth_token }}"
|
||||
|
||||
- name: Send matrix notification with user_id and password
|
||||
matrix:
|
||||
msg_plain: "**hello world**"
|
||||
msg_html: "<b>hello world</b>"
|
||||
room_id: "!12345678:server.tld"
|
||||
hs_url: "https://matrix.org"
|
||||
user_id: "ansible_notification_bot"
|
||||
password: "{{ matrix_auth_password }}"
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
'''
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
from matrix_client.client import MatrixClient
|
||||
except ImportError:
|
||||
matrix_found = False
|
||||
else:
|
||||
matrix_found = True
|
||||
|
||||
|
||||
def run_module():
|
||||
module_args = dict(
|
||||
msg_plain=dict(type='str', required=True),
|
||||
msg_html=dict(type='str', required=True),
|
||||
room_id=dict(type='str', required=True),
|
||||
hs_url=dict(type='str', required=True),
|
||||
token=dict(type='str', required=False, no_log=True),
|
||||
user_id=dict(type='str', required=False),
|
||||
password=dict(type='str', required=False, no_log=True),
|
||||
)
|
||||
|
||||
result = dict(
|
||||
changed=False,
|
||||
message=''
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=module_args,
|
||||
mutually_exclusive=[['password', 'token']],
|
||||
required_one_of=[['password', 'token']],
|
||||
required_together=[['user_id', 'password']],
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not matrix_found:
|
||||
module.fail_json(msg="Python 'matrix-client' module is required. Install via: $ pip install matrix-client")
|
||||
|
||||
if module.check_mode:
|
||||
return result
|
||||
|
||||
# create a client object
|
||||
client = MatrixClient(module.params['hs_url'])
|
||||
if module.params['token'] is not None:
|
||||
client.api.token = module.params['token']
|
||||
else:
|
||||
client.login(module.params['user_id'], module.params['password'], sync=False)
|
||||
|
||||
# make sure we are in a given room and return a room object for it
|
||||
room = client.join_room(module.params['room_id'])
|
||||
# send an html formatted messages
|
||||
room.send_html(module.params['msg_html'], module.params['msg_plain'])
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
def main():
|
||||
run_module()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in a new issue