watchfile.py

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

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

import subprocess
import logging
import os

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

log = logging.getLogger(__name__)


@test_result
class WatchfileTest(PluginResult):
    """ Result of the watchfile QA test """
    watch_file_present = bool_field('watch_file_present')
    watch_file_works = bool_field('watch_file_workds')
    uscan_output = string_field('uscan_output')
    latest_upstream = string_field('latest_upstream')

    def __str__(self):
        if not self.watch_file_present:
            outcome = 'Watch file is not present'

        elif not self.watch_file_works:
            outcome = "A watch file is present but doesn't work"

        else:
            outcome = 'Package is {} the latest upstream version'.format(
                '' if self.latest_upstream else 'not')

        return outcome


class WatchFilePlugin(QAPlugin):

    def _watch_file_present(self):
        return os.path.isfile(os.path.join('extracted', 'debian', 'watch'))

    def _run_uscan(self):
        if not hasattr(self, 'status') and not hasattr(self, 'output'):
            os.chdir('extracted')
            call = subprocess.Popen(["uscan", "--verbose", '--report'],
                                    stdout=subprocess.PIPE)
            (self.output, _) = call.communicate()
            self.status = call.returncode
            os.chdir('..')

    def _watch_file_works(self):
        self._run_uscan()
        return (self.output.find('Newest version on remote site is') != -1)

    @importercmd
    def test_uscan(self):
        """
        Run the watch file-related checks in the package
        """

        log.debug('Checking to see whether there is'
                  'a watch file in the package')
        test_result = self.new_test_result()

        if self._watch_file_present():
            log.debug('Watch file present')
            test_result.watch_file_present = True
        else:
            log.warning('Watch file not present')
            test_result.watch_file_present = False
            return

        test_result.watch_file_works = self._watch_file_works()
        test_result.uscan_output = self.output
        if not test_result.watch_file_works:
            log.debug('Watch file does not work')
            test_result.severity = constants.PLUGIN_SEVERITY_WARNING
            return

        log.debug('Looking whether there is a new upstream version')

        test_result.latest_upstream = self.status == 1
        if test_result.latest_upstream:
            log.debug('Package is the latest upstream version')
        else:
            log.warning('Package is not the latest upstream version')
            test_result.severity = constants.PLUGIN_SEVERITY_WARNING
        return


plugin = WatchFilePlugin
models = [WatchfileTest]