remove deprecated hidden option not available for all click versions.
[osm/osmclient.git] / osmclient / sol005 / nsi.py
index cb87b85..c01b4e9 100644 (file)
@@ -19,10 +19,12 @@ OSM NSI (Network Slice Instance) API handling
 """
 
 from osmclient.common import utils
+from osmclient.common import wait as WaitForStatus
 from osmclient.common.exceptions import ClientException
 from osmclient.common.exceptions import NotFound
 import yaml
 import json
+import logging
 
 
 class Nsi(object):
@@ -30,15 +32,33 @@ class Nsi(object):
     def __init__(self, http=None, client=None):
         self._http = http
         self._client = client
+        self._logger = logging.getLogger('osmclient')
         self._apiName = '/nsilcm'
         self._apiVersion = '/v1'
         self._apiResource = '/netslice_instances_content'
         self._apiBase = '{}{}{}'.format(self._apiName,
                                         self._apiVersion, self._apiResource)
 
+    # NSI '--wait' option
+    def _wait(self, id, deleteFlag=False):
+        self._logger.debug("")
+        self._client.get_token()
+        # Endpoint to get operation status
+        apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/nsi_lcm_op_occs')
+        # Wait for status for NSI instance creation/update/deletion
+        WaitForStatus.wait_for_status(
+            'NSI',
+            str(id),
+            WaitForStatus.TIMEOUT_NSI_OPERATION,
+            apiUrlStatus,
+            self._http.get2_cmd,
+            deleteFlag=deleteFlag)
+
     def list(self, filter=None):
         """Returns a list of NSI
         """
+        self._logger.debug("")
+        self._client.get_token()
         filter_string = ''
         if filter:
             filter_string = '?{}'.format(filter)
@@ -50,6 +70,8 @@ class Nsi(object):
     def get(self, name):
         """Returns an NSI based on name or id
         """
+        self._logger.debug("")
+        self._client.get_token()
         if utils.validate_uuid4(name):
             for nsi in self.list():
                 if name == nsi['_id']:
@@ -61,7 +83,9 @@ class Nsi(object):
         raise NotFound("nsi {} not found".format(name))
 
     def get_individual(self, name):
+        self._logger.debug("")
         nsi_id = name
+        self._client.get_token()
         if not utils.validate_uuid4(name):
             for nsi in self.list():
                 if name == nsi['name']:
@@ -69,22 +93,29 @@ class Nsi(object):
                     break
         resp = self._http.get_cmd('{}/{}'.format(self._apiBase, nsi_id))
         #resp = self._http.get_cmd('{}/{}/nsd_content'.format(self._apiBase, nsi_id))
-        #print yaml.safe_dump(resp)
+        #print(yaml.safe_dump(resp))
         if resp:
             return resp
         raise NotFound("nsi {} not found".format(name))
 
-    def delete(self, name, force=False):
+    def delete(self, name, force=False, wait=False):
+        self._logger.debug("")
         nsi = self.get(name)
         querystring = ''
         if force:
             querystring = '?FORCE=True'
         http_code, resp = self._http.delete_cmd('{}/{}{}'.format(self._apiBase,
                                          nsi['_id'], querystring))
-        #print 'HTTP CODE: {}'.format(http_code)
-        #print 'RESP: {}'.format(resp)
+        # print('HTTP CODE: {}'.format(http_code))
+        # print('RESP: {}'.format(resp))
         if http_code == 202:
-            print('Deletion in progress')
+            if wait and resp:
+                resp = json.loads(resp)
+                # Wait for status for NSI instance deletion
+                # For the 'delete' operation, '_id' is used
+                self._wait(resp.get('_id'), deleteFlag=True)
+            else:
+                print('Deletion in progress')
         elif http_code == 204:
             print('Deleted')
         else:
@@ -98,13 +129,16 @@ class Nsi(object):
 
     def create(self, nst_name, nsi_name, account, config=None,
                ssh_keys=None, description='default description',
-               admin_status='ENABLED'):
+               admin_status='ENABLED', wait=False):
 
+        self._logger.debug("")
+        self._client.get_token()
         nst = self._client.nst.get(nst_name)
 
         vim_account_id = {}
 
         def get_vim_account_id(vim_account):
+            self._logger.debug("")
             if vim_account_id.get(vim_account):
                 return vim_account_id[vim_account]
 
@@ -135,7 +169,7 @@ class Nsi(object):
                 with open(pubkeyfile, 'r') as f:
                     nsi['ssh_keys'].append(f.read())
         if config:
-            nsi_config = yaml.load(config)
+            nsi_config = yaml.safe_load(config)
             if "netslice-vld" in nsi_config:
                 for vld in nsi_config["netslice-vld"]:
                     if vld.get("vim-network-name"):
@@ -178,8 +212,10 @@ class Nsi(object):
                             not additional_param_subnet.get("additionalParamsForVnf"):
                         raise ValueError("Error at --config 'additionalParamsForSubnet' items must contain "
                                          "'additionalParamsForNs' and/or 'additionalParamsForVnf'")
+            if "timeout_nsi_deploy" in nsi_config:
+                nsi["timeout_nsi_deploy"] = nsi_config.pop("timeout_nsi_deploy")
 
-        # print yaml.safe_dump(nsi)
+        # print(yaml.safe_dump(nsi))
         try:
             self._apiResource = '/netslice_instances_content'
             self._apiBase = '{}{}{}'.format(self._apiName,
@@ -191,14 +227,17 @@ class Nsi(object):
             self._http.set_http_header(http_header)
             http_code, resp = self._http.post_cmd(endpoint=self._apiBase,
                                        postfields_dict=nsi)
-            #print 'HTTP CODE: {}'.format(http_code)
-            #print 'RESP: {}'.format(resp)
+            #print('HTTP CODE: {}'.format(http_code))
+            #print('RESP: {}'.format(resp))
             if http_code in (200, 201, 202, 204):
                 if resp:
                     resp = json.loads(resp)
                 if not resp or 'id' not in resp:
                     raise ClientException('unexpected response from server - {} '.format(
                                       resp))
+                if wait:
+                    # Wait for status for NSI instance creation
+                    self._wait(resp.get('nsilcmop_id'))
                 print(resp['id'])
             else:
                 msg = ""
@@ -212,12 +251,13 @@ class Nsi(object):
             message="failed to create nsi: {} nst: {}\nerror:\n{}".format(
                     nsi_name,
                     nst_name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def list_op(self, name, filter=None):
         """Returns the list of operations of a NSI
         """
+        self._logger.debug("")
         nsi = self.get(name)
         try:
             self._apiResource = '/nsi_lcm_op_occs'
@@ -226,11 +266,11 @@ class Nsi(object):
             filter_string = ''
             if filter:
                 filter_string = '&{}'.format(filter)
-            http_code, resp = self._http.get2_cmd('{}?nsiInstanceId={}'.format(
+            http_code, resp = self._http.get2_cmd('{}?netsliceInstanceId={}'.format(
                                                        self._apiBase, nsi['_id'],
                                                        filter_string) )
-            #print 'HTTP CODE: {}'.format(http_code)
-            #print 'RESP: {}'.format(resp)
+            #print('HTTP CODE: {}'.format(http_code))
+            #print('RESP: {}'.format(resp))
             if http_code == 200:
                 if resp:
                     resp = json.loads(resp)
@@ -249,19 +289,21 @@ class Nsi(object):
         except ClientException as exc:
             message="failed to get operation list of NSI {}:\nerror:\n{}".format(
                     name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def get_op(self, operationId):
         """Returns the status of an operation
         """
+        self._logger.debug("")
+        self._client.get_token()
         try:
             self._apiResource = '/nsi_lcm_op_occs'
             self._apiBase = '{}{}{}'.format(self._apiName,
                                       self._apiVersion, self._apiResource)
             http_code, resp = self._http.get2_cmd('{}/{}'.format(self._apiBase, operationId))
-            #print 'HTTP CODE: {}'.format(http_code)
-            #print 'RESP: {}'.format(resp)
+            #print('HTTP CODE: {}'.format(http_code))
+            #print('RESP: {}'.format(resp))
             if http_code == 200:
                 if resp:
                     resp = json.loads(resp)
@@ -280,23 +322,24 @@ class Nsi(object):
         except ClientException as exc:
             message="failed to get status of operation {}:\nerror:\n{}".format(
                     operationId,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def exec_op(self, name, op_name, op_data=None):
         """Executes an operation on a NSI
         """
+        self._logger.debug("")
         nsi = self.get(name)
         try:
             self._apiResource = '/netslice_instances'
             self._apiBase = '{}{}{}'.format(self._apiName,
                                             self._apiVersion, self._apiResource)
             endpoint = '{}/{}/{}'.format(self._apiBase, nsi['_id'], op_name)
-            #print 'OP_NAME: {}'.format(op_name)
-            #print 'OP_DATA: {}'.format(json.dumps(op_data))
+            #print('OP_NAME: {}'.format(op_name))
+            #print('OP_DATA: {}'.format(json.dumps(op_data)))
             http_code, resp = self._http.post_cmd(endpoint=endpoint, postfields_dict=op_data)
-            #print 'HTTP CODE: {}'.format(http_code)
-            #print 'RESP: {}'.format(resp)
+            #print('HTTP CODE: {}'.format(http_code))
+            #print('RESP: {}'.format(resp))
             if http_code in (200, 201, 202, 204):
                 if resp:
                     resp = json.loads(resp)
@@ -315,6 +358,6 @@ class Nsi(object):
         except ClientException as exc:
             message="failed to exec operation {}:\nerror:\n{}".format(
                     name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)