osm_lcm/ng_ro.py

   1 #!/usr/bin/env python3
   2 # -*- coding: utf-8 -*-
   3
   4 ##
   5 # Copyright 2020 Telefónica Investigación y Desarrollo, S.A.U.
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   8 # not use this file except in compliance with the License. You may obtain
   9 # a copy of the License at
  10 #
  11 #         http://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  16 # License for the specific language governing permissions and limitations
  17 # under the License.
  18 #
  19 ##
  20
  21 """
  22 asyncio RO python client to interact with New Generation RO server
  23 """
  24
  25 import asyncio
  26 import aiohttp
  27 import yaml
  28 import logging
  29
  30 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com"
  31 __date__ = "$09-Jan-2018 09:09:48$"
  32 __version__ = "0.1.2"
  33 version_date = "2020-05-08"
  34
  35
  36 class NgRoException(Exception):
  37     def __init__(self, message, http_code=400):
  38         """Common Exception for all RO client exceptions"""
  39         self.http_code = http_code
  40         Exception.__init__(self, message)
  41
  42
  43 class NgRoClient:
  44     headers_req = {"Accept": "application/yaml", "content-type": "application/yaml"}
  45     client_to_RO = {
  46         "tenant": "tenants",
  47         "vim": "datacenters",
  48         "vim_account": "datacenters",
  49         "sdn": "sdn_controllers",
  50         "vnfd": "vnfs",
  51         "nsd": "scenarios",
  52         "wim": "wims",
  53         "wim_account": "wims",
  54         "ns": "instances",
  55     }
  56     mandatory_for_create = {
  57         "tenant": ("name",),
  58         "vnfd": ("name", "id"),
  59         "nsd": ("name", "id"),
  60         "ns": ("name", "scenario", "datacenter"),
  61         "vim": ("name", "vim_url"),
  62         "wim": ("name", "wim_url"),
  63         "vim_account": (),
  64         "wim_account": (),
  65         "sdn": ("name", "type"),
  66     }
  67     timeout_large = 120
  68     timeout_short = 30
  69
  70     def __init__(self, loop, uri, **kwargs):
  71         self.loop = loop
  72         self.endpoint_url = uri
  73         if not self.endpoint_url.endswith("/"):
  74             self.endpoint_url += "/"
  75         if not self.endpoint_url.startswith("http"):
  76             self.endpoint_url = "http://" + self.endpoint_url
  77
  78         self.username = kwargs.get("username")
  79         self.password = kwargs.get("password")
  80         self.tenant_id_name = kwargs.get("tenant")
  81         self.tenant = None
  82         self.datacenter_id_name = kwargs.get("datacenter")
  83         self.datacenter = None
  84         logger_name = kwargs.get("logger_name", "lcm.ro")
  85         self.logger = logging.getLogger(logger_name)
  86         if kwargs.get("loglevel"):
  87             self.logger.setLevel(kwargs["loglevel"])
  88
  89     async def deploy(self, nsr_id, target):
  90         """
  91         Performs an action over an item
  92         :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
  93         :param item_id_name: RO id or name of the item. Raise and exception if more than one found
  94         :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
  95         :param descriptor_format: Can be 'json' or 'yaml'
  96         :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
  97                keys can be a dot separated list to specify elements inside dict
  98         :return: dictionary with the information or raises NgRoException on Error
  99         """
 100         try:
 101             if isinstance(target, str):
 102                 target = self._parse_yaml(target)
 103             payload_req = yaml.safe_dump(target)
 104
 105             url = "{}/ns/v1/deploy/{nsr_id}".format(self.endpoint_url, nsr_id=nsr_id)
 106             async with aiohttp.ClientSession(loop=self.loop) as session:
 107                 self.logger.debug("NG-RO POST %s %s", url, payload_req)
 108                 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
 109                 async with session.post(
 110                     url, headers=self.headers_req, data=payload_req
 111                 ) as response:
 112                     response_text = await response.read()
 113                     self.logger.debug(
 114                         "POST {} [{}] {}".format(
 115                             url, response.status, response_text[:100]
 116                         )
 117                     )
 118                     if response.status >= 300:
 119                         raise NgRoException(response_text, http_code=response.status)
 120                     return self._parse_yaml(response_text, response=True)
 121         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 122             raise NgRoException(e, http_code=504)
 123         except asyncio.TimeoutError:
 124             raise NgRoException("Timeout", http_code=504)
 125
 126     async def migrate(self, nsr_id, target):
 127         """
 128         Performs migration of VNFs
 129         :param nsr_id: NS Instance Id
 130         :param target: payload data for migrate operation
 131         :return: dictionary with the information or raises NgRoException on Error
 132         """
 133         try:
 134             if isinstance(target, str):
 135                 target = self._parse_yaml(target)
 136             payload_req = yaml.safe_dump(target)
 137
 138             url = "{}/ns/v1/migrate/{nsr_id}".format(self.endpoint_url, nsr_id=nsr_id)
 139             async with aiohttp.ClientSession(loop=self.loop) as session:
 140                 self.logger.debug("NG-RO POST %s %s", url, payload_req)
 141                 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
 142                 async with session.post(
 143                     url, headers=self.headers_req, data=payload_req
 144                 ) as response:
 145                     response_text = await response.read()
 146                     self.logger.debug(
 147                         "POST {} [{}] {}".format(
 148                             url, response.status, response_text[:100]
 149                         )
 150                     )
 151                     if response.status >= 300:
 152                         raise NgRoException(response_text, http_code=response.status)
 153                     return self._parse_yaml(response_text, response=True)
 154         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 155             raise NgRoException(e, http_code=504)
 156         except asyncio.TimeoutError:
 157             raise NgRoException("Timeout", http_code=504)
 158
 159     async def operate(self, nsr_id, target, operation_type):
 160         """
 161         Performs start/stop/rebuil of VNFs
 162         :param nsr_id: NS Instance Id
 163         :param target: payload data for migrate operation
 164         :param operation_type: start/stop/rebuil of VNFs
 165         :return: dictionary with the information or raises NgRoException on Error
 166         """
 167         try:
 168             if isinstance(target, str):
 169                 target = self._parse_yaml(target)
 170             payload_req = yaml.safe_dump(target)
 171
 172             url = "{}/ns/v1/{operation_type}/{nsr_id}".format(
 173                 self.endpoint_url, operation_type=operation_type, nsr_id=nsr_id
 174             )
 175             async with aiohttp.ClientSession(loop=self.loop) as session:
 176                 self.logger.debug("NG-RO POST %s %s", url, payload_req)
 177                 # timeout = aiohttp.ClientTimeout(total=self.timeout_large)
 178                 async with session.post(
 179                     url, headers=self.headers_req, data=payload_req
 180                 ) as response:
 181                     response_text = await response.read()
 182                     self.logger.debug(
 183                         "POST {} [{}] {}".format(
 184                             url, response.status, response_text[:100]
 185                         )
 186                     )
 187                     if response.status >= 300:
 188                         raise NgRoException(response_text, http_code=response.status)
 189                     return self._parse_yaml(response_text, response=True)
 190         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 191             raise NgRoException(e, http_code=504)
 192         except asyncio.TimeoutError:
 193             raise NgRoException("Timeout", http_code=504)
 194
 195     async def status(self, nsr_id, action_id):
 196         try:
 197             url = "{}/ns/v1/deploy/{nsr_id}/{action_id}".format(
 198                 self.endpoint_url, nsr_id=nsr_id, action_id=action_id
 199             )
 200             async with aiohttp.ClientSession(loop=self.loop) as session:
 201                 self.logger.debug("GET %s", url)
 202                 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
 203                 async with session.get(url, headers=self.headers_req) as response:
 204                     response_text = await response.read()
 205                     self.logger.debug(
 206                         "GET {} [{}] {}".format(
 207                             url, response.status, response_text[:100]
 208                         )
 209                     )
 210                     if response.status >= 300:
 211                         raise NgRoException(response_text, http_code=response.status)
 212                     return self._parse_yaml(response_text, response=True)
 213
 214         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 215             raise NgRoException(e, http_code=504)
 216         except asyncio.TimeoutError:
 217             raise NgRoException("Timeout", http_code=504)
 218
 219     async def delete(self, nsr_id):
 220         try:
 221             url = "{}/ns/v1/deploy/{nsr_id}".format(self.endpoint_url, nsr_id=nsr_id)
 222             async with aiohttp.ClientSession(loop=self.loop) as session:
 223                 self.logger.debug("DELETE %s", url)
 224                 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
 225                 async with session.delete(url, headers=self.headers_req) as response:
 226                     self.logger.debug("DELETE {} [{}]".format(url, response.status))
 227                     if response.status >= 300:
 228                         raise NgRoException(
 229                             "Delete {}".format(nsr_id), http_code=response.status
 230                         )
 231                     return
 232
 233         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 234             raise NgRoException(e, http_code=504)
 235         except asyncio.TimeoutError:
 236             raise NgRoException("Timeout", http_code=504)
 237
 238     async def get_version(self):
 239         """
 240         Obtain RO server version.
 241         :return: a list with integers ["major", "minor", "release"]. Raises NgRoException on Error,
 242         """
 243         try:
 244             response_text = ""
 245             async with aiohttp.ClientSession(loop=self.loop) as session:
 246                 url = "{}/version".format(self.endpoint_url)
 247                 self.logger.debug("RO GET %s", url)
 248                 # timeout = aiohttp.ClientTimeout(total=self.timeout_short)
 249                 async with session.get(url, headers=self.headers_req) as response:
 250                     response_text = await response.read()
 251                     self.logger.debug(
 252                         "GET {} [{}] {}".format(
 253                             url, response.status, response_text[:100]
 254                         )
 255                     )
 256                     if response.status >= 300:
 257                         raise NgRoException(response_text, http_code=response.status)
 258
 259                 for word in str(response_text).split(" "):
 260                     if "." in word:
 261                         version_text, _, _ = word.partition("-")
 262                         return version_text
 263                 raise NgRoException(
 264                     "Got invalid version text: '{}'".format(response_text),
 265                     http_code=500,
 266                 )
 267         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 268             raise NgRoException(e, http_code=504)
 269         except asyncio.TimeoutError:
 270             raise NgRoException("Timeout", http_code=504)
 271         except Exception as e:
 272             raise NgRoException(
 273                 "Got invalid version text: '{}'; causing exception {}".format(
 274                     response_text, e
 275                 ),
 276                 http_code=500,
 277             )
 278
 279     async def recreate(self, nsr_id, target):
 280         """
 281         Performs an action over an item
 282         :param item: can be 'tenant', 'vnfd', 'nsd', 'ns', 'vim', 'vim_account', 'sdn'
 283         :param item_id_name: RO id or name of the item. Raise and exception if more than one found
 284         :param descriptor: can be a dict, or a yaml/json text. Autodetect unless descriptor_format is provided
 285         :param descriptor_format: Can be 'json' or 'yaml'
 286         :param kwargs: Overrides descriptor with values as name, description, vim_url, vim_url_admin, vim_type
 287                keys can be a dot separated list to specify elements inside dict
 288         :return: dictionary with the information or raises NgRoException on Error
 289         """
 290         try:
 291             if isinstance(target, str):
 292                 target = self._parse_yaml(target)
 293             payload_req = yaml.safe_dump(target)
 294
 295             url = "{}/ns/v1/recreate/{nsr_id}".format(self.endpoint_url, nsr_id=nsr_id)
 296             async with aiohttp.ClientSession(loop=self.loop) as session:
 297                 self.logger.debug("NG-RO POST %s %s", url, payload_req)
 298                 async with session.post(
 299                     url, headers=self.headers_req, data=payload_req
 300                 ) as response:
 301                     response_text = await response.read()
 302                     self.logger.debug(
 303                         "POST {} [{}] {}".format(
 304                             url, response.status, response_text[:100]
 305                         )
 306                     )
 307                     if response.status >= 300:
 308                         raise NgRoException(response_text, http_code=response.status)
 309                     return self._parse_yaml(response_text, response=True)
 310         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 311             raise NgRoException(e, http_code=504)
 312         except asyncio.TimeoutError:
 313             raise NgRoException("Timeout", http_code=504)
 314
 315     async def recreate_status(self, nsr_id, action_id):
 316         try:
 317             url = "{}/ns/v1/recreate/{nsr_id}/{action_id}".format(
 318                 self.endpoint_url, nsr_id=nsr_id, action_id=action_id
 319             )
 320             async with aiohttp.ClientSession(loop=self.loop) as session:
 321                 self.logger.debug("GET %s", url)
 322                 async with session.get(url, headers=self.headers_req) as response:
 323                     response_text = await response.read()
 324                     self.logger.debug(
 325                         "GET {} [{}] {}".format(
 326                             url, response.status, response_text[:100]
 327                         )
 328                     )
 329                     if response.status >= 300:
 330                         raise NgRoException(response_text, http_code=response.status)
 331                     return self._parse_yaml(response_text, response=True)
 332
 333         except (aiohttp.ClientOSError, aiohttp.ClientError) as e:
 334             raise NgRoException(e, http_code=504)
 335         except asyncio.TimeoutError:
 336             raise NgRoException("Timeout", http_code=504)
 337
 338     @staticmethod
 339     def _parse_yaml(descriptor, response=False):
 340         try:
 341             return yaml.safe_load(descriptor)
 342         except yaml.YAMLError as exc:
 343             error_pos = ""
 344             if hasattr(exc, "problem_mark"):
 345                 mark = exc.problem_mark
 346                 error_pos = " at line:{} column:{}s".format(
 347                     mark.line + 1, mark.column + 1
 348                 )
 349             error_text = "yaml format error" + error_pos
 350             if response:
 351                 raise NgRoException("reponse with " + error_text)
 352             raise NgRoException(error_text)