diffclean.py

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

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

import subprocess
import logging

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

log = logging.getLogger(__name__)


@test_result
class DiffCleanTest(PluginResult):
    """ Result of the diffclean QA test """
    dirty = bool_field('dirty')
    diff_file = bool_field('diff_file')
    severity = int_field('severity')

    def __str__(self):
        outcome = 'Diff file  is {} clean'.format('not' if self.dirty else '')
        return outcome


class DiffFile(PluginResult):
    filename = string_field('filename')
    stats = string_field('stats')


class DiffCleanPlugin(BasePlugin):

    @importercmd
    def test_diff_clean(self):
        """
        Check to make sure the diff.gz is clean.
        """
        log.debug('Checking to make sure the diff.gz is clean')

        difffile = self.changes.get_diff()

        if difffile is None or not difffile.endswith('.diff.gz'):
            log.warning('Package has no diff.gz file;'
                        'native or format 3.0 package?')
            return

        diffstat = subprocess.Popen(["diffstat", "-p1", difffile],
                                    stdout=subprocess.PIPE).communicate()[0]

        test_result = self.new_test_result()

        # Last line is the summary line
        for item in diffstat.splitlines()[:-1]:
            filename, stats = [i.strip() for i in item.split("|")]
            if not filename.startswith('debian/'):
                test_resut.dirty = True
                self.new_result(DiffFile, filename=filename, stats=stats)

        if not test_result.dirty:
            log.debug('Diff file %s is clean' % difffile)
        else:
            log.error('Diff file %s is not clean' % difffile)
            test_result.severity = constants.PLUGIN_SEVERITY_WARNING

plugin = DiffCleanPlugin
models = [
    DiffCleanTest,
    DiffFile,
    ]