Adding logging capabilities to osmclient
[osm/osmclient.git] / osmclient / sol005 / ns.py
index bda7c3e..381ad42 100644 (file)
@@ -19,10 +19,12 @@ OSM ns 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 Ns(object):
@@ -30,15 +32,32 @@ class Ns(object):
     def __init__(self, http=None, client=None):
         self._http = http
         self._client = client
+        self._logger = logging.getLogger('osmclient')
         self._apiName = '/nslcm'
         self._apiVersion = '/v1'
         self._apiResource = '/ns_instances_content'
         self._apiBase = '{}{}{}'.format(self._apiName,
                                         self._apiVersion, self._apiResource)
 
+    # NS '--wait' option
+    def _wait(self, id, deleteFlag=False):
+        self._logger.debug("")
+        # Endpoint to get operation status
+        apiUrlStatus = '{}{}{}'.format(self._apiName, self._apiVersion, '/ns_lcm_op_occs')
+        # Wait for status for NS instance creation/update/deletion
+        WaitForStatus.wait_for_status(
+            'NS',
+            str(id),
+            WaitForStatus.TIMEOUT_NS_OPERATION,
+            apiUrlStatus,
+            self._http.get2_cmd,
+            deleteFlag=deleteFlag)
+
     def list(self, filter=None):
         """Returns a list of NS
         """
+        self._logger.debug("")
+        self._client.get_token()
         filter_string = ''
         if filter:
             filter_string = '?{}'.format(filter)
@@ -50,6 +69,8 @@ class Ns(object):
     def get(self, name):
         """Returns an NS based on name or id
         """
+        self._logger.debug("")
+        self._client.get_token()
         if utils.validate_uuid4(name):
             for ns in self.list():
                 if name == ns['_id']:
@@ -61,6 +82,8 @@ class Ns(object):
         raise NotFound("ns {} not found".format(name))
 
     def get_individual(self, name):
+        self._logger.debug("")
+        self._client.get_token()
         ns_id = name
         if not utils.validate_uuid4(name):
             for ns in self.list():
@@ -69,22 +92,28 @@ class Ns(object):
                     break
         resp = self._http.get_cmd('{}/{}'.format(self._apiBase, ns_id))
         #resp = self._http.get_cmd('{}/{}/nsd_content'.format(self._apiBase, ns_id))
-        #print yaml.safe_dump(resp)
+        #print(yaml.safe_dump(resp))
         if resp:
             return resp
         raise NotFound("ns {} not found".format(name))
 
-    def delete(self, name, force=False):
+    def delete(self, name, force=False, wait=False):
+        self._logger.debug("")
         ns = self.get(name)
         querystring = ''
         if force:
             querystring = '?FORCE=True'
         http_code, resp = self._http.delete_cmd('{}/{}{}'.format(self._apiBase,
-                                         ns['_id'], querystring))
-        #print 'HTTP CODE: {}'.format(http_code)
-        #print 'RESP: {}'.format(resp)
+                                                 ns['_id'], querystring))
+        # 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)
+                # 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 +127,16 @@ class Ns(object):
 
     def create(self, nsd_name, nsr_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()
         nsd = self._client.nsd.get(nsd_name)
 
         vim_account_id = {}
+        wim_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]
 
@@ -114,6 +146,19 @@ class Ns(object):
             vim_account_id[vim_account] = vim['_id']
             return vim['_id']
 
+        def get_wim_account_id(wim_account):
+            self._logger.debug("")
+            if not isinstance(wim_account, str):
+                return wim_account
+            if wim_account_id.get(wim_account):
+                return wim_account_id[wim_account]
+
+            wim = self._client.wim.get(wim_account)
+            if wim is None:
+                raise NotFound("cannot find wim account '{}'".format(wim_account))
+            wim_account_id[wim_account] = wim['_id']
+            return wim['_id']
+
         ns = {}
         ns['nsdId'] = nsd['_id']
         ns['nsName'] = nsr_name
@@ -129,7 +174,7 @@ class Ns(object):
                 with open(pubkeyfile, 'r') as f:
                     ns['ssh_keys'].append(f.read())
         if config:
-            ns_config = yaml.load(config)
+            ns_config = yaml.safe_load(config)
             if "vim-network-name" in ns_config:
                 ns_config["vld"] = ns_config.pop("vim-network-name")
             if "vld" in ns_config:
@@ -140,15 +185,35 @@ class Ns(object):
                             for vim_account, vim_net in list(vld["vim-network-name"].items()):
                                 vim_network_name_dict[get_vim_account_id(vim_account)] = vim_net
                             vld["vim-network-name"] = vim_network_name_dict
+                    if "wim_account" in vld and vld["wim_account"] is not None:
+                        vld["wimAccountId"] = get_wim_account_id(vld.pop("wim_account"))
                 ns["vld"] = ns_config["vld"]
             if "vnf" in ns_config:
                 for vnf in ns_config["vnf"]:
                     if vnf.get("vim_account"):
                         vnf["vimAccountId"] = get_vim_account_id(vnf.pop("vim_account"))
-
                 ns["vnf"] = ns_config["vnf"]
 
-        #print yaml.safe_dump(ns)
+            if "additionalParamsForNs" in ns_config:
+                ns["additionalParamsForNs"] = ns_config.pop("additionalParamsForNs")
+                if not isinstance(ns["additionalParamsForNs"], dict):
+                    raise ValueError("Error at --config 'additionalParamsForNs' must be a dictionary")
+            if "additionalParamsForVnf" in ns_config:
+                ns["additionalParamsForVnf"] = ns_config.pop("additionalParamsForVnf")
+                if not isinstance(ns["additionalParamsForVnf"], list):
+                    raise ValueError("Error at --config 'additionalParamsForVnf' must be a list")
+                for additional_param_vnf in ns["additionalParamsForVnf"]:
+                    if not isinstance(additional_param_vnf, dict):
+                        raise ValueError("Error at --config 'additionalParamsForVnf' items must be dictionaries")
+                    if not additional_param_vnf.get("member-vnf-index"):
+                        raise ValueError("Error at --config 'additionalParamsForVnf' items must contain "
+                                         "'member-vnf-index'")
+            if "wim_account" in ns_config:
+                wim_account = ns_config.pop("wim_account")
+                if wim_account is not None:
+                    ns['wimAccountId'] = get_wim_account_id(wim_account)
+
+        # print(yaml.safe_dump(ns))
         try:
             self._apiResource = '/ns_instances_content'
             self._apiBase = '{}{}{}'.format(self._apiName,
@@ -160,14 +225,17 @@ class Ns(object):
             self._http.set_http_header(http_header)
             http_code, resp = self._http.post_cmd(endpoint=self._apiBase,
                                        postfields_dict=ns)
-            #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 NS instance creation
+                    self._wait(resp.get('nslcmop_id'))
                 return resp['id']
             else:
                 msg = ""
@@ -181,12 +249,13 @@ class Ns(object):
             message="failed to create ns: {} nsd: {}\nerror:\n{}".format(
                     nsr_name,
                     nsd_name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def list_op(self, name, filter=None):
         """Returns the list of operations of a NS
         """
+        self._logger.debug("")
         ns = self.get(name)
         try:
             self._apiResource = '/ns_lcm_op_occs'
@@ -198,8 +267,8 @@ class Ns(object):
             http_code, resp = self._http.get2_cmd('{}?nsInstanceId={}'.format(
                                                        self._apiBase, ns['_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)
@@ -218,19 +287,21 @@ class Ns(object):
         except ClientException as exc:
             message="failed to get operation list of NS {}:\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 = '/ns_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)
@@ -249,30 +320,36 @@ class Ns(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):
+    def exec_op(self, name, op_name, op_data=None, wait=False, ):
         """Executes an operation on a NS
         """
+        self._logger.debug("")
         ns = self.get(name)
         try:
+            ns = self.get(name)
             self._apiResource = '/ns_instances'
             self._apiBase = '{}{}{}'.format(self._apiName,
                                             self._apiVersion, self._apiResource)
             endpoint = '{}/{}/{}'.format(self._apiBase, ns['_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)
                 if not resp or 'id' not in resp:
                     raise ClientException('unexpected response from server - {}'.format(
                                       resp))
-                print(resp['id'])
+                if wait:
+                    # Wait for status for NS instance action
+                    # For the 'action' operation, 'id' is used
+                    self._wait(resp.get('id'))
+                return resp['id']
             else:
                 msg = ""
                 if resp:
@@ -284,12 +361,14 @@ class Ns(object):
         except ClientException as exc:
             message="failed to exec operation {}:\nerror:\n{}".format(
                     name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
-    def scale_vnf(self, ns_name, vnf_name, scaling_group, scale_in, scale_out):
+    def scale_vnf(self, ns_name, vnf_name, scaling_group, scale_in, scale_out, wait=False):
         """Scales a VNF by adding/removing VDUs
         """
+        self._logger.debug("")
+        self._client.get_token()
         try:
             op_data={}
             op_data["scaleType"] = "SCALE_VNF"
@@ -302,21 +381,24 @@ class Ns(object):
                 "member-vnf-index": vnf_name,
                 "scaling-group-descriptor": scaling_group,
             }
-            self.exec_op(ns_name, op_name='scale', op_data=op_data)
+            op_id = self.exec_op(ns_name, op_name='scale', op_data=op_data, wait=wait)
+            print(str(op_id))
         except ClientException as exc:
             message="failed to scale vnf {} of ns {}:\nerror:\n{}".format(
-                    vnf_name, ns_name, exc.message)
+                    vnf_name, ns_name, str(exc))
             raise ClientException(message)
 
     def create_alarm(self, alarm):
+        self._logger.debug("")
+        self._client.get_token()
         data = {}
         data["create_alarm_request"] = {}
         data["create_alarm_request"]["alarm_create_request"] = alarm
         try:
             http_code, resp = self._http.post_cmd(endpoint='/test/message/alarm_request',
                                        postfields_dict=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):
                 #resp = json.loads(resp)
                 print('Alarm created')
@@ -332,10 +414,12 @@ class Ns(object):
         except ClientException as exc:
             message="failed to create alarm: alarm {}\n{}".format(
                     alarm,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def delete_alarm(self, name):
+        self._logger.debug("")
+        self._client.get_token()
         data = {}
         data["delete_alarm_request"] = {}
         data["delete_alarm_request"]["alarm_delete_request"] = {}
@@ -343,8 +427,8 @@ class Ns(object):
         try:
             http_code, resp = self._http.post_cmd(endpoint='/test/message/alarm_request',
                                        postfields_dict=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):
                 #resp = json.loads(resp)
                 print('Alarm deleted')
@@ -360,17 +444,19 @@ class Ns(object):
         except ClientException as exc:
             message="failed to delete alarm: alarm {}\n{}".format(
                     name,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def export_metric(self, metric):
+        self._logger.debug("")
+        self._client.get_token()
         data = {}
         data["read_metric_data_request"] = metric
         try:
             http_code, resp = self._http.post_cmd(endpoint='/test/message/metric_request',
                                        postfields_dict=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):
                 #resp = json.loads(resp)
                 return 'Metric exported'
@@ -386,11 +472,13 @@ class Ns(object):
         except ClientException as exc:
             message="failed to export metric: metric {}\n{}".format(
                     metric,
-                    exc.message)
+                    str(exc))
             raise ClientException(message)
 
     def get_field(self, ns_name, field):
+        self._logger.debug("")
         nsr = self.get(ns_name)
+        print(yaml.safe_dump(nsr))
         if nsr is None:
             raise NotFound("failed to retrieve ns {}".format(ns_name))
 
@@ -398,3 +486,4 @@ class Ns(object):
             return nsr[field]
 
         raise NotFound("failed to find {} in ns {}".format(field, ns_name))
+