mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 03:11:24 -07:00
RabbitMQ publisher module (#44718)
* RabbitMQ basic publisher * Split out of a module_util. Preparing for binary posts. * Can now send a file to the queue. * Allowing an empty queue to be used so RabbitMQ returns a random queue. * Added RETURN docstring. * Updated and added tests. Now returns a dictionary with msg, content_type and queue published to. * Extra tests and introduced a none url method of providing server host details. * Added testing and errors for url/host parameters. * Updating RETURN sample * Added an image file for testing binary publishing. * Minor changes to test. * Added filename key/value to headers if a binary file is published. * Adding ability to specify headers. * Renaming to rabbitmq_publish * Changed tests to reflect name, and, preparing for testing headers. * Updated some documentation * Minor pip install update * Modifications after feedback. * Updates based on feedback. * Fixing pep8 issue. * Updating module and module_util name to amqp. * Reverting back to rabbitmq_publish naming. * Minor addition to notes.
This commit is contained in:
John Imison
Will Thames
parent
136a2cca2f
commit
54c54fc960
7 changed files with 533 additions and 0 deletions
|
|
@ -1,9 +1,27 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2016, Jorge Rodriguez <jorge.rodriguez@tiriel.eu>
|
||||
# Copyright: (c) 2018, John Imison <john+github@imison.net>
|
||||
#
|
||||
# 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
|
||||
|
||||
from ansible.module_utils._text import to_native, to_text
|
||||
from ansible.module_utils.basic import env_fallback
|
||||
from mimetypes import MimeTypes
|
||||
|
||||
import json
|
||||
import os
|
||||
|
||||
try:
|
||||
import pika
|
||||
from pika import spec
|
||||
HAS_PIKA = True
|
||||
except ImportError:
|
||||
HAS_PIKA = False
|
||||
|
||||
|
||||
def rabbitmq_argument_spec():
|
||||
return dict(
|
||||
|
|
@ -17,3 +35,161 @@ def rabbitmq_argument_spec():
|
|||
key=dict(required=False, type='path', default=None),
|
||||
vhost=dict(default='/', type='str'),
|
||||
)
|
||||
|
||||
|
||||
# notification/rabbitmq_basic_publish.py
|
||||
class RabbitClient():
|
||||
def __init__(self, module):
|
||||
self.module = module
|
||||
self.params = module.params
|
||||
self.check_required_library()
|
||||
self.check_host_params()
|
||||
self.url = self.params['url']
|
||||
self.proto = self.params['proto']
|
||||
self.username = self.params['username']
|
||||
self.password = self.params['password']
|
||||
self.host = self.params['host']
|
||||
self.port = self.params['port']
|
||||
self.vhost = self.params['vhost']
|
||||
self.queue = self.params['queue']
|
||||
self.headers = self.params['headers']
|
||||
|
||||
if self.host is not None:
|
||||
self.build_url()
|
||||
|
||||
self.connect_to_rabbitmq()
|
||||
|
||||
def check_required_library(self):
|
||||
if not HAS_PIKA:
|
||||
self.module.fail_json(msg="Unable to find 'pika' Python library which is required.")
|
||||
|
||||
def check_host_params(self):
|
||||
# Fail if url is specified and other conflicting parameters have been specified
|
||||
if self.params['url'] is not None and any(self.params[k] is not None for k in ['proto', 'host', 'port', 'password', 'username', 'vhost']):
|
||||
self.module.fail_json(msg="url and proto, host, port, vhost, username or password cannot be specified at the same time.")
|
||||
|
||||
# Fail if url not specified and there is a missing parameter to build the url
|
||||
if self.params['url'] is None and any(self.params[k] is None for k in ['proto', 'host', 'port', 'password', 'username', 'vhost']):
|
||||
self.module.fail_json(msg="Connection parameters must be passed via url, or, proto, host, port, vhost, username or password.")
|
||||
|
||||
@staticmethod
|
||||
def rabbitmq_argument_spec():
|
||||
return dict(
|
||||
url=dict(default=None, type='str'),
|
||||
proto=dict(default=None, type='str', choices=['amqps', 'amqp']),
|
||||
host=dict(default=None, type='str'),
|
||||
port=dict(default=None, type='int'),
|
||||
username=dict(default=None, type='str'),
|
||||
password=dict(default=None, type='str', no_log=True),
|
||||
vhost=dict(default=None, type='str'),
|
||||
queue=dict(default=None, type='str')
|
||||
)
|
||||
|
||||
''' Consider some file size limits here '''
|
||||
def _read_file(self, path):
|
||||
try:
|
||||
fh = open(path, "rb").read()
|
||||
except IOError as e:
|
||||
self.module.fail_json(msg="Unable to open file %s: %s" % (path, to_native(e)))
|
||||
|
||||
return fh
|
||||
|
||||
@staticmethod
|
||||
def _check_file_mime_type(path):
|
||||
mime = MimeTypes()
|
||||
return mime.guess_type(path)
|
||||
|
||||
def build_url(self):
|
||||
self.url = '{0}://{1}:{2}@{3}:{4}/{5}'.format(self.proto,
|
||||
self.username,
|
||||
self.password,
|
||||
self.host,
|
||||
self.port,
|
||||
self.vhost)
|
||||
|
||||
def connect_to_rabbitmq(self):
|
||||
"""
|
||||
Function to connect to rabbitmq using username and password
|
||||
"""
|
||||
try:
|
||||
parameters = pika.URLParameters(self.url)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg="URL malformed: %s" % to_native(e))
|
||||
|
||||
try:
|
||||
self.connection = pika.BlockingConnection(parameters)
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg="Connection issue: %s" % to_native(e))
|
||||
|
||||
try:
|
||||
self.conn_channel = self.connection.channel()
|
||||
except pika.exceptions.AMQPChannelError as e:
|
||||
self.close_connection()
|
||||
self.module.fail_json(msg="Channel issue: %s" % to_native(e))
|
||||
|
||||
def close_connection(self):
|
||||
try:
|
||||
self.connection.close()
|
||||
except pika.exceptions.AMQPConnectionError:
|
||||
pass
|
||||
|
||||
def basic_publish(self):
|
||||
self.content_type = self.params.get("content_type")
|
||||
|
||||
if self.params.get("body") is not None:
|
||||
args = dict(
|
||||
body=self.params.get("body"),
|
||||
exchange=self.params.get("exchange"),
|
||||
routing_key=self.params.get("routing_key"),
|
||||
properties=pika.BasicProperties(content_type=self.content_type, delivery_mode=1, headers=self.headers))
|
||||
|
||||
# If src (file) is defined and content_type is left as default, do a mime lookup on the file
|
||||
if self.params.get("src") is not None and self.content_type == 'text/plain':
|
||||
self.content_type = RabbitClient._check_file_mime_type(self.params.get("src"))[0]
|
||||
self.headers.update(
|
||||
filename=os.path.basename(self.params.get("src"))
|
||||
)
|
||||
|
||||
args = dict(
|
||||
body=self._read_file(self.params.get("src")),
|
||||
exchange=self.params.get("exchange"),
|
||||
routing_key=self.params.get("routing_key"),
|
||||
properties=pika.BasicProperties(content_type=self.content_type,
|
||||
delivery_mode=1,
|
||||
headers=self.headers
|
||||
))
|
||||
elif self.params.get("src") is not None:
|
||||
args = dict(
|
||||
body=self._read_file(self.params.get("src")),
|
||||
exchange=self.params.get("exchange"),
|
||||
routing_key=self.params.get("routing_key"),
|
||||
properties=pika.BasicProperties(content_type=self.content_type,
|
||||
delivery_mode=1,
|
||||
headers=self.headers
|
||||
))
|
||||
|
||||
try:
|
||||
# If queue is not defined, RabbitMQ will return the queue name of the automatically generated queue.
|
||||
if self.queue is None:
|
||||
result = self.conn_channel.queue_declare(durable=self.params.get("durable"),
|
||||
exclusive=self.params.get("exclusive"),
|
||||
auto_delete=self.params.get("auto_delete"))
|
||||
self.conn_channel.confirm_delivery()
|
||||
self.queue = result.method.queue
|
||||
else:
|
||||
self.conn_channel.queue_declare(queue=self.queue,
|
||||
durable=self.params.get("durable"),
|
||||
exclusive=self.params.get("exclusive"),
|
||||
auto_delete=self.params.get("auto_delete"))
|
||||
self.conn_channel.confirm_delivery()
|
||||
except Exception as e:
|
||||
self.module.fail_json(msg="Queue declare issue: %s" % to_native(e))
|
||||
|
||||
# https://github.com/ansible/ansible/blob/devel/lib/ansible/module_utils/cloudstack.py#L150
|
||||
if args['routing_key'] is None:
|
||||
args['routing_key'] = self.queue
|
||||
|
||||
if args['exchange'] is None:
|
||||
args['exchange'] = ''
|
||||
|
||||
return self.conn_channel.basic_publish(**args)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue