aboutsummaryrefslogtreecommitdiffstats
path: root/onap-client/onap_client/sdc/vnf.py
blob: d07882cd6fb1d049971bf37352f04ecc77ecf2a9 (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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
# -*- coding: utf8 -*-
# ============LICENSE_START=======================================================
# org.onap.vvp/validation-scripts
# ===================================================================
# Copyright © 2020 AT&T Intellectual Property. All rights reserved.
# ===================================================================
#
# Unless otherwise specified, all software contained herein is licensed
# under the Apache License, Version 2.0 (the "License");
# you may not use this software except in compliance with the License.
# You may obtain a copy of the License at
#
#             http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
#
#
# Unless otherwise specified, all documentation contained herein is licensed
# under the Creative Commons License, Attribution 4.0 Intl. (the "License");
# you may not use this documentation except in compliance with the License.
# You may obtain a copy of the License at
#
#             https://creativecommons.org/licenses/by/4.0/
#
# Unless required by applicable law or agreed to in writing, documentation
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# ============LICENSE_END============================================

from onap_client.lib import generate_dummy_string
from onap_client.resource import Resource
from onap_client import exceptions, sdc
from onap_client.client.clients import Client as SDCClient
from onap_client.sdc import vsp
from onap_client.util import utility

import time
import random
import json

vnf_client = SDCClient().sdc.vnf


class VNF(Resource):
    resource_name = "VNF"
    spec = {
        "software_product_name": {"type": str, "required": True},
        "vnf_name": {
            "type": str,
            "required": False,
            "default": generate_dummy_string("test_vnf_"),
        },
        "resource_type": {"type": str, "required": False, "default": "VF"},
        "inputs": {"type": dict, "required": False, "default": {}},
        "vm_types": {
            "type": list,
            "list_item": dict,
            "required": False,
            "default": [],
            "nested": {
                "vm_type": {"type": str, "required": True},
                "properties": {"type": dict, "required": True, "default": {}},
                "resources": {
                    "type": list,
                    "list_item": dict,
                    "required": False,
                    "default": [],
                    "nested": {
                        "resource_name": {"type": str, "required": True},
                        "resource_id": {"type": str, "required": False},
                        "catalog_resource_name": {"type": str, "required": False},
                        "origin_type": {"type": str, "required": False, "default": "VF"},
                        "properties": {"type": dict, "required": False, "default": {}},
                        "relationship": {
                            "type": dict,
                            "required": False,
                            "default": {},
                            "nested": {
                                "relationship_type": {"type": str, "required": True},
                                "requirement": {"type": str, "required": True},
                                "requirement_id": {"type": str, "required": True},
                                "properties": {"type": dict, "required": False, "default": {}},
                            }
                        },
                    },
                },
            },
        },
        "network_roles": {
            "type": list,
            "list_item": dict,
            "required": False,
            "default": [],
            "nested": {
                "network_role_tag": {"type": str, "required": True},
                "network_role": {"type": str, "required": True},
                "related_networks": {
                    "type": list,
                    "list_item": str,
                    "required": False,
                    "default": [],
                },
            },
        },
        "policies": {
            "type": list,
            "list_item": dict,
            "required": False,
            "default": [],
            "nested": {
                "policy_name": {"type": str, "required": True},
                "properties": {"type": dict, "required": False, "default": {}},
            },
        },
        "allow_update": {"type": bool, "required": False, "default": False},
    }

    def __init__(
        self,
        software_product_name,
        vnf_name,
        resource_type,
        inputs={},
        vm_types=[],
        network_roles=[],
        policies=[],
        allow_update=False,
    ):

        vnf_input = {}

        software_product_id = vsp.get_vsp_id(software_product_name)
        software_product_version_id = vsp.get_vsp_version_id(software_product_id)
        vsp_model = vsp.get_vsp_model(software_product_id, software_product_version_id)
        vsp_vendor = vsp_model.get("vendorName")

        vnf_input["software_product_id"] = software_product_id
        vnf_input["vendor_name"] = vsp_vendor
        vnf_input["vnf_name"] = vnf_name
        vnf_input["resource_type"] = resource_type
        vnf_input["inputs"] = inputs
        vnf_input["vm_types"] = vm_types
        vnf_input["network_roles"] = network_roles
        vnf_input["policies"] = policies
        vnf_input["allow_update"] = allow_update

        super().__init__(vnf_input)

    def _create(self, vnf_input):
        """Creates a vnf object in SDC"""
        vnf = None

        existing = get_vnf_id(vnf_input.get("vnf_name"))
        if not existing:
            vnf = create_vnf(vnf_input)
        elif vnf_input.get("allow_update"):
            vnf = update_vnf(existing, vnf_input)
        else:
            raise exceptions.ResourceAlreadyExistsException(
                "VNF resource {} already exists".format(vnf_input.get("vnf_name"))
            )

        return vnf

    def _post_create(self):
        inputs = self.inputs
        vm_types = self.vm_types
        network_roles = self.network_roles
        policies = self.policies
        model = self.tosca
        vm_type_instances = []

        for vm_type in vm_types:
            vm_type_tag = vm_type.get("vm_type")
            properties = vm_type.get("properties")
            resources = vm_type.get("resources", [])
            instance_ids = instance_ids_for_property(model, "vm_type_tag", vm_type_tag)
            for instance_id in instance_ids:
                vm_type_instances.append(instance_id)
                self._add_instance_properties(instance_id, properties)
                self._add_resources(instance_id, resources)
                self._add_vm_type_network_role(instance_id, network_roles)

        for policy in policies:
            policy_name = policy.get("policy_name")
            if self.policy_exists(policy_name):
                continue
            policy_model = self.add_policy_resource(policy_name)
            self.associate_policy(policy_model.catalog_resource_id, vm_type_instances)
            for k, v in policy.get("properties", {}).items():
                self.add_policy_property(policy_model.catalog_resource_id, k, v)

        for k, v in inputs.items():
            self.add_input_value(k, v)

    def _add_instance_properties(self, instance_id, properties_dict):
        for k, v in properties_dict.items():
            # updating vm_type properties
            self.add_instance_property(instance_id, k, v)

    def _add_resources(self, instance_id, resources_dict):
        for resource in resources_dict:
            resource_name = resource.get("resource_name")

            if self.resource_exists(resource_name):
                continue

            catalog_resource_name = resource.get("catalog_resource_name")
            resource_id = resource.get("resource_id")
            resource_origin = resource.get("origin_type")
            resource_relationship = resource.get("relationship", {})

            if not resource_id:
                resource_id = get_vnf_id(catalog_resource_name)
                if not resource_id:
                    raise exceptions.ResourceIDNotFoundException(
                        "resource ID was not passed, and resource lookup by name was not found {}".format(
                            resource_name
                        )
                    )
            new_resource = add_resource(self.catalog_resource_id, resource_id, resource_name, origin_type=resource_origin)
            new_resource_id = new_resource["id"]
            if resource_relationship:
                relationship_type = resource_relationship.get("relationship_type")
                relationship_requirement = resource_relationship.get("requirement")
                relationship_requirement_id = resource_relationship.get("requirement_id")
                self.add_resource_relationship(new_resource_id, instance_id, relationship_type, relationship_requirement, relationship_requirement_id)
                for k, v in resource_relationship.get("properties", {}).items():
                    self.add_instance_property_non_vf(new_resource_id, k, v, origin_section="componentInstancesProperties")

    def add_resource_relationship(self, from_node, to_node, relationship_type, relationship_requirement, relationship_requirement_id):
        components = self.tosca.get("componentInstances", [])
        for component in components:
            if component.get("uniqueId") == to_node:
                capabilities = component.get("capabilities", {}).get(relationship_type, [])
                for capability in capabilities:
                    capability_owner_id = capability.get("ownerId")
                    capability_name = capability.get("name")
                    capability_uid = capability.get("uniqueId")

                    return vnf_client.add_resource_relationship(
                        **self.attributes,
                        from_node_resource_id=from_node,
                        to_node_resource_id=to_node,
                        relationship_type=relationship_type,
                        capability_name=capability_name,
                        capability_owner_id=capability_owner_id,
                        capability_id=capability_uid,
                        requirement_name=relationship_requirement,
                        requirement_id=relationship_requirement_id,
                    )

    def _add_vm_type_network_role(self, instance_id, network_roles_dict):
        model = self.tosca
        for network_role in network_roles_dict:
            # checking if abstract node has matching network role,
            # and updating if found
            nrt = network_role.get("network_role_tag")
            nr = network_role.get("network_role")
            related_networks = network_role.get("related_networks")
            instance_property = network_role_property_for_instance(
                nrt, model, instance_id
            )
            if instance_property:
                self.add_instance_property(instance_id, instance_property, nr)
                if related_networks:
                    property_val = [
                        {"related_network_role": related_network_role}
                        for related_network_role in related_networks
                    ]
                    rnr_instance_property = instance_property.replace(
                        "_network_role", "_related_networks"
                    )
                    self.add_instance_property(
                        instance_id,
                        rnr_instance_property,
                        str(property_val).replace("'", '\\"'),
                    )

    def resource_exists(self, resource_name):
        """Checking the tosca model for a VF to see if a resource
        has already been added"""

        component_instances = self.tosca.get("componentInstances", [])

        for component in component_instances:
            if component.get("name") == resource_name:
                return True

        return False

    def policy_exists(self, policy_name):
        """Checking the tosca model for a VF to see if a resource
        has already been added

        The policy name in the tosca model is all lowercase,
        and if there are dashes in the VNF name they are
        removed in the policy name.
        """

        policies = self.tosca.get("policies", {})

        for p_name, policy in policies.items():
            tosca_policy_name = policy.get("name").lower()
            if tosca_policy_name.find("{}..{}".format(self.vnf_name.lower().replace("-", ""), policy_name.lower())) != -1:
                return True

        return False

    def _submit(self):
        """Submits the vnf in SDC"""
        certification = vnf_client.certify_catalog_resource(
            **self.attributes, user_remarks="Ready!"
        )
        self.attributes["catalog_resource_id"] = certification.catalog_resource_id

        vnf = vnf_client.get_catalog_resource(**self.attributes)

        self.attributes["catalog_resource_name"] = vnf.catalog_resource_name
        self.attributes["tosca"] = vnf.response_data

    def add_input_value(self, input_name, input_default_value):
        """Updates an input value on a VNF

        :input_name: input name to update
        :property_value: value to update input with

        """
        self._refresh()

        inputs = self.tosca.get("inputs", [])
        for item in inputs:
            if item["name"] == input_name:
                unique_id = item["uniqueId"]
                parent_unique_id = item["parentUniqueId"]
                owner_id = item["ownerId"]
                return vnf_client.add_catalog_resource_input(
                    **self.attributes,
                    input_default_value=input_default_value,
                    input_name=input_name,
                    input_parent_unique_id=parent_unique_id,
                    input_unique_id=unique_id,
                    input_owner_id=owner_id,
                )

        raise exceptions.InputNotFoundException(
            "Input {} was not found in VF".format(input_name)
        )

    # TODO
    # instance, policy, and group properties can probably be merged
    # rn there is a lot of dup

    def add_instance_property(self, instance_id, property_name, property_value, origin_section="componentInstancesInputs"):
        """Updates an instance property on a abstract instance attached to a VNF

        :instance_id: ID of a instance attached to a VNF
        :property_name: property name to update
        :property_value: value to update property with

        """
        self._refresh()

        instance_inputs = self.tosca.get(origin_section, {}).get(
            instance_id, {}
        )

        for prop in instance_inputs:
            if prop.get("name") == property_name:
                unique_id = prop.get("uniqueId")
                parent_unique_id = prop.get("parentUniqueId")
                owner_id = prop.get("ownerId")
                schemaType = prop.get("schemaType", "")
                property_type = prop.get("type")
                return vnf_client.add_catalog_resource_property(
                    **self.attributes,
                    unique_id=unique_id,
                    parent_unique_id=parent_unique_id,
                    owner_id=owner_id,
                    catalog_resource_instance_id=instance_id,
                    property_name=property_name,
                    property_default_value=property_value,
                    schema_type=schemaType,
                    property_type=property_type,
                )

        raise exceptions.PropertyNotFoundException(
            "Property {} was not found in Instance {}".format(
                property_name, instance_id
            )
        )

    def add_instance_property_non_vf(self, instance_id, property_name, property_value, origin_section="componentInstancesProperties"):
        """Updates an instance property on a abstract instance attached to a VNF

        :instance_id: ID of a instance attached to a VNF
        :property_name: property name to update
        :property_value: value to update property with

        """
        self._refresh()

        instance_inputs = self.tosca.get(origin_section, {}).get(
            instance_id, {}
        )

        for prop in instance_inputs:
            if prop.get("name") == property_name:
                unique_id = prop.get("uniqueId")
                parent_unique_id = prop.get("parentUniqueId")
                owner_id = prop.get("ownerId")
                schemaType = prop.get("schemaType", "")
                property_type = prop.get("type")
                return vnf_client.add_catalog_resource_property_non_vf(
                    **self.attributes,
                    unique_id=unique_id,
                    parent_unique_id=parent_unique_id,
                    owner_id=owner_id,
                    catalog_resource_instance_id=instance_id,
                    property_name=property_name,
                    property_default_value=property_value,
                    schema_type=schemaType,
                    property_type=property_type,
                )

        raise exceptions.PropertyNotFoundException(
            "Property {} was not found in Instance {}".format(
                property_name, instance_id
            )
        )

    def add_policy_property(self, policy_id, property_name, property_value):
        """Updates a policy property on a polic attached to a VNF

        :policy_id: ID of a policy attached to a VNF
        :property_name: property name to update
        :property_value: value to update property with

        """
        self._refresh()

        policies = (
            self.tosca.get("policies", {}).get(policy_id, {}).get("properties", {})
        )

        for prop in policies:
            if prop.get("name") == property_name:
                unique_id = prop.get("uniqueId")
                property_type = prop.get("type")
                description = prop.get("description")
                return vnf_client.add_catalog_policy_property(
                    **self.attributes,
                    unique_id=unique_id,
                    catalog_policy_id=policy_id,
                    property_name=property_name,
                    property_default_value=property_value,
                    description=description,
                    property_type=property_type,
                )

        raise exceptions.PropertyNotFoundException(
            "Property {} was not found in policy {}".format(property_name, policy_id)
        )

    def add_policy_resource(self, policy_name):
        """Adds an SDC policy resource to a VNF

        :policy_name: name of the policy, matching onap-client.conf

        """
        sdc_properties = sdc.SDC_PROPERTIES
        policy = sdc_properties.POLICIES.get(policy_name)
        if not policy:
            raise exceptions.UnknownPolicyException(
                "Policy {} was not found in configuration file".format(policy_name)
            )

        return vnf_client.add_catalog_resource_policy(
            **self.attributes, catalog_policy_name=policy
        )

    def associate_policy(self, policy_id, instance_ids):
        """associates an SDC policy resource to an VNF instance resource

        :policy_id: ID of policy resource from catalog
        :instance_ids: list of instance ids to associate policy with

        """

        return vnf_client.add_policy_to_instance(
            **self.attributes, catalog_policy_id=policy_id, instance_ids=instance_ids
        )

    def _refresh(self):
        """GETs the VNF model from SDC and updates the VNF object"""
        vnf = vnf_client.get_catalog_resource(**self.attributes)
        self.attributes["tosca"] = vnf.response_data


def update_vnf(catalog_resource_id, vnf_input):
    vnf = vnf_client.checkout_catalog_resource(catalog_resource_id=catalog_resource_id).response_data

    new_vnf_metadata = vnf_client.get_catalog_resource_metadata(catalog_resource_id=vnf.get("uniqueId")).response_data.get("metadata", {})

    csar_version = vsp.get_vsp_version_id(vnf.get("csarUUID"), search_key="name")

    vnf["csarVersion"] = csar_version
    vnf["componentMetadata"] = new_vnf_metadata

    updated_vnf = vnf_client.update_catalog_resource(catalog_resource_id=vnf.get("uniqueId"), payload_data=json.dumps(vnf)).response_data

    vnf_input["catalog_resource_id"] = updated_vnf.get("uniqueId")
    vnf_input["tosca"] = updated_vnf

    return vnf_input


def create_vnf(vnf_input):
    """Creates a vnf object in SDC

    :vnf_input: dictionary with values to input for vnf creation

    :return: dictionary of updated values for created vnf
    """
    kwargs = vnf_input
    vnf = vnf_client.add_catalog_resource(**kwargs)

    kwargs["catalog_resource_id"] = vnf.catalog_resource_id
    kwargs["tosca"] = vnf.response_data

    return kwargs


def instance_ids_for_property(vnf_model, property_name, property_value):
    """Parses a VNF model dictionary for a property + property value, to find the
    abstract node tosca uuid

    :vnf_model: dictionary for a VNF tosca model
    :property_name: name of a property to look for in the vnf model
    :property_value: value of a property to look for in the vnf model

    :return: matching [instance_ids] or []
    """
    instance_ids = []
    instances = vnf_model.get("componentInstancesInputs", {})
    for instance_id, properties in instances.items():
        for prop in properties:
            if (
                prop.get("name") == property_name
                and prop.get("value", "") == property_value
            ):
                instance_ids.append(instance_id)
                break

    return instance_ids


def network_role_property_for_instance(network_role_tag, vnf_model, instance_id):
    """Parses a VNF model dictionary for a network_role_tag property, to find the
    corresponding network role property

    :network_role_tag: the network role tag to search for
    :vnf_model: dictionary for a VNF tosca model
    :instance_id: unique ID for an abstract node to look for the network_tag_property

    :return: network_role property ID or None
    """
    instance_inputs = vnf_model.get("componentInstancesInputs", {}).get(instance_id, {})
    for prop in instance_inputs:
        if prop.get("name").endswith(
            "network_role_tag"
        ) and network_role_tag == prop.get("value"):
            network_role_property = prop.get("name").replace("_tag", "")
            return network_role_property

    return None


def add_resource(parent_resource_id, catalog_resource_id, catalog_resource_name, origin_type="VF"):
    """Attaches a resource to a VNF in SDC

    :catalog_resource_id: ID of a resource in the SDC catalog
    :catalog_resource_name: name to give to the resource when attaching to vnf
    :origin_type: specifies the origin of the attached resource

    """
    milli_timestamp = int(time.time() * 1000)

    resource_instance = vnf_client.add_resource_instance(
        catalog_resource_id=parent_resource_id,
        posX=random.randrange(150, 550),  # nosec
        posY=random.randrange(150, 450),  # nosec
        milli_timestamp=milli_timestamp,
        new_catalog_resource_id=catalog_resource_id,
        new_catalog_resource_name=catalog_resource_name,
        originType=origin_type,
    )

    response = {
        "id": resource_instance.catalog_resource_instance_id,
        "tosca": resource_instance.response_data,
    }
    return response


@utility
def get_vnf(vnf_name):
    """Queries SDC for the TOSCA model for a VNF"""
    return vnf_client.get_catalog_resource(
        catalog_resource_id=get_vnf_id(vnf_name)
    ).response_data


def get_vnf_id(vnf_name):
    response = vnf_client.get_resources()
    results = response.response_data.get("resources", [])
    for vnf in results:
        if vnf.get("name") == vnf_name:
            return vnf["uniqueId"]
    return None