robotframework-onap/vcpeutils/vcpecommon.py

   1 import json
   2 import logging
   3 import os
   4 import pickle
   5 import re
   6 import sys
   7
   8 import ipaddress
   9 import requests
  10
  11
  12 class VcpeCommon:
  13     #############################################################################################
  14     #     Start: configurations that you must change for a new ONAP installation
  15     external_net_addr = '10.12.0.0'
  16     external_net_prefix_len = 16
  17     #############################################################################################
  18     # set the openstack cloud access credentials here
  19     oom_mode = True
  20
  21     cloud = {
  22         '--os-auth-url': 'http://10.12.25.2:5000',
  23         '--os-username': 'kxi',
  24         '--os-user-domain-id': 'default',
  25         '--os-project-domain-id': 'default',
  26         '--os-tenant-id': '09d8566ea45e43aa974cf447ed591d77' if oom_mode else '1e097c6713e74fd7ac8e4295e605ee1e',
  27         '--os-region-name': 'RegionOne',
  28         '--os-password': 'n3JhGMGuDzD8',
  29         '--os-project-domain-name': 'Integration-SB-03' if oom_mode else 'Integration-SB-07',
  30         '--os-identity-api-version': '3'
  31     }
  32
  33     common_preload_config = {
  34         'oam_onap_net': 'oam_network_2No2' if oom_mode else 'oam_onap_lAky',
  35         'oam_onap_subnet': 'oam_network_2No2' if oom_mode else 'oam_onap_lAky',
  36         'public_net': 'external',
  37         'public_net_id': '971040b2-7059-49dc-b220-4fab50cb2ad4'
  38     }
  39     sdnc_controller_pod = 'dev-sdnc-sdnc-0'
  40
  41     #############################################################################################
  42
  43     template_variable_symbol = '${'
  44     cpe_vm_prefix = 'zdcpe'
  45     #############################################################################################
  46     # preloading network config
  47     #  key=network role
  48     #  value = [subnet_start_ip, subnet_gateway_ip]
  49     preload_network_config = {
  50         'cpe_public': ['10.2.0.2', '10.2.0.1'],
  51         'cpe_signal': ['10.4.0.2', '10.4.0.1'],
  52         'brg_bng': ['10.3.0.2', '10.3.0.1'],
  53         'bng_mux': ['10.1.0.10', '10.1.0.1'],
  54         'mux_gw': ['10.5.0.10', '10.5.0.1']
  55     }
  56
  57     dcae_ves_collector_name = 'dcae-bootstrap'
  58     global_subscriber_id = 'Demonstration'
  59     project_name = 'Project-Demonstration'
  60     owning_entity_id = '520cc603-a3c4-4ec2-9ef4-ca70facd79c0'
  61     owning_entity_name = 'OE-Demonstration1'
  62
  63     def __init__(self, extra_host_names=None):
  64         rootlogger = logging.getLogger()
  65         handler = logging.StreamHandler()
  66         formatter = logging.Formatter('%(asctime)s %(levelname)s %(name)s.%(funcName)s(): %(message)s')
  67         handler.setFormatter(formatter)
  68         rootlogger.addHandler(handler)
  69         rootlogger.setLevel(logging.INFO)
  70
  71         self.logger = logging.getLogger(__name__)
  72         self.logger.propagate = False
  73         self.logger.addHandler(handler)
  74         self.logger.setLevel(logging.DEBUG)
  75         self.logger.info('Initializing configuration')
  76
  77         # CHANGEME: vgw_VfModuleModelInvariantUuid is in rescust service csar, look in service-VcpesvcRescust1118-template.yml for groups vgw module metadata. TODO: read this value automcatically
  78         self.vgw_VfModuleModelInvariantUuid = '26d6a718-17b2-4ba8-8691-c44343b2ecd2'
  79         # 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
  80         #self.sdnc_oam_ip = self.get_pod_node_oam_ip('sdnc-sdnc-0')
  81         self.sdnc_oam_ip = 'sdnc.onap'
  82         # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP
  83         #self.oom_so_sdnc_aai_ip = self.get_pod_node_public_ip('sdnc-sdnc-0')
  84         #self.oom_so_sdnc_aai_ip = self.get_pod_node_public_ip('sdnc-sdnc-0')
  85         # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP
  86         #self.oom_dcae_ves_collector = self.oom_so_sdnc_aai_ip
  87         # CHANGEME: OOM: this is a k8s host external IP, e.g. oom-k8s-01 IP
  88         #self.mr_ip_addr = self.oom_so_sdnc_aai_ip
  89         self.mr_ip_addr = 'mr.onap'
  90         #self.mr_ip_port = '30227'
  91         self.mr_ip_port = '3904'
  92         #self.so_nbi_port = '30277' if self.oom_mode else '8080'
  93         self.so_nbi_port = '8080'
  94         #self.sdnc_preloading_port = '30202' if self.oom_mode else '8282'
  95         self.sdnc_preloading_port = '8282'
  96         #self.aai_query_port = '30233' if self.oom_mode else '8443'
  97         self.aai_query_port = '8443'
  98         #self.sniro_port = '30288' if self.oom_mode else '8080'
  99         self.sniro_port = '8080'
 100
 101         self.host_names = ['so', 'sdnc', 'robot', 'aai', self.dcae_ves_collector_name]
 102         if extra_host_names:
 103             self.host_names.extend(extra_host_names)
 104         # get IP addresses
 105         #self.hosts = self.get_vm_ip(self.host_names, self.external_net_addr, self.external_net_prefix_len)
 106         self.hosts = { 'so': 'so.onap', 'sdnc': 'sdnc.onap', 'robot': 'robot.onap', 'aai': 'aai.onap' }
 107         # this is the keyword used to name vgw stack, must not be used in other stacks
 108         self.vgw_name_keyword = 'base_vcpe_vgw'
 109         # this is the file that will keep the index of last assigned SO name
 110         self.vgw_vfmod_name_index_file= '__var/vgw_vfmod_name_index'
 111         self.svc_instance_uuid_file = '__var/svc_instance_uuid'
 112         self.preload_dict_file = '__var/preload_dict'
 113         self.vgmux_vnf_name_file = '__var/vgmux_vnf_name'
 114         self.product_family_id = 'f9457e8c-4afd-45da-9389-46acd9bf5116'
 115         self.custom_product_family_id = 'a9a77d5a-123e-4ca2-9eb9-0b015d2ee0fb'
 116         self.instance_name_prefix = {
 117             'service': 'svc',
 118             'network': 'net',
 119             'vnf': 'vnf',
 120             'vfmodule': 'vf'
 121         }
 122         self.aai_userpass = 'AAI', 'AAI'
 123         self.pub_key = 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKXDgoo3+WOqcUG8/5uUbk81+yczgwC4Y8ywTmuQqbNxlY1oQ0YxdMUqUnhitSXs5S/yRuAVOYHwGg2mCs20oAINrP+mxBI544AMIb9itPjCtgqtE2EWo6MmnFGbHB4Sx3XioE7F4VPsh7japsIwzOjbrQe+Mua1TGQ5d4nfEOQaaglXLLPFfuc7WbhbJbK6Q7rHqZfRcOwAMXgDoBqlyqKeiKwnumddo2RyNT8ljYmvB6buz7KnMinzo7qB0uktVT05FH9Rg0CTWH5norlG5qXgP2aukL0gk1ph8iAt7uYLf1ktp+LJI2gaF6L0/qli9EmVCSLr1uJ38Q8CBflhkh'
 124         self.os_tenant_id = self.cloud['--os-tenant-id']
 125         self.os_region_name = self.cloud['--os-region-name']
 126         self.common_preload_config['pub_key'] = self.pub_key
 127         self.sniro_url = 'http://' + self.hosts['robot'] + ':' + self.sniro_port + '/__admin/mappings'
 128         self.sniro_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
 129         self.homing_solution = 'sniro'  # value is either 'sniro' or 'oof'
 130 #        self.homing_solution = 'oof'
 131         self.customer_location_used_by_oof = {
 132             "customerLatitude": "32.897480",
 133             "customerLongitude": "-97.040443",
 134             "customerName": "some_company"
 135         }
 136
 137         #############################################################################################
 138         # SDNC urls
 139         self.sdnc_userpass = 'admin', 'Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U'
 140         self.sdnc_db_name = 'sdnctl'
 141         self.sdnc_db_user = 'sdnctl'
 142         self.sdnc_db_pass = 'gamma'
 143         self.sdnc_db_port = '32774'
 144         self.sdnc_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
 145         self.sdnc_preload_network_url = 'http://' + self.hosts['sdnc'] + \
 146                                         ':' + self.sdnc_preloading_port + '/restconf/operations/VNF-API:preload-network-topology-operation'
 147         self.sdnc_preload_vnf_url = 'http://' + self.hosts['sdnc'] + \
 148                                     ':' + self.sdnc_preloading_port + '/restconf/operations/VNF-API:preload-vnf-topology-operation'
 149         self.sdnc_preload_gra_url = 'http://' + self.hosts['sdnc'] + \
 150                                     ':' + self.sdnc_preloading_port + '/restconf/operations/GENERIC-RESOURCE-API:preload-vf-module-topology-operation'
 151         self.sdnc_ar_cleanup_url = 'http://' + self.hosts['sdnc'] + ':' + self.sdnc_preloading_port + \
 152                                    '/restconf/config/GENERIC-RESOURCE-API:'
 153
 154         #############################################################################################
 155         # SO urls, note: do NOT add a '/' at the end of the url
 156         self.so_req_api_url = {'v4': 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/serviceInstantiation/v7/serviceInstances',
 157                            'v5': 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/serviceInstantiation/v7/serviceInstances'}
 158         self.so_check_progress_api_url = 'http://' + self.hosts['so'] + ':' + self.so_nbi_port + '/onap/so/infra/orchestrationRequests/v6'
 159         self.so_userpass = 'InfraPortalClient', 'password1$'
 160         self.so_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
 161         self.so_db_name = 'catalogdb'
 162         self.so_db_user = 'root'
 163         self.so_db_pass = 'password'
 164         self.so_db_port = '30252' if self.oom_mode else '32769'
 165
 166         self.vpp_inf_url = 'http://{0}:8183/restconf/config/ietf-interfaces:interfaces'
 167         self.vpp_api_headers = {'Content-Type': 'application/json', 'Accept': 'application/json'}
 168         self.vpp_api_userpass = ('admin', 'admin')
 169         self.vpp_ves_url= 'http://{0}:8183/restconf/config/vesagent:vesagent'
 170
 171
 172
 173     def find_file(self, file_name_keyword, file_ext, search_dir):
 174         """
 175         :param file_name_keyword:  keyword used to look for the csar file, case insensitive matching, e.g, infra
 176         :param file_ext: e.g., csar, json
 177         :param search_dir path to search
 178         :return: path name of the file
 179         """
 180         file_name_keyword = file_name_keyword.lower()
 181         file_ext = file_ext.lower()
 182         if not file_ext.startswith('.'):
 183             file_ext = '.' + file_ext
 184
 185         filenamepath = None
 186         for file_name in os.listdir(search_dir):
 187             file_name_lower = file_name.lower()
 188             if file_name_keyword in file_name_lower and file_name_lower.endswith(file_ext):
 189                 if filenamepath:
 190                     self.logger.error('Multiple files found for *{0}*.{1} in '
 191                                       'directory {2}'.format(file_name_keyword, file_ext, search_dir))
 192                     sys.exit()
 193                 filenamepath = os.path.abspath(os.path.join(search_dir, file_name))
 194
 195         if filenamepath:
 196             return filenamepath
 197         else:
 198             self.logger.error("Cannot find *{0}*{1} in directory {2}".format(file_name_keyword, file_ext, search_dir))
 199             sys.exit()
 200
 201     @staticmethod
 202     def network_name_to_subnet_name(network_name):
 203         """
 204         :param network_name: example: vcpe_net_cpe_signal_201711281221
 205         :return: vcpe_net_cpe_signal_subnet_201711281221
 206         """
 207         fields = network_name.split('_')
 208         fields.insert(-1, 'subnet')
 209         return '_'.join(fields)
 210
 211     def set_network_name(self, network_name):
 212         param = ' '.join([k + ' ' + v for k, v in list(self.cloud.items())])
 213         openstackcmd = 'openstack ' + param
 214         cmd = ' '.join([openstackcmd, 'network set --name', network_name, 'ONAP-NW1'])
 215         os.popen(cmd)
 216
 217     def set_subnet_name(self, network_name):
 218         """
 219         Example: network_name =  vcpe_net_cpe_signal_201711281221
 220         set subnet name to vcpe_net_cpe_signal_subnet_201711281221
 221         :return:
 222         """
 223         param = ' '.join([k + ' ' + v for k, v in list(self.cloud.items())])
 224         openstackcmd = 'openstack ' + param
 225
 226         # expected results: | subnets | subnet_id |
 227         subnet_info = os.popen(openstackcmd + ' network show ' + network_name + ' |grep subnets').read().split('|')
 228         if len(subnet_info) > 2 and subnet_info[1].strip() == 'subnets':
 229             subnet_id = subnet_info[2].strip()
 230             subnet_name = self.network_name_to_subnet_name(network_name)
 231             cmd = ' '.join([openstackcmd, 'subnet set --name', subnet_name, subnet_id])
 232             os.popen(cmd)
 233             self.logger.info("Subnet name set to: " + subnet_name)
 234             return True
 235         else:
 236             self.logger.error("Can't get subnet info from network name: " + network_name)
 237             return False
 238
 239     def is_node_in_aai(self, node_type, node_uuid):
 240         key = None
 241         search_node_type = None
 242         if node_type == 'service':
 243             search_node_type = 'service-instance'
 244             key = 'service-instance-id'
 245         elif node_type == 'vnf':
 246             search_node_type = 'generic-vnf'
 247             key = 'vnf-id'
 248         else:
 249             logging.error('Invalid node_type: ' + node_type)
 250             sys.exit()
 251
 252         url = 'https://{0}:{1}/aai/v11/search/nodes-query?search-node-type={2}&filter={3}:EQUALS:{4}'.format(
 253             self.hosts['aai'], self.aai_query_port, search_node_type, key, node_uuid)
 254
 255         headers = {'Content-Type': 'application/json', 'Accept': 'application/json', 'X-FromAppID': 'vCPE-Robot', 'X-TransactionId': 'get_aai_subscr'}
 256         requests.packages.urllib3.disable_warnings()
 257         r = requests.get(url, headers=headers, auth=self.aai_userpass, verify=False)
 258         response = r.json()
 259         self.logger.debug('aai query: ' + url)
 260         self.logger.debug('aai response:\n' + json.dumps(response, indent=4, sort_keys=True))
 261         return 'result-data' in response
 262
 263     @staticmethod
 264     def extract_ip_from_str(net_addr, net_addr_len, sz):
 265         """
 266         :param net_addr:  e.g. 10.5.12.0
 267         :param net_addr_len: e.g. 24
 268         :param sz: a string
 269         :return: the first IP address matching the network, e.g. 10.5.12.3
 270         """
 271         network = ipaddress.ip_network(str('{0}/{1}'.format(net_addr, net_addr_len)), strict=False)
 272         ip_list = re.findall(r'[0-9]+(?:\.[0-9]+){3}', sz)
 273         for ip in ip_list:
 274             this_net = ipaddress.ip_network(str('{0}/{1}'.format(ip, net_addr_len)), strict=False)
 275             if this_net == network:
 276                 return str(ip)
 277         return None
 278
 279
 280
 281     @staticmethod
 282     def save_object(obj, filepathname):
 283         with open(filepathname, 'wb') as fout:
 284             pickle.dump(obj, fout)
 285
 286     @staticmethod
 287     def load_object(filepathname):
 288         with open(filepathname, 'rb') as fin:
 289             return pickle.load(fin)
 290
 291     @staticmethod
 292     def increase_ip_address_or_vni_in_template(vnf_template_file, vnf_parameter_name_list):
 293         with open(vnf_template_file) as json_input:
 294             json_data = json.load(json_input)
 295             param_list = json_data['VNF-API:input']['VNF-API:vnf-topology-information']['VNF-API:vnf-parameters']
 296             for param in param_list:
 297                 if param['vnf-parameter-name'] in vnf_parameter_name_list:
 298                     ipaddr_or_vni = param['vnf-parameter-value'].split('.')
 299                     number = int(ipaddr_or_vni[-1])
 300                     if 254 == number:
 301                         number = 10
 302                     else:
 303                         number = number + 1
 304                     ipaddr_or_vni[-1] = str(number)
 305                     param['vnf-parameter-value'] = '.'.join(ipaddr_or_vni)
 306
 307         assert json_data is not None
 308         with open(vnf_template_file, 'w') as json_output:
 309             json.dump(json_data, json_output, indent=4, sort_keys=True)
 310
 311     def save_preload_data(self, preload_data):
 312         self.save_object(preload_data, self.preload_dict_file)
 313
 314     def load_preload_data(self):
 315         return self.load_object(self.preload_dict_file)
 316
 317     def save_vgmux_vnf_name(self, vgmux_vnf_name):
 318         self.save_object(vgmux_vnf_name, self.vgmux_vnf_name_file)
 319
 320     def load_vgmux_vnf_name(self):
 321         return self.load_object(self.vgmux_vnf_name_file)
 322