mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
BOTMETA: Move rabbitmq modules to own directory (#46064)
Moving rabbitmq modules to own directory makes it possible to automatically include $team_rabbitmq for new modules.
This commit is contained in:
Dag Wieers
Alicia Cozine
parent
77d73808e6
commit
b7e77c4274
11 changed files with 28 additions and 39 deletions
292
lib/ansible/modules/messaging/rabbitmq/rabbitmq_binding.py
Normal file
292
lib/ansible/modules/messaging/rabbitmq/rabbitmq_binding.py
Normal file
|
|
@ -0,0 +1,292 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright: (c) 2015, Manuel Sousa <manuel.sousa@gmail.com>
|
||||
# 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 = '''
|
||||
---
|
||||
module: rabbitmq_binding
|
||||
author: Manuel Sousa (@manuel-sousa)
|
||||
version_added: "2.0"
|
||||
|
||||
short_description: Manage rabbitMQ bindings
|
||||
description:
|
||||
- This module uses rabbitMQ REST APIs to create / delete bindings.
|
||||
requirements: [ "requests >= 1.0.0" ]
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- Whether the bindings should be present or absent.
|
||||
- Only present implemented at the momemt.
|
||||
choices: [ "present", "absent" ]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
- source exchange to create binding on.
|
||||
required: true
|
||||
aliases: [ "src", "source" ]
|
||||
destination:
|
||||
description:
|
||||
- destination exchange or queue for the binding.
|
||||
required: true
|
||||
aliases: [ "dst", "dest" ]
|
||||
destination_type:
|
||||
description:
|
||||
- Either queue or exchange.
|
||||
required: true
|
||||
choices: [ "queue", "exchange" ]
|
||||
aliases: [ "type", "dest_type" ]
|
||||
routing_key:
|
||||
description:
|
||||
- routing key for the binding.
|
||||
default: "#"
|
||||
arguments:
|
||||
description:
|
||||
- extra arguments for exchange. If defined this argument is a key/value dictionary
|
||||
required: false
|
||||
default: {}
|
||||
extends_documentation_fragment:
|
||||
- rabbitmq
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Bind myQueue to directExchange with routing key info
|
||||
- rabbitmq_binding:
|
||||
name: directExchange
|
||||
destination: myQueue
|
||||
type: queue
|
||||
routing_key: info
|
||||
|
||||
# Bind directExchange to topicExchange with routing key *.info
|
||||
- rabbitmq_binding:
|
||||
name: topicExchange
|
||||
destination: topicExchange
|
||||
type: exchange
|
||||
routing_key: '*.info'
|
||||
'''
|
||||
|
||||
import json
|
||||
|
||||
try:
|
||||
import requests
|
||||
|
||||
HAS_REQUESTS = True
|
||||
except ImportError:
|
||||
HAS_REQUESTS = False
|
||||
|
||||
from ansible.module_utils.six.moves.urllib import parse as urllib_parse
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.rabbitmq import rabbitmq_argument_spec
|
||||
|
||||
|
||||
class RabbitMqBinding(object):
|
||||
def __init__(self, module):
|
||||
"""
|
||||
:param module:
|
||||
"""
|
||||
self.module = module
|
||||
self.name = self.module.params['name']
|
||||
self.login_user = self.module.params['login_user']
|
||||
self.login_password = self.module.params['login_password']
|
||||
self.login_host = self.module.params['login_host']
|
||||
self.login_port = self.module.params['login_port']
|
||||
self.login_protocol = self.module.params['login_protocol']
|
||||
self.vhost = self.module.params['vhost']
|
||||
self.destination = self.module.params['destination']
|
||||
self.destination_type = 'q' if self.module.params['destination_type'] == 'queue' else 'e'
|
||||
self.routing_key = self.module.params['routing_key']
|
||||
self.arguments = self.module.params['arguments']
|
||||
self.verify = self.module.params['cacert']
|
||||
self.cert = self.module.params['cert']
|
||||
self.key = self.module.params['key']
|
||||
self.base_url = '{0}://{1}:{2}/api/bindings'.format(self.login_protocol,
|
||||
self.login_host,
|
||||
self.login_port)
|
||||
self.url = '{0}/{1}/e/{2}/{3}/{4}/{5}'.format(self.base_url,
|
||||
urllib_parse.quote(self.vhost, safe=''),
|
||||
urllib_parse.quote(self.name, safe=''),
|
||||
self.destination_type,
|
||||
urllib_parse.quote(self.destination, safe=''),
|
||||
urllib_parse.quote(self.routing_key))
|
||||
self.result = {
|
||||
'changed': False,
|
||||
'name': self.module.params['name'],
|
||||
}
|
||||
self.authentication = (
|
||||
self.login_user,
|
||||
self.login_password
|
||||
)
|
||||
self.request = requests
|
||||
self.http_check_states = {
|
||||
200: True,
|
||||
404: False,
|
||||
}
|
||||
self.http_actionable_states = {
|
||||
201: True,
|
||||
204: True,
|
||||
}
|
||||
self.api_result = self.request.get(self.url, auth=self.authentication)
|
||||
|
||||
def run(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
self.check_presence()
|
||||
self.check_mode()
|
||||
self.action_mode()
|
||||
|
||||
def check_presence(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if self.check_should_throw_fail():
|
||||
self.fail()
|
||||
|
||||
def change_required(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if self.module.params['state'] == 'present':
|
||||
if not self.is_present():
|
||||
return True
|
||||
return False
|
||||
|
||||
def is_present(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
return self.http_check_states.get(self.api_result.status_code, False)
|
||||
|
||||
def check_mode(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if self.module.check_mode:
|
||||
result = self.result
|
||||
result['changed'] = self.change_required()
|
||||
result['details'] = self.api_result.json() if self.is_present() else self.api_result.text
|
||||
result['arguments'] = self.module.params['arguments']
|
||||
self.module.exit_json(**result)
|
||||
|
||||
def check_reply_is_correct(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if self.api_result.status_code in self.http_check_states:
|
||||
return True
|
||||
return False
|
||||
|
||||
def check_should_throw_fail(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if not self.is_present():
|
||||
if not self.check_reply_is_correct():
|
||||
return True
|
||||
return False
|
||||
|
||||
def action_mode(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
result = self.result
|
||||
if self.change_required():
|
||||
if self.module.params['state'] == 'present':
|
||||
self.create()
|
||||
if self.module.params['state'] == 'absent':
|
||||
self.remove()
|
||||
if self.action_should_throw_fail():
|
||||
self.fail()
|
||||
result['changed'] = True
|
||||
result['destination'] = self.module.params['destination']
|
||||
self.module.exit_json(**result)
|
||||
else:
|
||||
result['changed'] = False
|
||||
self.module.exit_json(**result)
|
||||
|
||||
def action_reply_is_correct(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if self.api_result.status_code in self.http_actionable_states:
|
||||
return True
|
||||
return False
|
||||
|
||||
def action_should_throw_fail(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
if not self.action_reply_is_correct():
|
||||
return True
|
||||
return False
|
||||
|
||||
def create(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
self.url = '{0}/{1}/e/{2}/{3}/{4}'.format(self.base_url,
|
||||
urllib_parse.quote(self.vhost, safe=''),
|
||||
urllib_parse.quote(self.name, safe=''),
|
||||
self.destination_type,
|
||||
urllib_parse.quote(self.destination, safe=''))
|
||||
self.api_result = self.request.post(self.url,
|
||||
auth=self.authentication,
|
||||
verify=self.verify,
|
||||
cert=(self.cert, self.key),
|
||||
headers={"content-type": "application/json"},
|
||||
data=json.dumps({
|
||||
'routing_key': self.routing_key,
|
||||
'arguments': self.arguments
|
||||
}))
|
||||
|
||||
def remove(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
self.api_result = self.request.delete(self.url, auth=self.authentication)
|
||||
|
||||
def fail(self):
|
||||
"""
|
||||
:return:
|
||||
"""
|
||||
self.module.fail_json(
|
||||
msg="Unexpected reply from API",
|
||||
status=self.api_result.status_code,
|
||||
details=self.api_result.text
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec = rabbitmq_argument_spec()
|
||||
argument_spec.update(
|
||||
dict(
|
||||
state=dict(default='present', choices=['present', 'absent'], type='str'),
|
||||
name=dict(required=True, aliases=["src", "source"], type='str'),
|
||||
destination=dict(required=True, aliases=["dst", "dest"], type='str'),
|
||||
destination_type=dict(required=True, aliases=["type", "dest_type"], choices=["queue", "exchange"],
|
||||
type='str'),
|
||||
routing_key=dict(default='#', type='str'),
|
||||
arguments=dict(default=dict(), type='dict')
|
||||
)
|
||||
)
|
||||
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||
|
||||
if not HAS_REQUESTS:
|
||||
module.fail_json(msg="requests library is required for this module. To install, use `pip install requests`")
|
||||
|
||||
RabbitMqBinding(module).run()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue