core/component_factory.py

   1 # Copyright 2015-2016 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
  15 """Functions for creating controller objects based on deployment or traffic
  16 """
  17
  18 from core.traffic_controller_rfc2544 import TrafficControllerRFC2544
  19 from core.traffic_controller_rfc2889 import TrafficControllerRFC2889
  20 from core.vswitch_controller_clean import VswitchControllerClean
  21 from core.vswitch_controller_p2p import VswitchControllerP2P
  22 from core.vswitch_controller_pxp import VswitchControllerPXP
  23 from core.vswitch_controller_op2p import VswitchControllerOP2P
  24 from core.vswitch_controller_ptunp import VswitchControllerPtunP
  25 from core.vnf_controller import VnfController
  26 from core.pktfwd_controller import PktFwdController
  27 from tools.load_gen.stress.stress import Stress
  28 from tools.load_gen.stress_ng.stress_ng import StressNg
  29 from tools.load_gen.dummy.dummy import DummyLoadGen
  30
  31
  32 def __init__():
  33     """Finds and loads all the modules required.
  34
  35     Very similar code to load_trafficgens().
  36     """
  37     pass
  38
  39 def create_traffic(traffic_type, trafficgen_class):
  40     """Return a new IVSwitchController for the traffic type.
  41
  42     The returned traffic controller has the given traffic type and traffic
  43     generator class.
  44
  45     traffic_types: 'rfc2544_throughput'
  46
  47     :param traffic_type: Name of traffic type
  48     :param trafficgen_class: Reference to traffic generator class to be used.
  49     :return: A new ITrafficController
  50     """
  51     if traffic_type.lower().startswith('rfc2889'):
  52         return TrafficControllerRFC2889(trafficgen_class)
  53     else:
  54         return TrafficControllerRFC2544(trafficgen_class)
  55
  56
  57 def create_vswitch(deployment_scenario, vswitch_class, traffic,
  58                    tunnel_operation=None):
  59     """Return a new IVSwitchController for the deployment_scenario.
  60
  61     The returned controller is configured with the given vSwitch class.
  62
  63     Deployment scenarios: e.g. 'p2p', 'pvp', 'pvpv12', etc.
  64
  65     :param deployment_scenario: The deployment scenario name
  66     :param vswitch_class: Reference to vSwitch class to be used.
  67     :param traffic: Dictionary with traffic specific details
  68     :param tunnel_operation encapsulation/decapsulation or None
  69     :return: IVSwitchController for the deployment_scenario
  70     """
  71     deployment_scenario = deployment_scenario.lower()
  72     if deployment_scenario.startswith("p2p"):
  73         return VswitchControllerP2P(vswitch_class, traffic)
  74     elif deployment_scenario.startswith("pvp"):
  75         return VswitchControllerPXP(deployment_scenario, vswitch_class, traffic)
  76     elif deployment_scenario.startswith("pvvp"):
  77         return VswitchControllerPXP(deployment_scenario, vswitch_class, traffic)
  78     elif deployment_scenario.startswith("pvpv"):
  79         return VswitchControllerPXP(deployment_scenario, vswitch_class, traffic)
  80     elif deployment_scenario.startswith("op2p"):
  81         return VswitchControllerOP2P(vswitch_class, traffic, tunnel_operation)
  82     elif deployment_scenario.startswith("ptunp"):
  83         return VswitchControllerPtunP(vswitch_class, traffic)
  84     elif deployment_scenario.startswith("clean"):
  85         return VswitchControllerClean(vswitch_class, traffic)
  86     else:
  87         raise RuntimeError("Unknown deployment scenario '{}'.".format(deployment_scenario))
  88
  89
  90 def create_vnf(deployment_scenario, vnf_class):
  91     """Return a new VnfController for the deployment_scenario.
  92
  93     The returned controller is configured with the given VNF class.
  94
  95     Deployment scenarios: 'p2p', 'pvp'
  96
  97     :param deployment_scenario: The deployment scenario name
  98     :param vswitch_class: Reference to vSwitch class to be used.
  99     :return: VnfController for the deployment_scenario
 100     """
 101     return VnfController(deployment_scenario, vnf_class)
 102
 103 def create_collector(collector_class, result_dir, test_name):
 104     """Return a new Collector of the given class
 105
 106     :param collector_class: The collector class to be used.
 107     :param result_dir: Directory with test results
 108     :param test_name: Test to be run
 109     :return: A new CollectorController.
 110     """
 111     return collector_class(result_dir, test_name)
 112
 113 def create_loadgen(loadgen_type, loadgen_cfg):
 114     """Return a new ILoadGenerator for the loadgen type.
 115
 116     The returned load generator has the given loadgen type and loadgen
 117     generator class.
 118
 119     :param loadgen_type: Name of loadgen type
 120     :param loadgen_class: Reference to load generator class to be used.
 121     :return: A new ILoadGenerator class
 122     """
 123     loadgen_type = loadgen_type.lower()
 124     if loadgen_type.find("dummy") >= 0:
 125         return DummyLoadGen(loadgen_cfg)
 126     elif loadgen_type.find("stress-ng") >= 0:
 127         return StressNg(loadgen_cfg)
 128     elif loadgen_type.find("stress") >= 0:
 129         return Stress(loadgen_cfg)
 130
 131 def create_pktfwd(deployment, pktfwd_class):
 132     """Return a new packet forwarder controller
 133
 134     The returned controller is configured with the given
 135     packet forwarder class.
 136
 137     :param pktfwd_class: Reference to packet forwarder class to be used.
 138     :param deployment: The deployment scenario name
 139     :return: packet forwarder controller
 140     """
 141     return PktFwdController(deployment, pktfwd_class)