core/traffic_controller_rfc2544.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 """RFC2544 Traffic Controller implementation.
  15 """
  16 import logging
  17
  18 from core.traffic_controller import ITrafficController
  19 from core.results.results_constants import ResultsConstants
  20 from core.results.results import IResults
  21 from conf import settings
  22 from conf import get_test_param
  23
  24
  25 class TrafficControllerRFC2544(ITrafficController, IResults):
  26     """Traffic controller for RFC2544 traffic
  27
  28     Used to setup and control a traffic generator for an RFC2544 deployment
  29     traffic scenario.
  30     """
  31
  32     def __init__(self, traffic_gen_class):
  33         """Initialise the trafficgen and store.
  34
  35         :param traffic_gen_class: The traffic generator class to be used.
  36         """
  37         self._logger = logging.getLogger(__name__)
  38         self._logger.debug("__init__")
  39         self._traffic_gen_class = traffic_gen_class()
  40         self._traffic_started = False
  41         self._traffic_started_call_count = 0
  42         self._packet_sizes = settings.getValue('TRAFFICGEN_PKT_SIZES')
  43         self._trials = get_test_param('rfc2544_trials', 1)
  44         self._results = []
  45
  46     def __enter__(self):
  47         """Call initialisation function.
  48         """
  49         self._traffic_gen_class.connect()
  50
  51     def __exit__(self, type_, value, traceback):
  52         """Stop traffic, clean up.
  53         """
  54         if self._traffic_started:
  55             self.stop_traffic()
  56
  57     @staticmethod
  58     def _append_results(result_dict, packet_size):
  59         """Adds common values to traffic generator results.
  60
  61         :param result_dict: Dictionary containing results from trafficgen
  62         :param packet_size: Packet size value.
  63
  64         :returns: dictionary of results with addictional entries.
  65         """
  66
  67         ret_value = result_dict
  68
  69         #TODO Old TOIT controller had knowledge about scenario beeing
  70         #executed, should new controller also fill Configuration & ID,
  71         # or this should be passed to TestCase?
  72         ret_value[ResultsConstants.TYPE] = 'rfc2544'
  73         ret_value[ResultsConstants.PACKET_SIZE] = str(packet_size)
  74
  75         return ret_value
  76
  77     def send_traffic(self, traffic):
  78         """See ITrafficController for description
  79         """
  80         self._logger.debug('send_traffic with ' +
  81                            str(self._traffic_gen_class))
  82
  83         for packet_size in self._packet_sizes:
  84             traffic['l2'] = {'framesize': packet_size}
  85             result = self._traffic_gen_class.send_rfc2544_throughput(
  86                 traffic,
  87                 trials=int(self._trials),
  88                 duration=int(get_test_param('rfc2544_duration', 20)))
  89             result = TrafficControllerRFC2544._append_results(result,
  90                                                               packet_size)
  91             self._results.append(result)
  92
  93     def send_traffic_async(self, traffic, function):
  94         """See ITrafficController for description
  95         """
  96         self._logger.debug('send_traffic_async with ' +
  97                            str(self._traffic_gen_class))
  98
  99         for packet_size in self._packet_sizes:
 100             traffic['l2'] = {'framesize': packet_size}
 101             self._traffic_gen_class.start_rfc2544_throughput(
 102                 traffic,
 103                 trials=int(self._trials),
 104                 duration=int(get_test_param('rfc2544_duration', 20)))
 105             self._traffic_started = True
 106             if len(function['args']) > 0:
 107                 function['function'](function['args'])
 108             else:
 109                 function['function']()
 110             result = self._traffic_gen_class.wait_rfc2544_throughput()
 111             result = TrafficControllerRFC2544._append_results(result,
 112                                                               packet_size)
 113             self._results.append(result)
 114
 115     def stop_traffic(self):
 116         """Kills traffic being sent from the traffic generator.
 117         """
 118         self._logger.debug("stop_traffic()")
 119
 120     def print_results(self):
 121         """IResult interface implementation.
 122         """
 123         counter = 0
 124         for item in self._results:
 125             logging.info("Record: " + str(counter))
 126             counter += 1
 127             for(key, value) in list(item.items()):
 128                 logging.info("         Key: " + str(key) +
 129                              ", Value: " + str(value))
 130
 131
 132     def get_results(self):
 133         """IResult interface implementation.
 134         """
 135         return self._results