3 # Copyright (c) 2016 Orange and others.
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 """Define the parent class of all VNF TestCases."""
15 import functest.core.testcase as base
16 from functest.utils.constants import CONST
17 from snaps.openstack.create_user import UserSettings, OpenStackUser
18 from snaps.openstack.create_project import ProjectSettings, OpenStackProject
19 from snaps.openstack.tests import openstack_tests
21 __author__ = ("Morgan Richomme <morgan.richomme@orange.com>, "
22 "Valentin Boucher <valentin.boucher@orange.com>")
25 class VnfPreparationException(Exception):
26 """Raise when VNF preparation cannot be executed."""
29 class OrchestratorDeploymentException(Exception):
30 """Raise when orchestrator cannot be deployed."""
33 class VnfDeploymentException(Exception):
34 """Raise when VNF cannot be deployed."""
37 class VnfTestException(Exception):
38 """Raise when VNF cannot be tested."""
41 class VnfOnBoarding(base.TestCase):
42 """Base model for VNF test cases."""
44 __logger = logging.getLogger(__name__)
46 def __init__(self, **kwargs):
47 super(VnfOnBoarding, self).__init__(**kwargs)
48 self.tenant_name = CONST.__getattribute__(
49 'vnf_{}_tenant_name'.format(self.case_name))
51 self.created_object = []
52 self.os_project = None
54 def run(self, **kwargs):
56 Run of the VNF test case:
58 * Deploy an orchestrator if needed (e.g. heat, cloudify, ONAP,...),
60 * Perform tests on the VNF
62 A VNF test case is successfull when the 3 steps are PASS
63 If one of the step is FAIL, the test case is FAIL
66 TestCase.EX_OK if result is 'PASS'.
67 TestCase.EX_TESTCASE_FAILED otherwise.
69 self.start_time = time.time()
73 if (self.deploy_orchestrator() and
76 self.stop_time = time.time()
77 # Calculation with different weight depending on the steps TODO
79 return base.TestCase.EX_OK
82 self.stop_time = time.time()
83 return base.TestCase.EX_TESTCASE_FAILED
84 except Exception: # pylint: disable=broad-except
85 self.stop_time = time.time()
86 self.__logger.exception("Exception on VNF testing")
87 return base.TestCase.EX_TESTCASE_FAILED
91 Prepare the environment for VNF testing:
94 * Creation of a tenant,
95 * Allocation admin role to the user on this tenant
97 Returns base.TestCase.EX_OK if preparation is successfull
99 Raise VnfPreparationException in case of problem
102 tenant_description = CONST.__getattribute__(
103 'vnf_{}_tenant_description'.format(self.case_name))
104 self.__logger.info("Prepare VNF: %s, description: %s",
105 self.tenant_name, tenant_description)
106 snaps_creds = openstack_tests.get_credentials(
107 os_env_file=CONST.__getattribute__('openstack_creds'))
109 project_creator = OpenStackProject(
112 name=self.tenant_name,
113 description=tenant_description
115 project_creator.create()
116 self.created_object.append(project_creator)
117 self.os_project = project_creator
119 user_creator = OpenStackUser(
122 name=self.tenant_name,
123 password=self.tenant_name,
124 roles={'admin': self.tenant_name}))
126 user_creator.create()
127 self.created_object.append(user_creator)
129 self.snaps_creds = user_creator.get_os_creds(self.tenant_name)
131 return base.TestCase.EX_OK
132 except Exception: # pylint: disable=broad-except
133 self.__logger.exception("Exception raised during VNF preparation")
134 raise VnfPreparationException
136 def deploy_orchestrator(self):
138 Deploy an orchestrator (optional).
140 If this method is overriden then raise orchestratorDeploymentException
141 if error during orchestrator deployment
143 self.__logger.info("Deploy orchestrator (if necessary)")
146 def deploy_vnf(self):
150 This function MUST be implemented by vnf test cases.
151 The details section MAY be updated in the vnf test cases.
153 The deployment can be executed via a specific orchestrator
154 or using build-in orchestrators such as heat, OpenBaton, cloudify,
158 True if the VNF is properly deployed
159 False if the VNF is not deployed
161 Raise VnfDeploymentException if error during VNF deployment
163 self.__logger.error("VNF must be deployed")
164 raise VnfDeploymentException
170 This function MUST be implemented by vnf test cases.
171 The details section MAY be updated in the vnf test cases.
173 Once a VNF is deployed, it is assumed that specific test suite can be
174 run to validate the VNF.
175 Please note that the same test suite can be used on several test case
176 (e.g. clearwater test suite can be used whatever the orchestrator used
180 True if VNF tests are PASS
181 False if test suite is FAIL
183 Raise VnfTestException if error during VNF test
185 self.__logger.error("VNF must be tested")
186 raise VnfTestException
192 It is up to the test providers to delete resources used for the tests.
198 self.__logger.info("test cleaning")
199 self.__logger.info('Remove the cloudify manager OS object ..')
200 for creator in reversed(self.created_object):
203 except Exception as exc: # pylint: disable=broad-except
204 self.__logger.error('Unexpected error cleaning - %s', exc)