Feature 7181: Provide real-time feedback in CLI upon request using the '--wait' option
[osm/osmclient.git] / osmclient / sol005 / ns.py
index c60baa0..0e178c2 100644 (file)
@@ -19,6 +19,7 @@ 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
@@ -36,6 +37,19 @@ class Ns(object):
         self._apiBase = '{}{}{}'.format(self._apiName,
                                         self._apiVersion, self._apiResource)
 
+    # NS '--wait' option
+    def _wait(self, id, deleteFlag=False):
+        # 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
         """
@@ -74,17 +88,22 @@ class Ns(object):
             return resp
         raise NotFound("ns {} not found".format(name))
 
-    def delete(self, name, force=False):
+    def delete(self, name, force=False, wait=False):
         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,11 +117,12 @@ 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):
 
         nsd = self._client.nsd.get(nsd_name)
 
         vim_account_id = {}
+        wim_account_id = {}
 
         def get_vim_account_id(vim_account):
             if vim_account_id.get(vim_account):
@@ -114,6 +134,18 @@ class Ns(object):
             vim_account_id[vim_account] = vim['_id']
             return vim['_id']
 
+        def get_wim_account_id(wim_account):
+            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
@@ -124,16 +156,10 @@ class Ns(object):
         #ns['userdata']['key2']='value2'
 
         if ssh_keys is not None:
-            # ssh_keys is comma separate list
-            # ssh_keys_format = []
-            # for key in ssh_keys.split(','):
-            #     ssh_keys_format.append({'key-pair-ref': key})
-            #
-            # ns['ssh-authorized-key'] = ssh_keys_format
-            ns['ssh-authorized-key'] = []
+            ns['ssh_keys'] = []
             for pubkeyfile in ssh_keys.split(','):
                 with open(pubkeyfile, 'r') as f:
-                    ns['ssh-authorized-key'].append(f.read())
+                    ns['ssh_keys'].append(f.read())
         if config:
             ns_config = yaml.load(config)
             if "vim-network-name" in ns_config:
@@ -146,30 +172,61 @@ 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 not additional_param_vnf.get("additionalParams"):
+                        raise ValueError("Error at --config 'additionalParamsForVnf' items must contain "
+                                         "'additionalParams'")
+            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,
                                             self._apiVersion, self._apiResource)
+            headers = self._client._headers
+            headers['Content-Type'] = 'application/yaml'
+            http_header = ['{}: {}'.format(key,val)
+                          for (key,val) in list(headers.items())]
+            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))
-                print(resp['id'])
+                if wait:
+                    # Wait for status for NS instance creation
+                    self._wait(resp.get('nslcmop_id'))
+                return resp['id']
             else:
                 msg = ""
                 if resp:
@@ -253,7 +310,7 @@ class Ns(object):
                     exc.message)
             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
         """
         ns = self.get(name)
@@ -273,6 +330,10 @@ class Ns(object):
                 if not resp or 'id' not in resp:
                     raise ClientException('unexpected response from server - {}'.format(
                                       resp))
+                if wait:
+                    # Wait for status for NS instance action
+                    # For the 'action' operation, 'id' is used
+                    self._wait(resp.get('id'))
                 print(resp['id'])
             else:
                 msg = ""
@@ -288,6 +349,27 @@ class Ns(object):
                     exc.message)
             raise ClientException(message)
 
+    def scale_vnf(self, ns_name, vnf_name, scaling_group, scale_in, scale_out, wait=False):
+        """Scales a VNF by adding/removing VDUs
+        """
+        try:
+            op_data={}
+            op_data["scaleType"] = "SCALE_VNF"
+            op_data["scaleVnfData"] = {}
+            if scale_in:
+                op_data["scaleVnfData"]["scaleVnfType"] = "SCALE_IN"
+            else:
+                op_data["scaleVnfData"]["scaleVnfType"] = "SCALE_OUT"
+            op_data["scaleVnfData"]["scaleByStepData"] = {
+                "member-vnf-index": vnf_name,
+                "scaling-group-descriptor": scaling_group,
+            }
+            self.exec_op(ns_name, op_name='scale', op_data=op_data, wait=wait)
+        except ClientException as exc:
+            message="failed to scale vnf {} of ns {}:\nerror:\n{}".format(
+                    vnf_name, ns_name, exc.message)
+            raise ClientException(message)
+
     def create_alarm(self, alarm):
         data = {}
         data["create_alarm_request"] = {}
@@ -369,3 +451,12 @@ class Ns(object):
                     exc.message)
             raise ClientException(message)
 
+    def get_field(self, ns_name, field):
+        nsr = self.get(ns_name)
+        if nsr is None:
+            raise NotFound("failed to retrieve ns {}".format(ns_name))
+
+        if field in nsr:
+            return nsr[field]
+
+        raise NotFound("failed to find {} in ns {}".format(field, ns_name))