ansible-collections-openstack/plugins/modules/catalog_service.py

#!/usr/bin/python
# Copyright 2016 Sam Yaple
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = '''
---
module: catalog_service
short_description: Manage OpenStack Identity services
author: OpenStack Ansible SIG
description:
    - Create, update, or delete OpenStack Identity service. If a service
      with the supplied name already exists, it will be updated with the
      new description and enabled attributes.
options:
   name:
     description:
        - Name of the service
     required: true
     type: str
   description:
     description:
        - Description of the service
     type: str
   enabled:
     description:
        - Is the service enabled
     type: bool
     default: 'yes'
   service_type:
     description:
        - The type of service
     required: true
     type: str
   state:
     description:
       - Should the resource be present or absent.
     choices: [present, absent]
     default: present
     type: str
requirements:
    - "python >= 3.6"
    - "openstacksdk"

extends_documentation_fragment:
- openstack.cloud.openstack
'''

EXAMPLES = '''
# Create a service for glance
- openstack.cloud.catalog_service:
     cloud: mycloud
     state: present
     name: glance
     service_type: image
     description: OpenStack Image Service
# Delete a service
- openstack.cloud.catalog_service:
     cloud: mycloud
     state: absent
     name: glance
     service_type: image
'''

RETURN = '''
service:
    description: Dictionary describing the service.
    returned: On success when I(state) is 'present'
    type: complex
    contains:
        id:
            description: Service ID.
            type: str
            sample: "3292f020780b4d5baf27ff7e1d224c44"
        name:
            description: Service name.
            type: str
            sample: "glance"
        service_type:
            description: Service type.
            type: str
            sample: "image"
        description:
            description: Service description.
            type: str
            sample: "OpenStack Image Service"
        enabled:
            description: Service status.
            type: bool
            sample: True
id:
    description: The service ID.
    returned: On success when I(state) is 'present'
    type: str
    sample: "3292f020780b4d5baf27ff7e1d224c44"
'''

from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule


class IdentityCatalogServiceModule(OpenStackModule):
    argument_spec = dict(
        description=dict(default=None),
        enabled=dict(default=True, type='bool'),
        name=dict(required=True),
        service_type=dict(required=True),
        state=dict(default='present', choices=['absent', 'present']),
    )

    module_kwargs = dict(
        supports_check_mode=True
    )

    def _needs_update(self, service):
        if service.enabled != self.params['enabled']:
            return True
        if service.description is not None and \
           service.description != self.params['description']:
            return True
        return False

    def _system_state_change(self, service):
        state = self.params['state']
        if state == 'absent' and service:
            return True

        if state == 'present':
            if service is None:
                return True
            return self._needs_update(service)

        return False

    def run(self):
        description = self.params['description']
        enabled = self.params['enabled']
        name = self.params['name']
        state = self.params['state']
        service_type = self.params['service_type']

        services = self.conn.search_services(
            name_or_id=name, filters=dict(type=service_type))

        if len(services) > 1:
            self.fail_json(
                msg='Service name %s and type %s are not unique'
                % (name, service_type))
        elif len(services) == 1:
            service = services[0]
        else:
            service = None

        if self.ansible.check_mode:
            self.exit_json(changed=self._system_state_change(service))

        if state == 'present':
            if service is None:
                service = self.conn.create_service(
                    name=name, description=description, type=service_type, enabled=True)
                changed = True
            else:
                if self._needs_update(service):
                    service = self.conn.update_service(
                        service.id, name=name, type=service_type, enabled=enabled,
                        description=description)
                    changed = True
                else:
                    changed = False
            self.exit_json(changed=changed, service=service, id=service.id)

        elif state == 'absent':
            if service is None:
                changed = False
            else:
                self.conn.delete_service(service.id)
                changed = True
            self.exit_json(changed=changed)


def main():
    module = IdentityCatalogServiceModule()
    module()


if __name__ == '__main__':
    main()