From 58d9d83c40eef2039d030a7a953d4d3149bdac44 Mon Sep 17 00:00:00 2001
From: Jean-Philippe Evrard <jean-philippe.evrard@rackspace.co.uk>
Date: Tue, 26 Apr 2016 15:37:41 +0100
Subject: [PATCH] Bring delete and update functions to keystone module

This commit adds "state" parameter in the keystone module for
its ensure_endpoint command.

This is the state parameter behavior:
- When not set or set to present, it will ensure the endpoint
  with the URL given will be present in keystone

- When set to update, it will ensure that the same kind of
  endpoint gets its url changed if it was different. If there
  was no endpoint of the same kind, the module will create the
  endpoint

- When set to absent, the module will delete the endpoint with
  the given url.

Closes-Bug: #1426191
Change-Id: Ie5e715d02f2d5fb96ceeb2c3e368090aa4702599
---
 library/keystone | 100 +++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 89 insertions(+), 11 deletions(-)

diff --git a/library/keystone b/library/keystone
index e1dc328..b39d8d5 100644
--- a/library/keystone
+++ b/library/keystone
@@ -1,4 +1,5 @@
 #!/usr/bin/python
+# -*- coding: utf-8 -*-
 # (c) 2014, Kevin Carter <kevin.carter@rackspace.com>
 #
 # Copyright 2014, Rackspace US, Inc.
@@ -187,6 +188,11 @@ options:
             - Name for a domain
         required: False
         default: True
+    state:
+        description:
+            - Ensuring the endpoint is either present, absent, or update
+        required: False
+        default: 'present'
     command:
         description:
             - Indicate desired state of the resource
@@ -335,7 +341,8 @@ COMMAND_MAP = {
             'region_name',
             'service_name',
             'service_type',
-            'endpoint_list'
+            'endpoint_list',
+            'state'
         ]
     },
     'ensure_role': {
@@ -998,7 +1005,35 @@ class ManageKeystone(object):
 
         return self._facts(facts={'id': service.id})
 
+    def _get_endpoint_by_details(self, region, service_id, interface):
+        """ Getting endpoints per complete definition
+
+        Returns the endpoint details for an endpoint matching
+        region, service id and interface.
+
+        :param interface: ``str`` ‘public’, ‘admin’ or ‘internal’ network
+                                  interface
+        :param service_id: service to which the endpoint belongs
+        :param region: geographic location of the endpoint
+
+        """
+        for entry in self.keystone.endpoints.list():
+            check = [
+                entry.region == region,
+                entry.service_id == service_id,
+                entry.interface == interface
+            ]
+            if all(check):
+                return entry
+        else:
+            return None
+
     def _get_endpoint(self, region, url, interface):
+        """ Getting endpoints per URL
+        Returns the endpoint details for an endpoint matching
+        URL, region and interface.
+        This interface should be deprecated in next release.
+        """
         for entry in self.keystone.endpoints.list():
             check = [
                 entry.region == region,
@@ -1011,7 +1046,8 @@ class ManageKeystone(object):
             return None
 
     def ensure_endpoint(self, variables):
-        """Create a new endpoint within Keystone if it does not exist.
+        """Ensures the deletion/modification/addition of endpoints
+        within Keystone.
 
         Returns the endpoint ID on a successful run.
 
@@ -1031,6 +1067,7 @@ class ManageKeystone(object):
         service_type = variables_dict.pop('service_type')
         region = variables_dict.pop('region_name')
         endpoint_list = variables_dict.pop('endpoint_list')
+        state = variables_dict.pop('state')
 
         service = self._get_service(name=service_name, srv_type=service_type)
         if service is None:
@@ -1049,19 +1086,55 @@ class ManageKeystone(object):
                 url=url,
                 interface=interface
             )
-            if endpoint is None:
-                self.state_change = True
-                endpoint = self.keystone.endpoints.create(
+            if state == 'present':
+                ''' Creating an endpoint for this url
+                    (if it does not exist)
+                '''
+                if endpoint is None:
+                    self.state_change = True
+                    endpoint = self.keystone.endpoints.create(
+                        region=region,
+                        service=service,
+                        url=url,
+                        interface=interface
+                    )
+            elif state == 'update':
+                ''' Checking if there is a similar endpoint with a
+                    different url. Update it if there is one, create
+                    if there is none.
+                '''
+                similar_endpoint = self._get_endpoint_by_details(
                     region=region,
-                    service=service,
-                    url=url,
+                    service_id=service.id,
                     interface=interface
                 )
-            endpoints[interface] = endpoint
+                if similar_endpoint is None:
+                    self.state_change = True
+                    endpoint = self.keystone.endpoints.create(
+                        region=region,
+                        service=service,
+                        url=url,
+                        interface=interface
+                    )
+                elif similar_endpoint.url != url:
+                    self.state_change = True
+                    endpoint = self.keystone.endpoints.update(
+                        endpoint=similar_endpoint,
+                        url=url
+                    )
+            elif state == 'absent':
+                if endpoint is not None:
+                    self.state_change = True
+                    result = self.keystone.endpoints.delete(endpoint.id)
+                    if result[0].status_code != 204:
+                        module.fail()
 
-        return self._facts(
-            facts={'%sid' % interface: endpoint.id
-                   for interface, endpoint in endpoints.items()})
+        if state != 'absent':
+            endpoints[interface] = endpoint
+            return self._facts({'%sid' % interface: endpoint.id
+                                for interface, endpoint in endpoints.items()})
+        else:
+            return self._facts({})
 
     def _ensure_generic(self, manager, required_vars, variables):
         """Try and create a new 'thing' in keystone.
@@ -1281,6 +1354,11 @@ def main():
                 type='bool',
                 required=False,
                 default=True
+            ),
+            state=dict(
+                choices=['present', 'absent', 'update'],
+                required=False,
+                default='present'
             )
         ),
         supports_check_mode=False,