pungi/pungi/phases/extra_files.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, see <https://gnu.org/licenses/>.


import os
import copy
import fnmatch

from pungi.util import get_arch_variant_data, pkg_is_rpm, copy_all
from pungi.arch import split_name_arch
from pungi import metadata
from pungi.wrappers.scm import get_file_from_scm, get_dir_from_scm
from pungi.phases.base import ConfigGuardedPhase


class ExtraFilesPhase(ConfigGuardedPhase):
    """EXTRA_FILES"""
    name = "extra_files"

    def __init__(self, compose, pkgset_phase):
        super(ExtraFilesPhase, self).__init__(compose)
        # pkgset_phase provides package_sets
        self.pkgset_phase = pkgset_phase

    def run(self):
        for arch in self.compose.get_arches() + ["src"]:
            for variant in self.compose.get_variants(arch=arch):
                if variant.is_empty:
                    continue
                cfg = get_arch_variant_data(self.compose.conf, self.name, arch, variant)
                if cfg:
                    copy_extra_files(self.compose, cfg, arch, variant, self.pkgset_phase.package_sets)
                else:
                    self.compose.log_info('[SKIP ] No extra files (arch: %s, variant: %s)'
                                          % (arch, variant.uid))


def copy_extra_files(compose, cfg, arch, variant, package_sets, checksum_type=None):
    checksum_type = checksum_type or compose.conf['media_checksums']
    var_dict = {
        "arch": arch,
        "variant_id": variant.id,
        "variant_id_lower": variant.id.lower(),
        "variant_uid": variant.uid,
        "variant_uid_lower": variant.uid.lower(),
    }

    msg = "Getting extra files (arch: %s, variant: %s)" % (arch, variant)
    compose.log_info("[BEGIN] %s" % msg)

    os_tree = compose.paths.compose.os_tree(arch, variant)
    extra_files_dir = compose.paths.work.extra_files_dir(arch, variant)

    for scm_dict in cfg:
        scm_dict = copy.deepcopy(scm_dict)
        # if scm is "rpm" and repo contains only a package name, find the
        # package(s) in package set
        if scm_dict["scm"] == "rpm" and not _is_external(scm_dict["repo"]):
            rpms = []
            pattern = scm_dict["repo"] % var_dict
            pkg_name, pkg_arch = split_name_arch(pattern)
            for pkgset_file in package_sets[arch]:
                pkg_obj = package_sets[arch][pkgset_file]
                if pkg_is_rpm(pkg_obj) and _pkg_matches(pkg_obj, pkg_name, pkg_arch):
                    rpms.append(pkg_obj.file_path)
            if not rpms:
                raise RuntimeError('No package matching %s in the package set.' % pattern)
            scm_dict["repo"] = rpms

        getter = get_file_from_scm if 'file' in scm_dict else get_dir_from_scm
        target_path = os.path.join(extra_files_dir, scm_dict.get('target', '').lstrip('/'))
        getter(scm_dict, target_path, logger=compose._logger)

    if os.listdir(extra_files_dir):
        files_copied = copy_all(extra_files_dir, os_tree)
        metadata.write_extra_files(os_tree, files_copied, checksum_type, compose._logger)

    compose.log_info("[DONE ] %s" % msg)


def _pkg_matches(pkg_obj, name_glob, arch):
    """Check if `pkg_obj` matches name and arch."""
    return (fnmatch.fnmatch(pkg_obj.name, name_glob) and
            (arch is None or arch == pkg_obj.arch))


def _is_external(rpm):
    """Check if path to rpm points outside of the compose: i.e. it is an
    absolute path or a URL."""
    return rpm.startswith('/') or '://' in rpm