mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
141 lines
3.7 KiB
Python
141 lines
3.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: hipchat
|
|
version_added: "1.2"
|
|
short_description: Send a message to hipchat
|
|
description:
|
|
- Send a message to hipchat
|
|
options:
|
|
token:
|
|
description:
|
|
- API token.
|
|
required: true
|
|
room:
|
|
description:
|
|
- ID or name of the room.
|
|
required: true
|
|
from:
|
|
description:
|
|
- Name the message will appear be sent from. max 15 characters.
|
|
Over 15, will be shorten.
|
|
required: false
|
|
default: Ansible
|
|
msg:
|
|
description:
|
|
- The message body.
|
|
required: true
|
|
default: null
|
|
color:
|
|
description:
|
|
- Background color for the message. Default is yellow.
|
|
required: false
|
|
default: yellow
|
|
choices: [ "yellow", "red", "green", "purple", "gray", "random" ]
|
|
msg_format:
|
|
description:
|
|
- message format. html or text. Default is text.
|
|
required: false
|
|
default: text
|
|
choices: [ "text", "html" ]
|
|
notify:
|
|
description:
|
|
- notify or not (change the tab color, play a sound, etc)
|
|
required: false
|
|
default: 'yes'
|
|
choices: [ "yes", "no" ]
|
|
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']
|
|
version_added: 1.5.1
|
|
|
|
# informational: requirements for nodes
|
|
requirements: [ urllib, urllib2 ]
|
|
author: WAKAYAMA Shirou
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- hipchat: token=AAAAAA room=notify msg="Ansible task finished"
|
|
'''
|
|
|
|
# ===========================================
|
|
# HipChat module specific support methods.
|
|
#
|
|
|
|
MSG_URI = "https://api.hipchat.com/v1/rooms/message?"
|
|
|
|
|
|
def send_msg(module, token, room, msg_from, msg, msg_format='text',
|
|
color='yellow', notify=False):
|
|
'''sending message to hipchat'''
|
|
|
|
params = {}
|
|
params['room_id'] = room
|
|
params['from'] = msg_from[:15] # max length is 15
|
|
params['message'] = msg
|
|
params['message_format'] = msg_format
|
|
params['color'] = color
|
|
|
|
if notify:
|
|
params['notify'] = 1
|
|
else:
|
|
params['notify'] = 0
|
|
|
|
url = MSG_URI + "auth_token=%s" % (token)
|
|
data = urllib.urlencode(params)
|
|
response, info = fetch_url(module, url, data=data)
|
|
if info['status'] == 200:
|
|
return response.read()
|
|
else:
|
|
module.fail_json(msg="failed to send message, return status=%s" % str(info['status']))
|
|
|
|
|
|
# ===========================================
|
|
# Module execution.
|
|
#
|
|
|
|
def main():
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
token=dict(required=True),
|
|
room=dict(required=True),
|
|
msg=dict(required=True),
|
|
msg_from=dict(default="Ansible", aliases=['from']),
|
|
color=dict(default="yellow", choices=["yellow", "red", "green",
|
|
"purple", "gray", "random"]),
|
|
msg_format=dict(default="text", choices=["text", "html"]),
|
|
notify=dict(default=True, type='bool'),
|
|
validate_certs = dict(default='yes', type='bool'),
|
|
),
|
|
supports_check_mode=True
|
|
)
|
|
|
|
token = module.params["token"]
|
|
room = module.params["room"]
|
|
msg = module.params["msg"]
|
|
msg_from = module.params["msg_from"]
|
|
color = module.params["color"]
|
|
msg_format = module.params["msg_format"]
|
|
notify = module.params["notify"]
|
|
|
|
try:
|
|
send_msg(module, token, room, msg_from, msg, msg_format, color, notify)
|
|
except Exception, e:
|
|
module.fail_json(msg="unable to sent msg: %s" % e)
|
|
|
|
changed = True
|
|
module.exit_json(changed=changed, room=room, msg_from=msg_from, msg=msg)
|
|
|
|
# import module snippets
|
|
from ansible.module_utils.basic import *
|
|
from ansible.module_utils.urls import *
|
|
|
|
main()
|