mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 14:20:22 -07:00
Add regex support to gce_tag module, add unit tests and update integration test. (#19087)
The gce_tag module can support updating tags on multiple instances via an instance_pattern field. Full Python regex is supported in the instance_pattern field. 'instance_pattern' and 'instance_name' are mutually exclusive and one must be specified. The integration test for the gce_tag module has been updated to support the instance_pattern parameter. Unit tests have been added to test the list-manipulation functionality. Run the integration test with: TEST_FLAGS='--tags "test_gce_tag"' make gce Run the unit tests with: python test/units/modules/cloud/google/test_gce_tag.py
This commit is contained in:
Tom Melendez
Ryan Brown
parent
a10209cbe9
commit
d09ad82e71
4 changed files with 250 additions and 96 deletions
|
|
@ -22,17 +22,25 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: gce_tag
|
||||
version_added: "2.0"
|
||||
short_description: add or remove tag(s) to/from GCE instance
|
||||
short_description: add or remove tag(s) to/from GCE instances
|
||||
description:
|
||||
- This module can add or remove tags U(https://cloud.google.com/compute/docs/instances/#tags)
|
||||
to/from GCE instance.
|
||||
- This module can add or remove tags U(https://cloud.google.com/compute/docs/label-or-tag-resources#tags)
|
||||
to/from GCE instances. Use 'instance_pattern' to update multiple instances in a specify zone
|
||||
options:
|
||||
instance_name:
|
||||
description:
|
||||
- the name of the GCE instance to add/remove tags
|
||||
required: true
|
||||
- The name of the GCE instance to add/remove tags. Required if instance_pattern is not specified.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
instance_pattern:
|
||||
description:
|
||||
- The pattern of GCE instance names to match for adding/removing tags. Full-Python regex is supported. See U(https://docs.python.org/2/library/re.html) for details.
|
||||
If instance_name is not specified, this field is required.
|
||||
required: false
|
||||
default: null
|
||||
aliases: []
|
||||
version_added: "2.3"
|
||||
tags:
|
||||
description:
|
||||
- comma-separated list of tags to add or remove
|
||||
|
|
@ -73,8 +81,12 @@ options:
|
|||
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "apache-libcloud"
|
||||
author: "Do Hoang Khiem (dohoangkhiem@gmail.com)"
|
||||
- "apache-libcloud >= 0.17.0"
|
||||
notes:
|
||||
- Either I(instance_name) or I(instance_pattern) is required.
|
||||
author:
|
||||
- Do Hoang Khiem (dohoangkhiem@gmail.com)
|
||||
- Tom Melendez (@supertom)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
|
@ -91,7 +103,16 @@ EXAMPLES = '''
|
|||
tags: foo,bar
|
||||
state: absent
|
||||
|
||||
# Add tags 'foo', 'bar' to instances in zone that match pattern
|
||||
- gce_tag:
|
||||
instance_pattern: test-server-*
|
||||
tags: foo,bar
|
||||
zone: us-central1-a
|
||||
state: present
|
||||
|
||||
'''
|
||||
import re
|
||||
import traceback
|
||||
|
||||
try:
|
||||
from libcloud.compute.types import Provider
|
||||
|
|
@ -107,38 +128,40 @@ except ImportError:
|
|||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.gce import gce_connect
|
||||
|
||||
def _union_items(baselist, comparelist):
|
||||
"""Combine two lists, removing duplicates."""
|
||||
return list(set(baselist) | set(comparelist))
|
||||
|
||||
def add_tags(gce, module, instance_name, tags):
|
||||
"""Add tags to instance."""
|
||||
zone = module.params.get('zone')
|
||||
def _intersect_items(baselist, comparelist):
|
||||
"""Return matching items in both lists."""
|
||||
return list(set(baselist) & set(comparelist))
|
||||
|
||||
if not instance_name:
|
||||
module.fail_json(msg='Must supply instance_name', changed=False)
|
||||
def _get_changed_items(baselist, comparelist):
|
||||
"""Return changed items as they relate to baselist."""
|
||||
return list(set(baselist) & set(set(baselist) ^ set(comparelist)))
|
||||
|
||||
if not tags:
|
||||
module.fail_json(msg='Must supply tags', changed=False)
|
||||
def modify_tags(gce, module, node, tags, state='present'):
|
||||
"""Modify tags on an instance."""
|
||||
|
||||
zone = node.extra['zone'].name
|
||||
existing_tags = node.extra['tags']
|
||||
tags = [x.lower() for x in tags]
|
||||
|
||||
try:
|
||||
node = gce.ex_get_node(instance_name, zone=zone)
|
||||
except ResourceNotFoundError:
|
||||
module.fail_json(msg='Instance %s not found in zone %s' % (instance_name, zone), changed=False)
|
||||
except GoogleBaseError as e:
|
||||
module.fail_json(msg=str(e), changed=False)
|
||||
|
||||
node_tags = node.extra['tags']
|
||||
changed = False
|
||||
tags_changed = []
|
||||
|
||||
for t in tags:
|
||||
if t not in node_tags:
|
||||
changed = True
|
||||
node_tags.append(t)
|
||||
tags_changed.append(t)
|
||||
|
||||
if not changed:
|
||||
return False, None
|
||||
if state == 'absent':
|
||||
# tags changed are any that intersect
|
||||
tags_changed = _intersect_items(existing_tags, tags)
|
||||
if not tags_changed:
|
||||
return False, None
|
||||
# update instance with tags in existing tags that weren't specified
|
||||
node_tags = _get_changed_items(existing_tags, tags)
|
||||
else:
|
||||
# tags changed are any that in the new list that weren't in existing
|
||||
tags_changed = _get_changed_items(tags, existing_tags)
|
||||
if not tags_changed:
|
||||
return False, None
|
||||
# update instance with the combined list
|
||||
node_tags = _union_items(existing_tags, tags)
|
||||
|
||||
try:
|
||||
gce.ex_set_node_tags(node, node_tags)
|
||||
|
|
@ -146,87 +169,70 @@ def add_tags(gce, module, instance_name, tags):
|
|||
except (GoogleBaseError, InvalidRequestError) as e:
|
||||
module.fail_json(msg=str(e), changed=False)
|
||||
|
||||
|
||||
def remove_tags(gce, module, instance_name, tags):
|
||||
"""Remove tags from instance."""
|
||||
zone = module.params.get('zone')
|
||||
|
||||
if not instance_name:
|
||||
module.fail_json(msg='Must supply instance_name', changed=False)
|
||||
|
||||
if not tags:
|
||||
module.fail_json(msg='Must supply tags', changed=False)
|
||||
|
||||
tags = [x.lower() for x in tags]
|
||||
|
||||
try:
|
||||
node = gce.ex_get_node(instance_name, zone=zone)
|
||||
except ResourceNotFoundError:
|
||||
module.fail_json(msg='Instance %s not found in zone %s' % (instance_name, zone), changed=False)
|
||||
except GoogleBaseError as e:
|
||||
module.fail_json(msg=str(e), changed=False)
|
||||
|
||||
node_tags = node.extra['tags']
|
||||
|
||||
changed = False
|
||||
tags_changed = []
|
||||
|
||||
for t in tags:
|
||||
if t in node_tags:
|
||||
node_tags.remove(t)
|
||||
changed = True
|
||||
tags_changed.append(t)
|
||||
|
||||
if not changed:
|
||||
return False, None
|
||||
|
||||
try:
|
||||
gce.ex_set_node_tags(node, node_tags)
|
||||
return True, tags_changed
|
||||
except (GoogleBaseError, InvalidRequestError) as e:
|
||||
module.fail_json(msg=str(e), changed=False)
|
||||
|
||||
|
||||
def main():
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
instance_name=dict(required=True),
|
||||
tags=dict(type='list'),
|
||||
instance_name=dict(required=False),
|
||||
instance_pattern=dict(required=False),
|
||||
tags=dict(type='list', required=True),
|
||||
state=dict(default='present', choices=['present', 'absent']),
|
||||
zone=dict(default='us-central1-a'),
|
||||
service_account_email=dict(),
|
||||
pem_file=dict(type='path'),
|
||||
project_id=dict(),
|
||||
)
|
||||
),
|
||||
mutually_exclusive=[
|
||||
[ 'instance_name', 'instance_pattern' ]
|
||||
],
|
||||
required_one_of=[
|
||||
[ 'instance_name', 'instance_pattern' ]
|
||||
]
|
||||
)
|
||||
|
||||
if not HAS_LIBCLOUD:
|
||||
module.fail_json(msg='libcloud with GCE support is required.')
|
||||
|
||||
instance_name = module.params.get('instance_name')
|
||||
instance_pattern = module.params.get('instance_pattern')
|
||||
state = module.params.get('state')
|
||||
tags = module.params.get('tags')
|
||||
zone = module.params.get('zone')
|
||||
changed = False
|
||||
|
||||
if not zone:
|
||||
module.fail_json(msg='Must specify "zone"', changed=False)
|
||||
|
||||
if not tags:
|
||||
module.fail_json(msg='Must specify "tags"', changed=False)
|
||||
if not HAS_LIBCLOUD:
|
||||
module.fail_json(msg='libcloud with GCE support (0.17.0+) required for this module')
|
||||
|
||||
gce = gce_connect(module)
|
||||
|
||||
# add tags to instance.
|
||||
if state == 'present':
|
||||
changed, tags_changed = add_tags(gce, module, instance_name, tags)
|
||||
|
||||
# remove tags from instance
|
||||
if state == 'absent':
|
||||
changed, tags_changed = remove_tags(gce, module, instance_name, tags)
|
||||
|
||||
module.exit_json(changed=changed, instance_name=instance_name, tags=tags_changed, zone=zone)
|
||||
# Create list of nodes to operate on
|
||||
matching_nodes = []
|
||||
try:
|
||||
if instance_pattern:
|
||||
instances = gce.list_nodes(ex_zone=zone)
|
||||
# no instances in zone
|
||||
if not instances:
|
||||
module.exit_json(changed=False, tags=tags, zone=zone, instances_updated=[])
|
||||
try:
|
||||
# Python regex fully supported: https://docs.python.org/2/library/re.html
|
||||
p = re.compile(instance_pattern)
|
||||
matching_nodes = [i for i in instances if p.search(i.name) is not None]
|
||||
except re.error as e:
|
||||
module.fail_json(msg='Regex error for pattern %s: %s' % (instance_pattern, e), changed=False)
|
||||
else:
|
||||
matching_nodes = [gce.ex_get_node(instance_name, zone=zone)]
|
||||
except ResourceNotFoundError:
|
||||
module.fail_json(msg='Instance %s not found in zone %s' % (instance_name, zone), changed=False)
|
||||
except GoogleBaseError as e:
|
||||
module.fail_json(msg=str(e), changed=False, exception=traceback.format_exc())
|
||||
|
||||
# Tag nodes
|
||||
instance_pattern_matches = []
|
||||
tags_changed = []
|
||||
for node in matching_nodes:
|
||||
changed, tags_changed = modify_tags(gce, module, node, tags, state)
|
||||
if changed:
|
||||
instance_pattern_matches.append({'instance_name': node.name, 'tags_changed': tags_changed})
|
||||
if instance_pattern:
|
||||
module.exit_json(changed=changed, instance_pattern=instance_pattern, tags=tags_changed, zone=zone, instances_updated=instance_pattern_matches)
|
||||
else:
|
||||
module.exit_json(changed=changed, instance_name=instance_name, tags=tags_changed, zone=zone)
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue