1 # Copyright 2015-2016 Intel Corporation.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
16 Provides a model for an IxNetwork machine and appropriate applications.
18 This requires the following settings in your config file:
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
34 The following settings are also required. These can likely be shared
35 an 'Ixia' traffic generator instance:
37 * TRAFFICGEN_IXIA_HOST
38 IXIA chassis IP address
39 * TRAFFICGEN_IXIA_CARD
41 * TRAFFICGEN_IXIA_PORT1
43 * TRAFFICGEN_IXIA_PORT2
46 If any of these don't exist, the application will raise an exception
49 Additional Configuration:
50 -------------------------
52 You will also need to configure the IxNetwork machine to start the IXIA
53 IxNetworkTclServer. This can be started like so:
55 1. Connect to the IxNetwork machine using RDP
62 IxNetwork 7.21.893.14 GA ->
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:
73 ERROR: couldn't open socket : connection refused
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.
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
95 _ROOT_DIR = os.path.dirname(os.path.realpath(__file__))
97 _RESULT_RE = r'(?:\{kString,result\},\{kString,)(\w+)(?:\})'
98 _RESULTPATH_RE = r'(?:\{kString,resultPath\},\{kString,)([\\\w\.\-\:]+)(?:\})'
101 def _build_set_cmds(values, prefix='dict set'):
102 """Generate a list of 'dict set' args for Tcl.
104 Parse a dictionary and recursively build the arguments for the
105 'dict set' Tcl command, given that this is of the format:
107 dict set [name...] [key] [value]
109 For example, for a non-nested dict (i.e. a non-dict element):
111 dict set mydict mykey myvalue
113 For a nested dict (i.e. a dict element):
115 dict set mydict mysubdict mykey myvalue
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.
121 :yields: Output strings to be passed to a `Tcl` instance.
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):
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))
143 yield ' '.join([prefix, key, value]).strip()
145 yield ' '.join([key, value]).strip()
148 class IxNet(trafficgen.ITrafficGenerator):
149 """A wrapper around IXIA IxNetwork applications.
151 Runs different traffic generator tests through an Ixia traffic
152 generator chassis by generating TCL scripts from templates.
154 Currently only the RFC2544 tests are implemented.
156 if settings.getValue('TRAFFICGEN_IXNET_TCL_SCRIPT') == '':
157 _script = os.path.join(os.path.dirname(__file__), 'ixnetrfc2544.tcl')
159 _script = os.path.join(os.path.dirname(__file__),
160 settings.getValue('TRAFFICGEN_IXNET_TCL_SCRIPT'))
161 _tclsh = tkinter.Tcl()
163 _logger = logging.getLogger(__name__)
167 def run_tcl(self, cmd):
168 """Run a TCL script using the TCL interpreter found in ``tkinter``.
170 :param cmd: Command to execute
172 :returns: Output of command, where applicable.
174 self._logger.debug('%s%s', trafficgen.CMD_PREFIX, cmd)
176 output = self._tclsh.eval(cmd)
178 return output.split()
181 """Configure system for IxNetwork.
184 'lib_path': settings.getValue('TRAFFICGEN_IXNET_LIB_PATH'),
185 # IxNetwork machine configuration
186 'machine': settings.getValue('TRAFFICGEN_IXNET_MACHINE'),
187 'port': settings.getValue('TRAFFICGEN_IXNET_PORT'),
188 'user': settings.getValue('TRAFFICGEN_IXNET_USER'),
189 # IXIA chassis configuration
190 'chassis': settings.getValue('TRAFFICGEN_IXIA_HOST'),
191 'card': settings.getValue('TRAFFICGEN_IXIA_CARD'),
192 'port1': settings.getValue('TRAFFICGEN_IXIA_PORT1'),
193 'port2': settings.getValue('TRAFFICGEN_IXIA_PORT2'),
195 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
198 self._logger.debug('IXIA configuration configuration : %s', self._cfg)
202 def disconnect(self):
203 """Disconnect from Ixia chassis.
207 def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
208 """See ITrafficGenerator for description
210 self.start_cont_traffic(traffic, duration)
212 return self.stop_cont_traffic()
214 def start_cont_traffic(self, traffic=None, duration=30):
215 """Start transmission.
217 self._bidir = traffic['bidir']
220 self._params['config'] = {
221 'binary': False, # don't do binary search and send one stream
222 'duration': duration,
223 'framerate': traffic['frame_rate'],
224 'multipleStreams': traffic['multistream'],
225 'streamType': traffic['stream_type'],
226 'rfc2544TestType': 'throughput',
228 self._params['traffic'] = self.traffic_defaults.copy()
231 self._params['traffic'] = trafficgen.merge_spec(
232 self._params['traffic'], traffic)
233 self._cfg['bidir'] = self._bidir
235 for cmd in _build_set_cmds(self._cfg, prefix='set'):
238 for cmd in _build_set_cmds(self._params):
241 output = self.run_tcl('source {%s}' % self._script)
243 self._logger.critical(
244 'An error occured when connecting to IxNetwork machine...')
245 raise RuntimeError('Ixia failed to initialise.')
247 self.run_tcl('startRfc2544Test $config $traffic')
249 self._logger.critical(
250 'Failed to start continuous traffic test')
251 raise RuntimeError('Continuous traffic test failed to start.')
253 def stop_cont_traffic(self):
254 """See ITrafficGenerator for description
256 return self._wait_result()
258 def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
259 lossrate=0.0, multistream=False):
260 """See ITrafficGenerator for description
262 self.start_rfc2544_throughput(traffic, trials, duration, lossrate)
264 return self.wait_rfc2544_throughput()
266 def start_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
268 """Start transmission.
270 self._bidir = traffic['bidir']
273 self._params['config'] = {
276 'duration': duration,
277 'lossrate': lossrate,
278 'multipleStreams': traffic['multistream'],
279 'streamType': traffic['stream_type'],
280 'rfc2544TestType': 'throughput',
282 self._params['traffic'] = self.traffic_defaults.copy()
285 self._params['traffic'] = trafficgen.merge_spec(
286 self._params['traffic'], traffic)
287 self._cfg['bidir'] = self._bidir
289 for cmd in _build_set_cmds(self._cfg, prefix='set'):
292 for cmd in _build_set_cmds(self._params):
295 output = self.run_tcl('source {%s}' % self._script)
297 self._logger.critical(
298 'An error occured when connecting to IxNetwork machine...')
299 raise RuntimeError('Ixia failed to initialise.')
301 self.run_tcl('startRfc2544Test $config $traffic')
303 self._logger.critical(
304 'Failed to start RFC2544 test')
305 raise RuntimeError('RFC2544 test failed to start.')
307 def wait_rfc2544_throughput(self):
308 """See ITrafficGenerator for description
310 return self._wait_result()
312 def _wait_result(self):
315 def parse_result_string(results):
316 """Get path to results file from output
318 Check for related errors
320 :param results: Text stream from test.
322 :returns: Path to results file.
324 result_status = re.search(_RESULT_RE, results)
325 result_path = re.search(_RESULTPATH_RE, results)
327 if not result_status or not result_path:
328 self._logger.critical(
329 'Could not parse results from IxNetwork machine...')
330 raise ValueError('Failed to parse output.')
332 if result_status.group(1) != 'pass':
333 self._logger.critical(
334 'An error occured when running tests...')
335 raise RuntimeError('Ixia failed to initialise.')
337 # transform path into someting useful
339 path = result_path.group(1).replace('\\', '/')
340 path = os.path.join(path, 'AggregateResults.csv')
342 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
343 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
346 def parse_ixnet_rfc_results(path):
347 """Parse CSV output of IxNet RFC2544 test run.
349 :param path: Input file path
351 results = OrderedDict()
353 with open(path, 'r') as in_file:
354 reader = csv.reader(in_file, delimiter=',')
357 #Replace null entries added by Ixia with 0s.
358 row = [entry if len(entry) > 0 else '0' for entry in row]
360 # tx_fps and tx_mps cannot be reliably calculated
361 # as the DUT may be modifying the frame size
365 if bool(results.get(ResultsConstants.THROUGHPUT_RX_FPS)) \
367 prev_percent_rx = 0.0
370 float(results.get(ResultsConstants.THROUGHPUT_RX_FPS))
371 if float(row[5]) >= prev_percent_rx:
372 results[ResultsConstants.TX_RATE_FPS] = tx_fps
373 results[ResultsConstants.THROUGHPUT_RX_FPS] = row[5]
374 results[ResultsConstants.TX_RATE_MBPS] = tx_mbps
375 results[ResultsConstants.THROUGHPUT_RX_MBPS] = row[6]
376 results[ResultsConstants.TX_RATE_PERCENT] = row[3]
377 results[ResultsConstants.THROUGHPUT_RX_PERCENT] = row[4]
378 results[ResultsConstants.FRAME_LOSS_PERCENT] = row[10]
379 results[ResultsConstants.MIN_LATENCY_NS] = row[11]
380 results[ResultsConstants.MAX_LATENCY_NS] = row[12]
381 results[ResultsConstants.AVG_LATENCY_NS] = row[13]
384 output = self.run_tcl('waitForRfc2544Test')
386 # the run_tcl function will return a list with one element. We extract
387 # that one element (a string representation of an IXIA-specific Tcl
388 # datatype), parse it to find the path of the results file then parse
390 return parse_ixnet_rfc_results(parse_result_string(output[0]))
392 def send_rfc2544_back2back(self, traffic=None, trials=50, duration=2,
394 """See ITrafficGenerator for description
396 # NOTE 2 seconds is the recommended duration for a back 2 back
397 # test in RFC2544. 50 trials is the recommended number from the
399 self.start_rfc2544_back2back(traffic, trials, duration, lossrate)
401 return self.wait_rfc2544_back2back()
403 def start_rfc2544_back2back(self, traffic=None, trials=50, duration=2,
405 """Start transmission.
407 self._bidir = traffic['bidir']
410 self._params['config'] = {
413 'duration': duration,
414 'lossrate': lossrate,
415 'multipleStreams': traffic['multistream'],
416 'streamType': traffic['stream_type'],
417 'rfc2544TestType': 'back2back',
419 self._params['traffic'] = self.traffic_defaults.copy()
422 self._params['traffic'] = trafficgen.merge_spec(
423 self._params['traffic'], traffic)
424 self._cfg['bidir'] = self._bidir
426 for cmd in _build_set_cmds(self._cfg, prefix='set'):
429 for cmd in _build_set_cmds(self._params):
432 output = self.run_tcl('source {%s}' % self._script)
434 self._logger.critical(
435 'An error occured when connecting to IxNetwork machine...')
436 raise RuntimeError('Ixia failed to initialise.')
438 self.run_tcl('startRfc2544Test $config $traffic')
440 self._logger.critical(
441 'Failed to start RFC2544 test')
442 raise RuntimeError('RFC2544 test failed to start.')
444 def wait_rfc2544_back2back(self):
447 def parse_result_string(results):
448 """Get path to results file from output
450 Check for related errors
452 :param results: Text stream from test.
454 :returns: Path to results file.
456 result_status = re.search(_RESULT_RE, results)
457 result_path = re.search(_RESULTPATH_RE, results)
459 if not result_status or not result_path:
460 self._logger.critical(
461 'Could not parse results from IxNetwork machine...')
462 raise ValueError('Failed to parse output.')
464 if result_status.group(1) != 'pass':
465 self._logger.critical(
466 'An error occured when running tests...')
467 raise RuntimeError('Ixia failed to initialise.')
469 # transform path into something useful
471 path = result_path.group(1).replace('\\', '/')
472 path = os.path.join(path, 'iteration.csv')
474 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
475 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
479 def parse_ixnet_rfc_results(path):
480 """Parse CSV output of IxNet RFC2544 Back2Back test run.
482 :param path: Input file path
484 :returns: Best parsed result from CSV file.
486 results = OrderedDict()
487 results[ResultsConstants.B2B_FRAMES] = 0
488 results[ResultsConstants.B2B_FRAME_LOSS_PERCENT] = 100
490 with open(path, 'r') as in_file:
491 reader = csv.reader(in_file, delimiter=',')
494 # if back2back count higher than previously found, store it
495 # Note: row[N] here refers to the Nth column of a row
496 if float(row[14]) <= self._params['config']['lossrate']:
498 int(results[ResultsConstants.B2B_FRAMES]):
499 results[ResultsConstants.B2B_FRAMES] = int(row[12])
500 results[ResultsConstants.B2B_FRAME_LOSS_PERCENT] = float(row[14])
504 output = self.run_tcl('waitForRfc2544Test')
506 # the run_tcl function will return a list with one element. We extract
507 # that one element (a string representation of an IXIA-specific Tcl
508 # datatype), parse it to find the path of the results file then parse
511 return parse_ixnet_rfc_results(parse_result_string(output[0]))
514 if __name__ == '__main__':
519 'dstip': '10.1.1.254',
524 print(dev.send_cont_traffic())
525 print(dev.send_rfc2544_throughput())