Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NAT Gateway use module_utils helper for tag management #524

Merged
merged 5 commits into from
Oct 5, 2021
Merged

NAT Gateway use module_utils helper for tag management #524

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a093a3
Use module_util helper for tag management
alinabuzachis Oct 4, 2021
dfa098b
Add changelog fragment
alinabuzachis Oct 4, 2021
4f05afc
Use TagSpecifications
alinabuzachis Oct 4, 2021
ae9e152
Linting
tremble Oct 5, 2021
1e87146
Whitespace linting
tremble Oct 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/524-ec2_vpc_nat_gateway-tagging.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- ec2_vpc_nat_gateway - use module_util helper for tagging (https://github.com/ansible-collections/amazon.aws/pull/524).
155 changes: 57 additions & 98 deletions plugins/modules/ec2_vpc_nat_gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,15 +243,14 @@
except ImportError:
pass # Handled by AnsibleAWSModule

from ansible_collections.amazon.aws.plugins.module_utils.ec2 import AWSRetry
from ansible_collections.amazon.aws.plugins.module_utils.core import AnsibleAWSModule
from ansible_collections.amazon.aws.plugins.module_utils.core import is_boto3_error_code
from ansible_collections.amazon.aws.plugins.module_utils.waiters import get_waiter
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import camel_dict_to_snake_dict
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ansible_dict_to_boto3_filter_list
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import ansible_dict_to_boto3_tag_list
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import boto3_tag_list_to_ansible_dict
from ansible_collections.amazon.aws.plugins.module_utils.ec2 import compare_aws_tags
from ..module_utils.ec2 import AWSRetry
from ..module_utils.core import AnsibleAWSModule
from ..module_utils.core import is_boto3_error_code
from ..module_utils.waiters import get_waiter
from ..module_utils.ec2 import camel_dict_to_snake_dict
from ..module_utils.ec2 import boto3_tag_list_to_ansible_dict
from ..module_utils.ec2 import ensure_ec2_tags
from ..module_utils.ec2 import add_ec2_tags


@AWSRetry.jittered_backoff(retries=10)
Expand Down Expand Up @@ -296,8 +295,6 @@ def get_nat_gateways(client, module, subnet_id=None, nat_gateway_id=None, states
>>> subnet_id = 'subnet-12345678'
>>> get_nat_gateways(client, module, subnet_id)
[
true,
"",
{
"create_time": "2016-03-05T00:33:21.209000+00:00",
"delete_time": "2016-03-05T00:36:37.329000+00:00",
Expand All @@ -315,9 +312,10 @@ def get_nat_gateways(client, module, subnet_id=None, nat_gateway_id=None, states
"tags": {},
"vpc_id": "vpc-12345678"
}
]

Returns:
Tuple (bool, str, list)
list
"""

params = dict()
Expand Down Expand Up @@ -425,7 +423,9 @@ def get_eip_allocation_id_by_address(client, module, eip_address):
>>> module = AnsibleAWSModule(...)
>>> eip_address = '52.87.29.36'
>>> get_eip_allocation_id_by_address(client, module, eip_address)
'eipalloc-36014da3'
(
'eipalloc-36014da3', ''
)

Returns:
Tuple (str, str)
Expand Down Expand Up @@ -477,10 +477,12 @@ def allocate_eip_address(client, module):
>>> client = boto3.client('ec2')
>>> module = AnsibleAWSModule(...)
>>> allocate_eip_address(client, module)
True
(
True, '', ''
)

Returns:
Tuple (bool, str)
Tuple (bool, str, str)
"""

new_eip = None
Expand Down Expand Up @@ -516,10 +518,12 @@ def release_address(client, module, allocation_id):
>>> module = AnsibleAWSModule(...)
>>> allocation_id = "eipalloc-123456"
>>> release_address(client, module, allocation_id)
True
(
True, ''
)

Returns:
Boolean, string
Tuple (bool, str)
"""

msg = ''
Expand Down Expand Up @@ -548,7 +552,7 @@ def release_address(client, module, allocation_id):
return ip_released, msg


def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_token=None,
def create(client, module, subnet_id, allocation_id, tags, client_token=None,
wait=False):
"""Create an Amazon NAT Gateway.
Args:
Expand All @@ -558,7 +562,7 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
allocation_id (str): The eip Amazon identifier
tags (dict): Tags to associate to the NAT gateway
purge_tags (bool): If true, remove tags not listed in I(tags)
type: bool
type: bool

Kwargs:
wait (bool): Wait for the nat to be in the deleted state before returning.
Expand All @@ -574,7 +578,6 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
>>> create(client, module, subnet_id, allocation_id, wait=True)
[
true,
"",
{
"create_time": "2016-03-05T00:33:21.209000+00:00",
"delete_time": "2016-03-05T00:36:37.329000+00:00",
Expand All @@ -591,7 +594,8 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
"subnet_id": "subnet-1234567",
"tags": {},
"vpc_id": "vpc-1234567"
}
},
""
]

Returns:
Expand All @@ -617,7 +621,9 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
return changed, result, msg

try:
result = camel_dict_to_snake_dict(client.create_nat_gateway(aws_retry=True, **params)["NatGateway"])
result = camel_dict_to_snake_dict(
client.create_nat_gateway(aws_retry=True, **params)["NatGateway"]
)
changed = True

create_time = result['create_time'].replace(tzinfo=None)
Expand All @@ -633,10 +639,8 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
_describe_nat_gateways(client, NatGatewayIds=[result['nat_gateway_id']])[0]
)

result['tags'], _tags_update_exists = ensure_tags(
client, module, nat_gw_id=result['nat_gateway_id'], tags=tags,
purge_tags=purge_tags
)
changed |= add_ec2_tags(client, module, result['nat_gateway_id'], tags)
tremble marked this conversation as resolved.
Show resolved Hide resolved

except is_boto3_error_code('IdempotentParameterMismatch') as e:
msg = (
'NAT Gateway does not support update and token has already been provided:' + e
Expand All @@ -646,6 +650,10 @@ def create(client, module, subnet_id, allocation_id, tags, purge_tags, client_to
except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e: # pylint: disable=duplicate-except
module.fail_json_aws(e)

result = get_nat_gateways(client, module, subnet_id=subnet_id,
nat_gateway_id=result['nat_gateway_id'])[0]
result['tags'] = boto3_tag_list_to_ansible_dict(result['tags'])

return changed, result, msg


Expand Down Expand Up @@ -701,24 +709,29 @@ def pre_create(client, module, subnet_id, tags, purge_tags, allocation_id=None,
]

Returns:
Tuple (bool, bool, str, list)
Tuple (bool, str, list)
"""

changed = False
msg = ''
results = {}

if not allocation_id and not eip_address:
existing_gateways, allocation_id_exists = (gateway_in_subnet_exists(client, module, subnet_id))
existing_gateways, allocation_id_exists = (
gateway_in_subnet_exists(client, module, subnet_id)
)

if len(existing_gateways) > 0 and if_exist_do_not_create:
results = existing_gateways[0]
results['tags'], tags_update_exists = ensure_tags(
client, module, results['nat_gateway_id'], tags, purge_tags
)
changed |= ensure_ec2_tags(client, module, results['nat_gateway_id'],
resource_type='natgateway', tags=tags,
purge_tags=purge_tags)

results = get_nat_gateways(client, module, subnet_id=subnet_id,
nat_gateway_id=results['nat_gateway_id'])[0]
results['tags'] = boto3_tag_list_to_ansible_dict(results['tags'])

if tags_update_exists:
changed = True
if changed:
return changed, msg, results

changed = False
Expand All @@ -733,6 +746,7 @@ def pre_create(client, module, subnet_id, tags, purge_tags, allocation_id=None,
changed, msg, allocation_id = (
allocate_eip_address(client, module)
)

if not changed:
return changed, msg, dict()

Expand All @@ -755,12 +769,15 @@ def pre_create(client, module, subnet_id, tags, purge_tags, allocation_id=None,

if len(existing_gateways) > 0 and (allocation_id_exists or if_exist_do_not_create):
results = existing_gateways[0]
results['tags'], tags_update_exists = ensure_tags(
client, module, results['nat_gateway_id'], tags, purge_tags
)
changed |= ensure_ec2_tags(client, module, results['nat_gateway_id'],
resource_type='natgateway', tags=tags,
purge_tags=purge_tags)

results = get_nat_gateways(client, module, subnet_id=subnet_id,
nat_gateway_id=results['nat_gateway_id'])[0]
results['tags'] = boto3_tag_list_to_ansible_dict(results['tags'])

if tags_update_exists:
changed = True
if changed:
return changed, msg, results

changed = False
Expand All @@ -773,7 +790,7 @@ def pre_create(client, module, subnet_id, tags, purge_tags, allocation_id=None,
return changed, msg, results

changed, results, msg = create(
client, module, subnet_id, allocation_id, tags, purge_tags, client_token, wait
client, module, subnet_id, allocation_id, tags, client_token, wait
)

return changed, msg, results
Expand Down Expand Up @@ -870,69 +887,11 @@ def remove(client, module, nat_gateway_id, wait=False, release_eip=False):
module.fail_json(
msg="Failed to release EIP {0}: {1}".format(allocation_id, msg)
)
results['tags'] = boto3_tag_list_to_ansible_dict(results['tags'])

return changed, msg, results


def ensure_tags(client, module, nat_gw_id, tags, purge_tags):
final_tags = []
changed = False

if module.check_mode and nat_gw_id is None:
# We can't describe tags without an EIP id, we might get here when creating a new EIP in check_mode
return final_tags, changed

filters = ansible_dict_to_boto3_filter_list({'resource-id': nat_gw_id, 'resource-type': 'natgateway'})
cur_tags = None
try:
cur_tags = client.describe_tags(aws_retry=True, Filters=filters)
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, 'Couldnt describe tags')
if tags is None:
return boto3_tag_list_to_ansible_dict(cur_tags['Tags']), changed

to_update, to_delete = compare_aws_tags(boto3_tag_list_to_ansible_dict(cur_tags.get('Tags')), tags, purge_tags)
final_tags = boto3_tag_list_to_ansible_dict(cur_tags.get('Tags'))

if to_update:
try:
if module.check_mode:
final_tags.update(to_update)
else:
client.create_tags(
aws_retry=True,
Resources=[nat_gw_id],
Tags=ansible_dict_to_boto3_tag_list(to_update)
)
changed = True
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, "Couldn't create tags")

if to_delete:
try:
if module.check_mode:
for key in to_delete:
del final_tags[key]
else:
tags_list = []
for key in to_delete:
tags_list.append({'Key': key})

client.delete_tags(aws_retry=True, Resources=[nat_gw_id], Tags=tags_list)
changed = True
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, "Couldn't delete tags")

if not module.check_mode and (to_update or to_delete):
try:
response = client.describe_tags(aws_retry=True, Filters=filters)
final_tags = boto3_tag_list_to_ansible_dict(response.get('Tags'))
except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
module.fail_json_aws(e, "Couldn't describe tags")

return final_tags, changed


def main():
argument_spec = dict(
subnet_id=dict(type='str'),
Expand Down
Loading