test/mocks/mass-pnf-sim/MassPnfSim.py

   1 #!/usr/bin/env python3
   2 import logging
   3 from subprocess import run, CalledProcessError
   4 import argparse
   5 import ipaddress
   6 from sys import exit
   7 from os import chdir, getcwd, path, popen, kill, getuid, stat, mkdir, getlogin, chmod
   8 from shutil import copytree, rmtree, move
   9 from json import loads, dumps
  10 from yaml import load, SafeLoader, dump
  11 from glob import glob
  12 from time import strftime, tzname, daylight
  13 from docker import from_env
  14 from requests import get, codes, post
  15 from requests.exceptions import MissingSchema, InvalidSchema, InvalidURL, ConnectionError, ConnectTimeout
  16
  17 def validate_url(url):
  18     '''Helper function to perform --urlves input param validation'''
  19     logger = logging.getLogger("urllib3")
  20     logger.setLevel(logging.WARNING)
  21     try:
  22         get(url, timeout=0.001)
  23     except (MissingSchema, InvalidSchema, InvalidURL):
  24         raise argparse.ArgumentTypeError(f'{url} is not a valid URL')
  25     except (ConnectionError, ConnectTimeout):
  26         pass
  27     return url
  28
  29 def validate_ip(ip):
  30     '''Helper function to validate input param is a vaild IP address'''
  31     try:
  32         ip_valid = ipaddress.ip_address(ip)
  33     except ValueError:
  34         raise argparse.ArgumentTypeError(f'{ip} is not a valid IP address')
  35     else:
  36         return ip_valid
  37
  38 def get_parser():
  39     '''Process input arguments'''
  40
  41     parser = argparse.ArgumentParser()
  42     subparsers = parser.add_subparsers(title='Subcommands', dest='subcommand')
  43     # Build command parser
  44     subparsers.add_parser('build', help='Build simulator image')
  45     # Bootstrap command parser
  46     parser_bootstrap = subparsers.add_parser('bootstrap', help='Bootstrap the system')
  47     parser_bootstrap.add_argument('--count', help='Instance count to bootstrap', type=int, metavar='INT', default=1)
  48     parser_bootstrap.add_argument('--urlves', help='URL of the VES collector', type=validate_url, metavar='URL', required=True)
  49     parser_bootstrap.add_argument('--ipfileserver', help='Visible IP of the file server (SFTP/FTPS) to be included in the VES event',
  50                                   type=validate_ip, metavar='IP', required=True)
  51     parser_bootstrap.add_argument('--typefileserver', help='Type of the file server (SFTP/FTPS) to be included in the VES event',
  52                                   type=str, choices=['sftp', 'ftps'], required=True)
  53     parser_bootstrap.add_argument('--user', help='File server username', type=str, metavar='USERNAME', required=True)
  54     parser_bootstrap.add_argument('--password', help='File server password', type=str, metavar='PASSWORD', required=True)
  55     parser_bootstrap.add_argument('--ipstart', help='IP address range beginning', type=validate_ip, metavar='IP', required=True)
  56     # Start command parser
  57     parser_start = subparsers.add_parser('start', help='Start instances')
  58     parser_start.add_argument('--count', help='Instance count to start', type=int, metavar='INT', default=0)
  59     # Stop command parser
  60     parser_stop = subparsers.add_parser('stop', help='Stop instances')
  61     parser_stop.add_argument('--count', help='Instance count to stop', type=int, metavar='INT', default=0)
  62     # Trigger command parser
  63     parser_trigger = subparsers.add_parser('trigger', help='Trigger one single VES event from each simulator')
  64     parser_trigger.add_argument('--count', help='Instance count to trigger', type=int, metavar='INT', default=0)
  65     # Stop-simulator command parser
  66     parser_stopsimulator = subparsers.add_parser('stop_simulator', help='Stop sending PNF registration messages')
  67     parser_stopsimulator.add_argument('--count', help='Instance count to stop', type=int, metavar='INT', default=0)
  68     # Trigger-custom command parser
  69     parser_triggerstart = subparsers.add_parser('trigger_custom', help='Trigger one single VES event from specific simulators')
  70     parser_triggerstart.add_argument('--triggerstart', help='First simulator id to trigger', type=int,
  71                                      metavar='INT', required=True)
  72     parser_triggerstart.add_argument('--triggerend', help='Last simulator id to trigger', type=int,
  73                                      metavar='INT', required=True)
  74     # Status command parser
  75     parser_status = subparsers.add_parser('status', help='Status')
  76     parser_status.add_argument('--count', help='Instance count to show status for', type=int, metavar='INT', default=0)
  77     # Clean command parser
  78     subparsers.add_parser('clean', help='Clean work-dirs')
  79     # General options parser
  80     parser.add_argument('--verbose', help='Verbosity level', choices=['info', 'debug'],
  81                         type=str, default='info')
  82     return parser
  83
  84 class MassPnfSim:
  85
  86     log_lvl = logging.INFO
  87     sim_compose_template = 'docker-compose-template.yml'
  88     sim_vsftpd_template = 'config/vsftpd_ssl-TEMPLATE.conf'
  89     sim_vsftpd_config = 'config/vsftpd_ssl.conf'
  90     sim_sftp_script = 'fix-sftp-perms.sh'
  91     sim_sftp_script_template = 'fix-sftp-perms-template.sh'
  92     sim_config = 'config/config.yml'
  93     sim_msg_config = 'config/config.json'
  94     sim_port = 5000
  95     sim_base_url = 'http://{}:' + str(sim_port) + '/simulator'
  96     sim_start_url = sim_base_url + '/start'
  97     sim_status_url = sim_base_url + '/status'
  98     sim_stop_url = sim_base_url + '/stop'
  99     sim_container_name = 'pnf-simulator'
 100     rop_script_name = 'ROP_file_creator.sh'
 101
 102     def __init__(self, args):
 103         self.args = args
 104         self.logger = logging.getLogger(__name__)
 105         self.logger.setLevel(self.log_lvl)
 106         self.sim_dirname_pattern = "pnf-sim-lw-"
 107         self.mvn_build_cmd = 'mvn clean package docker:build -Dcheckstyle.skip'
 108         self.docker_compose_status_cmd = 'docker-compose ps'
 109
 110         # Validate 'trigger_custom' subcommand options
 111         if self.args.subcommand == 'trigger_custom':
 112             if (self.args.triggerend + 1) > self._enum_sim_instances():
 113                 self.logger.error('--triggerend value greater than existing instance count.')
 114                 exit(1)
 115
 116         # Validate --count option for subcommands that support it
 117         if self.args.subcommand in ['start', 'stop', 'trigger', 'status', 'stop_simulator']:
 118             if self.args.count > self._enum_sim_instances():
 119                 self.logger.error('--count value greater that existing instance count')
 120                 exit(1)
 121             if not self._enum_sim_instances():
 122                 self.logger.error('No bootstrapped instance found')
 123                 exit(1)
 124
 125         # Validate 'bootstrap' subcommand
 126         if (self.args.subcommand == 'bootstrap') and self._enum_sim_instances():
 127             self.logger.error('Bootstrapped instances detected, not overwiriting, clean first')
 128             exit(1)
 129
 130     def _run_cmd(self, cmd, dir_context='.'):
 131         old_pwd = getcwd()
 132         try:
 133             chdir(dir_context)
 134             self.logger.debug(f'_run_cmd: Current direcotry: {getcwd()}')
 135             self.logger.debug(f'_run_cmd: Command string: {cmd}')
 136             run(cmd, check=True, shell=True)
 137             chdir(old_pwd)
 138         except FileNotFoundError:
 139             self.logger.error(f"Directory {dir_context} not found")
 140         except CalledProcessError as e:
 141             exit(e.returncode)
 142
 143     def _enum_sim_instances(self):
 144         '''Helper method that returns bootstraped simulator instances count'''
 145         return len(glob(f"{self.sim_dirname_pattern}[0-9]*"))
 146
 147     def _get_sim_instance_data(self, instance_id):
 148         '''Helper method that returns specific instance data'''
 149         oldpwd = getcwd()
 150         chdir(f"{self.sim_dirname_pattern}{instance_id}")
 151         with open(self.sim_config) as cfg:
 152             yml = load(cfg, Loader=SafeLoader)
 153         chdir(oldpwd)
 154         return yml['ippnfsim']
 155
 156     def _get_docker_containers(self):
 157         '''Returns a list containing 'name' attribute of running docker containers'''
 158         dc = from_env()
 159         containers = []
 160         for container in dc.containers.list():
 161             containers.append(container.attrs['Name'][1:])
 162         return containers
 163
 164     def _get_iter_range(self):
 165         '''Helper routine to get the iteration range
 166         for the lifecycle commands'''
 167         if hasattr(self.args, 'count'):
 168             if not self.args.count:
 169                 return [self._enum_sim_instances()]
 170             else:
 171                 return [self.args.count]
 172         elif hasattr(self.args, 'triggerstart'):
 173             return [self.args.triggerstart, self.args.triggerend + 1]
 174         else:
 175             return [self._enum_sim_instances()]
 176
 177     def _archive_logs(self, sim_dir):
 178         '''Helper function to archive simulator logs or create the log dir'''
 179         old_pwd = getcwd()
 180         try:
 181             chdir(sim_dir)
 182             if path.isdir('logs'):
 183                 arch_dir = f"logs/archive_{strftime('%Y-%m-%d_%T')}"
 184                 mkdir(arch_dir)
 185                 self.logger.debug(f'Created {arch_dir}')
 186                 # Collect file list to move
 187                 self.logger.debug('Archiving log files')
 188                 for fpattern in ['*.log', '*.xml']:
 189                     for f in glob('logs/' + fpattern):
 190                         # Move files from list to arch dir
 191                         move(f, arch_dir)
 192                         self.logger.debug(f'Moving {f} to {arch_dir}')
 193             else:
 194                 mkdir('logs')
 195                 self.logger.debug("Logs dir didn't exist, created")
 196             chdir(old_pwd)
 197         except FileNotFoundError:
 198             self.logger.error(f"Directory {sim_dir} not found")
 199
 200     def _generate_pnf_sim_config(self, i, port_sftp, port_ftps, pnf_sim_ip):
 201         '''Writes a yaml formatted configuration file for Java simulator app'''
 202         yml = {}
 203         yml['urlves'] = self.args.urlves
 204         yml['urlsftp'] = f'sftp://{self.args.user}:{self.args.password}@{self.args.ipfileserver}:{port_sftp}'
 205         yml['urlftps'] = f'ftps://{self.args.user}:{self.args.password}@{self.args.ipfileserver}:{port_ftps}'
 206         yml['ippnfsim'] = pnf_sim_ip
 207         yml['typefileserver'] = self.args.typefileserver
 208         self.logger.debug(f'Generated simulator config:\n{dump(yml)}')
 209         with open(f'{self.sim_dirname_pattern}{i}/{self.sim_config}', 'w') as fout:
 210             fout.write(dump(yml))
 211
 212     def _generate_config_file(self, source, dest, **kwargs):
 213         '''Helper private method to generate a file based on a template'''
 214         old_pwd = getcwd()
 215         chdir(self.sim_dirname_pattern + str(kwargs['I']))
 216         # Read the template file
 217         with open(source, 'r') as f:
 218             template = f.read()
 219         # Replace all occurences of env like variable with it's
 220         # relevant value from a corresponding key form kwargs
 221         for (k,v) in kwargs.items():
 222             template = template.replace('${' + k + '}', str(v))
 223         with open(dest, 'w') as f:
 224             f.write(template)
 225         chdir(old_pwd)
 226
 227     def bootstrap(self):
 228         self.logger.info("Bootstrapping PNF instances")
 229
 230         start_port = 2000
 231         ftps_pasv_port_start = 8000
 232         ftps_pasv_port_num_of_ports = 10
 233
 234         ftps_pasv_port_end = ftps_pasv_port_start + ftps_pasv_port_num_of_ports
 235
 236         for i in range(self.args.count):
 237             self.logger.info(f"PNF simulator instance: {i}")
 238
 239             # The IP ranges are in distance of 16 compared to each other.
 240             # This is matching the /28 subnet mask used in the dockerfile inside.
 241             instance_ip_offset = i * 16
 242             ip_properties = [
 243                       'subnet',
 244                       'gw',
 245                       'PnfSim',
 246                       'ftps',
 247                       'sftp'
 248                     ]
 249
 250             ip_offset = 0
 251             ip = {}
 252             for prop in ip_properties:
 253                 ip.update({prop: str(self.args.ipstart + ip_offset + instance_ip_offset)})
 254                 ip_offset += 1
 255
 256             self.logger.debug(f'Instance #{i} properties:\n {dumps(ip, indent=4)}')
 257
 258             PortSftp = start_port + 1
 259             PortFtps = start_port + 2
 260             start_port += 2
 261
 262             self.logger.info(f'\tCreating {self.sim_dirname_pattern}{i}')
 263             copytree('pnf-sim-lightweight', f'{self.sim_dirname_pattern}{i}')
 264             self.logger.info(f"\tCreating instance #{i} configuration ")
 265             self._generate_pnf_sim_config(i, PortSftp, PortFtps, ip['PnfSim'])
 266             # generate docker-compose for the simulator instance
 267             self._generate_config_file(self.sim_compose_template, 'docker-compose.yml',
 268                                        IPGW = ip['gw'], IPSUBNET = ip['subnet'],
 269                                        I = i, IPPNFSIM = ip['PnfSim'],
 270                                        PORTSFTP = str(PortSftp),
 271                                        PORTFTPS = str(PortFtps),
 272                                        IPFTPS = ip['ftps'], IPSFTP = ip['sftp'],
 273                                        FTPS_PASV_MIN = str(ftps_pasv_port_start),
 274                                        FTPS_PASV_MAX = str(ftps_pasv_port_end),
 275                                        TIMEZONE = tzname[daylight],
 276                                        FILESERV_USER = self.args.user,
 277                                        FILESERV_PASS = self.args.password)
 278             # generate vsftpd config file for the simulator instance
 279             self._generate_config_file(self.sim_vsftpd_template, self.sim_vsftpd_config,
 280                                        I = i, USER = getlogin(),
 281                                        FTPS_PASV_MIN = str(ftps_pasv_port_start),
 282                                        FTPS_PASV_MAX = str(ftps_pasv_port_end),
 283                                        IPFILESERVER = str(self.args.ipfileserver))
 284             # generate sftp permission fix script
 285             self._generate_config_file(self.sim_sftp_script_template, self.sim_sftp_script,
 286                                        I = i, FILESERV_USER = self.args.user)
 287             chmod(f'{self.sim_dirname_pattern}{i}/{self.sim_sftp_script}', 0o755)
 288             # Run the 3GPP measurements file generator
 289             self._run_cmd(f'./ROP_file_creator.sh {i} &', f"{self.sim_dirname_pattern}{i}")
 290
 291             ftps_pasv_port_start += ftps_pasv_port_num_of_ports + 1
 292             ftps_pasv_port_end += ftps_pasv_port_num_of_ports + 1
 293
 294             # ugly hack to chown vsftpd config file to root
 295             if getuid():
 296                 self._run_cmd(f'sudo chown root {self.sim_vsftpd_config}', f'{self.sim_dirname_pattern}{i}')
 297                 self.logger.debug(f"vsftpd config file owner UID: {stat(self.sim_dirname_pattern + str(i) + '/' + self.sim_vsftpd_config).st_uid}")
 298
 299             self.logger.info(f'Done setting up instance #{i}')
 300
 301     def build(self):
 302         self.logger.info("Building simulator image")
 303         if path.isfile('pnf-sim-lightweight/pom.xml'):
 304             self._run_cmd(self.mvn_build_cmd, 'pnf-sim-lightweight')
 305         else:
 306             self.logger.error('POM file was not found, Maven cannot run')
 307             exit(1)
 308
 309     def clean(self):
 310         self.logger.info('Cleaning simulators workdirs')
 311         for sim_id in range(self._enum_sim_instances()):
 312             rmtree(f"{self.sim_dirname_pattern}{sim_id}")
 313
 314     def start(self):
 315         for i in range(*self._get_iter_range()):
 316             # If container is not running
 317             if f"{self.sim_container_name}-{i}" not in self._get_docker_containers():
 318                 self.logger.info(f'Starting {self.sim_dirname_pattern}{i} instance:')
 319                 self.logger.info(f' PNF-Sim IP: {self._get_sim_instance_data(i)}')
 320                 #Move logs to archive
 321                 self._archive_logs(self.sim_dirname_pattern + str(i))
 322                 self.logger.info(' Starting simulator containers using netconf model specified in config/netconf.env')
 323                 self._run_cmd('docker-compose up -d', self.sim_dirname_pattern + str(i))
 324             else:
 325                 self.logger.warning(f'Instance {self.sim_dirname_pattern}{i} containers are already up')
 326
 327     def status(self):
 328         for i in range(*self._get_iter_range()):
 329             self.logger.info(f'Getting {self.sim_dirname_pattern}{i} instance status:')
 330             if f"{self.sim_container_name}-{i}" in self._get_docker_containers():
 331                 try:
 332                     sim_ip = self._get_sim_instance_data(i)
 333                     self.logger.info(f' PNF-Sim IP: {sim_ip}')
 334                     self._run_cmd(self.docker_compose_status_cmd, f"{self.sim_dirname_pattern}{i}")
 335                     sim_response = get('{}'.format(self.sim_status_url).format(sim_ip))
 336                     if sim_response.status_code == codes.ok:
 337                         self.logger.info(sim_response.text)
 338                     else:
 339                         self.logger.error(f'Simulator request returned http code {sim_response.status_code}')
 340                 except KeyError:
 341                     self.logger.error(f'Unable to get sim instance IP from {self.sim_config}')
 342             else:
 343                 self.logger.info(' Simulator containers are down')
 344
 345     def stop(self):
 346         for i in range(*self._get_iter_range()):
 347             self.logger.info(f'Stopping {self.sim_dirname_pattern}{i} instance:')
 348             self.logger.info(f' PNF-Sim IP: {self._get_sim_instance_data(i)}')
 349             # attempt killing ROP script
 350             rop_pid = []
 351             for ps_line in iter(popen(f'ps --no-headers -C {self.rop_script_name} -o pid,cmd').readline, ''):
 352                 # try getting ROP script pid
 353                 try:
 354                     ps_line_arr = ps_line.split()
 355                     assert self.rop_script_name in ps_line_arr[2]
 356                     assert ps_line_arr[3] == str(i)
 357                     rop_pid = ps_line_arr[0]
 358                 except AssertionError:
 359                     pass
 360                 else:
 361                     # get rop script childs, kill ROP script and all childs
 362                     childs = popen(f'pgrep -P {rop_pid}').read().split()
 363                     for pid in [rop_pid] + childs:
 364                         kill(int(pid), 15)
 365                     self.logger.info(f' ROP_file_creator.sh {i} successfully killed')
 366             if not rop_pid:
 367                 # no process found
 368                 self.logger.warning(f' ROP_file_creator.sh {i} already not running')
 369             # try tearing down docker-compose application
 370             if f"{self.sim_container_name}-{i}" in self._get_docker_containers():
 371                 self._run_cmd('docker-compose down', self.sim_dirname_pattern + str(i))
 372                 self._run_cmd('docker-compose rm', self.sim_dirname_pattern + str(i))
 373             else:
 374                 self.logger.warning(" Simulator containers are already down")
 375
 376     def trigger(self):
 377         self.logger.info("Triggering VES sending:")
 378         for i in range(*self._get_iter_range()):
 379             sim_ip = self._get_sim_instance_data(i)
 380             self.logger.info(f'Triggering {self.sim_dirname_pattern}{i} instance:')
 381             self.logger.info(f' PNF-Sim IP: {sim_ip}')
 382             # setup req headers
 383             req_headers = {
 384                     "Content-Type": "application/json",
 385                     "X-ONAP-RequestID": "123",
 386                     "X-InvocationID": "456"
 387                 }
 388             self.logger.debug(f' Request headers: {req_headers}')
 389             try:
 390                 # get payload for the request
 391                 with open(f'{self.sim_dirname_pattern}{i}/{self.sim_msg_config}') as data:
 392                     json_data = loads(data.read())
 393                     self.logger.debug(f' JSON payload for the simulator:\n{json_data}')
 394                     # make a http request to the simulator
 395                     sim_response = post('{}'.format(self.sim_start_url).format(sim_ip), headers=req_headers, json=json_data)
 396                     if sim_response.status_code == codes.ok:
 397                         self.logger.info(' Simulator response: ' + sim_response.text)
 398                     else:
 399                         self.logger.warning(' Simulator response ' + sim_response.text)
 400             except TypeError:
 401                 self.logger.error(f' Could not load JSON data from {self.sim_dirname_pattern}{i}/{self.sim_msg_config}')
 402
 403     # Make the 'trigger_custom' an alias to the 'trigger' method
 404     trigger_custom = trigger
 405
 406     def stop_simulator(self):
 407         self.logger.info("Stopping sending PNF registration messages:")
 408         for i in range(*self._get_iter_range()):
 409             sim_ip = self._get_sim_instance_data(i)
 410             self.logger.info(f'Stopping {self.sim_dirname_pattern}{i} instance:')
 411             self.logger.info(f' PNF-Sim IP: {sim_ip}')
 412             sim_response = post('{}'.format(self.sim_stop_url).format(sim_ip))
 413             if sim_response.status_code == codes.ok:
 414                 self.logger.info(' Simulator response: ' + sim_response.text)
 415             else:
 416                 self.logger.warning(' Simulator response ' + sim_response.text)