From 2ddb8807bf4f2c4106bd2944391e5cea76d6acd5 Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Sat, 20 Jun 2015 22:22:30 +1000 Subject: [PATCH 1/6] Add new amazon sqs module. --- cloud/amazon/sqs | 221 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 221 insertions(+) create mode 100644 cloud/amazon/sqs diff --git a/cloud/amazon/sqs b/cloud/amazon/sqs new file mode 100644 index 00000000000..c30a840a22b --- /dev/null +++ b/cloud/amazon/sqs @@ -0,0 +1,221 @@ +#!/usr/bin/python +# 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 . + +DOCUMENTATION = """ +--- +module: sqs +short_description: Creates or deletes AWS SQS queues. +description: + - Create or delete AWS SQS queues. + - Update attributes on existing queues. +author: Alan Loi (@loia) +requirements: + - "boto >= 2.33.0" +options: + state: + description: + - Create or delete the queue + required: true + choices: ['present', 'absent'] + default: 'present' + name: + description: + - Name of the queue. + required: true + default_visibility_timeout: + description: + - The default visibility timeout in seconds. + required: false + message_retention_period: + description: + - The message retention period in seconds. + required: false + maximum_message_size: + description: + - The maximum message size in bytes. + required: false + delivery_delay: + description: + - The delivery delay in seconds. + required: false + receive_message_wait_time: + description: + - The receive message wait time in seconds. + required: false + region: + description: + - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used. + required: false + aliases: ['aws_region', 'ec2_region'] + +extends_documentation_fragment: aws +""" + +EXAMPLES = ''' +# Create SQS queue +- sqs: + name: my-queue + region: ap-southeast-2 + default_visibility_timeout: 120 + message_retention_period: 86400 + maximum_message_size: 1024 + delivery_delay: 30 + receive_message_wait_time: 20 + +# Delete SQS queue +- sqs: + name: my-queue + region: ap-southeast-2 + state: absent +''' + +try: + import boto.sqs + from boto.exception import BotoServerError + HAS_BOTO = True + +except ImportError: + HAS_BOTO = False + + +def create_or_update_sqs_queue(connection, module): + queue_name = module.params.get('name') + + queue_attributes = dict( + default_visibility_timeout=module.params.get('default_visibility_timeout'), + message_retention_period=module.params.get('message_retention_period'), + maximum_message_size=module.params.get('maximum_message_size'), + delivery_delay=module.params.get('delivery_delay'), + receive_message_wait_time=module.params.get('receive_message_wait_time'), + ) + + result = dict( + region=module.params.get('region'), + name=queue_name, + ) + result.update(queue_attributes) + + try: + queue = connection.get_queue(queue_name) + if queue: + # Update existing + result['changed'] = update_sqs_queue(queue, check_mode=module.check_mode, **queue_attributes) + + else: + # Create new + if not module.check_mode: + queue = connection.create_queue(queue_name) + update_sqs_queue(queue, **queue_attributes) + result['changed'] = True + + except BotoServerError: + result['msg'] = 'Failed to create/update sqs queue due to error: ' + traceback.format_exc() + module.fail_json(**result) + else: + module.exit_json(**result) + + +def update_sqs_queue(queue, + check_mode=False, + default_visibility_timeout=None, + message_retention_period=None, + maximum_message_size=None, + delivery_delay=None, + receive_message_wait_time=None): + changed = False + + changed = set_queue_attribute(queue, 'VisibilityTimeout', default_visibility_timeout, + check_mode=check_mode) or changed + changed = set_queue_attribute(queue, 'MessageRetentionPeriod', message_retention_period, + check_mode=check_mode) or changed + changed = set_queue_attribute(queue, 'MaximumMessageSize', maximum_message_size, + check_mode=check_mode) or changed + changed = set_queue_attribute(queue, 'DelaySeconds', delivery_delay, + check_mode=check_mode) or changed + changed = set_queue_attribute(queue, 'ReceiveMessageWaitTimeSeconds', receive_message_wait_time, + check_mode=check_mode) or changed + return changed + + +def set_queue_attribute(queue, attribute, value, check_mode=False): + if not value: + return False + + existing_value = queue.get_attributes(attributes=attribute)[attribute] + if str(value) != existing_value: + if not check_mode: + queue.set_attribute(attribute, value) + return True + + return False + + +def delete_sqs_queue(connection, module): + queue_name = module.params.get('name') + + result = dict( + region=module.params.get('region'), + name=queue_name, + ) + + try: + queue = connection.get_queue(queue_name) + if queue: + if not module.check_mode: + connection.delete_queue(queue) + result['changed'] = True + + else: + result['changed'] = False + + except BotoServerError: + result['msg'] = 'Failed to delete sqs queue due to error: ' + traceback.format_exc() + module.fail_json(**result) + else: + module.exit_json(**result) + + +def main(): + argument_spec = ec2_argument_spec() + argument_spec.update(dict( + state=dict(default='present', choices=['present', 'absent']), + name=dict(required=True, type='str'), + default_visibility_timeout=dict(type='int'), + message_retention_period=dict(type='int'), + maximum_message_size=dict(type='int'), + delivery_delay=dict(type='int'), + receive_message_wait_time=dict(type='int'), + )) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True) + + region, ec2_url, aws_connect_params = get_aws_connection_info(module) + connection = boto.sqs.connect_to_region(region) + + state = module.params.get('state') + if state == 'present': + create_or_update_sqs_queue(connection, module) + elif state == 'absent': + delete_sqs_queue(connection, module) + + +# import module snippets +from ansible.module_utils.basic import * +from ansible.module_utils.ec2 import * + +main() From 3f74ec35e667b004bb21751b8cb731fd0c7677c6 Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Sun, 21 Jun 2015 08:39:13 +1000 Subject: [PATCH 2/6] Add .py file extension to sqs module. --- cloud/amazon/{sqs => sqs.py} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename cloud/amazon/{sqs => sqs.py} (100%) diff --git a/cloud/amazon/sqs b/cloud/amazon/sqs.py similarity index 100% rename from cloud/amazon/sqs rename to cloud/amazon/sqs.py From 4bf188258d9fa2f0217afdda5982d17987836a7e Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Mon, 22 Jun 2015 19:56:09 +1000 Subject: [PATCH 3/6] Rename module to sqs_queue.py to differentiate from other potential modules e.g. reading/writing messages. --- cloud/amazon/{sqs.py => sqs_queue.py} | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename cloud/amazon/{sqs.py => sqs_queue.py} (99%) diff --git a/cloud/amazon/sqs.py b/cloud/amazon/sqs_queue.py similarity index 99% rename from cloud/amazon/sqs.py rename to cloud/amazon/sqs_queue.py index c30a840a22b..6ad8d2d1999 100644 --- a/cloud/amazon/sqs.py +++ b/cloud/amazon/sqs_queue.py @@ -16,7 +16,7 @@ DOCUMENTATION = """ --- -module: sqs +module: sqs_queue short_description: Creates or deletes AWS SQS queues. description: - Create or delete AWS SQS queues. @@ -66,7 +66,7 @@ extends_documentation_fragment: aws EXAMPLES = ''' # Create SQS queue -- sqs: +- sqs_queue: name: my-queue region: ap-southeast-2 default_visibility_timeout: 120 @@ -76,7 +76,7 @@ EXAMPLES = ''' receive_message_wait_time: 20 # Delete SQS queue -- sqs: +- sqs_queue: name: my-queue region: ap-southeast-2 state: absent From e66f4b998544adc0ec76e06a0334d67cb1f5ed90 Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Wed, 24 Jun 2015 07:42:36 +1000 Subject: [PATCH 4/6] Updated documentation for sqs_queue - state option is not required. --- cloud/amazon/sqs_queue.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cloud/amazon/sqs_queue.py b/cloud/amazon/sqs_queue.py index 6ad8d2d1999..6bc41544cf9 100644 --- a/cloud/amazon/sqs_queue.py +++ b/cloud/amazon/sqs_queue.py @@ -28,7 +28,7 @@ options: state: description: - Create or delete the queue - required: true + required: false choices: ['present', 'absent'] default: 'present' name: From c8b6e1efa5e03e2774ef5cadc6a267744abde017 Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Wed, 24 Jun 2015 07:45:23 +1000 Subject: [PATCH 5/6] Fix sqs_queue module to check that boto library is installed and AWS region & credentials are provided. --- cloud/amazon/sqs_queue.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/cloud/amazon/sqs_queue.py b/cloud/amazon/sqs_queue.py index 6bc41544cf9..a40433441aa 100644 --- a/cloud/amazon/sqs_queue.py +++ b/cloud/amazon/sqs_queue.py @@ -84,7 +84,7 @@ EXAMPLES = ''' try: import boto.sqs - from boto.exception import BotoServerError + from boto.exception import BotoServerError, NoAuthHandlerFound HAS_BOTO = True except ImportError: @@ -204,8 +204,18 @@ def main(): argument_spec=argument_spec, supports_check_mode=True) + if not HAS_BOTO: + module.fail_json(msg='boto required for this module') + region, ec2_url, aws_connect_params = get_aws_connection_info(module) - connection = boto.sqs.connect_to_region(region) + if not region: + module.fail_json(msg='region must be specified') + + try: + connection = connect_to_aws(boto.sqs, region, **aws_connect_params) + + except (NoAuthHandlerFound, StandardError), e: + module.fail_json(msg=str(e)) state = module.params.get('state') if state == 'present': From 8ded4ae862c94ebe8d82973aed932b37784a0f64 Mon Sep 17 00:00:00 2001 From: Alan Loi Date: Thu, 2 Jul 2015 20:50:02 +1000 Subject: [PATCH 6/6] Docfixes - add version_added and missing default values. --- cloud/amazon/sqs_queue.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cloud/amazon/sqs_queue.py b/cloud/amazon/sqs_queue.py index a40433441aa..3febc8981f2 100644 --- a/cloud/amazon/sqs_queue.py +++ b/cloud/amazon/sqs_queue.py @@ -21,6 +21,7 @@ short_description: Creates or deletes AWS SQS queues. description: - Create or delete AWS SQS queues. - Update attributes on existing queues. +version_added: "2.0" author: Alan Loi (@loia) requirements: - "boto >= 2.33.0" @@ -39,22 +40,27 @@ options: description: - The default visibility timeout in seconds. required: false + default: null message_retention_period: description: - The message retention period in seconds. required: false + default: null maximum_message_size: description: - The maximum message size in bytes. required: false + default: null delivery_delay: description: - The delivery delay in seconds. required: false + default: null receive_message_wait_time: description: - The receive message wait time in seconds. required: false + default: null region: description: - The AWS region to use. If not specified then the value of the EC2_REGION environment variable, if any, is used.