buildsystem.py

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

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

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

import logging
import os

from debian import deb822

log = logging.getLogger(__name__)

@test_result
class BuildsystemTest(PluginResult):
    """
    Result of the 'buildsystem' plugin.
    """

    @property
    def known(self):
        return self['buildsystem'] != 'unknown'

    def __str__(self):
        if self.known:
            msg = 'Package uses %s' % self['buildsystem']
        else:
            msg = 'Unknown'
        return 'Build system: %s' % msg

class BuildSystemPlugin(QAPlugin):

    @importercmd
    def test_build_system(self):
        """
        Finds the build system of the package.
        """
        log.debug("Finding the package's build system")

        log.debug('Opening dsc file in %s' % os.getcwd())
        dsc_path = os.path.join(self.changes.get_pool_path(),
                                self.changes.get_dsc())
        with open(dsc_path, 'r') as dsc_file:
            dsc = deb822.Dsc(dsc_file)

        build_depends = dsc.get('Build-Depends', '')

        result = self.new_test_result()

        if 'cdbs' in build_depends:
            result['buildsystem'] = 'cdbs'

        elif 'debhelper' in build_depends:
            result['buildsystem'] = 'debhelper'

            # Retrieve the debhelper compat level
            if hasattr(self, 'tempdir'):
                compatpath = os.path.join(self.tempdir, "extracted/debian/compat")
                try:
                    with open(compatpath, "rb") as f:
                        compat_level = int(f.read().strip())
                except IOError:
                    compat_level = 'unknown'
            else:
                compat_level = 'unknown'

            result['compat_level'] = compat_level

            # Warn on old compatibility levels
            if compat_level is None or compat_level <= 4:
                result['severity'] = constants.PLUGIN_SEVERITY_WARNING
        else:
            result['buildsystem'] = 'unknown'
            result['severity'] = constants.PLUGIN_SEVERITY_WARNING

plugin = BuildSystemPlugin
models = [
    BuildsystemTest,
    ]