plugin_results.py

# -*- coding: utf-8 -*-
#
#   plugin_results.py — plugin results table model
#
#   This file is part of debexpo - https://alioth.debian.org/projects/debexpo/
#
#   Copyright © 2012 Clément Schreiner <clement@mux.me>
#
#   Permission is hereby granted, free of charge, to any person
#   obtaining a copy of this software and associated documentation
#   files (the "Software"), to deal in the Software without
#   restriction, including without limitation the rights to use,
#   copy, modify, merge, publish, distribute, sublicense, and/or sell
#   copies of the Software, and to permit persons to whom the
#   Software is furnished to do so, subject to the following
#   conditions:
#
#   The above copyright notice and this permission notice shall be
#   included in all copies or substantial portions of the Software.
#
#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
#   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
#   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
#   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
#   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
#   OTHER DEALINGS IN THE SOFTWARE.

"""
Holds plugin_results table model.
"""

from sqlalchemy import orm
import sqlalchemy as sa
from sqlalchemy.orm.collections import attribute_mapped_collection
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.ext.declarative import (declared_attr, declarative_base,
                                        has_inherited_table)

from debexpo.model import meta
from debexpo.model.package_versions import PackageVersion

from debexpo.lib.utils import uncamel


class PluginResult(meta.Base):
    __tablename__ = 'plugin_results'

    # plugin that created the result: must be defined in subclasses
    plugin = None

    #
    # Table columns
    #

    id = sa.Column(sa.types.Integer, primary_key=True)
    entity = sa.Column(sa.types.String(200))
    package_version_id = sa.Column(sa.types.Integer,
                                   sa.ForeignKey('package_versions.id'),
                                   nullable=False)
    package_version = orm.relationship(PackageVersion, backref='plugin_results')

    _data = association_proxy(
        '_result_data', 'value',
        creator = lambda k, v: PluginResultData(key = k, value = v))


    #
    # Polymorphism configuration
    #

    @declared_attr
    def __mapper_args__(cls):
        if not has_inherited_table(cls):
            return {'polymorphic_on': 'entity'}
        else:
            d = {
                'inherits': PluginResult,
                'polymorphic_identity': uncamel(cls.__name__)
                }
            return d


    #
    # Quacking like a dict (but not really)
    #

    # FIXME: inherit MutableMapping or something and provide a complete
    # dictionary-like interface

    def __getitem__(self, key):
        return self._data[key]

    def get(self, key, default):
        return self._data.get(key, default)

    def __setitem__(self, key, value):
        self._data[key] = value

    def __delitem__(self, key):
        del self._data[key]

    def as_dict(self):
        return self._data

    #
    # Direct access to some attributes
    #

    @property
    def severity(self):
        return int(self.get('severity', 0))

class PluginResultData(meta.Base):
    __tablename__ = 'plugin_result_data'

    plugin_result_id = sa.Column(sa.ForeignKey('plugin_results.id'),
                                 primary_key=True)

    key = sa.Column(sa.types.String(200), primary_key=True)
    value = sa.Column(sa.types.Text())

    plugin_result = orm.relationship(PluginResult,
        backref = orm.backref('_result_data',
            collection_class = attribute_mapped_collection('key'),
            cascade="all, delete-orphan"))