tools/pkt_gen/ixnet/ixnet.py

   1 # Copyright 2015 Intel Corporation.
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #   http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14 """IxNetwork traffic generator model.
  15
  16 Provides a model for an IxNetwork machine and appropriate applications.
  17
  18 This requires the following settings in your config file:
  19
  20 * TRAFFICGEN_IXNET_LIB_PATH
  21     IxNetwork libraries path
  22 * TRAFFICGEN_IXNET_HOST
  23     IxNetwork host IP address
  24 * TRAFFICGEN_IXNET_PORT
  25     IxNetwork host port number
  26 * TRAFFICGEN_IXNET_USER
  27     IxNetwork host user name
  28 * TRAFFICGEN_IXNET_TESTER_RESULT_DIR
  29     The result directory on the IxNetwork computer
  30 * TRAFFICGEN_IXNET_DUT_RESULT_DIR
  31     The result directory on DUT. This needs to map to the same directory
  32     as the previous one
  33
  34 The following settings are also required. These can likely be shared
  35 an 'Ixia' traffic generator instance:
  36
  37 * TRAFFICGEN_IXIA_HOST
  38     IXIA chassis IP address
  39 * TRAFFICGEN_IXIA_CARD
  40     IXIA card
  41 * TRAFFICGEN_IXIA_PORT1
  42     IXIA Tx port
  43 * TRAFFICGEN_IXIA_PORT2
  44     IXIA Rx port
  45
  46 If any of these don't exist, the application will raise an exception
  47 (EAFP).
  48
  49 Additional Configuration:
  50 -------------------------
  51
  52 You will also need to configure the IxNetwork machine to start the IXIA
  53 IxNetworkTclServer. This can be started like so:
  54
  55 1. Connect to the IxNetwork machine using RDP
  56 2. Go to:
  57
  58     Start->
  59       Programs ->
  60         Ixia ->
  61           IxNetwork ->
  62             IxNetwork 7.21.893.14 GA ->
  63               IxNetworkTclServer
  64
  65    Pin a shortcut to this application to the taskbar.
  66 3. Before running it right click the pinned shortcut  and go to
  67    "Properties". Here change the port number to your own port number.
  68    This will be the same value as "TRAFFICGEN_IXNET_PORT" above.
  69 4. You will find this on the shortcut tab under the heading "Target"
  70 5. Finally run it. If you see the following error check that you
  71    followed the above steps exactly:
  72
  73        ERROR: couldn't open socket : connection refused
  74
  75 Debugging:
  76 ----------
  77
  78 This method of automation is quite error prone as the IxNetwork API
  79 does not give any feedback as to the status of tests. As such, it can
  80 be expected that the user have access to the IxNetwork machine should
  81 this trafficgen need to be debugged.
  82 """
  83
  84 import tkinter
  85 import logging
  86 import os
  87 import re
  88 import csv
  89
  90 from collections import OrderedDict
  91 from tools.pkt_gen import trafficgen
  92 from conf import settings
  93 from core.results.results_constants import ResultsConstants
  94
  95 _ROOT_DIR = os.path.dirname(os.path.realpath(__file__))
  96
  97 _RESULT_RE = r'(?:\{kString,result\},\{kString,)(\w+)(?:\})'
  98 _RESULTPATH_RE = r'(?:\{kString,resultPath\},\{kString,)([\\\w\.\-\:]+)(?:\})'
  99
 100
 101 def _build_set_cmds(values, prefix='dict set'):
 102     """Generate a list of 'dict set' args for Tcl.
 103
 104     Parse a dictionary and recursively build the arguments for the
 105     'dict set' Tcl command, given that this is of the format:
 106
 107         dict set [name...] [key] [value]
 108
 109     For example, for a non-nested dict (i.e. a non-dict element):
 110
 111         dict set mydict mykey myvalue
 112
 113     For a nested dict (i.e. a dict element):
 114
 115         dict set mydict mysubdict mykey myvalue
 116
 117     :param values: Dictionary to yield values for
 118     :param prefix: Prefix to append to output string. Generally the
 119         already generated part of the command.
 120
 121     :yields: Output strings to be passed to a `Tcl` instance.
 122     """
 123     for key in values:
 124         value = values[key]
 125
 126         # Not allowing derived dictionary types for now
 127         # pylint: disable=unidiomatic-typecheck
 128         if type(value) == dict:
 129             _prefix = ' '.join([prefix, key]).strip()
 130             for subkey in _build_set_cmds(value, _prefix):
 131                 yield subkey
 132             continue
 133
 134         # pylint: disable=unidiomatic-typecheck
 135         # tcl doesn't recognise the strings "True" or "False", only "1"
 136         # or "0". Special case to convert them
 137         if type(value) == bool:
 138             value = str(int(value))
 139         else:
 140             value = str(value)
 141
 142         if prefix:
 143             yield ' '.join([prefix, key, value]).strip()
 144         else:
 145             yield ' '.join([key, value]).strip()
 146
 147
 148 class IxNet(trafficgen.ITrafficGenerator):
 149     """A wrapper around IXIA IxNetwork applications.
 150
 151     Runs different traffic generator tests through an Ixia traffic
 152     generator chassis by generating TCL scripts from templates.
 153
 154     Currently only the RFC2544 tests are implemented.
 155     """
 156     _script = os.path.join(os.path.dirname(__file__), 'ixnetrfc2544.tcl')
 157     _tclsh = tkinter.Tcl()
 158     _cfg = None
 159     _logger = logging.getLogger(__name__)
 160     _params = None
 161     _bidir = None
 162
 163     def run_tcl(self, cmd):
 164         """Run a TCL script using the TCL interpreter found in ``tkinter``.
 165
 166         :param cmd: Command to execute
 167
 168         :returns: Output of command, where applicable.
 169         """
 170         self._logger.debug('%s%s', trafficgen.CMD_PREFIX, cmd)
 171
 172         output = self._tclsh.eval(cmd)
 173
 174         return output.split()
 175
 176     def connect(self):
 177         """Configure system for IxNetwork.
 178         """
 179         self._cfg = {
 180             'lib_path': settings.getValue('TRAFFICGEN_IXNET_LIB_PATH'),
 181             # IxNetwork machine configuration
 182             'machine': settings.getValue('TRAFFICGEN_IXNET_MACHINE'),
 183             'port': settings.getValue('TRAFFICGEN_IXNET_PORT'),
 184             'user': settings.getValue('TRAFFICGEN_IXNET_USER'),
 185             # IXIA chassis configuration
 186             'chassis': settings.getValue('TRAFFICGEN_IXIA_HOST'),
 187             'card': settings.getValue('TRAFFICGEN_IXIA_CARD'),
 188             'port1': settings.getValue('TRAFFICGEN_IXIA_PORT1'),
 189             'port2': settings.getValue('TRAFFICGEN_IXIA_PORT2'),
 190             'output_dir':
 191                 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
 192         }
 193
 194         self._logger.debug('IXIA configuration configuration : %s', self._cfg)
 195
 196         return self
 197
 198     def disconnect(self):
 199         """Disconnect from Ixia chassis.
 200         """
 201         pass
 202
 203     def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
 204         """See ITrafficGenerator for description
 205         """
 206         self.start_cont_traffic(traffic, duration)
 207
 208         return self.stop_cont_traffic()
 209
 210     def start_cont_traffic(self, traffic=None, duration=30):
 211         """Start transmission.
 212         """
 213         self._bidir = traffic['bidir']
 214         self._params = {}
 215
 216         self._params['config'] = {
 217             'binary': False,  # don't do binary search and send one stream
 218             'duration': duration,
 219             'framerate': traffic['frame_rate'],
 220             'multipleStreams': traffic['multistream'],
 221             'rfc2544TestType': 'throughput',
 222         }
 223         self._params['traffic'] = self.traffic_defaults.copy()
 224
 225         if traffic:
 226             self._params['traffic'] = trafficgen.merge_spec(
 227                 self._params['traffic'], traffic)
 228         self._cfg['bidir'] = self._bidir
 229
 230         for cmd in _build_set_cmds(self._cfg, prefix='set'):
 231             self.run_tcl(cmd)
 232
 233         for cmd in _build_set_cmds(self._params):
 234             self.run_tcl(cmd)
 235
 236         output = self.run_tcl('source {%s}' % self._script)
 237         if output:
 238             self._logger.critical(
 239                 'An error occured when connecting to IxNetwork machine...')
 240             raise RuntimeError('Ixia failed to initialise.')
 241
 242         self.run_tcl('startRfc2544Test $config $traffic')
 243         if output:
 244             self._logger.critical(
 245                 'Failed to start continuous traffic test')
 246             raise RuntimeError('Continuous traffic test failed to start.')
 247
 248     def stop_cont_traffic(self):
 249         """See ITrafficGenerator for description
 250         """
 251         return self._wait_result()
 252
 253     def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
 254                                 lossrate=0.0, multistream=False):
 255         """See ITrafficGenerator for description
 256         """
 257         self.start_rfc2544_throughput(traffic, trials, duration, lossrate)
 258
 259         return self.wait_rfc2544_throughput()
 260
 261     def start_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
 262                                  lossrate=0.0):
 263         """Start transmission.
 264         """
 265         self._bidir = traffic['bidir']
 266         self._params = {}
 267
 268         self._params['config'] = {
 269             'binary': True,
 270             'trials': trials,
 271             'duration': duration,
 272             'lossrate': lossrate,
 273             'multipleStreams': traffic['multistream'],
 274             'rfc2544TestType': 'throughput',
 275         }
 276         self._params['traffic'] = self.traffic_defaults.copy()
 277
 278         if traffic:
 279             self._params['traffic'] = trafficgen.merge_spec(
 280                 self._params['traffic'], traffic)
 281         self._cfg['bidir'] = self._bidir
 282
 283         for cmd in _build_set_cmds(self._cfg, prefix='set'):
 284             self.run_tcl(cmd)
 285
 286         for cmd in _build_set_cmds(self._params):
 287             self.run_tcl(cmd)
 288
 289         output = self.run_tcl('source {%s}' % self._script)
 290         if output:
 291             self._logger.critical(
 292                 'An error occured when connecting to IxNetwork machine...')
 293             raise RuntimeError('Ixia failed to initialise.')
 294
 295         self.run_tcl('startRfc2544Test $config $traffic')
 296         if output:
 297             self._logger.critical(
 298                 'Failed to start RFC2544 test')
 299             raise RuntimeError('RFC2544 test failed to start.')
 300
 301     def wait_rfc2544_throughput(self):
 302         """See ITrafficGenerator for description
 303         """
 304         return self._wait_result()
 305
 306     def _wait_result(self):
 307         """Wait for results.
 308         """
 309         def parse_result_string(results):
 310             """Get path to results file from output
 311
 312             Check for related errors
 313
 314             :param results: Text stream from test.
 315
 316             :returns: Path to results file.
 317             """
 318             result_status = re.search(_RESULT_RE, results)
 319             result_path = re.search(_RESULTPATH_RE, results)
 320
 321             if not result_status or not result_path:
 322                 self._logger.critical(
 323                     'Could not parse results from IxNetwork machine...')
 324                 raise ValueError('Failed to parse output.')
 325
 326             if result_status.group(1) != 'pass':
 327                 self._logger.critical(
 328                     'An error occured when running tests...')
 329                 raise RuntimeError('Ixia failed to initialise.')
 330
 331             # transform path into someting useful
 332
 333             path = result_path.group(1).replace('\\', '/')
 334             path = os.path.join(path, 'AggregateResults.csv')
 335             path = path.replace(
 336                 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
 337                 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
 338             return path
 339
 340         def parse_ixnet_rfc_results(path):
 341             """Parse CSV output of IxNet RFC2544 test run.
 342
 343             :param path: Input file path
 344             """
 345             results = OrderedDict()
 346
 347             with open(path, 'r') as in_file:
 348                 reader = csv.reader(in_file, delimiter=',')
 349                 next(reader)
 350                 for row in reader:
 351                     #Replace null entries added by Ixia with 0s.
 352                     row = [entry if len(entry) > 0 else '0' for entry in row]
 353
 354                     # tx_fps and tx_mps cannot be reliably calculated
 355                     # as the DUT may be modifying the frame size
 356                     tx_fps = 'Unknown'
 357                     tx_mbps = 'Unknown'
 358
 359                     if bool(results.get(ResultsConstants.THROUGHPUT_RX_FPS)) \
 360                                                                 == False:
 361                         prev_percent_rx = 0.0
 362                     else:
 363                         prev_percent_rx = \
 364                         float(results.get(ResultsConstants.THROUGHPUT_RX_FPS))
 365                     if float(row[5]) >= prev_percent_rx:
 366                         results[ResultsConstants.THROUGHPUT_TX_FPS] = tx_fps
 367                         results[ResultsConstants.THROUGHPUT_RX_FPS] = row[5]
 368                         results[ResultsConstants.THROUGHPUT_TX_MBPS] = tx_mbps
 369                         results[ResultsConstants.THROUGHPUT_RX_MBPS] = row[6]
 370                         results[ResultsConstants.THROUGHPUT_TX_PERCENT] = row[3]
 371                         results[ResultsConstants.THROUGHPUT_RX_PERCENT] = row[4]
 372                         results[ResultsConstants.MIN_LATENCY_NS] = row[11]
 373                         results[ResultsConstants.MAX_LATENCY_NS] = row[12]
 374                         results[ResultsConstants.AVG_LATENCY_NS] = row[13]
 375             return results
 376
 377         output = self.run_tcl('waitForRfc2544Test')
 378
 379         # the run_tcl function will return a list with one element. We extract
 380         # that one element (a string representation of an IXIA-specific Tcl
 381         # datatype), parse it to find the path of the results file then parse
 382         # the results file
 383         return parse_ixnet_rfc_results(parse_result_string(output[0]))
 384
 385     def send_rfc2544_back2back(self, traffic=None, trials=1, duration=20,
 386                                lossrate=0.0):
 387         """See ITrafficGenerator for description
 388         """
 389         self.start_rfc2544_back2back(traffic, trials, duration, lossrate)
 390
 391         return self.wait_rfc2544_back2back()
 392
 393     def start_rfc2544_back2back(self, traffic=None, trials=1, duration=20,
 394                                 lossrate=0.0):
 395         """Start transmission.
 396         """
 397         self._bidir = traffic['bidir']
 398         self._params = {}
 399
 400         self._params['config'] = {
 401             'binary': True,
 402             'trials': trials,
 403             'duration': duration,
 404             'lossrate': lossrate,
 405             'multipleStreams': traffic['multistream'],
 406             'rfc2544TestType': 'back2back',
 407         }
 408         self._params['traffic'] = self.traffic_defaults.copy()
 409
 410         if traffic:
 411             self._params['traffic'] = trafficgen.merge_spec(
 412                 self._params['traffic'], traffic)
 413         self._cfg['bidir'] = self._bidir
 414
 415         for cmd in _build_set_cmds(self._cfg, prefix='set'):
 416             self.run_tcl(cmd)
 417
 418         for cmd in _build_set_cmds(self._params):
 419             self.run_tcl(cmd)
 420
 421         output = self.run_tcl('source {%s}' % self._script)
 422         if output:
 423             self._logger.critical(
 424                 'An error occured when connecting to IxNetwork machine...')
 425             raise RuntimeError('Ixia failed to initialise.')
 426
 427         self.run_tcl('startRfc2544Test $config $traffic')
 428         if output:
 429             self._logger.critical(
 430                 'Failed to start RFC2544 test')
 431             raise RuntimeError('RFC2544 test failed to start.')
 432
 433     def wait_rfc2544_back2back(self):
 434         """Wait for results.
 435         """
 436         def parse_result_string(results):
 437             """Get path to results file from output
 438
 439             Check for related errors
 440
 441             :param results: Text stream from test.
 442
 443             :returns: Path to results file.
 444             """
 445             result_status = re.search(_RESULT_RE, results)
 446             result_path = re.search(_RESULTPATH_RE, results)
 447
 448             if not result_status or not result_path:
 449                 self._logger.critical(
 450                     'Could not parse results from IxNetwork machine...')
 451                 raise ValueError('Failed to parse output.')
 452
 453             if result_status.group(1) != 'pass':
 454                 self._logger.critical(
 455                     'An error occured when running tests...')
 456                 raise RuntimeError('Ixia failed to initialise.')
 457
 458             # transform path into something useful
 459
 460             path = result_path.group(1).replace('\\', '/')
 461             path = os.path.join(path, 'iteration.csv')
 462             path = path.replace(
 463                 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
 464                 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
 465
 466             return path
 467
 468         def parse_ixnet_rfc_results(path):
 469             """Parse CSV output of IxNet RFC2544 Back2Back test run.
 470
 471             :param path: Input file path
 472
 473             :returns: Best parsed result from CSV file.
 474             """
 475             results = OrderedDict()
 476             results[ResultsConstants.B2B_FRAMES] = 0
 477
 478             with open(path, 'r') as in_file:
 479                 reader = csv.reader(in_file, delimiter=',')
 480                 next(reader)
 481                 for row in reader:
 482                     # if back2back count higher than previously found, store it
 483                     # Note: row[N] here refers to the Nth column of a row
 484                     if float(row[14]) <= self._params['config']['lossrate']:
 485                         if int(row[12]) > \
 486                          int(results[ResultsConstants.B2B_FRAMES]):
 487                             results[ResultsConstants.B2B_FRAMES] = int(row[12])
 488
 489             return results
 490
 491         output = self.run_tcl('waitForRfc2544Test')
 492
 493         # the run_tcl function will return a list with one element. We extract
 494         # that one element (a string representation of an IXIA-specific Tcl
 495         # datatype), parse it to find the path of the results file then parse
 496         # the results file
 497
 498         return parse_ixnet_rfc_results(parse_result_string(output[0]))
 499
 500
 501 if __name__ == '__main__':
 502     TRAFFIC = {
 503         'l3': {
 504             'proto': 'udp',
 505             'srcip': '10.1.1.1',
 506             'dstip': '10.1.1.254',
 507         },
 508     }
 509
 510     with IxNet() as dev:
 511         print(dev.send_cont_traffic())
 512         print(dev.send_rfc2544_throughput())