aboutsummaryrefslogtreecommitdiffstats
path: root/src/onaptests/steps/onboard/service.py
blob: 9243d97e317ea3de743f3b81c16a1018cd90c396 (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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
import time
from typing import Any, Dict, Iterator
from urllib.parse import urlencode

import mysql.connector as mysql
from onapsdk.aai.service_design_and_creation import Model
from onapsdk.configuration import settings
from onapsdk.exceptions import InvalidResponse, ResourceNotFound
from onapsdk.sdc2.component_instance import (ComponentInstance,
                                             ComponentInstanceInput)
from onapsdk.sdc2.pnf import Pnf
from onapsdk.sdc2.sdc_resource import LifecycleOperation, LifecycleState
from onapsdk.sdc2.service import Service, ServiceInstantiationType
from onapsdk.sdc2.vf import Vf
from onapsdk.sdc2.vl import Vl
from onapsdk.so.catalog_db_adapter import CatalogDbAdapter
from yaml import SafeLoader, load

import onaptests.utils.exceptions as onap_test_exceptions
from onaptests.scenario.scenario_base import BaseScenarioStep
from onaptests.utils.kubernetes import KubernetesHelper

from ..base import BaseStep, YamlTemplateBaseStep
from .pnf import YamlTemplatePnfOnboardStep
from .vf import YamlTemplateVfOnboardStep


class YamlTemplateServiceOnboardStep(YamlTemplateBaseStep):
    """Service onboard using YAML template step."""

    def __init__(self):
        """Initialize step.

        Substeps:
            - YamlTemplateVfOnboardStep.
        """
        super().__init__(cleanup=settings.CLEANUP_FLAG)
        self._yaml_template: dict = None
        self._model_yaml_template: dict = None
        if "vnfs" in self.yaml_template[self.service_name]:
            self.add_step(YamlTemplateVfOnboardStep())
        if "pnfs" in self.yaml_template[self.service_name]:
            self.add_step(YamlTemplatePnfOnboardStep())

    @property
    def description(self) -> str:
        """Step description."""
        return "Onboard service described in YAML file in SDC."

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

    def check_preconditions(self, cleanup=False) -> bool:
        if not super().check_preconditions(cleanup):
            return False
        if cleanup:
            return settings.SDC_CLEANUP
        return True

    @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 settings.MODEL_YAML_TEMPLATE:
            return self.model_yaml_template
        if self.is_root:
            if not self._yaml_template:
                with open(settings.SERVICE_YAML_TEMPLATE, "r", encoding="utf-8") 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",
                          encoding="utf-8") as model_yaml_template:
                    self._model_yaml_template: dict = load(model_yaml_template, SafeLoader)
            return self._model_yaml_template
        return self.parent.model_yaml_template

    @YamlTemplateBaseStep.store_state
    def execute(self):
        """Onboard service."""
        super().execute()
        if "instantiation_type" in self.yaml_template[self.service_name]:
            instantiation_type: ServiceInstantiationType = ServiceInstantiationType(
                self.yaml_template[self.service_name]["instantiation_type"])
        else:
            instantiation_type: ServiceInstantiationType = ServiceInstantiationType.A_LA_CARTE
        try:
            service: Service = Service.get_by_name(name=self.service_name)
            if service.distributed:
                return
        except ResourceNotFound:
            service = Service.create(name=self.service_name, instantiation_type=instantiation_type)
            self.declare_resources(service)
            self.assign_properties(service)
        if service.lifecycle_state != LifecycleState.CERTIFIED:
            service.lifecycle_operation(LifecycleOperation.CERTIFY)
        service.distribute()

    def declare_resources(self, service: Service) -> None:
        """Declare resources.

        Resources defined in YAML template are declared.

        Args:
            service (Service): Service object

        """
        if "networks" in self.yaml_template[self.service_name]:
            for net in self.yaml_template[self.service_name]["networks"]:
                vl: Vl = Vl.get_by_name(name=net['vl_name'])
                service.add_resource(vl)
        if "vnfs" in self.yaml_template[self.service_name]:
            for vnf in self.yaml_template[self.service_name]["vnfs"]:
                vf: Vf = Vf.get_by_name(name=vnf["vnf_name"])
                service.add_resource(vf)
        if "pnfs" in self.yaml_template[self.service_name]:
            for pnf in self.yaml_template[self.service_name]["pnfs"]:
                pnf_obj: Pnf = Pnf.get_by_name(name=pnf["pnf_name"])
                service.add_resource(pnf_obj)

    def assign_properties(self, service: Service) -> None:
        """Assign components properties.

        For each component set properties and it's value if are declared
            in YAML template.

        Args:
            service (Service): Service object

        """
        if "networks" in self.yaml_template[self.service_name]:
            for net in self.yaml_template[self.service_name]["networks"]:
                if "properties" in net:
                    vl_component: ComponentInstance = service.get_component_by_name(net['vl_name'])
                    self.assign_properties_to_component(vl_component, net["properties"])
        if "vnfs" in self.yaml_template[self.service_name]:
            for vnf in self.yaml_template[self.service_name]["vnfs"]:
                if "properties" in vnf:
                    vf_component: ComponentInstance = service.get_component_by_name(vnf["vnf_name"])
                    self.assign_properties_to_component(vf_component, vnf["properties"])
        if "pnfs" in self.yaml_template[self.service_name]:
            for pnf in self.yaml_template[self.service_name]["pnfs"]:
                if "properties" in pnf:
                    pnf_component: ComponentInstance = \
                        service.get_component_by_name(pnf["pnf_name"])
                    self.assign_properties_to_component(pnf_component, pnf["properties"])

    def assign_properties_to_component(self,
                                       component: ComponentInstance,
                                       component_properties: Dict[str, Any]) -> None:
        """Assign properties to component.

        Args:
            component (Component): Component to which properites are going to be assigned
            component_properties (Dict[str, Any]): Properties dictionary

        """
        for property_name, property_value in component_properties.items():
            prop: ComponentInstanceInput = component.get_input_by_name(property_name)
            prop.value = property_value

    @YamlTemplateBaseStep.store_state(cleanup=True)
    def cleanup(self) -> None:
        """Cleanup service onboard step."""
        try:
            service: Service = Service.get_by_name(name=self.service_name)
            if service.lifecycle_state == LifecycleState.CERTIFIED:
                service.archive()
            service.delete()
        except ResourceNotFound:
            self._logger.info(f"Service {self.service_name} not found")
        super().cleanup()


class VerifyServiceDistributionStep(BaseScenarioStep):
    """Service distribution check step."""

    def __init__(self):
        """Initialize step."""
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)
        self.add_step(ServiceDistributionWaitStep())
        for notified_module in settings.SDC_SERVICE_DISTRIBUTION_COMPONENTS:
            self.add_step(VerifyServiceDistributionStatusStep(
                notified_module=notified_module))
        if settings.IN_CLUSTER:
            self.add_step(VerifyServiceDistributionInSoStep())
            self.add_step(VerifyServiceDistributionInSdncStep())
        self.add_step(VerifyServiceDistributionInAaiStep())

    @property
    def description(self) -> str:
        """Step description."""
        return "Verify complete status of distribution"

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


class BaseServiceDistributionComponentCheckStep(BaseStep):
    """Service distribution check step."""

    def __init__(self, component_name: str, break_on_error: bool = True):
        """Initialize step.

        Args:
            component_name (str): Name of tested component
            break_on_error (bool): If step breaks execution when failed
        """
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP,
                         break_on_error=break_on_error)
        self.component_name = component_name
        self.service: Service = None

    @property
    def description(self) -> str:
        """Step description."""
        return f"Check service distribution in {self.component_name}."

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

    def execute(self):
        """Check service distribution status."""
        super().execute()
        self.service = Service.get_by_name(name=settings.SERVICE_NAME)


class ServiceDistributionWaitStep(BaseServiceDistributionComponentCheckStep):
    """Service distribution wait step."""

    def __init__(self):
        """Initialize step."""
        super().__init__(component_name="SDC", break_on_error=False)

    @BaseStep.store_state
    def execute(self):
        """Wait for service distribution."""
        super().execute()
        # 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 = self.service.distributed
            if distribution_completed is True:
                self._logger.info(
                    "Service Distribution for %s is sucessfully finished",
                    self.service.name)
                break
            self._logger.info(
                "Service Distribution for %s ongoing, Wait for %d s",
                self.service.name, settings.SERVICE_DISTRIBUTION_SLEEP_TIME)
            time.sleep(settings.SERVICE_DISTRIBUTION_SLEEP_TIME)
            nb_try += 1

        if distribution_completed is False:
            msg = f"Service Distribution for {self.service.name} failed after timeout!!"
            self._logger.error(msg)
            raise onap_test_exceptions.ServiceDistributionException(msg)


class VerifyServiceDistributionStatusStep(BaseServiceDistributionComponentCheckStep):
    """Check service distribution in SO step."""

    def __init__(self, notified_module: str):
        """Initialize step.

        Args:
            notified_module (str): Name of notified module
        """

        component_name = notified_module.split("-")[0].upper()
        super().__init__(component_name=component_name)
        self.component_id = notified_module

    @property
    def description(self) -> str:
        """Step description."""
        return f"Check service distribution in {self.component_name} \
{self.component_id}."

    @BaseStep.store_state
    def execute(self):
        """Check service distribution status."""
        super().execute()
        if not self.service.distributed:
            latest_distribution = self.service.latest_distribution
            for status in latest_distribution.distribution_status_list:
                if status.component_id == self.component_id and status.failed:
                    msg = f"Service {self.service.name} is not \
distributed into [{self.component_id}]: {status.error_reason}"
                    self._logger.error(msg)
                    raise onap_test_exceptions.ServiceDistributionException(msg)
        msg = f"Service {self.service.name} is distributed in SO and {self.component_id}."
        self._logger.info(msg)


class VerifyServiceDistributionInSoStep(BaseServiceDistributionComponentCheckStep):
    """Check service distribution in SO step."""

    def __init__(self):
        """Initialize step."""
        super().__init__(component_name="SO")

    @BaseStep.store_state
    def execute(self):
        """Check service distribution status."""
        super().execute()
        try:
            CatalogDbAdapter.get_service_info(self.service.uuid)
        except ResourceNotFound as e:
            msg = f"Service {self.service.name} is missing in SO."
            self._logger.error(msg)
            raise onap_test_exceptions.ServiceDistributionException(msg) from e
        except InvalidResponse:
            # looks like json returned by SO catalog DB adapter returns wrong json
            # but we don't care here. It is important to just know if service is there
            pass


class VerifyServiceDistributionInAaiStep(BaseServiceDistributionComponentCheckStep):
    """Check service distribution in AAI step."""

    class ModelWithGet(Model):
        """"Workaround to fix """

        @classmethod
        def get_all(cls,
                    invariant_id: str = None,
                    resource_version: str = None) -> Iterator["Model"]:
            """Get all models.

            Args:
                invariant_id (str): model invariant ID
                resource_version (str): object resource version

            Yields:
                Model: Model object

            """
            filter_parameters: dict = cls.filter_none_key_values(
                {"model-invariant-id": invariant_id,
                 "resource-version": resource_version}
            )
            url: str = f"{cls.get_all_url()}?{urlencode(filter_parameters)}"
            for model in cls.send_message_json("GET", "Get A&AI sdc models",
                                               url).get("model", []):
                yield Model(
                    invariant_id=model.get("model-invariant-id"),
                    model_type=model.get("model-type"),
                    resource_version=model.get("resource-version")
                )

    def __init__(self):
        """Initialize step."""
        BaseServiceDistributionComponentCheckStep.__init__(
            self, component_name="AAI")

    @BaseStep.store_state
    def execute(self):
        """Check service distribution status."""
        super().execute()
        try:
            aai_services = self.ModelWithGet.get_all(
                invariant_id=self.service.invariant_uuid)
            for aai_service in aai_services:
                self._logger.info(
                    f"Resolved {aai_service.invariant_id} aai service")
        except ResourceNotFound as e:
            msg = f"Service {self.service.name} is missing in AAI."
            self._logger.error(msg)
            raise onap_test_exceptions.ServiceDistributionException(msg) from e


class VerifyServiceDistributionInSdncStep(BaseServiceDistributionComponentCheckStep):
    """Check service distribution in SDNC step."""

    SDNC_DATABASE = "sdnctl"
    SDNC_DB_LOGIN = "login"
    SDNC_DB_PASSWORD = "password"

    def __init__(self):
        """Initialize step."""
        BaseServiceDistributionComponentCheckStep.__init__(
            self, component_name="SDNC")

    @BaseStep.store_state
    def execute(self):
        """Check service distribution status."""
        super().execute()
        login, password = KubernetesHelper.get_credentials_from_secret(
            settings.SDNC_SECRET_NAME, self.SDNC_DB_LOGIN, self.SDNC_DB_PASSWORD)
        conn = None
        try:
            conn = mysql.connect(
                database=self.SDNC_DATABASE,
                host=settings.SDNC_DB_PRIMARY_HOST,
                port=settings.SDNC_DB_PORT,
                user=login,
                password=password)
            cursor = conn.cursor()
            cursor.execute(
                f"SELECT * FROM service_model WHERE service_uuid = '{self.service.uuid}';")
            cursor.fetchall()
            if cursor.rowcount <= 0:
                msg = "Service model is missing in SDNC."
                self._logger.error(msg)
                raise onap_test_exceptions.ServiceDistributionException(msg)
            self._logger.info("Service found in SDNC")
            cursor.close()
        except Exception as e:
            msg = f"Service {self.service.name} is missing in SDNC."
            raise onap_test_exceptions.ServiceDistributionException(msg) from e
        finally:
            if conn:
                try:
                    conn.close()
                except Exception:
                    pass