Skip to content
Snippets Groups Projects
PolicyRuleModel.py 3.5 KiB
Newer Older
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (https://tfs.etsi.org/)
#
# 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.

Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
import enum, json
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from sqlalchemy import CheckConstraint, Column, DateTime, Enum, ForeignKey, Integer, String
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from sqlalchemy.dialects.postgresql import UUID
from sqlalchemy.orm import relationship
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from typing import Dict
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from .enums.PolicyRuleState import ORM_PolicyRuleStateEnum
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
from ._Base import _Base
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
# Enum values should match name of field in PolicyRule message
class PolicyRuleKindEnum(enum.Enum):
    DEVICE  = 'device'
    SERVICE = 'service'

class PolicyRuleModel(_Base):
    __tablename__ = 'policyrule'

Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    policyrule_uuid         = Column(UUID(as_uuid=False), primary_key=True)
    policyrule_kind         = Column(Enum(PolicyRuleKindEnum), nullable=False)
    policyrule_state        = Column(Enum(ORM_PolicyRuleStateEnum), nullable=False)
    policyrule_state_msg    = Column(String, nullable=False)
    policyrule_priority     = Column(Integer, nullable=False)
    policyrule_service_uuid = Column(ForeignKey('service.service_uuid', ondelete='RESTRICT'), nullable=True, index=True)
    policyrule_eca_data     = Column(String, nullable=False)
    created_at              = Column(DateTime, nullable=False)
    updated_at              = Column(DateTime, nullable=False)
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    policyrule_service = relationship('ServiceModel') # back_populates='policyrules'
    policyrule_devices = relationship('PolicyRuleDeviceModel' ) # back_populates='policyrule'

    __table_args__ = (
        CheckConstraint(policyrule_priority >= 0, name='check_priority_value'),
    )

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

    def dump(self) -> Dict:
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
        # Load JSON-encoded Event-Condition-Action (ECA) model data and populate with policy basic details
        policyrule_basic = json.loads(self.policyrule_eca_data)
        policyrule_basic.update({
            'policyRuleId': self.dump_id(),
            'policyRuleState': {
                'policyRuleState': self.policyrule_state.value,
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
                'policyRuleStateMessage': self.policyrule_state_msg,
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
            },
            'priority': self.policyrule_priority,
        })
        result = {
            'policyRuleBasic': policyrule_basic,
            'deviceList': [{'device_uuid': {'uuid': pr_d.device_uuid}} for pr_d in self.policyrule_devices],
        }
        if self.policyrule_kind == PolicyRuleKindEnum.SERVICE:
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
            result['serviceId'] = self.policyrule_service.dump_id()
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
        return {self.policyrule_kind.value: result}

class PolicyRuleDeviceModel(_Base):
    __tablename__ = 'policyrule_device'

    policyrule_uuid = Column(ForeignKey('policyrule.policyrule_uuid', ondelete='RESTRICT'), primary_key=True)
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed
    device_uuid     = Column(ForeignKey('device.device_uuid', ondelete='RESTRICT'), primary_key=True, index=True)
Lluis Gifre Renom's avatar
Lluis Gifre Renom committed

    #policyrule = relationship('PolicyRuleModel', lazy='joined') # back_populates='policyrule_devices'
    device     = relationship('DeviceModel',     lazy='joined') # back_populates='policyrule_devices'