Merge "Improve description of push policy for vFW" into casablanca
[integration.git] / test / vcpe / vcpecommon.py
index cac5219..980092c 100755 (executable)
@@ -10,7 +10,9 @@ import mysql.connector
 import requests
 import commands
 import time
-
+from novaclient import client as openstackclient
+from kubernetes import client, config
+from netaddr import IPAddress, IPNetwork
 
 class VcpeCommon:
     #############################################################################################
@@ -19,28 +21,32 @@ class VcpeCommon:
     external_net_prefix_len = 16
     #############################################################################################
     # set the openstack cloud access credentials here
+    oom_mode = True
+
     cloud = {
         '--os-auth-url': 'http://10.12.25.2:5000',
         '--os-username': 'kxi',
         '--os-user-domain-id': 'default',
         '--os-project-domain-id': 'default',
-        '--os-tenant-id': '1e097c6713e74fd7ac8e4295e605ee1e',
+        '--os-tenant-id': 'bc43d50ffcb84750bac0c1707a9a765b' if oom_mode else '1e097c6713e74fd7ac8e4295e605ee1e',
         '--os-region-name': 'RegionOne',
         '--os-password': 'n3JhGMGuDzD8',
-        '--os-project-domain-name': 'Integration-SB-07',
+        '--os-project-domain-name': 'Integration-SB-03' if oom_mode else 'Integration-SB-07',
         '--os-identity-api-version': '3'
     }
 
     common_preload_config = {
-        'oam_onap_net': 'oam_onap_lAky',
-        'oam_onap_subnet': 'oam_onap_lAky',
+        'oam_onap_net': 'oam_network_2No2' if oom_mode else 'oam_onap_lAky',
+        'oam_onap_subnet': 'oam_network_2No2' if oom_mode else 'oam_onap_lAky',
         'public_net': 'external',
         'public_net_id': '971040b2-7059-49dc-b220-4fab50cb2ad4'
     }
-    #     End: configurations that you must change for a new ONAP installation
+    sdnc_controller_pod = 'dev-sdnc-sdnc-0'
+
     #############################################################################################
 
     template_variable_symbol = '${'
+    cpe_vm_prefix = 'zdcpe'
     #############################################################################################
     # preloading network config
     #  key=network role
@@ -57,12 +63,38 @@ class VcpeCommon:
     global_subscriber_id = 'SDN-ETHERNET-INTERNET'
     project_name = 'Project-Demonstration'
     owning_entity_id = '520cc603-a3c4-4ec2-9ef4-ca70facd79c0'
-    owning_entity_name = 'OE-Demonstration'
+    owning_entity_name = 'OE-Demonstration1'
 
     def __init__(self, extra_host_names=None):
+        rootlogger = logging.getLogger()
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter('%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s')
+        handler.setFormatter(formatter)
+        rootlogger.addHandler(handler)
+        rootlogger.setLevel(logging.INFO)
+
         self.logger = logging.getLogger(__name__)
+        self.logger.propagate = False
+        self.logger.addHandler(handler)
+        self.logger.setLevel(logging.DEBUG)
         self.logger.info('Initializing configuration')
 
+        # CHANGEME: vgw_VfModuleModelInvariantUuid is in rescust service csar, look in service-VcpesvcRescust1118-template.yml for groups vgw module metadata. TODO: read this value automcatically
+        self.vgw_VfModuleModelInvariantUuid = '26d6a718-17b2-4ba8-8691-c44343b2ecd2'
+        # CHANGEME: OOM: this is the address that the brg and bng will nat for sdnc access - 10.0.0.x address of k8 host for sdnc-0 container
+        self.sdnc_oam_ip = self.get_pod_node_oam_ip('sdnc-sdnc-0')
+        # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP 
+        self.oom_so_sdnc_aai_ip = self.get_pod_node_public_ip('sdnc-sdnc-0')
+        # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP
+        self.oom_dcae_ves_collector = self.oom_so_sdnc_aai_ip
+        # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP
+        self.mr_ip_addr = self.oom_so_sdnc_aai_ip
+        self.mr_ip_port = '30227'
+        self.so_nbi_port = '30277' if self.oom_mode else '8080'
+        self.sdnc_preloading_port = '30202' if self.oom_mode else '8282'
+        self.aai_query_port = '30233' if self.oom_mode else '8443'
+        self.sniro_port = '30288' if self.oom_mode else '8080'
+
         self.host_names = ['so', 'sdnc', 'robot', 'aai-inst1', self.dcae_ves_collector_name]
         if extra_host_names:
             self.host_names.extend(extra_host_names)
@@ -70,6 +102,8 @@ class VcpeCommon:
         self.hosts = self.get_vm_ip(self.host_names, self.external_net_addr, self.external_net_prefix_len)
         # this is the keyword used to name vgw stack, must not be used in other stacks
         self.vgw_name_keyword = 'base_vcpe_vgw'
+        # this is the file that will keep the index of last assigned SO name
+        self.vgw_vfmod_name_index_file= '__var/vgw_vfmod_name_index'
         self.svc_instance_uuid_file = '__var/svc_instance_uuid'
         self.preload_dict_file = '__var/preload_dict'
         self.vgmux_vnf_name_file = '__var/vgmux_vnf_name'
@@ -86,7 +120,7 @@ class VcpeCommon:
         self.os_tenant_id = self.cloud['--os-tenant-id']
         self.os_region_name = self.cloud['--os-region-name']
         self.common_preload_config['pub_key'] = self.pub_key
-        self.sniro_url = 'http://' + self.hosts['robot'] + ':8080/__admin/mappings'
+        self.sniro_url = 'http://' + self.hosts['robot'] + ':' + self.sniro_port + '/__admin/mappings'
         self.sniro_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
         self.homing_solution = 'sniro'  # value is either 'sniro' or 'oof'
 #        self.homing_solution = 'oof'
@@ -105,22 +139,25 @@ class VcpeCommon:
         self.sdnc_db_port = '32774'
         self.sdnc_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
         self.sdnc_preload_network_url = 'http://' + self.hosts['sdnc'] + \
-                                        ':8282/restconf/operations/VNF-API:preload-network-topology-operation'
+                                        ':' + self.sdnc_preloading_port + '/restconf/operations/VNF-API:preload-network-topology-operation'
         self.sdnc_preload_vnf_url = 'http://' + self.hosts['sdnc'] + \
-                                    ':8282/restconf/operations/VNF-API:preload-vnf-topology-operation'
-        self.sdnc_ar_cleanup_url = 'http://' + self.hosts['sdnc'] + ':8282/restconf/config/GENERIC-RESOURCE-API:'
+                                    ':' + self.sdnc_preloading_port + '/restconf/operations/VNF-API:preload-vnf-topology-operation'
+        self.sdnc_preload_gra_url = 'http://' + self.hosts['sdnc'] + \
+                                    ':' + self.sdnc_preloading_port + '/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation'
+        self.sdnc_ar_cleanup_url = 'http://' + self.hosts['sdnc'] + ':' + self.sdnc_preloading_port + \
+                                   '/restconf/config/GENERIC-RESOURCE-API:'
 
         #############################################################################################
         # SO urls, note: do NOT add a '/' at the end of the url
-        self.so_req_api_url = {'v4': 'http://' + self.hosts['so'] + ':8080/ecomp/mso/infra/serviceInstances/v4',
-                           'v5': 'http://' + self.hosts['so'] + ':8080/ecomp/mso/infra/serviceInstances/v5'}
-        self.so_check_progress_api_url = 'http://' + self.hosts['so'] + ':8080/ecomp/mso/infra/orchestrationRequests/v5'
+        self.so_req_api_url = {'v4': 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/serviceInstantiation/v7/serviceInstances',
+                           'v5': 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/serviceInstantiation/v7/serviceInstances'}
+        self.so_check_progress_api_url = 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/orchestrationRequests/v6'
         self.so_userpass = 'InfraPortalClient', 'password1$'
         self.so_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
-        self.so_db_name = 'mso_catalog'
+        self.so_db_name = 'catalogdb'
         self.so_db_user = 'root'
         self.so_db_pass = 'password'
-        self.so_db_port = '32768'
+        self.so_db_port = '30252' if self.oom_mode else '32769'
 
         self.vpp_inf_url = 'http://{0}:8183/restconf/config/ietf-interfaces:interfaces'
         self.vpp_api_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
@@ -132,13 +169,21 @@ class VcpeCommon:
         Add vserver information to AAI
         """
         self.logger.info('Adding vServer information to AAI for {0}'.format(openstack_stack_name))
-        cmd = '/opt/demo.sh heatbridge {0} {1} vCPE'.format(openstack_stack_name, svc_instance_uuid)
-        ret = commands.getstatusoutput("ssh -i onap_dev root@{0} '{1}'".format(self.hosts['robot'], cmd))
-        self.logger.debug('%s', ret)
+        if not self.oom_mode:
+            cmd = '/opt/demo.sh heatbridge {0} {1} vCPE'.format(openstack_stack_name, svc_instance_uuid)
+            ret = commands.getstatusoutput("ssh -i onap_dev root@{0} '{1}'".format(self.hosts['robot'], cmd))
+            self.logger.debug('%s', ret)
+        else:
+            print('To add vGMUX vserver info to AAI, do the following:')
+            print('- ssh to rancher')
+            print('- sudo su -')
+            print('- cd /root/oom/kubernetes/robot')
+            print('- ./demo-k8s.sh onap heatbridge {0} {1} vCPE'.format(openstack_stack_name, svc_instance_uuid))
 
     def get_brg_mac_from_sdnc(self):
         """
-        :return:  BRG MAC address. Currently we only support one BRG instance.
+        Check table DHCP_MAP in the SDNC DB. Find the newly instantiated BRG MAC address.
+        Note that there might be multiple BRGs, the most recently instantiated BRG always has the largest IP address.
         """
         cnx = mysql.connector.connect(user=self.sdnc_db_user, password=self.sdnc_db_pass, database=self.sdnc_db_name,
                                       host=self.hosts['sdnc'], port=self.sdnc_db_port)
@@ -147,36 +192,30 @@ class VcpeCommon:
         cursor.execute(query)
 
         self.logger.debug('DHCP_MAP table in SDNC')
-        counter = 0
-        mac = None
+        mac_recent = None
+        host = -1
         for mac, ip in cursor:
-            counter += 1
             self.logger.debug(mac + ':' + ip)
+            this_host = int(ip.split('.')[-1])
+            if host < this_host:
+                host = this_host
+                mac_recent = mac
 
         cnx.close()
 
-        if counter != 1:
-            self.logger.error('Found %s MAC addresses in DHCP_MAP', counter)
-            sys.exit()
-        else:
-            self.logger.debug('Found MAC addresses in DHCP_MAP: %s', mac)
-            return mac
+        assert mac_recent
+        return mac_recent
 
-    def insert_into_sdnc_db(self, cmds):
-        cnx = mysql.connector.connect(user=self.sdnc_db_user, password=self.sdnc_db_pass, database=self.sdnc_db_name,
-                                      host=self.hosts['sdnc'], port=self.sdnc_db_port)
-        cursor = cnx.cursor()
-        for cmd in cmds:
-            self.logger.debug(cmd)
-            cursor.execute(cmd)
-            self.logger.debug('%s', cursor)
-        cnx.commit()
-        cursor.close()
-        cnx.close()
+    def execute_cmds_sdnc_db(self, cmds):
+        self.execute_cmds_db(cmds, self.sdnc_db_user, self.sdnc_db_pass, self.sdnc_db_name,
+                             self.hosts['sdnc'], self.sdnc_db_port)
+
+    def execute_cmds_so_db(self, cmds):
+        self.execute_cmds_db(cmds, self.so_db_user, self.so_db_pass, self.so_db_name,
+                             self.hosts['so'], self.so_db_port)
 
-    def insert_into_so_db(self, cmds):
-        cnx = mysql.connector.connect(user=self.so_db_user, password=self.so_db_pass, database=self.so_db_name,
-                                      host=self.hosts['so'], port=self.so_db_port)
+    def execute_cmds_db(self, cmds, dbuser, dbpass, dbname, host, port):
+        cnx = mysql.connector.connect(user=dbuser, password=dbpass, database=dbname, host=host, port=port)
         cursor = cnx.cursor()
         for cmd in cmds:
             self.logger.debug(cmd)
@@ -265,8 +304,8 @@ class VcpeCommon:
             logging.error('Invalid node_type: ' + node_type)
             sys.exit()
 
-        url = 'https://{0}:8443/aai/v11/search/nodes-query?search-node-type={1}&filter={2}:EQUALS:{3}'.format(
-            self.hosts['aai-inst1'], search_node_type, key, node_uuid)
+        url = 'https://{0}:{1}/aai/v11/search/nodes-query?search-node-type={2}&filter={3}:EQUALS:{4}'.format(
+            self.hosts['aai-inst1'], self.aai_query_port, search_node_type, key, node_uuid)
 
         headers = {'Content-Type': 'application/json', 'Accept': 'application/json', 'X-FromAppID': 'vCPE-Robot', 'X-TransactionId': 'get_aai_subscr'}
         requests.packages.urllib3.disable_warnings()
@@ -292,6 +331,66 @@ class VcpeCommon:
                 return str(ip)
         return None
 
+    def get_pod_node_oam_ip(self, pod):
+        """
+        :Assuming kubectl is available and configured by default config (~/.kube/config) 
+        :param pod: pod name substring, e.g. 'sdnc-sdnc-0'
+        :return pod's cluster node oam ip (10.0.0.0/16)
+        """
+        ret = None
+        config.load_kube_config()
+        api = client.CoreV1Api()
+        kslogger = logging.getLogger('kubernetes')
+        kslogger.setLevel(logging.INFO)
+        res = api.list_pod_for_all_namespaces()
+        for i in res.items:
+            if pod in i.metadata.name:
+                self.logger.debug("found {0}\t{1}\t{2}".format(i.metadata.name, i.status.host_ip, i.spec.node_name))
+                ret = i.status.host_ip
+                break
+
+        if ret is None:
+            ret = raw_input("Enter sdnc-sdnc-0 pod cluster node OAM IP address(10.0.0.0/16): ")
+        return ret
+
+    def get_pod_node_public_ip(self, pod):
+        """
+        :Assuming kubectl is available and configured by default config (~/.kube/config) 
+        :param pod: pod name substring, e.g. 'sdnc-sdnc-0'
+        :return pod's cluster node public ip (i.e. 10.12.0.0/16)
+        """
+        ret = None
+        config.load_kube_config()
+        api = client.CoreV1Api()
+        kslogger = logging.getLogger('kubernetes')
+        kslogger.setLevel(logging.INFO)
+        res = api.list_pod_for_all_namespaces()
+        for i in res.items:
+            if pod in i.metadata.name:
+                ret = self.get_vm_public_ip_by_nova(i.spec.node_name)
+                self.logger.debug("found node {0} public ip: {1}".format(i.spec.node_name, ret))
+                break
+
+        if ret is None:
+            ret = raw_input("Enter sdnc-sdnc-0 pod cluster node public IP address(i.e. 10.12.0.0/16): ")
+        return ret
+
+    def get_vm_public_ip_by_nova(self, vm):
+        """
+        This method uses openstack nova api to retrieve vm public ip
+        :param vm: vm name
+        :return vm public ip
+        """
+        subnet = IPNetwork('{0}/{1}'.format(self.external_net_addr, self.external_net_prefix_len))
+        nova = openstackclient.Client(2, self.cloud['--os-username'], self.cloud['--os-password'], self.cloud['--os-tenant-id'], self.cloud['--os-auth-url']) 
+        for i in nova.servers.list():
+            if i.name == vm:
+                for k, v in i.networks.items():
+                    for ip in v:
+                        if IPAddress(ip) in subnet:
+                            return ip
+        return None
+
     def get_vm_ip(self, keywords, net_addr=None, net_addr_len=None):
         """
         :param keywords: list of keywords to search for vm, e.g. ['bng', 'gmux', 'brg']
@@ -309,25 +408,71 @@ class VcpeCommon:
         openstackcmd = 'nova ' + param + ' list'
         self.logger.debug(openstackcmd)
 
-        ip_dict = {}
         results = os.popen(openstackcmd).read()
-        for line in results.split('\n'):
-            fields = line.split('|')
-            if len(fields) == 8:
-                vm_name = fields[2]
-                ip_info = fields[-2]
-                for keyword in keywords:
-                    if keyword in vm_name:
-                        ip = self.extract_ip_from_str(net_addr, net_addr_len, ip_info)
-                        if ip:
-                            ip_dict[keyword] = ip
+        all_vm_ip_dict = self.extract_vm_ip_as_dict(results, net_addr, net_addr_len)
+        latest_vm_list = self.remove_old_vms(all_vm_ip_dict.keys(), self.cpe_vm_prefix)
+        latest_vm_ip_dict = {vm: all_vm_ip_dict[vm] for vm in latest_vm_list}
+        ip_dict = self.select_subset_vm_ip(latest_vm_ip_dict, keywords)
+        if self.oom_mode:
+            ip_dict.update(self.get_oom_onap_vm_ip(keywords))
+
         if len(ip_dict) != len(keywords):
             self.logger.error('Cannot find all desired IP addresses for %s.', keywords)
             self.logger.error(json.dumps(ip_dict, indent=4, sort_keys=True))
-            self.logger.error('Temporarily continue.. remember to check back vcpecommon.py line: 316')
+            self.logger.error('Temporarily continue.. remember to check back vcpecommon.py line: 396')
 #            sys.exit()
         return ip_dict
 
+    def get_oom_onap_vm_ip(self, keywords):
+        vm_ip = {}
+        onap_vm_list = set(['so', 'sdnc', 'aai-inst1', 'robot', self.dcae_ves_collector_name])
+        for vm in keywords:
+            if vm in onap_vm_list:
+                vm_ip[vm] = self.oom_so_sdnc_aai_ip
+        return vm_ip
+
+    def extract_vm_ip_as_dict(self, novalist_results, net_addr, net_addr_len):
+        vm_ip_dict = {}
+        for line in novalist_results.split('\n'):
+            fields = line.split('|')
+            if len(fields) == 8:
+                vm_name = fields[2]
+                ip_info = fields[-2]
+                ip = self.extract_ip_from_str(net_addr, net_addr_len, ip_info)
+                vm_ip_dict[vm_name] = ip
+
+        return vm_ip_dict
+
+    def remove_old_vms(self, vm_list, prefix):
+        """
+        For vms with format name_timestamp, only keep the one with the latest timestamp.
+        E.g.,
+            zdcpe1cpe01brgemu01_201805222148        (drop this)
+            zdcpe1cpe01brgemu01_201805222229        (keep this)
+            zdcpe1cpe01gw01_201805162201
+        """
+        new_vm_list = []
+        same_type_vm_dict = {}
+        for vm in vm_list:
+            fields = vm.split('_')
+            if vm.startswith(prefix) and len(fields) == 2 and len(fields[-1]) == len('201805222148') and fields[-1].isdigit():
+                if vm > same_type_vm_dict.get(fields[0], '0'):
+                    same_type_vm_dict[fields[0]] = vm
+            else:
+                new_vm_list.append(vm)
+
+        new_vm_list.extend(same_type_vm_dict.values())
+        return new_vm_list
+
+    def select_subset_vm_ip(self, all_vm_ip_dict, vm_name_keyword_list):
+        vm_ip_dict = {}
+        for keyword in vm_name_keyword_list:
+            for vm, ip in all_vm_ip_dict.items():
+                if keyword in vm:
+                    vm_ip_dict[keyword] = ip
+                    break
+        return vm_ip_dict
+
     def del_vgmux_ves_mode(self):
         url = self.vpp_ves_url.format(self.hosts['mux']) + '/mode'
         r = requests.delete(url, headers=self.vpp_api_headers, auth=self.vpp_api_userpass)
@@ -342,7 +487,7 @@ class VcpeCommon:
         url = self.vpp_ves_url.format(self.hosts['mux'])
         data = {'config':
                     {'server-addr': self.hosts[self.dcae_ves_collector_name],
-                     'server-port': '8081',
+                     'server-port': '30235' if self.oom_mode else '8081',
                      'read-interval': '10',
                      'is-add':'1'
                      }
@@ -412,6 +557,26 @@ class VcpeCommon:
         with open(filepathname, 'rb') as fin:
             return pickle.load(fin)
 
+    @staticmethod
+    def increase_ip_address_or_vni_in_template(vnf_template_file, vnf_parameter_name_list):
+        with open(vnf_template_file) as json_input:
+            json_data = json.load(json_input)
+            param_list = json_data['VNF-API:input']['VNF-API:vnf-topology-information']['VNF-API:vnf-parameters']
+            for param in param_list:
+                if param['vnf-parameter-name'] in vnf_parameter_name_list:
+                    ipaddr_or_vni = param['vnf-parameter-value'].split('.')
+                    number = int(ipaddr_or_vni[-1])
+                    if 254 == number:
+                        number = 10
+                    else:
+                        number = number + 1
+                    ipaddr_or_vni[-1] = str(number)
+                    param['vnf-parameter-value'] = '.'.join(ipaddr_or_vni)
+
+        assert json_data is not None
+        with open(vnf_template_file, 'w') as json_output:
+            json.dump(json_data, json_output, indent=4, sort_keys=True)
+
     def save_preload_data(self, preload_data):
         self.save_object(preload_data, self.preload_dict_file)