pungi/pungi/checks.py

# -*- coding: utf-8 -*-


# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Library General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


import os.path
import platform


def _will_productimg_run(conf):
    return conf.get('productimg', False) and conf.get('bootable', False)


def is_jigdo_needed(conf):
    return conf.get('create_jigdo', True)


def is_isohybrid_needed(conf):
    """The isohybrid command is needed locally only for productimg phase and
    createiso phase without runroot. If that is not going to run, we don't need
    to check for it. Additionally, the syslinux package is only available on
    x86_64 and i386.
    """
    runroot = conf.get('runroot', False)
    if runroot and not _will_productimg_run(conf):
        return False
    if platform.machine() not in ('x86_64', 'i686', 'i386'):
        msg = ('Not checking for /usr/bin/isohybrid due to current architecture. '
               'Expect failures in productimg phase.')
        print msg
        return False
    return True


def is_genisoimage_needed(conf):
    """This is only needed locally for productimg and createiso without runroot.
    """
    runroot = conf.get('runroot', False)
    if runroot and not _will_productimg_run(conf):
        return False
    return True

# The first element in the tuple is package name expected to have the
# executable (2nd element of the tuple). The last element is an optional
# function that should determine if the tool is required based on
# configuration.
tools = [
    ("isomd5sum", "/usr/bin/implantisomd5", None),
    ("isomd5sum", "/usr/bin/checkisomd5", None),
    ("jigdo", "/usr/bin/jigdo-lite", is_jigdo_needed),
    ("genisoimage", "/usr/bin/genisoimage", is_genisoimage_needed),
    ("gettext", "/usr/bin/msgfmt", None),
    ("syslinux", "/usr/bin/isohybrid", is_isohybrid_needed),
    ("yum-utils", "/usr/bin/createrepo", None),
    ("yum-utils", "/usr/bin/mergerepo", None),
    ("yum-utils", "/usr/bin/repoquery", None),
    ("git", "/usr/bin/git", None),
    ("cvs", "/usr/bin/cvs", None),
]

imports = [
    ("kobo", "kobo"),
    ("kobo-rpmlib", "kobo.rpmlib"),
    ("python-lxml", "lxml"),
    ("koji", "koji"),
    ("python-productmd", "productmd"),
]


def check(conf):
    fail = False

    # Check python modules
    for package, module in imports:
        try:
            __import__(module)
        except ImportError:
            print("Module '%s' doesn't exist. Install package '%s'." % (module, package))
            fail = True

    # Check tools
    for package, path, test_if_required in tools:
        if test_if_required and not test_if_required(conf):
            # The config says this file is not required, so we won't even check it.
            continue
        if not os.path.exists(path):
            print("Program '%s' doesn't exist. Install package '%s'." % (path, package))
            fail = True

    return not fail


def check_umask(logger):
    """Make sure umask is set to something reasonable. If not, log a warning."""
    mask = os.umask(0)
    os.umask(mask)

    if mask > 0o022:
        logger.warning('Unusually strict umask detected (0%03o), '
                       'expect files with broken permissions.', mask)


def validate_options(conf, valid_options):
    errors = []
    for i in valid_options:
        name = i["name"]
        value = conf.get(name)

        if i.get("deprecated", False):
            if name in conf:
                errors.append("Deprecated config option: %s; %s" % (name, i["comment"]))
            continue

        if name not in conf:
            if not i.get("optional", False):
                errors.append("Config option not set: %s" % name)
            continue

        # verify type
        if "expected_types" in i:
            etypes = i["expected_types"]
            if not isinstance(etypes, list) and not isinstance(etypes, tuple):
                raise TypeError("The 'expected_types' value must be wrapped in a list: %s" % i)
            found = False
            for etype in etypes:
                if isinstance(value, etype):
                    found = True
                    break
            if not found:
                errors.append("Config option '%s' has invalid type: %s. Expected: %s." % (name, str(type(value)), etypes))
                continue

        # verify value
        if "expected_values" in i:
            evalues = i["expected_values"]
            if not isinstance(evalues, list) and not isinstance(evalues, tuple):
                raise TypeError("The 'expected_values' value must be wrapped in a list: %s" % i)
            found = False
            for evalue in evalues:
                if value == evalue:
                    found = True
                    break
            if not found:
                errors.append("Config option '%s' has invalid value: %s. Expected: %s." % (name, value, evalues))
                continue

        if "requires" in i:
            for func, requires in i["requires"]:
                if func(value):
                    for req in requires:
                        if req not in conf:
                            errors.append("Config option %s=%s requires %s which is not set" % (name, value, req))

        if "conflicts" in i:
            for func, conflicts in i["conflicts"]:
                if func(value):
                    for con in conflicts:
                        if con in conf:
                            errors.append("Config option %s=%s conflicts with option %s" % (name, value, con))

    return errors