Coverage for occi.backend : 100%

# coding=utf-8 

# 

# Copyright (C) 2010-2012 Platform Computing 

# 

# This library is free software; you can redistribute it and/or 

# modify it under the terms of the GNU Lesser General Public 

# License as published by the Free Software Foundation; either 

# version 2.1 of the License, or (at your option) any later version. 

# 

# This library is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 

# Lesser General Public License for more details. 

# 

# You should have received a copy of the GNU Lesser General Public 

# License along with this library; if not, write to the Free Software 

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA 

# 

''' 

Backends should derive from this class. 

Created on Jun 27, 2011 

@author: tmetsch 

''' 

def is_related_valid(link): 

    ''' 

    Verifies that a link is consistent. 

    link -- The link which should be verified. 

    ''' 

    if link.target.kind == link.kind.related: 

        return True 

    else: 

        return False 

def is_attr_mutable(category, attribute_name): 

    ''' 

    Checks if an attribute is mutable. Return True if so. 

    category -- The category which defines the attribute. 

    attribute_name -- The name of the attribute. 

    ''' 

    if category.attributes[attribute_name] == 'mutable': 

        return True 

    else: 

        return False 

def is_attr_required(category, attribute_name): 

    ''' 

    Checks if an attribute is required. Return True if so. 

    category -- The category which defines the attribute. 

    attribute_name -- The name of the attribute. 

    ''' 

    if category.attributes[attribute_name] == 'required': 

        return True 

    else: 

        return False 

def is_action_applicable(entity, action): 

    ''' 

    Returns true if the action is currently applicable. 

    entity -- The current entity. 

    action -- The action to test for. 

    ''' 

    if action in entity.actions and action in entity.kind.actions: 

        return True 

    else: 

        return False 

class KindBackend(object): 

    ''' 

    A prototype backend which essentially does nothing. 

    Use this Backend for your Resource and Link types. 

    Note that it can happen that an entity has more than one backend assigned 

    (this is the case when it has a couple of mixins). But you can assign 

    multiple kinds to one backend. 

    ''' 

    def create(self, entity, extras): 

        ''' 

        Call the Resource Management and create this entity. 

        entity -- The entity which is to be created. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

    def retrieve(self, entity, extras): 

        ''' 

        Call the Resource Management and refresh this entity so the client gets 

        up to date information. 

        entity -- The entity which is to be retrieved. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

    def update(self, old, new, extras): 

        ''' 

        Call the Resource Management and update this entity. 

        It is up to the backend implementation to decide which information from 

        new if copied into old. 

        Note that the new entity might no have all the information the old one 

        had. 

        old -- The old entity which is to be updated. 

        new -- The new entity holding the updated information. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

    def replace(self, old, new, extras): 

        ''' 

        Call the Resource Management and update this entity. This is 

        essentially a full update (Which allows removal of attributes for 

        example). 

        It is up to the backend implementation to decide which information from 

        new if copied into old. So if you really want to replace old with new 

        you need to have an old.* = new.* somewhere here (RECOMMENDED). 

        old -- The old entity which is to be updated. 

        new -- The new entity holding the updated information. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

    def delete(self, entity, extras): 

        ''' 

        Call the Resource Management and delete this entity. 

        entity -- The entity which is to be deleted. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

class ActionBackend(object): 

    ''' 

    A prototype backend which essentially does nothing. 

    Use this Backend for Action types. 

    ''' 

    # disabling 'Too few public...' pylint check (this is for extension) 

    # pylint: disable=R0903 

    def action(self, entity, action, attributes, extras): 

        ''' 

        Call the Resource Management and perform this action. 

        entity -- The entity on which the action is going to be performed. 

        action -- The action category definition. 

        attributes -- The acctributes for this action. 

        extras -- Any extra arguments which are defined by the user. 

        ''' 

        pass 

class MixinBackend(KindBackend): 

    ''' 

    A prototype backend which essentially does nothing. 

    Use this Backend for Mixin types. 

    ''' 

    pass 

class UserDefinedMixinBackend(MixinBackend): 

    ''' 

    A Backend for mixins defined by users. 

    DO NOT USE THIS CLASS IN YOUR IMPLEMENTATION! 

    ''' 

    pass