testcases/testcase.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 """TestCase base class
  15 """
  16
  17 import time
  18 import csv
  19 import os
  20 import logging
  21 from collections import OrderedDict
  22
  23 import core.component_factory as component_factory
  24 from core.loader import Loader
  25
  26 class TestCase(object):
  27     """TestCase base class
  28
  29     In this basic form runs RFC2544 throughput test
  30     """
  31     def __init__(self, cfg, results_dir):
  32         """Pull out fields from test config
  33
  34         :param cfg: A dictionary of string-value pairs describing the test
  35             configuration. Both the key and values strings use well-known
  36             values.
  37         :param results_dir: Where the csv formatted results are written.
  38         """
  39         self._logger = logging.getLogger(__name__)
  40         self.name = cfg['Name']
  41         self.desc = cfg.get('Description', 'No description given.')
  42         self._traffic_type = cfg['Traffic Type']
  43         self._deployment = cfg['Deployment']
  44         self._collector = cfg['Collector']
  45         self._bidir = cfg['biDirectional']
  46         self._frame_mod = cfg.get('Frame Modification', None)
  47         if self._frame_mod:
  48             self._frame_mod = self._frame_mod.lower()
  49         self._results_dir = results_dir
  50         self._multistream = cfg.get('MultiStream', 0)
  51
  52     def run(self):
  53         """Run the test
  54
  55         All setup and teardown through controllers is included.
  56         """
  57         self._logger.debug(self.name)
  58
  59         self._logger.debug("Controllers:")
  60         loader = Loader()
  61         traffic_ctl = component_factory.create_traffic(
  62             self._traffic_type,
  63             loader.get_trafficgen_class())
  64         vnf_ctl = component_factory.create_vnf(
  65             self._deployment,
  66             loader.get_vnf_class())
  67         vswitch_ctl = component_factory.create_vswitch(
  68             self._deployment,
  69             loader.get_vswitch_class())
  70         collector_ctl = component_factory.create_collector(
  71             self._collector,
  72             loader.get_collector_class())
  73
  74
  75         self._logger.debug("Setup:")
  76         collector_ctl.log_cpu_stats()
  77         with vswitch_ctl:
  78             if vnf_ctl:
  79                 vnf_ctl.start()
  80                 traffic = {'traffic_type': self._traffic_type,
  81                            'bidir': self._bidir,
  82                            'multistream': self._multistream}
  83                 vswitch = vswitch_ctl.get_vswitch()
  84                 if self._frame_mod == "vlan":
  85                     flow = {'table':'2', 'priority':'1000', 'metadata':'2', 'actions': ['push_vlan:0x8100','goto_table:3']}
  86                     vswitch.add_flow('br0', flow)
  87                     flow = {'table':'2', 'priority':'1000', 'metadata':'1', 'actions': ['push_vlan:0x8100','goto_table:3']}
  88                     vswitch.add_flow('br0', flow)
  89
  90             with traffic_ctl:
  91                 traffic_ctl.send_traffic(traffic)
  92
  93
  94         self._logger.debug("Traffic Results:")
  95         traffic_ctl.print_results()
  96
  97         self._logger.debug("Collector Results:")
  98         self._logger.debug(collector_ctl.get_results())
  99
 100
 101         output_file = "result_" + self.name + "_" + self._deployment +".csv"
 102
 103         self._write_result_to_file(
 104             traffic_ctl.get_results(),
 105             os.path.join(self._results_dir, output_file))
 106
 107     @staticmethod
 108     def _write_result_to_file(results, output):
 109         """Write list of dictionaries to a CSV file.
 110
 111         Each element on list will create separate row in output file.
 112         If output file already exists, data will be appended at the end,
 113         otherwise it will be created.
 114
 115         :param results: list of dictionaries.
 116         :param output: path to output file.
 117         """
 118         with open(output, 'a') as csvfile:
 119
 120             logging.info("Write results to file: " + output)
 121             fieldnames = TestCase._get_unique_keys(results)
 122
 123             writer = csv.DictWriter(csvfile, fieldnames)
 124
 125             if not csvfile.tell():  # file is now empty
 126                 writer.writeheader()
 127
 128             for result in results:
 129                 writer.writerow(result)
 130
 131
 132     @staticmethod
 133     def _get_unique_keys(list_of_dicts):
 134         """Gets unique key values as ordered list of strings in given dicts
 135
 136         :param list_of_dicts: list of dictionaries.
 137
 138         :returns: list of unique keys(strings).
 139         """
 140         result = OrderedDict()
 141         for item in list_of_dicts:
 142             for key in item.keys():
 143                 result[key] = ''
 144
 145         return list(result.keys())