controlfields.py

# -*- coding: utf-8 -*-
#
#   controlfields.py — controlfields plugin
#
#   This file is part of debexpo - https://alioth.debian.org/projects/debexpo/
#
#   Copyright © 2008 Jonny Lamb <jonny@debian.org>
#   Copyright © 2010 Jan Dittberner <jandd@debian.org>
#   Copyright © 2012 Nicolas Dandrimont <Nicolas.Dandrimont@crans.org>
#
#   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 the controlfields plugin.
"""

__author__ = 'Jonny Lamb'
__copyright__ = ', '.join([
        'Copyright © 2008 Jonny Lamb',
        'Copyright © 2010 Jan Dittberner',
        'Copyright © 2012 Nicolas Dandrimont',
        ])
__license__ = 'MIT'

from debian import deb822
import logging

from debexpo.lib import constants
from debexpo.plugins.api import *
from debexpo.model import meta

log = logging.getLogger(__name__)

fields = ['Homepage', 'Vcs-Browser', 'Vcs-Git', 'Vcs-Svn', 'Vcs-Bzr', 'Vcs-Hg']


@test_result
class ControlfieldTest(PluginResult):
    """ Result of the control fields plugin """

    homepage = bool_field('homepage')
    vcs = bool_field('vcs')

    def get_fields(self):

        q = meta.session.query(ControlField)
        q = q.filter_by(package_version=self.package_version)
        return dict((f.field, f.value) for f in q.all())

    def __str__(self):
        if self.homepage:
            return 'Homepage {vcs} control field{s} present'.format(
                vcs='and VCS' if self.vcs else '',
                s='s' if self.vcs else '')


class ControlField(PluginResult):
    """ Additional debian/control field """
    field = string_field('field')
    value = string_field('data')


class ControlFieldsPlugin(QAPlugin):

    @importercmd
    def test_control_fields(self):
        """
        Checks whether additional debian/control fields are present.
        """
        log.debug('Checking whether additional debian/control'
                  'fields are present')

        try:
            dsc = deb822.Dsc(file(self.changes.get_dsc()))
        except:
            log.critical('Could not open dsc file; skipping plugin')
            return

        severity = constants.PLUGIN_SEVERITY_WARNING

        found_homepage = False
        for item in fields:
            if item in dsc:
                if item == 'Homepage':
                    found_homepage = True
                self.new_result(ControlField, field=item,
                                value=dsc[item])

        if found_homepage:
            test_result = self.new_test_result(
                severity=constants.PLUGIN_SEVERITY_INFO)
            test_result.homepage = True

            if len(self.results) > 1:
                test_result.vcs = True

plugin = ControlFieldsPlugin
models = [
    ControlfieldTest,
    ControlField,
    ]