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
  51     def run(self):
  52         """Run the test
  53
  54         All setup and teardown through controllers is included.
  55         """
  56         self._logger.debug(self.name)
  57
  58         self._logger.debug("Controllers:")
  59         loader = Loader()
  60         traffic_ctl = component_factory.create_traffic(
  61             self._traffic_type,
  62             loader.get_trafficgen_class())
  63         vnf_ctl = component_factory.create_vnf(
  64             self._deployment,
  65             loader.get_vnf_class())
  66         vswitch_ctl = component_factory.create_vswitch(
  67             self._deployment,
  68             loader.get_vswitch_class())
  69         collector_ctl = component_factory.create_collector(
  70             self._collector,
  71             loader.get_collector_class())
  72
  73
  74         self._logger.debug("Setup:")
  75         collector_ctl.log_cpu_stats()
  76         with vswitch_ctl:
  77             if vnf_ctl:
  78                 vnf_ctl.start()
  79                 traffic = {'traffic_type': self._traffic_type, 'bidir': self._bidir}
  80                 vswitch = vswitch_ctl.get_vswitch()
  81                 if self._frame_mod == "vlan":
  82                     flow = {'table':'2', 'priority':'1000', 'metadata':'2', 'actions': ['push_vlan:0x8100','goto_table:3']}
  83                     vswitch.add_flow('br0', flow)
  84                     flow = {'table':'2', 'priority':'1000', 'metadata':'1', 'actions': ['push_vlan:0x8100','goto_table:3']}
  85                     vswitch.add_flow('br0', flow)
  86
  87             with traffic_ctl:
  88                 traffic_ctl.send_traffic(traffic)
  89
  90
  91         self._logger.debug("Traffic Results:")
  92         traffic_ctl.print_results()
  93
  94         self._logger.debug("Collector Results:")
  95         self._logger.debug(collector_ctl.get_results())
  96
  97
  98         output_file = "result_" + self.name + "_" + self._deployment +".csv"
  99
 100         self._write_result_to_file(
 101             traffic_ctl.get_results(),
 102             os.path.join(self._results_dir, output_file))
 103
 104     @staticmethod
 105     def _write_result_to_file(results, output):
 106         """Write list of dictionaries to a CSV file.
 107
 108         Each element on list will create separate row in output file.
 109         If output file already exists, data will be appended at the end,
 110         otherwise it will be created.
 111
 112         :param results: list of dictionaries.
 113         :param output: path to output file.
 114         """
 115         with open(output, 'a') as csvfile:
 116
 117             logging.info("Write results to file: " + output)
 118             fieldnames = TestCase._get_unique_keys(results)
 119
 120             writer = csv.DictWriter(csvfile, fieldnames)
 121
 122             if not csvfile.tell():  # file is now empty
 123                 writer.writeheader()
 124
 125             for result in results:
 126                 writer.writerow(result)
 127
 128
 129     @staticmethod
 130     def _get_unique_keys(list_of_dicts):
 131         """Gets unique key values as ordered list of strings in given dicts
 132
 133         :param list_of_dicts: list of dictionaries.
 134
 135         :returns: list of unique keys(strings).
 136         """
 137         result = OrderedDict()
 138         for item in list_of_dicts:
 139             for key in item.keys():
 140                 result[key] = ''
 141
 142         return list(result.keys())