ec2_vpc_net refactor

lib/ansible/modules/cloud/amazon/ec2_vpc_net.py

@@ -17,10 +17,11 @@
 DOCUMENTATION = '''
 ---
 module: ec2_vpc_net
-short_description: configure AWS virtual private clouds
+short_description: Configure AWS virtual private clouds
 description:
-    - Create or terminates AWS virtual private clouds.  This module has a dependency on python-boto.
+    - Create or terminate AWS virtual private clouds.  This module has a dependency on python-boto.
 version_added: "2.0"
+author: Jonathan Davila (@defionscode)
 options:
   name:
     description:
@@ -30,23 +31,25 @@ options:
     description:
       - The CIDR of the VPC
     required: yes
-    aliases: []
   tenancy:
     description:
       - Whether to be default or dedicated tenancy. This cannot be changed after the VPC has been created.
     required: false
     default: default
+    choices: [ 'default', 'dedicated' ]
   dns_support:
     description:
       - Whether to enable AWS DNS support.
     required: false
-    default: true
+    default: yes
+    choices: [ 'yes', 'no' ]
   dns_hostnames:
     description:
       - Whether to enable AWS hostname support.
     required: false
-    default: true
+    default: yes
-  dhcp_id:
+    choices: [ 'yes', 'no' ]
+  dhcp_opts_id:
     description:
       - the id of the DHCP options to use for this vpc
     default: null
@@ -61,30 +64,32 @@ options:
       - The state of the VPC. Either absent or present.
     default: present
     required: false
+    choices: [ 'present', 'absent' ]
   multi_ok:
     description:
       - By default the module will not create another VPC if there is another VPC with the same name and CIDR block. Specify this as true if you want duplicate VPCs created.
     default: false
     required: false
-author: Jonathan Davila
+
 extends_documentation_fragment: aws
 '''
 
 EXAMPLES = '''
+# Note: These examples do not set authentication details, see the AWS Guide for details.
+
 # Create a VPC with dedicate tenancy and a couple of tags
 
-- ec2_vpc:
+- ec2_vpc_net:
     name: Module_dev2
-    cidr_block: 170.10.0.0/16
+    cidr_block: 10.10.0.0/16
     region: us-east-1
     tags:
-      new_vpc: ec2_vpc_module
+      module: ec2_vpc_net
-      this: works22
+      this: works
     tenancy: dedicated
 
 '''
 
-
 import time
 import sys
 
@@ -92,8 +97,7 @@ try:
     import boto
     import boto.ec2
     import boto.vpc
-    from boto.exception import EC2ResponseError
+    from boto.exception import BotoServerError
-
     HAS_BOTO=True
 except ImportError:
     HAS_BOTO=False
@@ -110,11 +114,10 @@ def boto_exception(err):
     return error
 
 def vpc_exists(module, vpc, name, cidr_block, multi):
-    """Returns True or False in regards to the existance of a VPC. When supplied
+    """Returns True or False in regards to the existence of a VPC. When supplied
     with a CIDR, it will check for matching tags to determine if it is a match
     otherwise it will assume the VPC does not exist and thus return false.
     """
-    exists=False
     matched_vpc = None
 
     try:
@@ -123,100 +126,56 @@ def vpc_exists(module, vpc, name, cidr_block, multi):
         e_msg=boto_exception(e)
         module.fail_json(msg=e_msg)
 
-    if len(matching_vpcs) == 1 and not multi:
+    if len(matching_vpcs) == 1:
-        exists=True
+        matched_vpc = matching_vpcs[0]
-        matched_vpc=str(matching_vpcs).split(':')[1].split(']')[0]
+    elif len(matching_vpcs) > 1:
-    elif len(matching_vpcs) > 1 and not multi:
+        if multi:
             module.fail_json(msg='Currently there are %d VPCs that have the same name and '
                              'CIDR block you specified. If you would like to create '
-                             'the VPC anyways please pass True to the multi_ok param.' % len(matching_vpcs))
+                             'the VPC anyway please pass True to the multi_ok param.' % len(matching_vpcs))
     
-    return exists, matched_vpc
+    return matched_vpc
 
-def vpc_needs_update(module, vpc, vpc_id, dns_support, dns_hostnames, dhcp_id, tags):
-    """This returns True or False. Intended to run after vpc_exists.
-    It will check all the characteristics of the parameters passed and compare them
-    to the active VPC. If any discrepancy is found, it will report true, meaning that
-    the VPC needs to be update in order to match the specified state in the params.
-    """
 
-    update_dhcp=False
+def update_vpc_tags(vpc, module, vpc_obj, tags, name):
-    update_tags=False
-    dhcp_match=False
     
-    try:
+    if tags is None:
-        dhcp_list=vpc.get_all_dhcp_options()
+        tags = dict()
         
-        if dhcp_id is not None:
-            has_default=vpc.get_all_vpcs(filters={'dhcp-options-id' : 'default', 'vpc-id' : vpc_id})
-            for opts in dhcp_list:
-                if (str(opts).split(':')[1] == dhcp_id) or has_default:
-                    dhcp_match=True
-                    break
-                else:
-                    pass
-    except Exception, e:
-        e_msg=boto_exception(e)
-        module.fail_json(msg=e_msg)
-
-        if not dhcp_match or (has_default and dhcp_id != 'default'):
-            update_dhcp=True
-
-    if dns_hostnames and dns_support == False:
-        module.fail_json('In order to enable DNS Hostnames you must have DNS support enabled')
-    else:
-
-    # Note: Boto currently doesn't currently provide an interface to ec2-describe-vpc-attribute
-    # which is needed in order to detect the current status of DNS options. For now we just update
-    # the attribute each time and is not used as a changed-factor.
-        try:
-            vpc.modify_vpc_attribute(vpc_id, enable_dns_support=dns_support)
-            vpc.modify_vpc_attribute(vpc_id, enable_dns_hostnames=dns_hostnames)
-        except Exception, e:
-            e_msg=boto_exception(e)
-            module.fail_json(msg=e_msg)
-
-    if tags:
-        try:
-            current_tags = dict((t.name, t.value) for t in vpc.get_all_tags(filters={'resource-id': vpc_id}))
-            if not set(tags.items()).issubset(set(current_tags.items())):
-                update_tags=True
-        except Exception, e:
-            e_msg=boto_exception(e)
-            module.fail_json(msg=e_msg)
-
-    return update_dhcp, update_tags
-
-
-def update_vpc_tags(module, vpc, vpc_id, tags, name):
     tags.update({'Name': name})
     try:
-        vpc.create_tags(vpc_id, tags)
+        current_tags = dict((t.name, t.value) for t in vpc.get_all_tags(filters={'resource-id': vpc_obj.id}))
-        updated_tags=dict((t.name, t.value) for t in vpc.get_all_tags(filters={'resource-id': vpc_id}))
+        if sorted(current_tags) != sorted(tags):
+            vpc.create_tags(vpc_obj.id, tags)
+            return True
+        else:
+            return False
     except Exception, e:
         e_msg=boto_exception(e)
         module.fail_json(msg=e_msg)
         
-    return updated_tags
-
 
-def update_dhcp_opts(module, vpc, vpc_id, dhcp_id):
+def update_dhcp_opts(connection, module, vpc_obj, dhcp_id):
-    try:
-        vpc.associate_dhcp_options(dhcp_id, vpc_id)
-        dhcp_list=vpc.get_all_dhcp_options()
-    except Exception, e:
-        e_msg=boto_exception(e)
-        module.fail_json(msg=e_msg)
     
-    for opts in dhcp_list:
+    if vpc_obj.dhcp_options_id != dhcp_id:
-        vpc_dhcp=vpc.get_all_vpcs(filters={'dhcp-options-id' : opts, 'vpc-id' : vpc_id})
+        connection.associate_dhcp_options(dhcp_id, vpc_obj.id)
-        matched=False
+        return True
-        if opts == dhcp_id:
+    else:
-            matched=True
+        return False
-            return opts
+
-
+def get_vpc_values(vpc_obj):
-    if matched == False:
+
-        return dhcp_id
+    if vpc_obj is not None:
+        vpc_values = vpc_obj.__dict__
+        if "region" in vpc_values:
+            vpc_values.pop("region")
+        if "item" in vpc_values:
+            vpc_values.pop("item")
+        if "connection" in vpc_values:
+            vpc_values.pop("connection")
+        return vpc_values
+    else:
+        return None
 
 def main():
     argument_spec=ec2_argument_spec()
@@ -229,7 +188,6 @@ def main():
             dhcp_opts_id = dict(type='str', default=None, required=False),
             tags = dict(type='dict', required=False, default=None),
             state = dict(choices=['present', 'absent'], default='present'),
-            region=dict(type='str', required=True),
             multi_ok = dict(type='bool', default=False)
         )
     )
@@ -239,7 +197,7 @@ def main():
     )
 
     if not HAS_BOTO:
-        module.fail_json(msg='Boto is required for this module')
+        module.fail_json(msg='boto is required for this module')
 
     name=module.params.get('name')
     cidr_block=module.params.get('cidr_block')
@@ -252,91 +210,83 @@ def main():
     multi=module.params.get('multi_ok')
     
     changed=False
-    new_dhcp_opts=None
-    new_tags=None
-    update_dhcp=False
-    update_tags=False
 
-    region, ec2_url, aws_connect_kwargs=get_aws_connection_info(module)
+    region, ec2_url, aws_connect_params = get_aws_connection_info(module)
     
+    if region:
         try:
-        vpc=boto.vpc.connect_to_region(
+            connection = connect_to_aws(boto.vpc, region, **aws_connect_params)
-            region,
+        except (boto.exception.NoAuthHandlerFound, StandardError), e:
-            **aws_connect_kwargs
-        )
-    except boto.exception.NoAuthHandlerFound, e:
             module.fail_json(msg=str(e))
+    else:
+        module.fail_json(msg="region must be specified")
+        
+    if dns_hostnames and not dns_support:
+        module.fail_json('In order to enable DNS Hostnames you must also enable DNS support')
+
+    if state == 'present':
+        
+        # Check if VPC exists
+        vpc_obj = vpc_exists(module, connection, name, cidr_block, multi)
         
-    already_exists, vpc_id=vpc_exists(module, vpc, name, cidr_block, multi)
+        if vpc_obj is None:
+            try:
+                vpc_obj = connection.create_vpc(cidr_block, instance_tenancy=tenancy)
+                changed = True
+            except BotoServerError, e:
+                module.fail_json(msg=e)
         
-    if already_exists:
+        if dhcp_id is not None:        
-        update_dhcp, update_tags=vpc_needs_update(module, vpc, vpc_id, dns_support, dns_hostnames, dhcp_id, tags)
+            try:
-        if update_dhcp or update_tags:
+                if update_dhcp_opts(connection, module, vpc_obj, dhcp_id):
                     changed = True
+            except BotoServerError, e:
+                module.fail_json(msg=e)
         
+        if tags is not None or name is not None:            
             try:
-            e_tags=dict((t.name, t.value) for t in vpc.get_all_tags(filters={'resource-id': vpc_id}))
+                if update_vpc_tags(connection, module, vpc_obj, tags, name):
-            dhcp_list=vpc.get_all_dhcp_options()
+                    changed = True
-            has_default=vpc.get_all_vpcs(filters={'dhcp-options-id' : 'default', 'vpc-id' : vpc_id})
+            except BotoServerError, e:
-        except Exception, e:
+                module.fail_json(msg=e)
-            e_msg=boto_exception(e)
-            module.fail_json(msg=e_msg)
                 
-        dhcp_opts=None
 
+        # Note: Boto currently doesn't currently provide an interface to ec2-describe-vpc-attribute
+        # which is needed in order to detect the current status of DNS options. For now we just update
+        # the attribute each time and is not used as a changed-factor.
         try:
-            for opts in dhcp_list:
+            connection.modify_vpc_attribute(vpc_obj.id, enable_dns_support=dns_support)
-                if vpc.get_all_vpcs(filters={'dhcp-options-id' : opts, 'vpc-id' : vpc_id}):
+            connection.modify_vpc_attribute(vpc_obj.id, enable_dns_hostnames=dns_hostnames)
-                    dhcp_opts=opts
+        except BotoServerError, e:
-                    break
-                else:
-                    pass
-        except Exception, e:
             e_msg=boto_exception(e)
             module.fail_json(msg=e_msg)
             
-        if not dhcp_opts and has_default:
+        # get the vpc obj again in case it has changed
-            dhcp_opts='default'
-
-    if state == 'present':
-
-        if not changed and already_exists:
-            module.exit_json(changed=changed, vpc_id=vpc_id)
-        elif changed:
-            if update_dhcp:
-                dhcp_opts=update_dhcp_opts(module, vpc, vpc_id, dhcp_id)
-            if update_tags:
-                e_tags=update_vpc_tags(module, vpc, vpc_id, tags, name)
-
-            module.exit_json(changed=changed, name=name, dhcp_options_id=dhcp_opts, tags=e_tags)
-
-        if not already_exists:
         try:
-                vpc_id=str(vpc.create_vpc(cidr_block, instance_tenancy=tenancy)).split(':')[1]
+            vpc_obj = connection.get_all_vpcs(vpc_obj.id)[0]
-                vpc.create_tags(vpc_id, dict(Name=name))
+        except BotoServerError, e:
-            except Exception, e:
             e_msg=boto_exception(e)
             module.fail_json(msg=e_msg)
         
-            update_dhcp, update_tags=vpc_needs_update(module, vpc, vpc_id, dns_support, dns_hostnames, dhcp_id, tags)
+        module.exit_json(changed=changed, vpc=get_vpc_values(vpc_obj))
 
-            if update_dhcp:
-                new_dhcp_opts=update_dhcp_opts(module, vpc, vpc_id, dhcp_id)
-            if update_tags:
-                new_tags=update_vpc_tags(module, vpc, vpc_id, tags, name)
-                module.exit_json(changed=True, name=name, vpc_id=vpc_id, dhcp_options=new_dhcp_opts, tags=new_tags)
     elif state == 'absent':
-        if already_exists:
+        
-            changed=True
+        # Check if VPC exists
+        vpc_obj = vpc_exists(module, connection, name, cidr_block, multi)
+        
+        if vpc_obj is not None:
             try:
-                vpc.delete_vpc(vpc_id)
+                connection.delete_vpc(vpc_obj.id)
-                module.exit_json(changed=changed, vpc_id=vpc_id)
+                vpc_obj = None
-            except Exception, e:
+                changed = True
+            except BotoServerError, e:
                 e_msg = boto_exception(e)
                 module.fail_json(msg="%s. You may want to use the ec2_vpc_subnet, ec2_vpc_igw, "
-                "and/or ec2_vpc_rt modules to ensure the other components are absent." % e_msg)
+                "and/or ec2_vpc_route_table modules to ensure the other components are absent." % e_msg)
-        else:
+            
-            module.exit_json(msg="VPC is absent")
+        module.exit_json(changed=changed, vpc=get_vpc_values(vpc_obj))
+            
 # import module snippets
 from ansible.module_utils.basic import *
 from ansible.module_utils.ec2 import *