wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix cloudformation module return parameter documentation

Browse source 
Always return stack outputs, even if only an empty dict
This commit is contained in:
Ryan S. Brown 2016-10-18 10:58:09 -04:00 committed by Matt Clay
parent d01bfa6a72
commit 08b119df33
1 changed files with 34 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
lib/ansible/modules/cloud/amazon/cloudformation.py
View file

@ -170,20 +170,24 @@ log:
returned: always returned: always
type: list type: list
sample: ["updating stack"] sample: ["updating stack"]
stack_resources: stack_resources:
description: AWS stack resources and their status. List of dictionaries, one dict per resource. description: AWS stack resources and their status. List of dictionaries, one dict per resource.
type: list type: list
sample: [ sample: [
{ {
"last_updated_time": "2016-10-11T19:40:14.979000+00:00", "last_updated_time": "2016-10-11T19:40:14.979000+00:00",
"logical_resource_id": "CFTestSg", "logical_resource_id": "CFTestSg",
"physical_resource_id": "cloudformation2-CFTestSg-16UQ4CYQ57O9F", "physical_resource_id": "cloudformation2-CFTestSg-16UQ4CYQ57O9F",
"resource_type": "AWS::EC2::SecurityGroup", "resource_type": "AWS::EC2::SecurityGroup",
"status": "UPDATE_COMPLETE", "status": "UPDATE_COMPLETE",
"status_reason": null "status_reason": null
} }
] ]
stack_outputs:
type: dict
description: A key:value dictionary of all the stack outputs currently defined. If there are no stack outputs, it is an empty dictionary.
returned: always
sample: {"MySg": "AnsibleModuleTestYAML-CFTestSg-C8UVS567B6NS"}
''' '''
import json import json
@ -227,13 +231,13 @@ def boto_version_required(version_tuple):
def get_stack_events(cfn, stack_name): def get_stack_events(cfn, stack_name):
'''This event data was never correct, it worked as a side effect. So the v2.3 format is different.''' '''This event data was never correct, it worked as a side effect. So the v2.3 format is different.'''
ret = { 'events':[], 'log':[] } ret = {'events':[], 'log':[]}
try: try:
events = cfn.describe_stack_events(StackName=stack_name) events = cfn.describe_stack_events(StackName=stack_name)
except (botocore.exceptions.ValidationError,botocore.exceptions.ClientError) as err: except (botocore.exceptions.ValidationError, botocore.exceptions.ClientError) as err:
error_msg = boto_exception(err) error_msg = boto_exception(err)
if 'does not exist'.format(stack_name) in error_msg: if 'does not exist' in error_msg:
# missing stack, don't bail. # missing stack, don't bail.
ret['log'].append('Stack does not exist.') ret['log'].append('Stack does not exist.')
return ret return ret
@ -262,36 +266,35 @@ def stack_operation(cfn, stack_name, operation):
# been deleted successfully. # been deleted successfully.
if 'yes' in existed or operation == 'DELETE': # stacks may delete fast, look in a few ways. if 'yes' in existed or operation == 'DELETE': # stacks may delete fast, look in a few ways.
ret = get_stack_events(cfn, stack_name) ret = get_stack_events(cfn, stack_name)
ret.update({ 'changed': True, 'output': 'Stack Deleted'}) ret.update({'changed': True, 'output': 'Stack Deleted'})
return ret return ret
else: else:
return {'changed': True, 'failed': True, 'output': 'Stack Not Found', 'exception': traceback.format_exc()} return {'changed': True, 'failed': True, 'output': 'Stack Not Found', 'exception': traceback.format_exc()}
ret = get_stack_events(cfn, stack_name) ret = get_stack_events(cfn, stack_name)
if not stack: if not stack:
if 'yes' in existed or operation=='DELETE': # stacks may delete fast, look in a few ways. if 'yes' in existed or operation == 'DELETE': # stacks may delete fast, look in a few ways.
ret = get_stack_events(cfn, stack_name) ret = get_stack_events(cfn, stack_name)
ret.update({ 'changed': True, 'output': 'Stack Deleted'}) ret.update({'changed': True, 'output': 'Stack Deleted'})
return ret return ret
else: else:
ret.update({'changed':False, 'failed':True, 'output' : 'Stack not found.'}) ret.update({'changed': False, 'failed': True, 'output' : 'Stack not found.'})
return ret return ret
elif stack['StackStatus'].endswith('_ROLLBACK_COMPLETE'): elif stack['StackStatus'].endswith('_ROLLBACK_COMPLETE'):
ret.update({'changed':True, 'failed':True, 'output' : 'Problem with %s. Rollback complete' % operation}) ret.update({'changed': True, 'failed' :True, 'output': 'Problem with %s. Rollback complete' % operation})
return ret return ret
# note the ordering of ROLLBACK_COMPLETE and COMPLETE, because otherwise COMPLETE will match both cases. # note the ordering of ROLLBACK_COMPLETE and COMPLETE, because otherwise COMPLETE will match both cases.
elif stack['StackStatus'].endswith('_COMPLETE'): elif stack['StackStatus'].endswith('_COMPLETE'):
ret.update({'changed':True, 'output' : 'Stack %s complete' % operation }) ret.update({'changed': True, 'output' : 'Stack %s complete' % operation })
return ret return ret
elif stack['StackStatus'].endswith('_ROLLBACK_FAILED'): elif stack['StackStatus'].endswith('_ROLLBACK_FAILED'):
ret.update({'changed':True, 'failed':True, 'output' : 'Stack %s rollback failed' % operation}) ret.update({'changed': True, 'failed': True, 'output': 'Stack %s rollback failed' % operation})
return ret return ret
# note the ordering of ROLLBACK_FAILED and FAILED, because otherwise FAILED will match both cases. # note the ordering of ROLLBACK_FAILED and FAILED, because otherwise FAILED will match both cases.
elif stack['StackStatus'].endswith('_FAILED'): elif stack['StackStatus'].endswith('_FAILED'):
ret.update({'changed':True, 'failed':True, 'output': 'Stack %s failed' % operation}) ret.update({'changed': True, 'failed': True, 'output': 'Stack %s failed' % operation})
return ret return ret
else: else:
# this can loop forever :/ # this can loop forever :/
#return dict(changed=True, failed=True, output = str(stack), operation=operation)
time.sleep(5) time.sleep(5)
return {'failed': True, 'output':'Failed for unknown reasons.'} return {'failed': True, 'output':'Failed for unknown reasons.'}
@ -356,7 +359,7 @@ def main():
mutually_exclusive=[['template_url', 'template']], mutually_exclusive=[['template_url', 'template']],
) )
if not HAS_BOTO3: if not HAS_BOTO3:
module.fail_json(msg='boto3 required for this module') module.fail_json(msg='boto3 and botocore are required for this module')
# collect the parameters that are passed to boto3. Keeps us from having so many scalars floating around. # collect the parameters that are passed to boto3. Keeps us from having so many scalars floating around.
stack_params = { stack_params = {
@ -443,6 +446,9 @@ def main():
if state == 'present' or update: if state == 'present' or update:
stack = get_stack_facts(cfn, stack_params['StackName']) stack = get_stack_facts(cfn, stack_params['StackName'])
if result.get('stack_outputs') is None:
# always define stack_outputs, but it may be empty
result['stack_outputs'] = {}
for output in stack.get('Outputs', []): for output in stack.get('Outputs', []):
result['stack_outputs'][output['OutputKey']] = output['OutputValue'] result['stack_outputs'][output['OutputKey']] = output['OutputValue']
stack_resources = [] stack_resources = []
@ -467,7 +473,7 @@ def main():
try: try:
stack = get_stack_facts(cfn, stack_params['StackName']) stack = get_stack_facts(cfn, stack_params['StackName'])
if not stack: if not stack:
result = dict(changed=False, output='Stack not found.') result = {'changed': False, 'output': 'Stack not found.'}
else: else:
cfn.delete_stack(StackName=stack_params['StackName']) cfn.delete_stack(StackName=stack_params['StackName'])
result = stack_operation(cfn, stack_params['StackName'], 'DELETE') result = stack_operation(cfn, stack_params['StackName'], 'DELETE')