Skip to content
Snippets Groups Projects
DeviceModel.py 5.06 KiB
Newer Older
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)
#
# 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.
import enum
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
import functools, logging
import uuid
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from typing import Dict, List
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from common.orm.Database import Database
from common.orm.backend.Tools import key_to_str
from common.proto.context_pb2 import DeviceDriverEnum, DeviceOperationalStatusEnum
from sqlalchemy import Column, ForeignKey, String, Enum
from sqlalchemy.dialects.postgresql import UUID, ARRAY
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from context.service.database._Base import Base
from sqlalchemy.orm import relationship
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from .Tools import grpc_to_enum

LOGGER = logging.getLogger(__name__)

class ORM_DeviceDriverEnum(enum.Enum):
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    UNDEFINED             = DeviceDriverEnum.DEVICEDRIVER_UNDEFINED
    OPENCONFIG            = DeviceDriverEnum.DEVICEDRIVER_OPENCONFIG
    TRANSPORT_API         = DeviceDriverEnum.DEVICEDRIVER_TRANSPORT_API
    P4                    = DeviceDriverEnum.DEVICEDRIVER_P4
    IETF_NETWORK_TOPOLOGY = DeviceDriverEnum.DEVICEDRIVER_IETF_NETWORK_TOPOLOGY
    ONF_TR_352            = DeviceDriverEnum.DEVICEDRIVER_ONF_TR_352
    XR                    = DeviceDriverEnum.DEVICEDRIVER_XR
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

grpc_to_enum__device_driver = functools.partial(
    grpc_to_enum, DeviceDriverEnum, ORM_DeviceDriverEnum)

class ORM_DeviceOperationalStatusEnum(enum.Enum):
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    UNDEFINED = DeviceOperationalStatusEnum.DEVICEOPERATIONALSTATUS_UNDEFINED
    DISABLED  = DeviceOperationalStatusEnum.DEVICEOPERATIONALSTATUS_DISABLED
    ENABLED   = DeviceOperationalStatusEnum.DEVICEOPERATIONALSTATUS_ENABLED

grpc_to_enum__device_operational_status = functools.partial(
    grpc_to_enum, DeviceOperationalStatusEnum, ORM_DeviceOperationalStatusEnum)

class DeviceModel(Base):
    __tablename__ = 'Device'
    device_uuid = Column(UUID(as_uuid=False), primary_key=True)
    device_type = Column(String)
Carlos Manso's avatar
Carlos Manso committed
    device_config_uuid = Column(UUID(as_uuid=False), ForeignKey("Config.config_uuid", ondelete='CASCADE'))
    device_operational_status = Column(Enum(ORM_DeviceOperationalStatusEnum, create_constraint=False,
                                            native_enum=False))

    # Relationships
Carlos Manso's avatar
Carlos Manso committed
    device_config = relationship("ConfigModel", passive_deletes=True, lazy="joined")
Carlos Manso's avatar
Carlos Manso committed
    driver = relationship("DriverModel", passive_deletes=True, back_populates="device")
    endpoints = relationship("EndPointModel", passive_deletes=True, back_populates="device")

Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    def dump_id(self) -> Dict:
        return {'device_uuid': {'uuid': self.device_uuid}}

    def dump_config(self) -> Dict:
        return self.device_config.dump()
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    def dump_drivers(self) -> List[int]:
Carlos Manso's avatar
Carlos Manso committed
        response = []
        for a in self.driver:
            response.append(a.dump())

        return response
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    def dump_endpoints(self) -> List[Dict]:
Carlos Manso's avatar
Carlos Manso committed
        response = []

        for a in self.endpoints:
            response.append(a.dump())

        return response
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    def dump(   # pylint: disable=arguments-differ
Carlos Manso's avatar
Carlos Manso committed
            self, include_config_rules=True, include_drivers=True, include_endpoints=True
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
        ) -> Dict:
        result = {
            'device_id': self.dump_id(),
            'device_type': self.device_type,
            'device_operational_status': self.device_operational_status.value,
        }
        if include_config_rules: result.setdefault('device_config', {})['config_rules'] = self.dump_config()
        if include_drivers: result['device_drivers'] = self.dump_drivers()
        if include_endpoints: result['device_endpoints'] = self.dump_endpoints()
        return result

Carlos Manso's avatar
Carlos Manso committed
    @staticmethod
    def main_pk_name():
        return 'device_uuid'

class DriverModel(Base): # pylint: disable=abstract-method
    __tablename__ = 'Driver'
Carlos Manso's avatar
Carlos Manso committed
    # driver_uuid = Column(UUID(as_uuid=False), primary_key=True)
    device_uuid = Column(UUID(as_uuid=False), ForeignKey("Device.device_uuid", ondelete='CASCADE'), primary_key=True)
    driver = Column(Enum(ORM_DeviceDriverEnum, create_constraint=False, native_enum=False))

    # Relationships
Carlos Manso's avatar
Carlos Manso committed
    device = relationship("DeviceModel", back_populates="driver")
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    def dump(self) -> Dict:
        return self.driver.value
Carlos Manso's avatar
Carlos Manso committed
    @staticmethod
    def main_pk_name():
        return 'device_uuid'
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
def set_drivers(database : Database, db_device : DeviceModel, grpc_device_drivers):
    db_device_pk = db_device.device_uuid
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    for driver in grpc_device_drivers:
        orm_driver = grpc_to_enum__device_driver(driver)
        str_device_driver_key = key_to_str([db_device_pk, orm_driver.name])
        db_device_driver = DriverModel(database, str_device_driver_key)
        db_device_driver.device_fk = db_device
        db_device_driver.driver = orm_driver
        db_device_driver.save()