1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
#!/usr/bin/env python
# Copyright (c) 2016 Orange and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
"""Define the parent class of all VNF TestCases."""
import logging
import time
import uuid
from snaps.config.user import UserConfig
from snaps.config.project import ProjectConfig
from snaps.openstack.create_user import OpenStackUser
from snaps.openstack.create_project import OpenStackProject
from snaps.openstack.tests import openstack_tests
from xtesting.core import testcase
from xtesting.utils import constants
__author__ = ("Morgan Richomme <morgan.richomme@orange.com>, "
"Valentin Boucher <valentin.boucher@orange.com>")
class VnfPreparationException(Exception):
"""Raise when VNF preparation cannot be executed."""
class OrchestratorDeploymentException(Exception):
"""Raise when orchestrator cannot be deployed."""
class VnfDeploymentException(Exception):
"""Raise when VNF cannot be deployed."""
class VnfTestException(Exception):
"""Raise when VNF cannot be tested."""
class VnfOnBoarding(testcase.TestCase):
# pylint: disable=too-many-instance-attributes
"""Base model for VNF test cases."""
__logger = logging.getLogger(__name__)
def __init__(self, **kwargs):
super(VnfOnBoarding, self).__init__(**kwargs)
self.uuid = uuid.uuid4()
self.user_name = "{}-{}".format(self.case_name, self.uuid)
self.tenant_name = "{}-{}".format(self.case_name, self.uuid)
self.snaps_creds = {}
self.created_object = []
self.os_project = None
self.tenant_description = "Created by OPNFV Functest: {}".format(
self.case_name)
def run(self, **kwargs):
"""
Run of the VNF test case:
* Deploy an orchestrator if needed (e.g. heat, cloudify, ONAP,...),
* Deploy the VNF,
* Perform tests on the VNF
A VNF test case is successfull when the 3 steps are PASS
If one of the step is FAIL, the test case is FAIL
Returns:
TestCase.EX_OK if result is 'PASS'.
TestCase.EX_TESTCASE_FAILED otherwise.
"""
self.start_time = time.time()
try:
self.prepare()
if (self.deploy_orchestrator() and
self.deploy_vnf() and
self.test_vnf()):
self.stop_time = time.time()
# Calculation with different weight depending on the steps TODO
self.result = 100
return testcase.TestCase.EX_OK
self.result = 0
self.stop_time = time.time()
return testcase.TestCase.EX_TESTCASE_FAILED
except Exception: # pylint: disable=broad-except
self.stop_time = time.time()
self.__logger.exception("Exception on VNF testing")
return testcase.TestCase.EX_TESTCASE_FAILED
def prepare(self):
"""
Prepare the environment for VNF testing:
* Creation of a user,
* Creation of a tenant,
* Allocation admin role to the user on this tenant
Returns base.TestCase.EX_OK if preparation is successfull
Raise VnfPreparationException in case of problem
"""
try:
self.__logger.info(
"Prepare VNF: %s, description: %s", self.case_name,
self.tenant_description)
snaps_creds = openstack_tests.get_credentials(
os_env_file=constants.ENV_FILE)
self.os_project = OpenStackProject(
snaps_creds,
ProjectConfig(
name=self.tenant_name,
description=self.tenant_description
))
self.os_project.create()
self.created_object.append(self.os_project)
user_creator = OpenStackUser(
snaps_creds,
UserConfig(
name=self.user_name,
password=str(uuid.uuid4()),
roles={'admin': self.tenant_name}))
user_creator.create()
self.created_object.append(user_creator)
self.snaps_creds = user_creator.get_os_creds(self.tenant_name)
return testcase.TestCase.EX_OK
except Exception: # pylint: disable=broad-except
self.__logger.exception("Exception raised during VNF preparation")
raise VnfPreparationException
def deploy_orchestrator(self):
"""
Deploy an orchestrator (optional).
If this method is overriden then raise orchestratorDeploymentException
if error during orchestrator deployment
"""
self.__logger.info("Deploy orchestrator (if necessary)")
return True
def deploy_vnf(self):
"""
Deploy the VNF
This function MUST be implemented by vnf test cases.
The details section MAY be updated in the vnf test cases.
The deployment can be executed via a specific orchestrator
or using build-in orchestrators such as heat, OpenBaton, cloudify,
juju, onap, ...
Returns:
True if the VNF is properly deployed
False if the VNF is not deployed
Raise VnfDeploymentException if error during VNF deployment
"""
self.__logger.error("VNF must be deployed")
raise VnfDeploymentException
def test_vnf(self):
"""
Test the VNF
This function MUST be implemented by vnf test cases.
The details section MAY be updated in the vnf test cases.
Once a VNF is deployed, it is assumed that specific test suite can be
run to validate the VNF.
Please note that the same test suite can be used on several test case
(e.g. clearwater test suite can be used whatever the orchestrator used
for the deployment)
Returns:
True if VNF tests are PASS
False if test suite is FAIL
Raise VnfTestException if error during VNF test
"""
self.__logger.error("VNF must be tested")
raise VnfTestException
def clean(self):
"""
Clean VNF test case.
It is up to the test providers to delete resources used for the tests.
By default we clean:
* the user,
* the tenant
"""
self.__logger.info('Removing the VNF resources ..')
for creator in reversed(self.created_object):
try:
creator.clean()
except Exception as exc: # pylint: disable=broad-except
self.__logger.error('Unexpected error cleaning - %s', exc)
|
