osm_policy_module/common/lcm_client.py

# -*- coding: utf-8 -*-

# Copyright 2018 Whitestack, LLC
# *************************************************************

# This file is part of OSM Monitoring module
# All Rights Reserved to Whitestack, LLC

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file 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.

# For those usages not covered by the Apache License, Version 2.0 please
# contact: bdiaz@whitestack.com or glavado@whitestack.com
##
import datetime
import json
import logging
import time
import uuid

from osm_policy_module.common.common_db_client import CommonDbClient
from osm_policy_module.common.message_bus_client import MessageBusClient
from osm_policy_module.core.config import Config

log = logging.getLogger(__name__)


class LcmClient:
    """
    Client to communicate with LCM through the message bus.
    """

    def __init__(self, config: Config):
        self.db_client = CommonDbClient(config)
        self.msg_bus = MessageBusClient(config)

    async def scale(
        self, nsr_id: str, scaling_group_name: str, vnf_member_index: str, action: str
    ):
        """
        Sends scaling action to LCM through the message bus.

        :param nsr_id: Network service record id
        :param scaling_group_name: Scaling group name
        :param vnf_member_index: VNF member index
        :param action: Scaling action to be executed. Valid values: scale_in, scale_out
        :return:
        """
        log.debug(
            "scale %s %s %s %s", nsr_id, scaling_group_name, vnf_member_index, action
        )
        nsr = self.db_client.get_nsr(nsr_id)
        nslcmop = self._generate_nslcmop(
            nsr_id, scaling_group_name, vnf_member_index, action, nsr["_admin"]
        )
        self.db_client.create_nslcmop(nslcmop)
        log.debug("Sending scale action message: %s", json.dumps(nslcmop))
        await self.msg_bus.aiowrite("ns", "scale", nslcmop)

    def _generate_nslcmop(
        self,
        nsr_id: str,
        scaling_group_name: str,
        vnf_member_index: str,
        action: str,
        admin: dict,
    ):
        """
        Builds scaling nslcmop.

        :param nsr_id: Network service record id
        :param scaling_group_name: Scaling group name
        :param vnf_member_index: VNF member index
        :param action: Scaling action to be executed. Valid values: scale_in, scale_out
        :param admin: Dict corresponding to the _admin section of the nsr. Required keys: projects_read, projects_write.
        :return:
        """
        log.debug(
            "_generate_nslcmop %s %s %s %s %s",
            nsr_id,
            scaling_group_name,
            vnf_member_index,
            action,
            admin,
        )
        _id = str(uuid.uuid4())
        now = time.time()
        params = {
            "scaleType": "SCALE_VNF",
            "scaleVnfData": {
                "scaleVnfType": action.upper(),
                "scaleByStepData": {
                    "scaling-group-descriptor": scaling_group_name,
                    "member-vnf-index": vnf_member_index,
                },
            },
            "scaleTime": "{}Z".format(datetime.datetime.utcnow().isoformat()),
        }

        nslcmop = {
            "id": _id,
            "_id": _id,
            "operationState": "PROCESSING",
            "statusEnteredTime": now,
            "nsInstanceId": nsr_id,
            "lcmOperationType": "scale",
            "startTime": now,
            "isAutomaticInvocation": True,
            "operationParams": params,
            "isCancelPending": False,
            "links": {
                "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
                "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
            },
            "_admin": {
                "projects_read": admin["projects_read"],
                "projects_write": admin["projects_write"],
            },
        }
        return nslcmop

    async def heal(
        self,
        nsr_id: str,
        vnfinstance_id: str,
        vdur_name: str,
        vdu_id: str,
        vnf_member_index: str,
        heal_type: str,
        day1: bool,
        count_index: int,
    ):
        """
        Sends healing action to LCM through the message bus.

        param nsr_id: Network service record id
        param vdu_id: Scaling vdu id
        param vnf_member_index: VNF member index
        param heal_type: healing action to be executed. Valid values: restart,respawn
        param day1: To run day1 operations
        param cause: cause of healing
        return
        """
        log.debug(
            "heal %s %s %s %s %s %s %s %s",
            nsr_id,
            vnfinstance_id,
            vdur_name,
            vdu_id,
            vnf_member_index,
            heal_type,
            day1,
            count_index,
        )
        nsr = self.db_client.get_nsr(nsr_id)
        nslcmop = self._generate_nslcmop_heal(
            nsr_id,
            vnfinstance_id,
            vdur_name,
            vdu_id,
            vnf_member_index,
            heal_type,
            day1,
            count_index,
            nsr["_admin"],
        )
        self.db_client.create_nslcmop(nslcmop)
        log.debug("Sending heal action message: %s", json.dumps(nslcmop))
        await self.msg_bus.aiowrite("ns", "heal", nslcmop)

    def _generate_nslcmop_heal(
        self,
        nsr_id: str,
        vnfinstance_id: str,
        vdur_name: str,
        vdu_id: str,
        vnf_member_index: str,
        heal_type: str,
        day1: bool,
        count_index: int,
        admin: dict,
    ):
        """
        Builds healing nslcmop.
        param nsr_id: Network service record id
        param vnf_member_index: VNF member index
        param action: healing action to be executed. Valid values: restart, respawn
        param admin: Dict corresponding to the _admin section of the nsr. Required keys: projects_read, projects_write.
        return:
        """
        log.debug(
            "_generate_nslcmop_heal %s %s %s %s %s %s %s %s %s",
            nsr_id,
            vnfinstance_id,
            vdur_name,
            vdu_id,
            vnf_member_index,
            heal_type,
            day1,
            count_index,
            admin,
        )
        _id = str(uuid.uuid4())
        now = time.time()
        params = {
            "lcmOperationType": "heal",
            "nsInstanceId": nsr_id,
            "healVnfData": [
                {
                    "vnfInstanceId": vnfinstance_id,
                    "cause": "default",
                    "additionalParams": {
                        "run-day1": day1,
                        "vdu": [
                            {
                                "run-day1": day1,
                                "count-index": count_index,
                                "vdu-id": vdu_id,
                            }
                        ],
                    },
                }
            ],
        }

        nslcmop = {
            "id": _id,
            "_id": _id,
            "operationState": "PROCESSING",
            "statusEnteredTime": now,
            "nsInstanceId": nsr_id,
            "member-vnf-index": vnf_member_index,
            "lcmOperationType": "heal",
            "startTime": now,
            "location": "default",
            "isAutomaticInvocation": True,
            "operationParams": params,
            "isCancelPending": False,
            "links": {
                "self": "/osm/nslcm/v1/ns_lcm_op_occs/" + _id,
                "nsInstance": "/osm/nslcm/v1/ns_instances/" + nsr_id,
            },
            "_admin": {
                "projects_read": admin["projects_read"],
                "projects_write": admin["projects_write"],
            },
        }
        return nslcmop