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