1 # Copyright 2015 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 _script = os.path.join(os.path.dirname(__file__), 'ixnetrfc2544.tcl')
157 _tclsh = tkinter.Tcl()
159 _logger = logging.getLogger(__name__)
163 def run_tcl(self, cmd):
164 """Run a TCL script using the TCL interpreter found in ``tkinter``.
166 :param cmd: Command to execute
168 :returns: Output of command, where applicable.
170 self._logger.debug('%s%s', trafficgen.CMD_PREFIX, cmd)
172 output = self._tclsh.eval(cmd)
174 return output.split()
177 """Configure system for IxNetwork.
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'),
191 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
194 self._logger.debug('IXIA configuration configuration : %s', self._cfg)
198 def disconnect(self):
199 """Disconnect from Ixia chassis.
203 def send_cont_traffic(self, traffic=None, duration=30, multistream=False):
204 """See ITrafficGenerator for description
206 self.start_cont_traffic(traffic, duration)
208 return self.stop_cont_traffic()
210 def start_cont_traffic(self, traffic=None, duration=30):
211 """Start transmission.
213 self._bidir = traffic['bidir']
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 'streamType': traffic['stream_type'],
222 'rfc2544TestType': 'throughput',
224 self._params['traffic'] = self.traffic_defaults.copy()
227 self._params['traffic'] = trafficgen.merge_spec(
228 self._params['traffic'], traffic)
229 self._cfg['bidir'] = self._bidir
231 for cmd in _build_set_cmds(self._cfg, prefix='set'):
234 for cmd in _build_set_cmds(self._params):
237 output = self.run_tcl('source {%s}' % self._script)
239 self._logger.critical(
240 'An error occured when connecting to IxNetwork machine...')
241 raise RuntimeError('Ixia failed to initialise.')
243 self.run_tcl('startRfc2544Test $config $traffic')
245 self._logger.critical(
246 'Failed to start continuous traffic test')
247 raise RuntimeError('Continuous traffic test failed to start.')
249 def stop_cont_traffic(self):
250 """See ITrafficGenerator for description
252 return self._wait_result()
254 def send_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
255 lossrate=0.0, multistream=False):
256 """See ITrafficGenerator for description
258 self.start_rfc2544_throughput(traffic, trials, duration, lossrate)
260 return self.wait_rfc2544_throughput()
262 def start_rfc2544_throughput(self, traffic=None, trials=3, duration=20,
264 """Start transmission.
266 self._bidir = traffic['bidir']
269 self._params['config'] = {
272 'duration': duration,
273 'lossrate': lossrate,
274 'multipleStreams': traffic['multistream'],
275 'streamType': traffic['stream_type'],
276 'rfc2544TestType': 'throughput',
278 self._params['traffic'] = self.traffic_defaults.copy()
281 self._params['traffic'] = trafficgen.merge_spec(
282 self._params['traffic'], traffic)
283 self._cfg['bidir'] = self._bidir
285 for cmd in _build_set_cmds(self._cfg, prefix='set'):
288 for cmd in _build_set_cmds(self._params):
291 output = self.run_tcl('source {%s}' % self._script)
293 self._logger.critical(
294 'An error occured when connecting to IxNetwork machine...')
295 raise RuntimeError('Ixia failed to initialise.')
297 self.run_tcl('startRfc2544Test $config $traffic')
299 self._logger.critical(
300 'Failed to start RFC2544 test')
301 raise RuntimeError('RFC2544 test failed to start.')
303 def wait_rfc2544_throughput(self):
304 """See ITrafficGenerator for description
306 return self._wait_result()
308 def _wait_result(self):
311 def parse_result_string(results):
312 """Get path to results file from output
314 Check for related errors
316 :param results: Text stream from test.
318 :returns: Path to results file.
320 result_status = re.search(_RESULT_RE, results)
321 result_path = re.search(_RESULTPATH_RE, results)
323 if not result_status or not result_path:
324 self._logger.critical(
325 'Could not parse results from IxNetwork machine...')
326 raise ValueError('Failed to parse output.')
328 if result_status.group(1) != 'pass':
329 self._logger.critical(
330 'An error occured when running tests...')
331 raise RuntimeError('Ixia failed to initialise.')
333 # transform path into someting useful
335 path = result_path.group(1).replace('\\', '/')
336 path = os.path.join(path, 'AggregateResults.csv')
338 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
339 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
342 def parse_ixnet_rfc_results(path):
343 """Parse CSV output of IxNet RFC2544 test run.
345 :param path: Input file path
347 results = OrderedDict()
349 with open(path, 'r') as in_file:
350 reader = csv.reader(in_file, delimiter=',')
353 #Replace null entries added by Ixia with 0s.
354 row = [entry if len(entry) > 0 else '0' for entry in row]
356 # tx_fps and tx_mps cannot be reliably calculated
357 # as the DUT may be modifying the frame size
361 if bool(results.get(ResultsConstants.THROUGHPUT_RX_FPS)) \
363 prev_percent_rx = 0.0
366 float(results.get(ResultsConstants.THROUGHPUT_RX_FPS))
367 if float(row[5]) >= prev_percent_rx:
368 results[ResultsConstants.TX_RATE_FPS] = tx_fps
369 results[ResultsConstants.THROUGHPUT_RX_FPS] = row[5]
370 results[ResultsConstants.TX_RATE_MBPS] = tx_mbps
371 results[ResultsConstants.THROUGHPUT_RX_MBPS] = row[6]
372 results[ResultsConstants.TX_RATE_PERCENT] = row[3]
373 results[ResultsConstants.THROUGHPUT_RX_PERCENT] = row[4]
374 results[ResultsConstants.MIN_LATENCY_NS] = row[11]
375 results[ResultsConstants.MAX_LATENCY_NS] = row[12]
376 results[ResultsConstants.AVG_LATENCY_NS] = row[13]
379 output = self.run_tcl('waitForRfc2544Test')
381 # the run_tcl function will return a list with one element. We extract
382 # that one element (a string representation of an IXIA-specific Tcl
383 # datatype), parse it to find the path of the results file then parse
385 return parse_ixnet_rfc_results(parse_result_string(output[0]))
387 def send_rfc2544_back2back(self, traffic=None, trials=1, duration=20,
389 """See ITrafficGenerator for description
391 self.start_rfc2544_back2back(traffic, trials, duration, lossrate)
393 return self.wait_rfc2544_back2back()
395 def start_rfc2544_back2back(self, traffic=None, trials=1, duration=20,
397 """Start transmission.
399 self._bidir = traffic['bidir']
402 self._params['config'] = {
405 'duration': duration,
406 'lossrate': lossrate,
407 'multipleStreams': traffic['multistream'],
408 'streamType': traffic['stream_type'],
409 'rfc2544TestType': 'back2back',
411 self._params['traffic'] = self.traffic_defaults.copy()
414 self._params['traffic'] = trafficgen.merge_spec(
415 self._params['traffic'], traffic)
416 self._cfg['bidir'] = self._bidir
418 for cmd in _build_set_cmds(self._cfg, prefix='set'):
421 for cmd in _build_set_cmds(self._params):
424 output = self.run_tcl('source {%s}' % self._script)
426 self._logger.critical(
427 'An error occured when connecting to IxNetwork machine...')
428 raise RuntimeError('Ixia failed to initialise.')
430 self.run_tcl('startRfc2544Test $config $traffic')
432 self._logger.critical(
433 'Failed to start RFC2544 test')
434 raise RuntimeError('RFC2544 test failed to start.')
436 def wait_rfc2544_back2back(self):
439 def parse_result_string(results):
440 """Get path to results file from output
442 Check for related errors
444 :param results: Text stream from test.
446 :returns: Path to results file.
448 result_status = re.search(_RESULT_RE, results)
449 result_path = re.search(_RESULTPATH_RE, results)
451 if not result_status or not result_path:
452 self._logger.critical(
453 'Could not parse results from IxNetwork machine...')
454 raise ValueError('Failed to parse output.')
456 if result_status.group(1) != 'pass':
457 self._logger.critical(
458 'An error occured when running tests...')
459 raise RuntimeError('Ixia failed to initialise.')
461 # transform path into something useful
463 path = result_path.group(1).replace('\\', '/')
464 path = os.path.join(path, 'iteration.csv')
466 settings.getValue('TRAFFICGEN_IXNET_TESTER_RESULT_DIR'),
467 settings.getValue('TRAFFICGEN_IXNET_DUT_RESULT_DIR'))
471 def parse_ixnet_rfc_results(path):
472 """Parse CSV output of IxNet RFC2544 Back2Back test run.
474 :param path: Input file path
476 :returns: Best parsed result from CSV file.
478 results = OrderedDict()
479 results[ResultsConstants.B2B_FRAMES] = 0
481 with open(path, 'r') as in_file:
482 reader = csv.reader(in_file, delimiter=',')
485 # if back2back count higher than previously found, store it
486 # Note: row[N] here refers to the Nth column of a row
487 if float(row[14]) <= self._params['config']['lossrate']:
489 int(results[ResultsConstants.B2B_FRAMES]):
490 results[ResultsConstants.B2B_FRAMES] = int(row[12])
494 output = self.run_tcl('waitForRfc2544Test')
496 # the run_tcl function will return a list with one element. We extract
497 # that one element (a string representation of an IXIA-specific Tcl
498 # datatype), parse it to find the path of the results file then parse
501 return parse_ixnet_rfc_results(parse_result_string(output[0]))
504 if __name__ == '__main__':
509 'dstip': '10.1.1.254',
514 print(dev.send_cont_traffic())
515 print(dev.send_rfc2544_throughput())