maintaineremail.py

# -*- coding: utf-8 -*-
#
#   maintaineremail.py — maintaineremail 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>
#   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 the maintaineremail plugin.
"""

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

import email.utils
import logging
import re

from debian import deb822

from debexpo.lib import constants
from debexpo.plugins.api import *
from debexpo.model.users import User

log = logging.getLogger(__name__)

@test_result
class MaintainerEmailTest(PluginResult):
    """ Result of the maintaineremail QA test. """

    user_is_maintainer = bool_field('user_is_maintainer')
    user_in_uploaders = bool_field('user_in_uploaders')

    def __str__(self):
        if self.user_is_maintainer:
            return '"Maintainer" email is the same as the uploader'
        elif self.user_in_uploaders:
            return 'The uploader is in the package\'s "Uploaders" field'
        else:
            return 'The uploader is not in the package\'s "Maintainer"' \
                ' or "Uploaders" fields'

class UploaderEmail(PluginResult):
    """ Email address of one of the package's co-maintainers """

    def __str__(self):
        return self['email']

class MaintainerEmailPlugin(QAPlugin):

    @importercmd
    def test_maintainer_email(self):
        """
        Tests whether the maintainer email is the same as the uploader email.
        """
        user_id = self.kw.get('user_id', None)
        if user_id is None:
            log.warning('Could not get the uploader\'s user details from the database')
            return

        log.debug('Checking whether the maintainer email is the same as the uploader email')

        user = self.session.query(User).get(user_id)

        log.debug('Checking whether the maintainer email is the same as'
                  ' the uploader email')

        user = self.package_version.package.user

        if user is not None:
            maintainer_name, maintainer_email = email.utils.parseaddr(
                self.changes['Maintainer'])
            uploader_emails = []

            dsc = deb822.Dsc(file(self.changes.get_dsc()))

            if 'Uploaders' in dsc:
                for uploader_name, uploader_email in email.utils.getaddresses(
                        [dsc['Uploaders']]):
                    uploader_emails.append(uploader_email)

            severity = constants.PLUGIN_SEVERITY_INFO
            user_is_maintainer = True

            if user.email == maintainer_email:
                log.debug('"Maintainer" email is the same as the uploader')
            elif user.email in uploader_emails:
                user_in_uploaders = True
                log.debug('The uploader is in the package\'s "Uploaders" field')
            else:
                log.warning('%s != %s' % (user.email, maintainer_email))
                severity = constants.PLUGIN_SEVERITY_WARNING
                user_is_maintainer = False

            result = self.new_test_result(severity=severity,
                                          user_is_maintainer=user_is_maintainer,
                                          user_email=user.email,
                                          maintainer_email=maintainer_email)

            for uploader in uploaders_emails:
                self.new_result(UploaderEmail, email='uploader')


plugin = MaintainerEmailPlugin
models = [
    MaintainerEmailTest,
    UploaderEmail,
    ]