Source code for tendril.entityhub.prototypebase

#!/usr/bin/env python
# encoding: utf-8

# Copyright (C) 2016 Chintalagiri Shashank
#
# This file is part of tendril.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""
Docstring for prototypebase
"""
from copy import copy

from tendril.boms.validate import ValidatableBase
from tendril.boms.validate import FilePolicy
from tendril.boms.validate import MissingFileError
from tendril.boms.validate import MangledFileError

from tendril.utils import log
from tendril.utils.parsers import changelog

logger = log.get_logger(__name__, log.DEFAULT)


[docs]class MissingInformationError(Exception):
    pass


[docs]class PrototypeBase(ValidatableBase):
    def __init__(self):
        super(PrototypeBase, self).__init__()
        self._status = None
        self._strategy = None

    @property
    def ident(self):
        raise NotImplementedError

    @ident.setter
    def ident(self, value):
        raise NotImplementedError

    @property
    def desc(self):
        raise NotImplementedError

    @property
    def status(self):
        if self._status is None:
            self._get_status()
        return self._status

[docs]    def _get_status(self):
        raise NotImplementedError

    @property
    def bom(self):
        raise NotImplementedError

    @property
    def obom(self):
        raise NotImplementedError

    @property
    def strategy(self):
        if self._strategy is None:
            raise MissingInformationError(
                "Production strategy information missing for {0}"
                "".format(self.ident)
            )
        return self._strategy

[docs]    def make_labels(self, sno, label_manager=None):
        raise NotImplementedError

    @property
    def changelog(self):
        return self._changelog

    @property
    def _changelogpath(self):
        raise NotImplementedError

[docs]    def _get_changelog(self):
        try:
            self._changelog = changelog.ChangeLog(self._changelogpath)
        except changelog.ChangeLogNotFoundError:
            ctx = copy(self._validation_context)
            ctx.locality = 'ChangeLog'
            policy = FilePolicy(ctx, self._changelogpath, False)
            raise MissingFileError(policy)
        except changelog.ChangeLogParseError:
            ctx = copy(self._validation_context)
            ctx.locality = 'ChangeLog'
            policy = FilePolicy(ctx, self._changelogpath, False)
            raise MangledFileError(policy)

[docs]    def _register_for_changes(self):
        raise NotImplementedError

[docs]    def _reload(self):
        raise NotImplementedError

[docs]    def _validate(self):
        raise NotImplementedError