core/vnf_controller.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 """ VNF Controller interface
  15 """
  16
  17 import logging
  18 from vnfs.vnf.vnf import IVnf
  19
  20 class VnfController(object):
  21     """VNF controller class
  22
  23     Used to set-up and control VNFs for specified scenario
  24
  25     Attributes:
  26         _vnf_class: A class object representing the VNF to be used.
  27         _deployment_scenario: A string describing the scenario to set-up in the
  28             constructor.
  29         _vnfs: A list of vnfs controlled by the controller.
  30     """
  31
  32     def __init__(self, deployment_scenario, vnf_class):
  33         """Sets up the VNF infrastructure for the PVP deployment scenario.
  34
  35         :param vnf_class: The VNF class to be used.
  36         """
  37         # reset VNF ID counter for each testcase
  38         IVnf.reset_vnf_counter()
  39
  40         # setup controller with requested number of VNFs
  41         self._logger = logging.getLogger(__name__)
  42         self._vnf_class = vnf_class
  43         self._deployment_scenario = deployment_scenario.upper()
  44         if self._deployment_scenario == 'P2P':
  45             self._vnfs = []
  46         elif self._deployment_scenario == 'PVP':
  47             self._vnfs = [vnf_class()]
  48         elif self._deployment_scenario == 'PVVP':
  49             self._vnfs = [vnf_class(), vnf_class()]
  50         elif self._deployment_scenario == 'OP2P':
  51             self._vnfs = []
  52         else:
  53             self._vnfs = []
  54         self._logger.debug('__init__ ' + str(len(self._vnfs)) +
  55                            ' VNF[s] with ' + ' '.join(map(str, self._vnfs)))
  56
  57     def get_vnfs(self):
  58         """Returns a list of vnfs controlled by this controller.
  59         """
  60         self._logger.debug('get_vnfs ' + str(len(self._vnfs)) +
  61                            ' VNF[s] with ' + ' '.join(map(str, self._vnfs)))
  62         return self._vnfs
  63
  64     def start(self):
  65         """Boots all VNFs set-up by __init__.
  66
  67         This is a blocking function.
  68         """
  69         self._logger.debug('start ' + str(len(self._vnfs)) +
  70                            ' VNF[s] with ' + ' '.join(map(str, self._vnfs)))
  71         for vnf in self._vnfs:
  72             vnf.start()
  73
  74     def stop(self):
  75         """Stops all VNFs set-up by __init__.
  76
  77         This is a blocking function.
  78         """
  79         self._logger.debug('stop ' + str(len(self._vnfs)) +
  80                            ' VNF[s] with ' + ' '.join(map(str, self._vnfs)))
  81         for vnf in self._vnfs:
  82             vnf.stop()
  83
  84     def __enter__(self):
  85         self.start()
  86
  87     def __exit__(self, type_, value, traceback):
  88         self.stop()