added os_aggregate module (#19374)

* added os_aggregate module

* various fixed to os_aggregate module

based on comments by @emonty (https://github.com/ansible/ansible-modules-extras/pull/2873)

* updated shade version requirement

lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py

@@ -0,0 +1,196 @@
+#!/usr/bin/python
+# Copyright 2016 Jakub Jursa <jakub.jursa1@gmail.com>
+#
+# This module 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.
+#
+# This software 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 this software.  If not, see <http://www.gnu.org/licenses/>.
+
+try:
+    import shade
+    HAS_SHADE = True
+except ImportError:
+    HAS_SHADE = False
+
+from distutils.version import StrictVersion
+
+DOCUMENTATION = '''
+---
+module: os_nova_host_aggregate
+short_description: Manage OpenStack host aggregates
+extends_documentation_fragment: openstack
+author: "Jakub Jursa"
+version_added: "2.3"
+description:
+    - Create, update, or delete OpenStack host aggregates. If a aggregate
+      with the supplied name already exists, it will be updated with the
+      new name, new availability zone, new metadata and new list of hosts.
+options:
+  name:
+    description: Name of the aggregate.
+    required: true
+  metadata:
+    description: Metadata dict.
+    required: false
+    default: None
+  availability_zone:
+    description: Availability zone to create aggregate into.
+    required: false
+    default: None
+  hosts:
+    description: List of hosts to set for an aggregate.
+    required: false
+    default: None
+  state:
+    description: Should the resource be present or absent.
+    choices: [present, absent]
+    default: present
+requirements:
+    - "python >= 2.6"
+    - "shade"
+'''
+
+EXAMPLES = '''
+# Create a host aggregate
+- os_nova_host_aggregate:
+    cloud: mycloud
+    state: present
+    name: db_aggregate
+    hosts:
+      - host1
+      - host2
+    metadata:
+      type: dbcluster
+# Delete an aggregate
+- os_nova_host_aggregate:
+    cloud: mycloud
+    state: absent
+    name: db_aggregate
+'''
+
+RETURN = '''
+
+'''
+
+def _needs_update(module, aggregate):
+    new_metadata = (module.params['metadata'] or {})
+    new_metadata['availability_zone'] = module.params['availability_zone']
+
+    if (module.params['name'] != aggregate.name) or \
+        (module.params['hosts'] is not None and module.params['hosts'] != aggregate.hosts) or \
+        (module.params['availability_zone'] is not None and module.params['availability_zone'] != aggregate.availability_zone) or \
+        (module.params['metadata'] is not None and new_metadata != aggregate.metadata):
+        return True
+
+    return False
+
+def _system_state_change(module, aggregate):
+    state = module.params['state']
+    if state == 'absent' and aggregate:
+        return True
+
+    if state == 'present':
+        if aggregate is None:
+            return True
+        return _needs_update(module, aggregate)
+
+    return False
+
+def main():
+    argument_spec = openstack_full_argument_spec(
+        name=dict(required=True),
+        metadata=dict(required=False, default=None, type='dict'),
+        availability_zone=dict(required=False, default=None),
+        hosts=dict(required=False, default=None, type='list'),
+        state=dict(default='present', choices=['absent', 'present']),
+    )
+
+    module_kwargs = openstack_module_kwargs()
+    module = AnsibleModule(argument_spec,
+                           supports_check_mode=True,
+                           **module_kwargs)
+
+    if not HAS_SHADE:
+        module.fail_json(msg='shade is required for this module')
+    if StrictVersion(shade.__version__) < StrictVersion('1.9.0'):
+        module.fail_json(msg="To utilize this module, the installed version of"
+                             "the shade library MUST be >=1.9.0")
+
+    name = module.params['name']
+    metadata = module.params['metadata']
+    availability_zone = module.params['availability_zone']
+    hosts = module.params['hosts']
+    state = module.params['state']
+
+    if metadata is not None:
+        metadata.pop('availability_zone', None)
+
+    try:
+        cloud = shade.operator_cloud(**module.params)
+        aggregates = cloud.search_aggregates(name_or_id=name)
+
+        if len(aggregates) == 1:
+            aggregate = aggregates[0]
+        elif len(aggregates) == 0:
+            aggregate = None
+        else:
+            raise Exception("Should not happen")
+
+        if module.check_mode:
+            module.exit_json(changed=_system_state_change(module, aggregate))
+
+        if state == 'present':
+            if aggregate is None:
+                aggregate = cloud.create_aggregate(name=name,
+                    availability_zone=availability_zone)
+                if hosts:
+                    for h in hosts:
+                        cloud.add_host_to_aggregate(aggregate.id, h)
+                if metadata:
+                    cloud.set_aggregate_metadata(aggregate.id, metadata)
+                changed = True
+            else:
+                if _needs_update(module, aggregate):
+                    if availability_zone is not None:
+                        aggregate = cloud.update_aggregate(aggregate.id,
+                            name=name, availability_zone=availability_zone)
+                    if metadata is not None:
+                        metas = metadata
+                        for i in (set(aggregate.metadata.keys()) - set(metadata.keys())):
+                            if i != 'availability_zone':
+                                metas[i] = None
+                        cloud.set_aggregate_metadata(aggregate.id, metas)
+                    if hosts is not None:
+                        for i in (set(aggregate.hosts) - set (hosts)):
+                            cloud.remove_host_from_aggregate(aggregate.id, i)
+                        for i in (set(hosts) - set(aggregate.hosts)):
+                            cloud.add_host_to_aggregate(aggregate.id, i)
+                    changed = True
+                else:
+                    changed = False
+            module.exit_json(changed=changed)
+
+        elif state == 'absent':
+            if aggregate is None:
+                changed=False
+            else:
+                cloud.delete_aggregate(aggregate.id)
+                changed=True
+            module.exit_json(changed=changed)
+
+    except shade.OpenStackCloudException as e:
+        module.fail_json(msg=str(e))
+
+
+from ansible.module_utils.basic import *
+from ansible.module_utils.openstack import *
+if __name__ == '__main__':
+    main()