osmclient/sol005/sdncontroller.py

   1 # Copyright 2018 Telefonica
   2 #
   3 # All Rights Reserved.
   4 #
   5 #    Licensed under the Apache License, Version 2.0 (the "License"); you may
   6 #    not use this file except in compliance with the License. You may obtain
   7 #    a copy of the License at
   8 #
   9 #         http://www.apache.org/licenses/LICENSE-2.0
  10 #
  11 #    Unless required by applicable law or agreed to in writing, software
  12 #    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14 #    License for the specific language governing permissions and limitations
  15 #    under the License.
  16
  17 """
  18 OSM SDN controller API handling
  19 """
  20
  21 from osmclient.common import utils
  22 from osmclient.common import wait as WaitForStatus
  23 from osmclient.common.exceptions import ClientException
  24 from osmclient.common.exceptions import NotFound
  25 import json
  26 import logging
  27
  28
  29 class SdnController(object):
  30     def __init__(self, http=None, client=None):
  31         self._http = http
  32         self._client = client
  33         self._logger = logging.getLogger('osmclient')
  34         self._apiName = '/admin'
  35         self._apiVersion = '/v1'
  36         self._apiResource = '/sdns'
  37         self._apiBase = '{}{}{}'.format(self._apiName,
  38                                         self._apiVersion, self._apiResource)
  39
  40     # SDNC '--wait' option
  41     def _wait(self, id, deleteFlag=False):
  42         self._logger.debug("")
  43         self._client.get_token()
  44         # Endpoint to get operation status
  45         apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/sdns')
  46         # Wait for status for SDN instance creation/update/deletion
  47         WaitForStatus.wait_for_status(
  48             'SDNC',
  49             str(id),
  50             WaitForStatus.TIMEOUT_SDNC_OPERATION,
  51             apiUrlStatus,
  52             self._http.get2_cmd,
  53             deleteFlag=deleteFlag)
  54
  55     def _get_id_for_wait(self, name):
  56         """Returns id of name, or the id itself if given as argument
  57         """
  58         self._logger.debug("")
  59         for sdnc in self.list():
  60             if name == sdnc['_id']:
  61                 return sdnc['_id']
  62         for sdnc in self.list():
  63             if name == sdnc['name']:
  64                 return sdnc['_id']
  65         return ''
  66
  67     def create(self, name, sdn_controller, wait=False):
  68         self._logger.debug("")
  69         self._client.get_token()
  70         http_code, resp = self._http.post_cmd(endpoint=self._apiBase, postfields_dict=sdn_controller)
  71         # print('HTTP CODE: {}'.format(http_code))
  72         # print('RESP: {}'.format(resp))
  73         if http_code in (200, 201, 202, 204):
  74             if resp:
  75                 resp = json.loads(resp)
  76             if not resp or 'id' not in resp:
  77                 raise ClientException('unexpected response from server - {}'.format(resp))
  78             if wait:
  79                 # Wait for status for SDNC instance creation
  80                 self._wait(resp.get('id'))
  81             print(resp['id'])
  82         else:
  83             msg = ""
  84             if resp:
  85                 try:
  86                     msg = json.loads(resp)
  87                 except ValueError:
  88                     msg = resp
  89             raise ClientException("failed to create SDN controller {} - {}".format(name, msg))
  90
  91     def update(self, name, sdn_controller, wait=False):
  92         self._logger.debug("")
  93         self._client.get_token()
  94         sdnc = self.get(name)
  95         sdnc_id_for_wait = self._get_id_for_wait(name)
  96         http_code, resp = self._http.patch_cmd(endpoint='{}/{}'.format(self._apiBase,sdnc['_id']),
  97                                                postfields_dict=sdn_controller)
  98         # print('HTTP CODE: {}'.format(http_code))
  99         # print('RESP: {}'.format(resp))
 100         if http_code in (200, 201, 202, 204):
 101             if wait:
 102                 # In this case, 'resp' always returns None, so 'resp['id']' cannot be used.
 103                 # Use the previously obtained id instead.
 104                 wait_id = sdnc_id_for_wait
 105                 # Wait for status for VI instance update
 106                 self._wait(wait_id)
 107             else:
 108                 pass
 109         else:
 110             msg = ""
 111             if resp:
 112                 try:
 113                     msg = json.loads(resp)
 114                 except ValueError:
 115                     msg = resp
 116             raise ClientException("failed to update SDN controller {} - {}".format(name, msg))
 117
 118     def delete(self, name, force=False, wait=False):
 119         self._logger.debug("")
 120         self._client.get_token()
 121         sdn_controller = self.get(name)
 122         sdnc_id_for_wait = self._get_id_for_wait(name)
 123         querystring = ''
 124         if force:
 125             querystring = '?FORCE=True'
 126         http_code, resp = self._http.delete_cmd('{}/{}{}'.format(self._apiBase,
 127                                                                  sdn_controller['_id'], querystring))
 128         # print('HTTP CODE: {}'.format(http_code))
 129         # print('RESP: {}'.format(resp))
 130         if http_code == 202:
 131             if wait:
 132                 # Wait for status for SDNC instance deletion
 133                 self._wait(sdnc_id_for_wait, deleteFlag=True)
 134             else:
 135                 print('Deletion in progress')
 136         elif http_code == 204:
 137             print('Deleted')
 138         elif resp and 'result' in resp:
 139             print('Deleted')
 140         else:
 141             msg = ""
 142             if resp:
 143                 try:
 144                     msg = json.loads(resp)
 145                 except ValueError:
 146                     msg = resp
 147             raise ClientException("failed to delete SDN controller {} - {}".format(name, msg))
 148
 149     def list(self, filter=None):
 150         """Returns a list of SDN controllers
 151         """
 152         self._logger.debug("")
 153         self._client.get_token()
 154         filter_string = ''
 155         if filter:
 156             filter_string = '?{}'.format(filter)
 157         resp = self._http.get_cmd('{}{}'.format(self._apiBase, filter_string))
 158         # print('RESP: {}'.format(resp))
 159         if resp:
 160             return resp
 161         return list()
 162
 163     def get(self, name):
 164         """Returns an SDN controller based on name or id
 165         """
 166         self._logger.debug("")
 167         self._client.get_token()
 168         if utils.validate_uuid4(name):
 169             for sdnc in self.list():
 170                 if name == sdnc['_id']:
 171                     return sdnc
 172         else:
 173             for sdnc in self.list():
 174                 if name == sdnc['name']:
 175                     return sdnc
 176         raise NotFound("SDN controller {} not found".format(name))
 177