aboutsummaryrefslogtreecommitdiffstats
path: root/src/onaptests/steps/instantiate/service_macro.py
blob: d97a109899f9708bce69f3b97045c74ee646ac69 (plain)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
import time
from typing import List
from uuid import uuid4
from onapsdk.aai.business.service import ServiceInstance
from yaml import load, SafeLoader

from onapsdk.aai.business.customer import Customer, ServiceSubscription
from onapsdk.aai.business.owning_entity import OwningEntity
from onapsdk.aai.cloud_infrastructure.cloud_region import CloudRegion
from onapsdk.aai.cloud_infrastructure.tenant import Tenant
from onapsdk.configuration import settings
from onapsdk.exceptions import ResourceNotFound
from onapsdk.sdc.service import Service
from onapsdk.so.instantiation import (
    InstantiationParameter,
    ServiceInstantiation,
    VfmoduleParameters,
    VnfParameters,
    SoService
)
from onaptests.steps.cloud.customer_service_subscription_create import (
    CustomerServiceSubscriptionCreateStep
)

import onaptests.utils.exceptions as onap_test_exceptions
from onaptests.steps.base import YamlTemplateBaseStep
from onaptests.steps.onboard.service import YamlTemplateServiceOnboardStep
from onaptests.steps.cloud.connect_service_subscription_to_cloud_region import (
    ConnectServiceSubToCloudRegionStep
)


class YamlTemplateServiceMacroInstantiateStep(YamlTemplateBaseStep):
    """Instantiate service a'la carte using YAML template."""

    def __init__(self, cleanup=False):
        """Initialize step.

        Substeps:
            - YamlTemplateServiceOnboardStep,
            - ConnectServiceSubToCloudRegionStep,
            - CustomerServiceSubscriptionCreateStep.
        """
        super().__init__(cleanup=cleanup)
        self._yaml_template: dict = None
        self._model_yaml_template: dict = None
        self._service_instance_name: str = None
        self._service_instance: str = None
        if not settings.ONLY_INSTANTIATE:
            self.add_step(YamlTemplateServiceOnboardStep(cleanup))

            if any(
                filter(lambda x: x in self.yaml_template[self.service_name].keys(),
                       ["vnfs", "networks"])):
                # can additionally contain "pnfs", no difference
                self.add_step(ConnectServiceSubToCloudRegionStep(cleanup))
            else:  # only pnfs
                self.add_step(CustomerServiceSubscriptionCreateStep(cleanup))

    @property
    def description(self) -> str:
        """Step description."""
        return "Instantiate service described in YAML using SO macro method."

    @property
    def component(self) -> str:
        """Component name."""
        return "SO"

    @property
    def yaml_template(self) -> dict:
        """Step YAML template.

        Load from file if it's a root step, get from parent otherwise.

        Returns:
            dict: Step YAML template

        """
        if self.is_root:
            if not self._yaml_template:
                with open(settings.SERVICE_YAML_TEMPLATE, "r") as yaml_template:
                    self._yaml_template: dict = load(yaml_template, SafeLoader)
            return self._yaml_template
        return self.parent.yaml_template

    @property
    def model_yaml_template(self) -> dict:
        """Step Model YAML template.

        Load from file if it's a root step, get from parent otherwise.

        Returns:
            dict: Step YAML template

        """
        if self.is_root:
            if not self._model_yaml_template:
                with open(settings.MODEL_YAML_TEMPLATE, "r") as model_yaml_template:
                    self._model_yaml_template: dict = load(model_yaml_template)
            return self._model_yaml_template
        return self.parent.model_yaml_template

    @property
    def service_name(self) -> str:
        """Service name.

        Get from YAML template if it's a root step, get from parent otherwise.

        Returns:
            str: Service name

        """
        if self.is_root:
            return next(iter(self.yaml_template.keys()))
        return self.parent.service_name

    @property
    def service_instance_name(self) -> str:
        """Service instance name.

        Generate using `service_name` and `uuid4()` function if it's a root step,
            get from parent otherwise.

        Returns:
            str: Service instance name

        """
        if self.is_root:
            if not self._service_instance_name:
                self._service_instance_name: str = f"{self.service_name}-{str(uuid4())}"
            return self._service_instance_name
        return self.parent.service_instance_name

    @YamlTemplateBaseStep.store_state
    def execute(self):  # noqa
        """Instantiate service.

        Use settings values:
         - GLOBAL_CUSTOMER_ID,
         - CLOUD_REGION_CLOUD_OWNER,
         - CLOUD_REGION_ID,
         - TENANT_ID,
         - OWNING_ENTITY,
         - PROJECT.

        Raises:
            Exception: Service instantiation failed

        """
        super().execute()
        service = Service(self.service_name)
        customer: Customer = Customer.get_by_global_customer_id(settings.GLOBAL_CUSTOMER_ID)
        service_subscription: ServiceSubscription = \
            customer.get_service_subscription_by_service_type(service.name)
        if any(
                filter(lambda x: x in self.yaml_template[self.service_name].keys(),
                       ["vnfs", "networks"])):
            cloud_region: CloudRegion = CloudRegion.get_by_id(
                cloud_owner=settings.CLOUD_REGION_CLOUD_OWNER,
                cloud_region_id=settings.CLOUD_REGION_ID,
            )
            tenant: Tenant = cloud_region.get_tenant(settings.TENANT_ID)
        else:
            #  Only PNF is going to be instantiated so
            #  neither cloud_region nor tenant are needed
            cloud_region, tenant = None, None
        try:
            owning_entity = OwningEntity.get_by_owning_entity_name(
                settings.OWNING_ENTITY)
        except ResourceNotFound:
            self._logger.info("Owning entity not found, create it")
            owning_entity = OwningEntity.create(settings.OWNING_ENTITY)

        # Before instantiating, be sure that the service has been distributed
        self._logger.info("******** Check Service Distribution *******")
        distribution_completed = False
        nb_try = 0
        while distribution_completed is False and \
                nb_try < settings.SERVICE_DISTRIBUTION_NUMBER_OF_TRIES:
            distribution_completed = service.distributed
            if distribution_completed is True:
                self._logger.info(
                    "Service Distribution for %s is sucessfully finished",
                    service.name)
                break
            self._logger.info(
                "Service Distribution for %s ongoing, Wait for %d s",
                service.name, settings.SERVICE_DISTRIBUTION_SLEEP_TIME)
            time.sleep(settings.SERVICE_DISTRIBUTION_SLEEP_TIME)
            nb_try += 1

        if distribution_completed is False:
            self._logger.error(
                "Service Distribution for %s failed !!", service.name)
            raise onap_test_exceptions.ServiceDistributionException

        so_service = None
        vnf_params_list: List[VnfParameters] = []
        if settings.MODEL_YAML_TEMPLATE:
            so_data = self.yaml_template[self.service_name]
            so_service = SoService(vnfs=so_data.get("vnfs", []),
                                   subscription_service_type=so_data.get(
                                       'subscription_service_type'))
        else:
            for vnf_data in self.yaml_template[self.service_name].get("vnfs", []):
                vnf_params_list.append(VnfParameters(
                    vnf_data["vnf_name"],
                    [InstantiationParameter(name=parameter["name"],
                                            value=parameter["value"]) for parameter in
                     vnf_data.get("vnf_parameters", [])],
                    [VfmoduleParameters(vf_module_data["vf_module_name"],
                                        [InstantiationParameter(name=parameter["name"],
                                                                value=parameter["value"]) for
                                         parameter in vf_module_data.get("parameters", [])])
                     for vf_module_data in vnf_data.get("vf_module_parameters", [])]
                ))

        service_instantiation = ServiceInstantiation.instantiate_macro(
            sdc_service=service,
            customer=customer,
            owning_entity=owning_entity,
            project=settings.PROJECT,
            line_of_business=settings.LINE_OF_BUSINESS,
            platform=settings.PLATFORM,
            cloud_region=cloud_region,
            tenant=tenant,
            service_subscription=service_subscription,
            service_instance_name=self.service_instance_name,
            vnf_parameters=vnf_params_list,
            enable_multicloud=settings.USE_MULTICLOUD,
            so_service=so_service
        )
        try:
            service_instantiation.wait_for_finish(timeout=settings.ORCHESTRATION_REQUEST_TIMEOUT)
        except TimeoutError:
            self._logger.error("Service instantiation %s timed out", self.service_instance_name)
            raise onap_test_exceptions.ServiceInstantiateException
        if service_instantiation.failed:
            self._logger.error("Service instantiation %s failed", self.service_instance_name)
            raise onap_test_exceptions.ServiceInstantiateException

        service_subscription: ServiceSubscription = \
            customer.get_service_subscription_by_service_type(self.service_name)
        self._service_instance: ServiceInstance = \
            service_subscription.get_service_instance_by_name(self.service_instance_name)

    @YamlTemplateBaseStep.store_state(cleanup=True)
    def cleanup(self) -> None:
        """Cleanup Service.

        Raises:
            Exception: Service cleaning failed

        """
        if self._service_instance:
            service_deletion = self._service_instance.delete(a_la_carte=False)
            try:
                service_deletion.wait_for_finish(timeout=settings.ORCHESTRATION_REQUEST_TIMEOUT)
            except TimeoutError:
                self._logger.error("Service deletion %s timed out", self._service_instance_name)
                raise onap_test_exceptions.ServiceCleanupException
            if service_deletion.finished:
                self._logger.info("Service %s deleted", self._service_instance_name)
            else:
                self._logger.error("Service deletion %s failed", self._service_instance_name)
                raise onap_test_exceptions.ServiceCleanupException
        super().cleanup()