VNFs/DPPD-PROX/helper-scripts/rapid/rapid_flowsizetest.py

   1 #!/usr/bin/python
   2
   3 ##
   4 ## Copyright (c) 2020 Intel Corporation
   5 ##
   6 ## Licensed under the Apache License, Version 2.0 (the "License");
   7 ## you may not use this file except in compliance with the License.
   8 ## You may obtain a copy of the License at
   9 ##
  10 ##
  11 ##     http://www.apache.org/licenses/LICENSE-2.0
  12 ##
  13 ## Unless required by applicable law or agreed to in writing, software
  14 ## distributed under the License is distributed on an "AS IS" BASIS,
  15 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 ## See the License for the specific language governing permissions and
  17 ## limitations under the License.
  18 ##
  19 import sys
  20 import time
  21 import copy
  22 from math import ceil
  23 from statistics import mean
  24 from past.utils import old_div
  25 from rapid_log import RapidLog
  26 from rapid_log import bcolors
  27 from rapid_test import RapidTest
  28 inf = float("inf")
  29
  30 class FlowSizeTest(RapidTest):
  31     """
  32     Class to manage the flowsizetesting
  33     """
  34     def __init__(self, test_param, lat_percentile, runtime, testname,
  35             environment_file, gen_machine, sut_machine, background_machines):
  36         super().__init__(test_param, runtime, testname, environment_file)
  37         self.gen_machine = gen_machine
  38         self.sut_machine = sut_machine
  39         self.background_machines = background_machines
  40         self.test['lat_percentile'] = lat_percentile
  41         if self.test['test'] == 'TST009test':
  42             # This test implements some of the testing as defined in
  43             # https://docbox.etsi.org/ISG/NFV/open/Publications_pdf/Specs-Reports/NFV-TST%20009v3.2.1%20-%20GS%20-%20NFVI_Benchmarks.pdf
  44             self.test['TST009_n'] = int(ceil(old_div(
  45                 self.test['maxframespersecondallingress'],
  46                 self.test['stepsize'])))
  47             self.test['TST009'] = True
  48             self.test['TST009_L'] = 0
  49             self.test['TST009_R'] = self.test['TST009_n'] - 1
  50             self.test['TST009_S']= []
  51             for m in range(0, self.test['TST009_n']):
  52                 self.test['TST009_S'].append((m+1) * self.test['stepsize'])
  53         elif self.test['test'] == 'fixed_rate':
  54             for key in['drop_rate_threshold','lat_avg_threshold',
  55                     'lat_perc_threshold','lat_max_threshold','mis_ordered_threshold']:
  56                 self.test[key] = inf
  57
  58     def new_speed(self, speed,size,success):
  59         if self.test['test'] == 'fixed_rate':
  60             return (self.test['startspeed'])
  61         elif self.test['test'] == 'increment_till_fail':
  62             return (speed + self.test['step'])
  63         elif 'TST009' in self.test.keys():
  64             if success:
  65                 self.test['TST009_L'] = self.test['TST009_m'] + 1
  66             else:
  67                 self.test['TST009_R'] = max(self.test['TST009_m'] - 1,
  68                         self.test['TST009_L'])
  69             self.test['TST009_m'] = int (old_div((self.test['TST009_L'] +
  70                 self.test['TST009_R']),2))
  71             return (self.get_percentageof10Gbps(self.test['TST009_S'][self.test['TST009_m']],size))
  72         else:
  73             if success:
  74                 self.test['minspeed'] = speed
  75             else:
  76                 self.test['maxspeed'] = speed
  77             return (old_div((self.test['minspeed'] + self.test['maxspeed']),2.0))
  78
  79     def get_start_speed_and_init(self, size):
  80         if self.test['test'] == 'fixed_rate':
  81             return (self.test['startspeed'])
  82         elif self.test['test'] == 'increment_till_fail':
  83             return (self.test['startspeed'])
  84         elif 'TST009' in self.test.keys():
  85             self.test['TST009_L'] = 0
  86             self.test['TST009_R'] = self.test['TST009_n'] - 1
  87             self.test['TST009_m'] = int(old_div((self.test['TST009_L'] +
  88                 self.test['TST009_R']), 2))
  89             return (self.get_percentageof10Gbps(self.test['TST009_S'][self.test['TST009_m']],size))
  90         else:
  91             self.test['minspeed'] = 0
  92             self.test['maxspeed'] = self.test['startspeed']
  93             return (self.test['startspeed'])
  94
  95     def resolution_achieved(self):
  96         if self.test['test'] == 'fixed_rate':
  97             return (True)
  98         elif 'TST009' in self.test.keys():
  99             return (self.test['TST009_L'] == self.test['TST009_R'])
 100         else:
 101             return ((self.test['maxspeed'] - self.test['minspeed']) <= self.test['accuracy'])
 102
 103     def warm_up(self):
 104         # Running at low speed to make sure the ARP messages can get through.
 105         # If not doing this, the ARP message could be dropped by a switch in overload and then the test will not give proper results
 106         # Note however that if we would run the test steps during a very long time, the ARP would expire in the switch.
 107         # PROX will send a new ARP request every seconds so chances are very low that they will all fail to get through
 108         imix = self.test['warmupimix']
 109         FLOWSIZE = self.test['warmupflowsize']
 110         WARMUPSPEED = self.test['warmupspeed']
 111         WARMUPTIME = self.test['warmuptime']
 112
 113         if WARMUPTIME == 0:
 114             RapidLog.info(("Not Warming up"))
 115             return
 116
 117         RapidLog.info(("Warming up during {} seconds..., packet size = {},"
 118             " flows = {}, speed = {}").format(WARMUPTIME, imix, FLOWSIZE,
 119                 WARMUPSPEED))
 120         self.gen_machine.set_generator_speed(WARMUPSPEED)
 121         self.set_background_speed(self.background_machines, WARMUPSPEED)
 122         self.gen_machine.set_udp_packet_size(imix)
 123         self.set_background_size(self.background_machines, imix)
 124         if FLOWSIZE:
 125             _ = self.gen_machine.set_flows(FLOWSIZE)
 126             self.set_background_flows(self.background_machines, FLOWSIZE)
 127         self.gen_machine.start()
 128         self.start_background_traffic(self.background_machines)
 129         time.sleep(WARMUPTIME)
 130         self.stop_background_traffic(self.background_machines)
 131         self.gen_machine.stop()
 132
 133     def run(self):
 134         result_details = {'Details': 'Nothing'}
 135         TestResult = 0
 136         end_data = {}
 137         iteration_prefix = {}
 138         self.warm_up()
 139         for imix in self.test['imixs']:
 140             size = mean(imix)
 141             self.gen_machine.set_udp_packet_size(imix)
 142             if self.background_machines:
 143                 backgroundinfo = ('{}Running {} x background traffic not '
 144                     'represented in the table{}').format(bcolors.FLASH,
 145                             len(self.background_machines),bcolors.ENDC)
 146             else:
 147                 backgroundinfo = '{}{}'.format(bcolors.FLASH,bcolors.ENDC)
 148             self.set_background_size(self.background_machines, imix)
 149             RapidLog.info('+' + '-' * 200 + '+')
 150             RapidLog.info(("| UDP, {:>5} bytes, different number of flows by "
 151                 "randomizing SRC & DST UDP port. {:128.128}|").
 152                 format(round(size), backgroundinfo))
 153             RapidLog.info('+' + '-' * 8 + '+' + '-' * 18 + '+' + '-' * 13 +
 154                     '+' + '-' * 13 + '+' + '-' * 13 + '+' + '-' * 24 + '+' +
 155                     '-' * 10 + '+' + '-' * 10 + '+' + '-' * 10 + '+' + '-' * 11
 156                     + '+' + '-' * 11 + '+' + '-' * 11 + '+'  + '-' * 11 +  '+'
 157                     + '-' * 7 + '+' + '-' * 11 + '+' + '-' * 4 + '+')
 158             RapidLog.info(('| Flows  | Speed requested  | Gen by core | Sent by'
 159                 ' NIC | Fwrd by SUT | Rec. by core           | Avg. Lat.|{:.0f}'
 160                 ' Pcentil| Max. Lat.|   Sent    |  Received |    Lost   | Total'
 161                 ' Lost|L.Ratio|Mis-ordered|Time').format(self.test['lat_percentile']*100))
 162             RapidLog.info('+' + '-' * 8 + '+' + '-' * 18 + '+' + '-' * 13 +
 163                     '+' + '-' * 13 + '+' + '-' * 13 + '+' + '-' * 24 + '+' +
 164                     '-' * 10 + '+' + '-' * 10 + '+' + '-' * 10 + '+' + '-' * 11
 165                     + '+' + '-' * 11 + '+' + '-' * 11 + '+'  + '-' * 11 +  '+'
 166                     + '-' * 7 + '+' + '-' * 11 + '+' + '-' * 4 + '+')
 167             for flow_number in self.test['flows']:
 168                 attempts = 0
 169                 self.gen_machine.reset_stats()
 170                 if self.sut_machine:
 171                     self.sut_machine.reset_stats()
 172                 if flow_number != 0:
 173                     flow_number = self.gen_machine.set_flows(flow_number)
 174                     self.set_background_flows(self.background_machines, flow_number)
 175                 end_data['speed'] = None
 176                 speed = self.get_start_speed_and_init(size)
 177                 while True:
 178                     attempts += 1
 179                     endwarning = False
 180                     print('{} flows: Measurement ongoing at speed: {}%'.format(
 181                         str(flow_number), str(round(speed, 2))), end='     \r')
 182                     sys.stdout.flush()
 183                     iteration_data = self.run_iteration(
 184                             float(self.test['runtime']),flow_number,size,speed)
 185                     if iteration_data['r'] > 1:
 186                         retry_warning = '{} {:1} retries needed{}'.format(
 187                                 bcolors.WARNING, iteration_data['r'],
 188                                 bcolors.ENDC)
 189                     else:
 190                         retry_warning = ''
 191                     # Drop rate is expressed in percentage. lat_used is a ratio
 192                     # (0 to 1). The sum of these 2 should be 100%.
 193                     # If the sum is lower than 95, it means that more than 5%
 194                     # of the latency measurements where dropped for accuracy
 195                     # reasons.
 196                     if (iteration_data['drop_rate'] +
 197                             iteration_data['lat_used'] * 100) < 95:
 198                         lat_warning = ('{} Latency accuracy issue?: {:>3.0f}%'
 199                             '{}').format(bcolors.WARNING,
 200                                     iteration_data['lat_used'] * 100,
 201                                     bcolors.ENDC)
 202                     else:
 203                         lat_warning = ''
 204                     iteration_prefix = {'speed' : bcolors.ENDC,
 205                             'lat_avg' : bcolors.ENDC,
 206                             'lat_perc' : bcolors.ENDC,
 207                             'lat_max' : bcolors.ENDC,
 208                             'abs_drop_rate' : bcolors.ENDC,
 209                             'mis_ordered' : bcolors.ENDC,
 210                             'drop_rate' : bcolors.ENDC}
 211                     if self.test['test'] == 'fixed_rate':
 212                         end_data = copy.deepcopy(iteration_data)
 213                         end_prefix = copy.deepcopy(iteration_prefix)
 214                         if lat_warning or retry_warning:
 215                             endwarning = '|        | {:177.177} |'.format(
 216                                     retry_warning + lat_warning)
 217                         success = True
 218                         # TestResult = TestResult + iteration_data['pps_rx']
 219                         # fixed rate testing result is strange: we just report
 220                         # the pps received
 221                     # The following if statement is testing if we pass the
 222                     # success criteria of a certain drop rate, average latency
 223                     # and maximum latency below the threshold.
 224                     # The drop rate success can be achieved in 2 ways: either
 225                     # the drop rate is below a treshold, either we want that no
 226                     # packet has been lost during the test.
 227                     # This can be specified by putting 0 in the .test file
 228                     elif ((iteration_data['drop_rate'] < self.test['drop_rate_threshold']) or (iteration_data['abs_dropped']==self.test['drop_rate_threshold']==0)) and (iteration_data['lat_avg']< self.test['lat_avg_threshold']) and (iteration_data['lat_perc']< self.test['lat_perc_threshold']) and (iteration_data['lat_max'] < self.test['lat_max_threshold'] and iteration_data['mis_ordered'] <= self.test['mis_ordered_threshold']):
 229                         if (old_div((self.get_pps(speed,size) - iteration_data['pps_tx']),self.get_pps(speed,size)))>0.01:
 230                             iteration_prefix['speed'] = bcolors.WARNING
 231                             if iteration_data['abs_tx_fail'] > 0:
 232                                 gen_warning = bcolors.WARNING + ' Network limit?: requesting {:<.3f} Mpps and getting {:<.3f} Mpps - {} failed to be transmitted'.format(self.get_pps(speed,size), iteration_data['pps_tx'], iteration_data['abs_tx_fail']) + bcolors.ENDC
 233                             else:
 234                                 gen_warning = bcolors.WARNING + ' Generator limit?: requesting {:<.3f} Mpps and getting {:<.3f} Mpps'.format(self.get_pps(speed,size), iteration_data['pps_tx']) + bcolors.ENDC
 235                         else:
 236                             iteration_prefix['speed'] = bcolors.ENDC
 237                             gen_warning = ''
 238                         end_data = copy.deepcopy(iteration_data)
 239                         end_prefix = copy.deepcopy(iteration_prefix)
 240                         if lat_warning or gen_warning or retry_warning:
 241                             endwarning = '|        | {:186.186} |'.format(retry_warning + lat_warning + gen_warning)
 242                         success = True
 243                         success_message=' SUCCESS'
 244                         RapidLog.debug(self.report_result(-attempts, size,
 245                             iteration_data, iteration_prefix) + success_message +
 246                             retry_warning + lat_warning + gen_warning)
 247                     else:
 248                         success_message=' FAILED'
 249                         if ((iteration_data['abs_dropped']>0) and (self.test['drop_rate_threshold'] ==0)):
 250                             iteration_prefix['abs_drop_rate'] = bcolors.FAIL
 251                         if (iteration_data['drop_rate'] <= self.test['drop_rate_threshold']):
 252                             iteration_prefix['drop_rate'] = bcolors.ENDC
 253                         else:
 254                             iteration_prefix['drop_rate'] = bcolors.FAIL
 255                         if (iteration_data['lat_avg']< self.test['lat_avg_threshold']):
 256                             iteration_prefix['lat_avg'] = bcolors.ENDC
 257                         else:
 258                             iteration_prefix['lat_avg'] = bcolors.FAIL
 259                         if (iteration_data['lat_perc']< self.test['lat_perc_threshold']):
 260                             iteration_prefix['lat_perc'] = bcolors.ENDC
 261                         else:
 262                             iteration_prefix['lat_perc'] = bcolors.FAIL
 263                         if (iteration_data['lat_max']< self.test['lat_max_threshold']):
 264                             iteration_prefix['lat_max'] = bcolors.ENDC
 265                         else:
 266                             iteration_prefix['lat_max'] = bcolors.FAIL
 267                         if ((old_div((self.get_pps(speed,size) - iteration_data['pps_tx']),self.get_pps(speed,size)))<0.001):
 268                             iteration_prefix['speed'] = bcolors.ENDC
 269                         else:
 270                             iteration_prefix['speed'] = bcolors.FAIL
 271                         if (iteration_data['mis_ordered']< self.test['mis_ordered_threshold']):
 272                             iteration_prefix['mis_ordered'] = bcolors.ENDC
 273                         else:
 274                             iteration_prefix['mis_ordered'] = bcolors.FAIL
 275
 276                         success = False
 277                         RapidLog.debug(self.report_result(-attempts, size,
 278                             iteration_data, iteration_prefix) +
 279                             success_message + retry_warning + lat_warning)
 280                     speed = self.new_speed(speed, size, success)
 281                     if self.test['test'] == 'increment_till_fail':
 282                         if not success:
 283                             break
 284                     elif self.resolution_achieved():
 285                         break
 286                 if end_data['speed'] is None:
 287                     end_data = iteration_data
 288                     end_prefix = iteration_prefix
 289                     RapidLog.info('|{:>7} | {:<177} |'.format("FAILED","Speed 0 or close to 0, data for last failed step below:"))
 290                 RapidLog.info(self.report_result(flow_number, size,
 291                     end_data, end_prefix))
 292                 if end_data['avg_bg_rate']:
 293                     tot_avg_rx_rate = end_data['pps_rx'] + (end_data['avg_bg_rate'] * len(self.background_machines))
 294                     endtotaltrafficrate = '|        | Total amount of traffic received by all generators during this test: {:>4.3f} Gb/s {:7.3f} Mpps {} |'.format(RapidTest.get_speed(tot_avg_rx_rate,size) , tot_avg_rx_rate, ' '*84)
 295                     RapidLog.info (endtotaltrafficrate)
 296                 if endwarning:
 297                     RapidLog.info (endwarning)
 298                 if self.test['test'] != 'fixed_rate':
 299                     TestResult = TestResult + end_data['pps_rx']
 300                     end_data['test'] = self.test['testname']
 301                     end_data['environment_file'] = self.test['environment_file']
 302                     end_data['Flows'] = flow_number
 303                     end_data['Size'] = size
 304                     end_data['RequestedSpeed'] = RapidTest.get_pps(end_data['speed'] ,size)
 305                     result_details = self.post_data(end_data)
 306                     RapidLog.debug(result_details)
 307                 RapidLog.info('+' + '-' * 8 + '+' + '-' * 18 + '+' + '-' * 13 +
 308                     '+' + '-' * 13 + '+' + '-' * 13 + '+' + '-' * 24 + '+' +
 309                     '-' * 10 + '+' + '-' * 10 + '+' + '-' * 10 + '+' + '-' * 11
 310                     + '+' + '-' * 11 + '+' + '-' * 11 + '+'  + '-' * 11 +  '+'
 311                     + '+' + '-' * 11 + '+'
 312                     + '-' * 7 + '+' + '-' * 4 + '+')
 313         return (TestResult, result_details)