path: root/onap-client/onap_client/sdc/vnf.py

# -*- 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
from onap_client.client.clients import get_client as Client
from onap_client.sdc import vsp
from onap_client.util import utility

import time
import random
import json


class VNF(Resource):
    resource_name = "VNF"
    spec = {
        "software_product_name": {"type": str, "required": True},
        "description": {"type": str, "required": False, "default": "VNF"},
        "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 _create(self, vnf_input):
        """Creates a vnf object in SDC"""
        vnf = None

        existing = get_vnf_id(vnf_input.get("vnf_name"), oc=self.oc)
        if not existing:
            vnf = create_vnf(vnf_input, oc=self.oc)
        elif vnf_input.get("allow_update"):
            vnf = update_vnf(existing, vnf_input, oc=self.oc)
        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)
            x = 0
            for instance_id in instance_ids:
                name_index = ""
                if x > 0:
                    name_index = x
                vm_type_instances.append(instance_id)
                self._add_instance_properties(instance_id, properties)
                self._add_resources(instance_id, resources, resource_name_index=name_index)
                self._add_vm_type_network_role(instance_id, network_roles)
                x += 1

        for policy in policies:
            policy_name = policy.get("policy_name")
            policy_id = self.policy_exists(policy_name)
            if policy_id:
                self.oc.sdc.vnf.delete_catalog_resource_policy(
                    policy_id=policy_id,
                    catalog_resource_id=self.catalog_resource_id
                )

            policy_id = self.add_policy_resource(policy_name)
            self.associate_policy(policy_id, vm_type_instances)
            for k, v in policy.get("properties", {}).items():
                self.add_policy_property(policy_id, k, v)

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

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

        vnf = self.oc.sdc.vnf.get_catalog_resource(**self.attributes)

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

    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, resource_name_index=""):
        for resource in resources_dict:
            resource_name = resource.get("resource_name")
            if resource_name_index:
                resource_name = "{}-{}".format(resource_name, resource_name_index)

            if self.resource_exists(resource_name):
                self.delete_resource(resource_name)

            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, oc=self.oc)
                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, oc=self.oc)
            self._refresh()
            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")

                    self.oc.sdc.vnf.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_properties = network_role_property_for_instance(
                nrt, model, instance_id
            )
            for instance_property in instance_properties:
                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 delete_resource(self, resource_name):
        component_instances = self.tosca.get("componentInstances", [])

        for component in component_instances:
            if component.get("name") == resource_name:
                self.oc.sdc.vnf.delete_resource_from_vnf(
                    catalog_resource_id=self.catalog_resource_id,
                    resource_id=component.get("uniqueId")
                )
                return

    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 policy.get("uniqueId")

        return None

    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

        """
        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"]
                default_value = item.get("defaultValue", "")
                if default_value != input_default_value:
                    return self.oc.sdc.vnf.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,
                    )
                else:
                    return None

        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

        """
        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")
                value = prop.get("value", "")
                if value != property_value:
                    return self.oc.sdc.vnf.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,
                    )
                else:
                    return None

        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

        """
        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")
                value = prop.get("value", "")
                if value != property_value:
                    return self.oc.sdc.vnf.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,
                    )
                else:
                    return None

        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

        """
        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")
                value = prop.get("value", "")
                if value != property_value:
                    return self.oc.sdc.vnf.add_catalog_policy_property(
                        catalog_resource_id=self.catalog_resource_id,
                        unique_id=unique_id,
                        catalog_policy_id=policy_id,
                        property_name=property_name,
                        property_default_value=property_value,
                        description=description,
                        property_type=property_type,
                    )
                else:
                    return None

        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

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

        new_policy = self.oc.sdc.vnf.add_catalog_resource_policy(
            **self.attributes, catalog_policy_name=policy
        )

        self._refresh()

        return new_policy.catalog_resource_id

    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 self.oc.sdc.vnf.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 = self.oc.sdc.vnf.get_catalog_resource(**self.attributes)
        self.attributes["tosca"] = vnf.response_data

    def _output(self):
        return self.tosca


def update_vnf(catalog_resource_id, vnf_input, oc=None):
    if not oc:
        oc = Client()

    existing_vnf = oc.sdc.vnf.get_catalog_resource(
        catalog_resource_id=catalog_resource_id
    ).response_data

    if existing_vnf.get("lifecycleState") != "NOT_CERTIFIED_CHECKOUT":
        vnf = oc.sdc.vnf.checkout_catalog_resource(catalog_resource_id=catalog_resource_id).response_data
    else:
        vnf = oc.sdc.vnf.get_catalog_resource_metadata(catalog_resource_id=catalog_resource_id).response_data.get("metadata", {})

    new_vnf_metadata = oc.sdc.vnf.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", oc=oc)

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

    updated_vnf = oc.sdc.vnf.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, oc=None):
    """Creates a vnf object in SDC

    :vnf_input: dictionary with values to input for vnf creation

    :return: dictionary of updated values for created vnf
    """
    if not oc:
        oc = Client()

    software_product_id = vsp.get_vsp_id(vnf_input.get("software_product_name"), oc=oc)
    software_product_version_id = vsp.get_vsp_version_id(software_product_id, oc=oc)
    vsp_model = vsp.get_vsp_model(software_product_id, software_product_version_id, oc=oc)

    vsp_vendor = vsp_model.get("vendorName")
    vsp_category = vsp_model.get("category")
    vsp_sub_category = vsp_model.get("subCategory")

    vnf_input["software_product_id"] = software_product_id
    vnf_input["vsp_category"] = vsp_category
    vnf_input["vsp_sub_category"] = vsp_sub_category
    vnf_input["vendor_name"] = vsp_vendor
    vnf_input["vnf_description"] = vnf_input.get("description")

    category = get_resource_category(vsp_category, oc=oc)
    vsp_sub_categories = []
    for subcategory in category.get("subcategories", []):
        if subcategory.get("uniqueId").lower() == vsp_sub_category.lower():
            vsp_sub_categories.append(subcategory)
            break

    category["subcategories"] = vsp_sub_categories
    vnf_input["contact_id"] = vsp.get_vsp_owner(software_product_id, oc=oc)

    vnf = oc.sdc.vnf.add_catalog_resource(**vnf_input, categories=[category])

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

    return vnf_input


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
    """
    properties = []
    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", "")
            properties.append(network_role_property)

    return properties


def add_resource(parent_resource_id, catalog_resource_id, catalog_resource_name, origin_type="VF", oc=None):
    """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

    """
    if not oc:
        oc = Client()

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

    resource_instance = oc.sdc.vnf.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, oc=None):
    """Queries SDC for the TOSCA model for a VNF"""
    if not oc:
        oc = Client()

    return oc.sdc.vnf.get_catalog_resource(
        catalog_resource_id=get_vnf_id(vnf_name, oc=oc)
    ).response_data


def get_resource_category(category_name, oc=None):
    if not oc:
        oc = Client()

    resource_categories = oc.sdc.get_resource_categories().response_data
    for category in resource_categories:
        if category.get("uniqueId").lower() == category_name.lower():
            return category
    return None


def get_vnf_id(vnf_name, oc=None):
    if not oc:
        oc = Client()

    response = oc.sdc.vnf.get_resources()
    results = response.response_data.get("resources", [])
    catalog_resource = {}
    update_time = -1
    for vnf in results:
        if vnf.get("name") == vnf_name and vnf.get("lastUpdateDate") > update_time:
            update_time = vnf.get("lastUpdateDate")
            catalog_resource = vnf

    return catalog_resource.get("uniqueId")