native.py

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

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

import logging

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

log = logging.getLogger(__name__)


@test_result
class NativeTest(PluginResult):
    """
    Result of the 'native' plugin for a package.
    """

    is_native = bool_field('native')

    def __str__(self):
        return 'Package is %s native' % ('' if self.is_native else 'not')


class NativePlugin(QAPlugin):
    """
    Plugin checking whether a package is a native package.
    """

    @importercmd
    def test_native(self):
        """
        Test to see whether the package is a native package.
        """
        log.debug('Checking whether the package is native or not')
        filecheck = filesystem.CheckFiles()

        is_native = filecheck.is_native_package(self.changes)

        result = self.new_test_result()
        if is_native:
            # Most uploads will not be native, and especially on mentors, a native
            # package is almost probably in error.
            log.warning('Package is native')

            result['severity'] = constants.PLUGIN_SEVERITY_WARNING
        else:
            log.debug('Package is not native')
            result['severity'] = constants.PLUGIN_SEVERITY_INFO

        result.is_native = is_native

plugin = NativePlugin
models = [
    NativeTest,
    ]