debianqa.py

# -*- coding: utf-8 -*-
#
#   debian.py — debian plugin
#
#   This file is part of debexpo - https://alioth.debian.org/projects/debexpo/
#
#   Copyright © 2008 Jonny Lamb <jonny@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 debian plugin.
"""

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

import logging
import lxml.etree
import urllib2

from debexpo.model import meta
from debexpo.model.users import User

from debexpo.plugins.api import *

log = logging.getLogger(__name__)

@test_result
class DebianqaTest(PluginResult):

    in_debian = bool_field('in_debian')
    is_nmu = bool_field('is_nmu')
    is_debian_maintainer = bool_field('is_debian_maintainer')

    def __str__(self):
        # FIXME: this variable name sucks.
        s = 'already' if self.in_debian else 'not'
        return 'Package is %s in debian' % s


class DebianQAPlugin(QAPlugin):
    """ Plugin for Debian QA tests """

    @property
    def _in_debian(self):
        try:
            self.qa_page = urllib2.urlopen('http://packages.qa.debian.org/%s'
                                           % self.changes['Source'])
        except urllib2.HTTPError:
           return False
        else:
            self.parsed_qa = lxml.etree.fromstring(self.qa_page.read())
            return True

    def _qa_xpath(self, query, item = None):
        """Perform the xpath query on the given item"""
        if item is None:
            item = self.parsed_qa
        return item.xpath(
            query,
            namespaces={'xhtml': 'http://www.w3.org/1999/xhtml'}
            )

    def _test_package_in_debian(self):
        """
        Finds whether the package is in Debian.
        """
        log.debug('Testing whether the package is in Debian already')
        self.test_result.in_debian=self._in_debian

    def _test_last_upload(self):
        """
        Finds the date of the last upload of the package.
        """
        log.debug('Finding when the last upload of the package was')

        news = self._qa_xpath('//xhtml:ul[@id="news-list"]')[0]
        for item in news.getchildren():
            if 'Accepted' in self._qa_xpath('xhtml:a/child::text()', item):
                last_change = item.text[1:11]
                log.debug('Last upload on %s' % last_change)
                self.test_result["latest_upload"] = last_change
                return

        log.warning('Couldn\'t find last upload date')

    def _test_is_nmu(self):
        """
        Finds out whether the package is an NMU.
        """
        log.debug('Finding out whether the package is a NMU')

        import string

        delete_chars = string.maketrans(
            string.ascii_lowercase + "\n", " " * (len(string.ascii_lowercase) + 1)
            )

        changes = str(self.changes["Changes"]).lower().translate(None, delete_chars).splitlines()

        self.test_result.is_nmu = (
            any(change.startswith('nonmaintainerupload') for change in changes) or
            any(change.startswith('nmu') for change in changes) or
            'nmu' in self.changes["Version"]
            )

    def _get_debian_maintainer_data(self):

        self.debian_maintainers = sorted(
            self._qa_xpath('//xhtml:span[@title="maintainer"]/child::text()') +
            self._qa_xpath('//xhtml:span[@title="uploader"]/child::text()')
            )

        self.user_name = ""
        self.user_email = ""

        user_id = self.kw.get('user_id', None)
        if user_id is not None:
            user = meta.session.query(User).get(user_id)

            if user is not None:
                self.user_name = user.name
                self.user_email = user.email

    def _test_is_debian_maintainer(self):
        """
        Tests whether the package Maintainer is the Debian Maintainer.
        """

        log.debug('Finding out whether the package Maintainer is the Debian Maintainer')

        self.test_result.is_debian_maintainer = self.user_name in self.debian_maintainers


    def _test_has_new_maintainer(self):
        """
        Tests whether this package version introduces a new Maintainer.
        """
        log.debug('Finding out whether this package version introduces a new Maintainer')

        # TODO

    def _test_previous_sponsors(self):
        """
        Finds previous sponsors.
        """
        log.debug('Finding previous sponsors of the package')

        # TODO

    @importercmd
    def test_qa(self):
        """Run the Debian QA tests"""

        self.test_result = self.new_test_result()

        self._test_package_in_debian()
        if self._in_debian:
            self._test_last_upload()
            self._test_is_nmu()
            self._get_debian_maintainer_data()
            self._test_is_debian_maintainer()
            self._test_has_new_maintainer()
            self._test_previous_sponsors()



plugin = DebianQAPlugin
models = [
    DebianqaTest,
    ]
template = 'debianqa'