Source code for distro_tracker.vendor.kali.rules

# Copyright 2015 The Distro Tracker Developers
# See the COPYRIGHT file at the top-level directory of this distribution and
# at https://deb.li/DTAuthors
#
# This file is part of Distro Tracker. It is subject to the license terms
# in the LICENSE file found in the top-level directory of this
# distribution and at https://deb.li/DTLicense. No part of Distro Tracker,
# including this file, may be copied, modified, propagated, or distributed
# except according to the terms contained in the LICENSE file.
"""
Kali specific rules
"""

import os.path
import re

from distro_tracker.core.package_tables import create_table
from distro_tracker.debci_status.tracker_package_tables import DebciTableField
from distro_tracker.mail import mail_news


def classify_message(msg, package, keyword):
    """Classify incoming email messages with a package and a keyword."""
    # Default values for git commit notifications
    xgitrepo = msg.get('X-GitLab-Project-Path', msg.get('X-Git-Repo'))
    if xgitrepo:
        if not package:
            if xgitrepo.endswith('.git'):
                xgitrepo = xgitrepo[:-4]
            package = os.path.basename(xgitrepo)
        if not keyword:
            keyword = 'vcs'

    # Recognize build logs
    if msg.get('X-Rebuildd-Host'):
        match = re.search(r'build of (\S+)_', msg.get('Subject'))
        if match:
            keyword = 'build'
            package = match.group(1)

    # Store some messages as news
    if msg.get('X-Distro-Tracker-News', 'no') == 'yes' and package:
        mail_news.create_news(msg, package)
    return (package, keyword)


def approve_default_message(msg):
    """
    The function should return a ``Boolean`` indicating whether this message
    should be forwarded to subscribers which are subscribed to default
    keyword messages.

    :param msg: The message to approve
    :type msg: :py:class:`email.message.Message`
    """
    return False


def get_table_fields(table):
    """
    The function provides additional fields which should be displayed in
    the team's packages table
    """
    return table.default_fields + [DebciTableField]


def get_tables_for_team_page(team, limit):
    """
    The function must return a list of :class:`BasePackageTable` objects
    to be displayed in the main page of teams.

    :param team: The team for which the tables must be added.
    :type package: :class:`Team <distro_tracker.core.models.Team>`
    :param int limit: The number of packages to be displayed in the tables
    """
    return [
        create_table(slug='general', scope=team, limit=limit),
        create_table(
            slug='general', scope=team, limit=limit,
            tag='tag:debci-failures')
    ]