path: root/src/onaptests/steps/instantiate/sdnc_service.py

import base64
import logging
from typing import Dict

import mysql.connector as mysql
from kubernetes import client, config
from onapsdk.configuration import settings
from onapsdk.exceptions import APIError
from onapsdk.sdnc import VfModulePreload
from onapsdk.sdnc.preload import PreloadInformation
from onapsdk.sdnc.sdnc_element import SdncElement
from onapsdk.sdnc.services import Service
from onapsdk.utils.headers_creator import headers_sdnc_creator

from onaptests.scenario.scenario_base import BaseScenarioStep
from onaptests.steps.base import BaseStep
from onaptests.utils.exceptions import (EnvironmentPreparationException,
                                        OnapTestException)


class BaseSdncStep(BaseStep):
    """Basic SDNC step."""

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

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

        Name of component which step is related with.
            Most is the name of ONAP component.

        Returns:
            str: Component name

        """
        return "SDNC"


class CheckSdncDbStep(BaseSdncStep):
    """Check MariaDB connection status."""

    SDNC_QUERY_LOGIC = "SELECT * FROM svc_logic LIMIT 1;"
    SDNC_QUERY_MODEL = "SELECT * FROM service_model LIMIT 1;"
    SDNC_DATABASE = "sdnctl"
    SDNC_DB_LOGIN = "login"
    SDNC_DB_PASSWORD = "password"

    def __init__(self):
        """Initialize step."""
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)
        self.login = None
        self.password = None

    @property
    def description(self) -> str:
        """Step description."""
        return "Check MariaDB connection."

    def get_database_credentials(self):
        """Resolve SDNC datbase credentials from k8s secret."""

        if settings.IN_CLUSTER:
            config.load_incluster_config()
        else:
            config.load_kube_config(config_file=settings.K8S_CONFIG)
        api_instance = client.CoreV1Api()
        try:
            secret = api_instance.read_namespaced_secret(
                settings.SDNC_SECRET_NAME, settings.K8S_TESTS_NAMESPACE)
            if secret.data:
                if (self.SDNC_DB_LOGIN in secret.data and self.SDNC_DB_PASSWORD in secret.data):
                    login_base64 = secret.data[self.SDNC_DB_LOGIN]
                    self.login = base64.b64decode(login_base64).decode("utf-8")
                    password_base64 = secret.data[self.SDNC_DB_PASSWORD]
                    self.password = base64.b64decode(password_base64).decode("utf-8")
                else:
                    raise EnvironmentPreparationException(
                        "Login key or password key not found in secret")
            else:
                raise EnvironmentPreparationException("Secret data not found in secret")
        except client.rest.ApiException as e:
            self.login = None
            self.password = None
            raise EnvironmentPreparationException("Error accessing secret") from e

    def _check_query(self, conn, query):
        cursor = conn.cursor()
        cursor.execute(query)
        for _ in cursor:
            pass
        cursor.close()

    @BaseStep.store_state
    def execute(self) -> None:
        """Check MariaDB connection."""
        super().execute()
        self.get_database_credentials()
        conn = None
        try:
            conn = mysql.connect(
                database=self.SDNC_DATABASE,
                host=settings.SDNC_DB_PRIMARY_HOST,
                port=settings.SDNC_DB_PORT,
                user=self.login,
                password=self.password)
            self._check_query(conn, self.SDNC_QUERY_LOGIC)
            self._check_query(conn, self.SDNC_QUERY_MODEL)
        except (mysql.errors.ProgrammingError,
                mysql.errors.DatabaseError) as e:
            raise OnapTestException(e) from e
        except Exception as e:
            raise OnapTestException("Cannot connect to SDNC Database") from e
        finally:
            if conn:
                try:
                    conn.close()
                except Exception:
                    pass


class ServiceCreateStep(BaseSdncStep):
    """Service creation step."""

    def __init__(self, service: Service = None):
        """Initialize step."""
        super().__init__(cleanup=settings.CLEANUP_FLAG)
        self.service = service

    @property
    def description(self) -> str:
        """Step description."""
        return "Create SDNC service."

    @BaseStep.store_state
    def execute(self) -> None:
        """Create service at SDNC."""
        super().execute()
        self._logger.info("Create new service instance in SDNC by GR-API")
        try:
            self.service = Service(
                service_instance_id=settings.SERVICE_ID,
                service_status=settings.SERVICE_STATUS,
                service_data=settings.SERVICE_DATA
            )
            self.service.create()
            self._logger.info("SDNC service is created.")
        except APIError as exc:
            if exc.response_status_code == 409:
                self._logger.warning("SDNC service already exists.")
            else:
                raise OnapTestException("SDNC service creation failed.") from exc

    @BaseStep.store_state(cleanup=True)
    def cleanup(self) -> None:
        """Cleanup Service."""
        if self.service is not None:
            self.service.delete()
            self._logger.info("SDNC service is deleted.")
        super().cleanup()


class UpdateSdncService(BaseSdncStep):
    """Service update step.

    The step needs in an existing SDNC service as a prerequisite.
    """

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

        Sub steps:
            - ServiceCreateStep.
        """
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)
        self.add_step(ServiceCreateStep())

    @property
    def description(self) -> str:
        """Step description.

        Used for reports

        Returns:
            str: Step description

        """
        return "Update SDNC service"

    @BaseSdncStep.store_state
    def execute(self) -> None:
        super().execute()
        self._logger.info("Get existing SDNC service instance and update it over GR-API")
        try:
            service = Service.get(settings.SERVICE_ID)
            service.service_status = settings.SERVICE_CHANGED_STATUS
            service.service_data = settings.SERVICE_CHANGED_DATA
            service.update()
            self._logger.info("SDNC service update is completed.")
        except APIError as exc:
            raise OnapTestException("SDNC service update is failed.") from exc


class UploadVfModulePreloadStep(BaseSdncStep):
    """Upload preload information for VfModule.

    Upload preload information for VfModule over GR-API.
    """

    def __init__(self):
        """Initialize step."""
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)

    @property
    def description(self) -> str:
        """Step description.

        Used for reports

        Returns:
            str: Step description

        """
        return "Upload Preload information for VfModule"

    @BaseSdncStep.store_state
    def execute(self) -> None:
        super().execute()
        self._logger.info("Upload VfModule preload information over GR-API")
        VfModulePreload.upload_vf_module_preload(
            {
                "vnf_name": settings.VNF_NAME,
                "vnf_type": settings.VNF_TYPE
            },
            settings.VF_MODULE_NAME,
            None
        )


class CheckSdncHealthStep(BaseSdncStep, SdncElement):
    """Check SDNC Health API response."""

    headers: Dict[str, str] = headers_sdnc_creator(SdncElement.headers)

    def __init__(self):
        """Initialize step."""
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)

    @property
    def description(self) -> str:
        """Step description.

        Used for reports

        Returns:
            str: Step description

        """
        return "Check SDNC Health API response."

    @BaseSdncStep.store_state
    def execute(self) -> None:
        super().execute()
        result = self.send_message_json(
            "POST",
            "SDNC SLI API Healthcheck",
            f"{self.base_url}/restconf/operations/SLI-API:healthcheck")
        message = ""
        if result and result["output"]:
            if result["output"]["response-code"] == "200":
                return
            message = result["output"]["response-message"]
        raise OnapTestException("SDNC is not healthy. %s" % message)


class GetSdncPreloadStep(BaseSdncStep):
    """Get preload information from SDNC.

    Get preload information from SDNC over GR-API.
    """

    __logger = logging.getLogger(__name__)

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

        Sub steps:
            - UploadVfModulePreloadStep.
        """
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)
        self.add_step(UploadVfModulePreloadStep())

    @property
    def description(self) -> str:
        """Step description.

        Used for reports

        Returns:
            str: Step description

        """
        return "Get Preload information"

    @BaseSdncStep.store_state
    def execute(self) -> None:
        super().execute()
        self._logger.info("Get existing SDNC service instance and update it over GR-API")
        preloads = PreloadInformation.get_all()
        for preload_information in preloads:
            self.__logger.debug(preload_information)


class TestSdncStep(BaseScenarioStep):
    """Top level step for SDNC tests."""

    def __init__(self, full: bool = True):
        """Initialize step.

        Args:
            full (bool): If the API logic calls should be executed
        Sub steps:
            - CheckSdncDbStep
            - UpdateSdncService
            - GetSdncPreloadStep
        """
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP)
        if settings.IN_CLUSTER:
            self.add_step(CheckSdncDbStep())
        self.add_step(CheckSdncHealthStep())
        if full:
            self.add_step(UpdateSdncService())
            self.add_step(GetSdncPreloadStep())

    @property
    def description(self) -> str:
        """Step description.

        Used for reports

        Returns:
            str: Step description

        """
        return "Test SDNC functionality"

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

        Name of component which step is related with.
            Most is the name of ONAP component.

        Returns:
            str: Component name

        """
        return "SDNC"